2 File : $Source: /cvsroot/ijbswa/current/doc/source/p-config.sgml,v $
4 Purpose : Used with other docs and files only.
6 $Id: p-config.sgml,v 2.119 2016/03/30 11:14:46 fabiankeil Exp $
8 Copyright (C) 2001-2016 Privoxy Developers http://www.privoxy.org/
11 ========================================================================
12 NOTE: Please read developer-manual/documentation.html before touching
13 anything in this, or other Privoxy documentation.
14 ========================================================================
17 This file contains all the config file comments and options. It used to
18 build both the user-manual config sections, and all of config (yes, the main
21 Rationale: This is broken up into two files since a file with a prolog
22 (DTD, etc) cannot be sourced as a secondary file. config.sgml is basically
23 a wrapper for this file.
27 OPTIONS: The actual options are included in this file and prefixed with
28 '@@', and processed by the Makefile to strip the '@@'. Default options
29 that should appear commented out should be listed as: '@@#OPTION'.
30 Otherwise, as '@@OPTION'. Example:
32 @@listen-address 127.0.0.1:8118
34 The Makefile does significant other processing too. The final results
35 should be checked to make sure that the perl processing does not
36 fubar something!!! Makefile processing requires w3m, fmt (shell line
40 This file is included into:
43 config (the actual Privoxy config file)
48 <!-- This part only goes into user-manual -->
50 <title>The Main Configuration File</title>
53 By default, the main configuration file is named <filename>config</filename>,
54 with the exception of Windows, where it is named <filename>config.txt</filename>.
55 Configuration lines consist of an initial keyword followed by a list of
56 values, all separated by whitespace (any number of spaces or tabs). For
64 <emphasis>confdir /etc/privoxy</emphasis></literallayout>
70 Assigns the value <literal>/etc/privoxy</literal> to the option
71 <literal>confdir</literal> and thus indicates that the configuration
72 directory is named <quote>/etc/privoxy/</quote>.
76 All options in the config file except for <literal>confdir</literal> and
77 <literal>logdir</literal> are optional. Watch out in the below description
78 for what happens if you leave them unset.
82 The main config file controls all aspects of <application>Privoxy</application>'s
83 operation that are not location dependent (i.e. they apply universally, no matter
84 where you may be surfing). Like the filter and action files, the config file is
85 a plain text file and can be modified with a text editor like emacs, vim or
93 <!-- This part only goes into the config file -->
96 @@TITLE<!-- between the @@ is stripped by Makefile -->@@
97 Sample Configuration File for Privoxy &p-version;
100 $Id: p-config.sgml,v 2.119 2016/03/30 11:14:46 fabiankeil Exp $
103 Copyright (C) 2001-2016 Privoxy Developers http://www.privoxy.org/
108 #################################################################
113 II. FORMAT OF THE CONFIGURATION FILE #
115 1. LOCAL SET-UP DOCUMENTATION #
116 2. CONFIGURATION AND LOG FILE LOCATIONS #
118 4. ACCESS CONTROL AND SECURITY #
121 7. WINDOWS GUI OPTIONS #
123 #################################################################
127 <literallayout>I. INTRODUCTION
128 =============== <!-- fuck this madness --></literallayout>
131 This file holds Privoxy's main configuration. Privoxy detects
132 configuration changes automatically, so you don't have to restart it
133 unless you want to load a different configuration file.
136 The configuration will be reloaded with the first request after the
137 change was done, this request itself will still use the old configuration,
138 though. In other words: it takes two requests before you see the result of
139 your changes. Requests that are dropped due to ACL don't trigger reloads.
142 When starting Privoxy on Unix systems, give the location of this
143 file as last argument. On Windows systems, Privoxy will look for
144 this file with the name 'config.txt' in the current working directory
145 of the Privoxy process.
149 <literallayout><!-- funky spacing -->
151 II. FORMAT OF THE CONFIGURATION FILE
152 ====================================</literallayout>
155 Configuration lines consist of an initial keyword followed by a list
156 of values, all separated by whitespace (any number of spaces or
160 actionsfile default.action
163 Indicates that the actionsfile is named 'default.action'.
166 The '#' indicates a comment. Any part of a line following a '#' is
167 ignored, except if the '#' is preceded by a '\'.
170 Thus, by placing a # at the start of an existing configuration line,
171 you can make it a comment and it will be treated as if it weren't there.
172 This is called "commenting out" an option and can be useful. Removing
173 the # again is called "uncommenting".
176 Note that commenting out an option and leaving it at its default
177 are two completely different things! Most options behave very
178 differently when unset. See the "Effect if unset" explanation
179 in each option's description for details.
182 Long lines can be continued on the next line by using a `\' as
188 <!-- ************************************************ -->
189 <!-- The following is common to both outputs (mostly) -->
190 <!-- ************************************************ -->
194 <!-- ~~~~~ New section ~~~~~ -->
195 <sect2 id="local-set-up">
196 <title>Local Set-up Documentation</title>
199 If you intend to operate <application>Privoxy</application> for more users
200 than just yourself, it might be a good idea to let them know how to reach
201 you, what you block and why you do that, your policies, etc.
205 <!-- ~~~~~ New section ~~~~~ -->
206 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
209 <term>Specifies:</term>
212 Location of the <application>Privoxy</application> User Manual.
217 <term>Type of value:</term>
219 <para>A fully qualified URI</para>
223 <term>Default value:</term>
225 <para><emphasis>Unset</emphasis></para>
229 <term>Effect if unset:</term>
232 <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/<replaceable class="parameter">version</replaceable>/user-manual/</ulink>
233 will be used, where <replaceable class="parameter">version</replaceable> is the <application>Privoxy</application> version.
241 The User Manual URI is the single best source of information on
242 <application>Privoxy</application>, and is used for help links from some
243 of the internal CGI pages. The manual itself is normally packaged with the
244 binary distributions, so you probably want to set this to a locally
252 Unix, in local filesystem (may not work with all browsers):
255 <screen> user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
258 Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
261 <screen> user-manual file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
264 Windows, UNC notation (with forward slashes):
267 <screen> user-manual file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
271 The best all purpose solution is simply to put the full local
272 <literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
276 <screen> user-manual /usr/share/doc/privoxy/user-manual</screen>
279 The User Manual is then available to anyone with access to
280 <application>Privoxy</application>, by following the built-in URL:
281 <literal>http://config.privoxy.org/user-manual/</literal>
282 (or the shortcut: <literal>http://p.p/user-manual/</literal>).
285 If the documentation is not on the local system, it can be accessed
286 from a remote server, as:
289 <screen> user-manual http://example.com/privoxy/user-manual/</screen>
292 <!-- this gets hammered in conversion to config. Text repeated below. -->
295 If set, this option should be <emphasis>the first option in the config
296 file</emphasis>, because it is used while the config file is being read
309 If set, this option should be the first option in the config
310 file, because it is used while the config file is being read.
319 <![%config-file;[<literallayout>@@#user-manual http://www.privoxy.org/user-manual/</literallayout>]]>
323 <!-- ~~~~~ New section ~~~~~ -->
324 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
328 <term>Specifies:</term>
331 A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
336 <term>Type of value:</term>
342 <term>Default value:</term>
344 <para><emphasis>Unset</emphasis></para>
348 <term>Effect if unset:</term>
351 No links are displayed on the "untrusted" error page.
359 The value of this option only matters if the experimental trust mechanism has been
360 activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> below.)
363 If you use the trust mechanism, it is a good idea to write up some on-line
364 documentation about your trust policy and to specify the URL(s) here.
365 Use multiple times for multiple URLs.
368 The URL(s) should be added to the trustfile as well, so users don't end up
369 locked out from the information on why they were locked out in the first place!
375 <![%config-file;[<literallayout>@@#trust-info-url http://www.example.com/why_we_block.html</literallayout>]]>
376 <![%config-file;[<literallayout>@@#trust-info-url http://www.example.com/what_we_allow.html</literallayout>]]>
380 <!-- ~~~~~ New section ~~~~~ -->
381 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
385 <term>Specifies:</term>
388 An email address to reach the <application>Privoxy</application> administrator.
393 <term>Type of value:</term>
395 <para>Email address</para>
399 <term>Default value:</term>
401 <para><emphasis>Unset</emphasis></para>
405 <term>Effect if unset:</term>
408 No email address is displayed on error pages and the CGI user interface.
416 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
417 are unset, the whole "Local Privoxy Support" box on all generated pages will
424 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
428 <!-- ~~~~~ New section ~~~~~ -->
429 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
433 <term>Specifies:</term>
436 A URL to documentation about the local <application>Privoxy</application> setup,
437 configuration or policies.
442 <term>Type of value:</term>
448 <term>Default value:</term>
450 <para><emphasis>Unset</emphasis></para>
454 <term>Effect if unset:</term>
457 No link to local documentation is displayed on error pages and the CGI user interface.
465 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
466 are unset, the whole "Local Privoxy Support" box on all generated pages will
470 This URL shouldn't be blocked ;-)
476 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
480 <!-- ~ End section ~ -->
484 <!-- ~~~~~ New section ~~~~~ -->
486 <sect2 id="conf-log-loc">
487 <title>Configuration and Log File Locations</title>
490 <application>Privoxy</application> can (and normally does) use a number of
491 other files for additional configuration, help and logging.
492 This section of the configuration file tells <application>Privoxy</application>
493 where to find those other files.
497 The user running <application>Privoxy</application>, must have read
498 permission for all configuration files, and write permission to any files
499 that would be modified, such as log files and actions files.
503 <!-- ~~~~~ New section ~~~~~ -->
504 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
508 <term>Specifies:</term>
510 <para>The directory where the other configuration files are located.</para>
514 <term>Type of value:</term>
516 <para>Path name</para>
520 <term>Default value:</term>
522 <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
526 <term>Effect if unset:</term>
528 <para><emphasis>Mandatory</emphasis></para>
535 No trailing <quote><literal>/</literal></quote>, please.
541 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
544 <!-- ~~~~~ New section ~~~~~ -->
545 <sect3 renderas="sect4" id="templdir"><title>templdir</title>
549 <term>Specifies:</term>
551 <para>An alternative directory where the templates are loaded from.</para>
555 <term>Type of value:</term>
557 <para>Path name</para>
561 <term>Default value:</term>
567 <term>Effect if unset:</term>
569 <para>The templates are assumed to be located in confdir/template.</para>
576 <application>Privoxy's</application> original templates are usually
577 overwritten with each update. Use this option to relocate customized
578 templates that should be kept. As template variables might change
579 between updates, you shouldn't expect templates to work with
580 <application>Privoxy</application> releases other than the one
581 they were part of, though.
587 <![%config-file;[<literallayout>@@#templdir .</literallayout>]]>
591 <!-- ~~~~~ New section ~~~~~ -->
592 <sect3 renderas="sect4" id="temporary-directory"><title>temporary-directory</title>
596 <term>Specifies:</term>
598 <para>A directory where Privoxy can create temporary files.</para>
602 <term>Type of value:</term>
604 <para>Path name</para>
608 <term>Default value:</term>
614 <term>Effect if unset:</term>
616 <para>No temporary files are created, external filters don't work.</para>
623 To execute <literal><ulink url="actions-file.html#EXTERNAL-FILTER">external filters</ulink></literal>,
624 <application>Privoxy</application> has to create temporary files.
625 This directive specifies the directory the temporary files should
629 It should be a directory only <application>Privoxy</application>
630 (and trusted users) can access.
636 <![%config-file;[<literallayout>@@#temporary-directory .</literallayout>]]>
640 <!-- ~~~~~ New section ~~~~~ -->
641 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
645 <term>Specifies:</term>
648 The directory where all logging takes place
649 (i.e. where the <filename>logfile</filename> is located).
654 <term>Type of value:</term>
656 <para>Path name</para>
660 <term>Default value:</term>
662 <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
666 <term>Effect if unset:</term>
668 <para><emphasis>Mandatory</emphasis></para>
675 No trailing <quote><literal>/</literal></quote>, please.
681 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
685 <!-- ~~~~~ New section ~~~~~ -->
686 <sect3 renderas="sect4" id="actionsfile"><title>
689 <anchor id="default.action">
690 <anchor id="standard.action">
691 <anchor id="user.action">
692 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
695 <term>Specifies:</term>
698 The <link linkend="actions-file">actions file(s)</link> to use
703 <term>Type of value:</term>
705 <para>Complete file name, relative to <literal>confdir</literal></para>
709 <term>Default values:</term>
713 <msgtext><literallayout> match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout></msgtext>
716 <msgtext><literallayout> default.action # Main actions file</literallayout></msgtext>
719 <msgtext><literallayout> user.action # User customizations</literallayout></msgtext>
725 <term>Effect if unset:</term>
728 No actions are taken at all. More or less neutral proxying.
736 Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
739 The default values are <filename>default.action</filename>, which is the
740 <quote>main</quote> actions file maintained by the developers, and
741 <filename>user.action</filename>, where you can make your personal additions.
744 Actions files contain all the per site and per URL configuration for
745 ad blocking, cookie management, privacy considerations, etc.
751 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
752 <!-- html -> text conversion, blah -->
753 <![%config-file;[<literallayout>@@actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout>]]>
754 <![%config-file;[<literallayout>@@actionsfile default.action # Main actions file</literallayout>]]>
756 XXX: Like user.filter, user.action should probably be commented out
757 by default as not all packages install it into the default directory.
760 <![%config-file;[<literallayout>@@actionsfile user.action # User customizations</literallayout>]]>
763 <!-- ~~~~~ New section ~~~~~ -->
764 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
765 <anchor id="default.filter">
768 <term>Specifies:</term>
771 The <link linkend="filter-file">filter file(s)</link> to use
776 <term>Type of value:</term>
778 <para>File name, relative to <literal>confdir</literal></para>
782 <term>Default value:</term>
784 <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
788 <term>Effect if unset:</term>
791 No textual content filtering takes place, i.e. all
792 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
793 actions in the actions files are turned neutral.
801 Multiple <literal>filterfile</literal> lines are permitted.
804 The <link linkend="filter-file">filter files</link> contain content modification
805 rules that use <link linkend="regex">regular expressions</link>. These rules permit
806 powerful changes on the content of Web pages, and optionally the headers
807 as well, e.g., you could try to disable your favorite JavaScript annoyances,
808 re-write the actual displayed text, or just have some fun
809 playing buzzword bingo with web pages.
813 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
814 actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
815 to be defined in a filter file!
818 A pre-defined filter file called <filename>default.filter</filename> that contains
819 a number of useful filters for common problems is included in the distribution.
820 See the section on the <literal><link linkend="filter">filter</link></literal>
824 It is recommended to place any locally adapted filters into a separate
825 file, such as <filename>user.filter</filename>.
831 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
832 <![%config-file;[<literallayout>@@filterfile user.filter # User customizations</literallayout>]]>
836 <!-- ~~~~~ New section ~~~~~ -->
837 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
841 <term>Specifies:</term>
849 <term>Type of value:</term>
851 <para>File name, relative to <literal>logdir</literal></para>
855 <term>Default value:</term>
857 <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
861 <term>Effect if unset:</term>
864 No logfile is written.
872 The logfile is where all logging and error messages are written. The level
873 of detail and number of messages are set with the <literal>debug</literal>
874 option (see below). The logfile can be useful for tracking down a problem with
875 <application>Privoxy</application> (e.g., it's not blocking an ad you
876 think it should block) and it can help you to monitor what your browser
880 Depending on the debug options below, the logfile may be a privacy risk
881 if third parties can get access to it. As most users will never look
882 at it, <application>Privoxy</application> only logs fatal errors by default.
885 For most troubleshooting purposes, you will have to change that,
886 please refer to the debugging section for details.
889 Any log files must be writable by whatever user <application>Privoxy</application>
890 is being run as (on Unix, default user id is <quote>privoxy</quote>).
893 To prevent the logfile from growing indefinitely, it is recommended to
894 periodically rotate or shorten it. Many operating systems support log
895 rotation out of the box, some require additional software to do it.
896 For details, please refer to the documentation for your operating system.
902 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
906 <!-- ~~~~~ New section ~~~~~ -->
907 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
910 <term>Specifies:</term>
913 The name of the trust file to use
918 <term>Type of value:</term>
920 <para>File name, relative to <literal>confdir</literal></para>
924 <term>Default value:</term>
926 <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
930 <term>Effect if unset:</term>
933 The entire trust mechanism is disabled.
941 The trust mechanism is an experimental feature for building white-lists and should
942 be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
945 If you specify a trust file, <application>Privoxy</application> will only allow
946 access to sites that are specified in the trustfile. Sites can be listed
950 Prepending a <literal>~</literal> character limits access to this site
951 only (and any sub-paths within this site), e.g.
952 <literal>~www.example.com</literal> allows access to
953 <literal>~www.example.com/features/news.html</literal>, etc.
956 Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
957 prepending the name with a <literal>+</literal> character. The effect is that
958 access to untrusted sites will be granted -- but only if a link from this
959 trusted referrer was used to get there. The link target will then be added
960 to the <quote>trustfile</quote> so that future, direct accesses will be
961 granted. Sites added via this mechanism do not become trusted referrers
962 themselves (i.e. they are added with a <literal>~</literal> designation).
963 There is a limit of 512 such entries, after which new entries will not be
967 If you use the <literal>+</literal> operator in the trust file, it may grow
968 considerably over time.
971 It is recommended that <application>Privoxy</application> be compiled with
972 the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
973 <literal> --disable-editor</literal> options, if this feature is to be
977 Possible applications include limiting Internet access for children.
984 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
988 <!-- ~ End section ~ -->
990 <!-- ~~~~~ New section ~~~~~ -->
991 <sect2 id="debugging">
992 <title>Debugging</title>
995 These options are mainly useful when tracing a problem.
996 Note that you might also want to invoke
997 <application>Privoxy</application> with the <literal>--no-daemon</literal>
998 command line option when debugging.
1001 <sect3 renderas="sect4" id="debug"><title>debug</title>
1005 <term>Specifies:</term>
1008 Key values that determine what information gets logged.
1013 <term>Type of value:</term>
1015 <para>Integer values</para>
1019 <term>Default value:</term>
1021 <para>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</para>
1025 <term>Effect if unset:</term>
1028 Default value is used (see above).
1036 The available debug levels are:
1040 debug 1 # Log the destination for each request &my-app; let through. See also debug 1024.
1041 debug 2 # show each connection status
1042 debug 4 # show I/O status
1043 debug 8 # show header parsing
1044 debug 16 # log all data written to the network
1045 debug 32 # debug force feature
1046 debug 64 # debug regular expression filters
1047 debug 128 # debug redirects
1048 debug 256 # debug GIF de-animation
1049 debug 512 # Common Log Format
1050 debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
1051 debug 2048 # CGI user interface
1052 debug 4096 # Startup banner and warnings.
1053 debug 8192 # Non-fatal errors
1054 debug 32768 # log all data read from the network
1055 debug 65536 # Log the applying actions
1059 To select multiple debug levels, you can either add them or use
1060 multiple <literal>debug</literal> lines.
1063 A debug level of 1 is informative because it will show you each request
1064 as it happens. <emphasis>1, 1024, 4096 and 8192 are recommended</emphasis>
1065 so that you will notice when things go wrong. The other levels are
1066 probably only of interest if you are hunting down a specific problem.
1067 They can produce a hell of an output (especially 16).
1070 If you are used to the more verbose settings, simply enable the debug lines
1074 If you want to use pure CLF (Common Log Format), you should set <quote>debug
1075 512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1078 <application>Privoxy</application> has a hard-coded limit for the
1079 length of log messages. If it's reached, messages are logged truncated
1080 and marked with <quote>... [too long, truncated]</quote>.
1083 Please don't file any support requests without trying to reproduce
1084 the problem with increased debug level first. Once you read the log
1085 messages, you may even be able to solve the problem on your own.
1091 <![%config-file;[<literallayout>@@#debug 1 # Log the destination for each request &my-app; let through.</literallayout>]]>
1092 <![%config-file;[<literallayout>@@#debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
1093 <![%config-file;[<literallayout>@@#debug 4096 # Startup banner and warnings</literallayout>]]>
1094 <![%config-file;[<literallayout>@@#debug 8192 # Non-fatal errors</literallayout>]]>
1098 <!-- ~~~~~ New section ~~~~~ -->
1099 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1103 <term>Specifies:</term>
1106 Whether to run only one server thread.
1111 <term>Type of value:</term>
1113 <para><emphasis>1 or 0</emphasis></para>
1117 <term>Default value:</term>
1119 <para><emphasis>0</emphasis></para>
1123 <term>Effect if unset:</term>
1126 Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1127 serve multiple requests simultaneously.
1135 This option is only there for debugging purposes.
1136 <emphasis>It will drastically reduce performance.</emphasis>
1142 <![%config-file;[<literallayout>@@#single-threaded 1</literallayout>]]>
1145 <!-- ~~~~~ New section ~~~~~ -->
1146 <sect3 renderas="sect4" id="hostname"><title>hostname</title>
1150 <term>Specifies:</term>
1153 The hostname shown on the CGI pages.
1158 <term>Type of value:</term>
1164 <term>Default value:</term>
1166 <para><emphasis>Unset</emphasis></para>
1170 <term>Effect if unset:</term>
1173 The hostname provided by the operating system is used.
1181 On some misconfigured systems resolving the hostname fails or
1182 takes too much time and slows Privoxy down. Setting a fixed hostname
1183 works around the problem.
1186 In other circumstances it might be desirable to show a hostname
1187 other than the one returned by the operating system. For example
1188 if the system has several different hostnames and you don't want
1189 to use the first one.
1192 Note that Privoxy does not validate the specified hostname value.
1198 <![%config-file;[<literallayout>@@#hostname hostname.example.org</literallayout>]]>
1203 <!-- ~ End section ~ -->
1206 <!-- ~~~~~ New section ~~~~~ -->
1207 <sect2 id="access-control">
1208 <title>Access Control and Security</title>
1211 This section of the config file controls the security-relevant aspects
1212 of <application>Privoxy</application>'s configuration.
1216 <!-- ~~~~~ New section ~~~~~ -->
1217 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1221 <term>Specifies:</term>
1224 The address and TCP port on which <application>Privoxy</application> will
1225 listen for client requests.
1230 <term>Type of value:</term>
1232 <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1233 <para>[<replaceable class="parameter">Hostname</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1238 <term>Default value:</term>
1240 <para>127.0.0.1:8118</para>
1244 <term>Effect if unset:</term>
1247 Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable and
1248 recommended for home users who run <application>Privoxy</application> on
1249 the same machine as their browser.
1257 You will need to configure your browser(s) to this proxy address and port.
1260 If you already have another service running on port 8118, or if you want to
1261 serve requests from other machines (e.g. on your local network) as well, you
1262 will need to override the default.
1265 You can use this statement multiple times to make
1266 <application>Privoxy</application> listen on more ports or more
1267 <abbrev>IP</abbrev> addresses. Suitable if your operating system does not
1268 support sharing <abbrev>IPv6</abbrev> and <abbrev>IPv4</abbrev> protocols
1272 If a hostname is used instead of an IP address, <application>Privoxy</application>
1273 will try to resolve it to an IP address and if there are multiple, use the first
1277 If the address for the hostname isn't already known on the system
1278 (for example because it's in /etc/hostname), this may result in DNS
1282 If the specified address isn't available on the system, or if the
1283 hostname can't be resolved, <application>Privoxy</application>
1287 IPv6 addresses containing colons have to be quoted by brackets.
1288 They can only be used if <application>Privoxy</application> has
1289 been compiled with IPv6 support. If you aren't sure if your version
1290 supports it, have a look at
1291 <literal>http://config.privoxy.org/show-status</literal>.
1294 Some operating systems will prefer IPv6 to IPv4 addresses even if the
1295 system has no IPv6 connectivity which is usually not expected by the user.
1296 Some even rely on DNS to resolve localhost which mean the "localhost" address
1297 used may not actually be local.
1300 It is therefore recommended to explicitly configure the intended IP address
1301 instead of relying on the operating system, unless there's a strong reason not to.
1304 If you leave out the address, <application>Privoxy</application> will bind to all
1305 IPv4 interfaces (addresses) on your machine and may become reachable from the
1306 Internet and/or the local network. Be aware that some GNU/Linux distributions
1307 modify that behaviour without updating the documentation. Check for non-standard
1308 patches if your <application>Privoxy</application> version behaves differently.
1311 If you configure <application>Privoxy</application> to be reachable from the
1312 network, consider using <link linkend="acls">access control lists</link>
1313 (ACL's, see below), and/or a firewall.
1316 If you open <application>Privoxy</application> to untrusted users, you will
1317 also want to make sure that the following actions are disabled: <literal><link
1318 linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1319 <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1324 <term>Example:</term>
1327 Suppose you are running <application>Privoxy</application> on
1328 a machine which has the address 192.168.0.1 on your local private network
1329 (192.168.0.0) and has another outside connection with a different address.
1330 You want it to serve requests from inside only:
1334 listen-address 192.168.0.1:8118
1338 Suppose you are running <application>Privoxy</application> on an
1339 IPv6-capable machine and you want it to listen on the IPv6 address
1340 of the loopback device:
1344 listen-address [::1]:8118
1351 <![%config-file;[<literallayout>@@listen-address 127.0.0.1:8118</literallayout>]]>
1355 <!-- ~~~~~ New section ~~~~~ -->
1356 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1360 <term>Specifies:</term>
1363 Initial state of "toggle" status
1368 <term>Type of value:</term>
1374 <term>Default value:</term>
1380 <term>Effect if unset:</term>
1383 Act as if toggled on
1391 If set to 0, <application>Privoxy</application> will start in
1392 <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1393 content-neutral proxy with both ad blocking and content filtering
1394 disabled. See <literal>enable-remote-toggle</literal> below.
1400 <![%config-file;[<literallayout>@@toggle 1</literallayout>]]>
1404 <!-- ~~~~~ New section ~~~~~ -->
1405 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1408 <term>Specifies:</term>
1411 Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1412 feature</ulink> may be used
1417 <term>Type of value:</term>
1423 <term>Default value:</term>
1429 <term>Effect if unset:</term>
1432 The web-based toggle feature is disabled.
1440 When toggled off, <application>Privoxy</application> mostly acts like a normal,
1441 content-neutral proxy, i.e. doesn't block ads or filter content.
1444 Access to the toggle feature can <emphasis>not</emphasis> be
1445 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1446 so that everybody who can access <application>Privoxy</application> (see
1447 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1448 toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1449 for multi-user environments with untrusted users.
1452 Note that malicious client side code (e.g Java) is also
1453 capable of using this option.
1456 As a lot of <application>Privoxy</application> users don't read
1457 documentation, this feature is disabled by default.
1460 Note that you must have compiled <application>Privoxy</application> with
1461 support for this feature, otherwise this option has no effect.
1467 <![%config-file;[<literallayout>@@enable-remote-toggle 0</literallayout>]]>
1471 <!-- ~~~~~ New section ~~~~~ -->
1472 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1475 <term>Specifies:</term>
1478 Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1483 <term>Type of value:</term>
1489 <term>Default value:</term>
1495 <term>Effect if unset:</term>
1498 Privoxy ignores special HTTP headers.
1506 When toggled on, the client can change <application>Privoxy's</application>
1507 behaviour by setting special HTTP headers. Currently the only supported
1508 special header is <quote>X-Filter: No</quote>, to disable filtering for
1509 the ongoing request, even if it is enabled in one of the action files.
1512 This feature is disabled by default. If you are using
1513 <application>Privoxy</application> in a environment with trusted clients,
1514 you may enable this feature at your discretion. Note that malicious client
1515 side code (e.g Java) is also capable of using this feature.
1518 This option will be removed in future releases as it has been obsoleted
1519 by the more general header taggers.
1525 <![%config-file;[<literallayout>@@enable-remote-http-toggle 0</literallayout>]]>
1529 <!-- ~~~~~ New section ~~~~~ -->
1530 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1533 <term>Specifies:</term>
1536 Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1537 file editor</ulink> may be used
1542 <term>Type of value:</term>
1548 <term>Default value:</term>
1554 <term>Effect if unset:</term>
1557 The web-based actions file editor is disabled.
1565 Access to the editor can <emphasis>not</emphasis> be
1566 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1567 so that everybody who can access <application>Privoxy</application> (see
1568 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1569 modify its configuration for all users.
1572 This option is <emphasis>not recommended</emphasis> for environments
1573 with untrusted users and as a lot of <application>Privoxy</application>
1574 users don't read documentation, this feature is disabled by default.
1577 Note that malicious client side code (e.g Java) is also
1578 capable of using the actions editor and you shouldn't enable
1579 this options unless you understand the consequences and are
1580 sure your browser is configured correctly.
1583 Note that you must have compiled <application>Privoxy</application> with
1584 support for this feature, otherwise this option has no effect.
1590 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1594 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1597 <term>Specifies:</term>
1600 Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1605 <term>Type of value:</term>
1608 <replaceable>0 or 1</replaceable>
1613 <term>Default value:</term>
1615 <para><emphasis>0</emphasis></para>
1619 <term>Effect if unset:</term>
1622 Blocks are not enforced.
1630 <application>Privoxy</application> is mainly used to block and filter
1631 requests as a service to the user, for example to block ads and other
1632 junk that clogs the pipes. <application>Privoxy's</application> configuration
1633 isn't perfect and sometimes innocent pages are blocked. In this situation it
1634 makes sense to allow the user to enforce the request and have
1635 <application>Privoxy</application> ignore the block.
1638 In the default configuration <application>Privoxy's</application>
1639 <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1640 link to adds a special string (the force prefix) to the request URL.
1641 If that link is used, <application>Privoxy</application> will
1642 detect the force prefix, remove it again and let the request pass.
1645 Of course <application>Privoxy</application> can also be used to enforce
1646 a network policy. In that case the user obviously should not be able to
1647 bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1648 option is for. If it's enabled, <application>Privoxy</application> hides
1649 the <quote>go there anyway</quote> link. If the user adds the force
1650 prefix by hand, it will not be accepted and the circumvention attempt
1656 <term>Examples:</term>
1664 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1668 <!-- ~~~~~ New section ~~~~~ -->
1669 <sect3 renderas="sect4" id="acls"><title>
1670 ACLs: permit-access and deny-access</title>
1671 <anchor id="permit-access">
1672 <anchor id="deny-access">
1676 <term>Specifies:</term>
1679 Who can access what.
1684 <term>Type of value:</term>
1687 <replaceable class="parameter">src_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">src_masklen</replaceable>]
1688 [<replaceable class="parameter">dst_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">dst_masklen</replaceable>]]
1691 Where <replaceable class="parameter">src_addr</replaceable> and
1692 <replaceable class="parameter">dst_addr</replaceable> are IPv4 addresses in dotted decimal notation or valid
1693 DNS names, <replaceable class="parameter">port</replaceable> is a port
1694 number, and <replaceable class="parameter">src_masklen</replaceable> and
1695 <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1696 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1697 destination part are optional.
1700 If your system implements
1701 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink>, then
1702 <replaceable class="parameter">src_addr</replaceable> and <replaceable
1703 class="parameter">dst_addr</replaceable> can be IPv6 addresses delimeted by
1704 brackets, <replaceable class="parameter">port</replaceable> can be a number
1705 or a service name, and
1706 <replaceable class="parameter">src_masklen</replaceable> and
1707 <replaceable class="parameter">dst_masklen</replaceable> can be a number
1713 <term>Default value:</term>
1715 <para><emphasis>Unset</emphasis></para>
1717 If no <replaceable class="parameter">port</replaceable> is specified,
1718 any port will match. If no <replaceable class="parameter">src_masklen</replaceable> or
1719 <replaceable class="parameter">src_masklen</replaceable> is given, the complete IP
1720 address has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1725 <term>Effect if unset:</term>
1728 Don't restrict access further than implied by <literal>listen-address</literal>
1736 Access controls are included at the request of ISPs and systems
1737 administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1738 For a typical home user, it will normally suffice to ensure that
1739 <application>Privoxy</application> only listens on the localhost
1740 (127.0.0.1) or internal (home) network address by means of the
1741 <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1745 Please see the warnings in the FAQ that <application>Privoxy</application>
1746 is not intended to be a substitute for a firewall or to encourage anyone
1747 to defer addressing basic security weaknesses.
1750 Multiple ACL lines are OK.
1751 If any ACLs are specified, <application>Privoxy</application> only talks
1752 to IP addresses that match at least one <literal>permit-access</literal> line
1753 and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1754 last match wins, with the default being <literal>deny-access</literal>.
1757 If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1758 for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1759 that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1760 of the ultimate target. This is necessary because it may be impossible for the local
1761 <application>Privoxy</application> to determine the IP address of the
1762 ultimate target (that's often what gateways are used for).
1765 You should prefer using IP addresses over DNS names, because the address lookups take
1766 time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1767 like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1768 IP addresses, only the first one is used.
1771 Some systems allow IPv4 clients to connect to IPv6 server sockets.
1772 Then the client's IPv4 address will be translated by the system into
1773 IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4
1774 mapped IPv6 address). <application>Privoxy</application> can handle it
1775 and maps such ACL addresses automatically.
1778 Denying access to particular sites by ACL may have undesired side effects
1779 if the site in question is hosted on a machine which also hosts other sites
1785 <term>Examples:</term>
1788 Explicitly define the default behavior if no ACL and
1789 <literal>listen-address</literal> are set: <quote>localhost</quote>
1790 is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1791 <emphasis>all</emphasis> destination addresses are OK:
1795 permit-access localhost
1799 Allow any host on the same class C subnet as www.privoxy.org access to
1800 nothing but www.example.com (or other domains hosted on the same system):
1804 permit-access www.privoxy.org/24 www.example.com/32
1808 Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1809 with the exception that 192.168.45.73 may not access the IP address behind
1810 www.dirty-stuff.example.com:
1814 permit-access 192.168.45.64/26
1815 deny-access 192.168.45.73 www.dirty-stuff.example.com
1819 Allow access from the IPv4 network 192.0.2.0/24 even if listening on
1820 an IPv6 wild card address (not supported on all platforms):
1824 permit-access 192.0.2.0/24
1828 This is equivalent to the following line even if listening on an
1829 IPv4 address (not supported on all platforms):
1833 permit-access [::ffff:192.0.2.0]/120
1842 <!-- ~~~~~ New section ~~~~~ -->
1843 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1847 <term>Specifies:</term>
1850 Maximum size of the buffer for content filtering.
1855 <term>Type of value:</term>
1857 <para>Size in Kbytes</para>
1861 <term>Default value:</term>
1867 <term>Effect if unset:</term>
1870 Use a 4MB (4096 KB) limit.
1878 For content filtering, i.e. the <literal>+filter</literal> and
1879 <literal>+deanimate-gif</literal> actions, it is necessary that
1880 <application>Privoxy</application> buffers the entire document body.
1881 This can be potentially dangerous, since a server could just keep sending
1882 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1886 When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1887 flushed to the client unfiltered and no further attempt to
1888 filter the rest of the document is made. Remember that there may be multiple threads
1889 running, which might require up to <literal>buffer-limit</literal> Kbytes
1890 <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1897 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1900 <!-- ~~~~~ New section ~~~~~ -->
1901 <sect3 renderas="sect4" id="enable-proxy-authentication-forwarding"><title>enable-proxy-authentication-forwarding</title>
1904 <term>Specifies:</term>
1907 Whether or not proxy authentication through &my-app; should work.
1912 <term>Type of value:</term>
1918 <term>Default value:</term>
1924 <term>Effect if unset:</term>
1927 Proxy authentication headers are removed.
1935 Privoxy itself does not support proxy authentication, but can
1936 allow clients to authenticate against Privoxy's parent proxy.
1939 By default Privoxy (3.0.21 and later) don't do that and remove
1940 Proxy-Authorization headers in requests and Proxy-Authenticate
1941 headers in responses to make it harder for malicious sites to
1942 trick inexperienced users into providing login information.
1945 If this option is enabled the headers are forwarded.
1948 Enabling this option is <emphasis>not recommended</emphasis> if there is
1949 no parent proxy that requires authentication or if the local network between
1950 Privoxy and the parent proxy isn't trustworthy. If proxy authentication is
1951 only required for some requests, it is recommended to use a client header filter
1952 to remove the authentication headers for requests where they aren't needed.
1958 <![%config-file;[<literallayout>@@enable-proxy-authentication-forwarding 0</literallayout>]]>
1963 <!-- ~ End section ~ -->
1966 <!-- ~~~~~ New section ~~~~~ -->
1968 <sect2 id="forwarding">
1969 <title>Forwarding</title>
1972 This feature allows routing of HTTP requests through a chain of
1976 Forwarding can be used to chain Privoxy with a caching proxy to speed
1977 up browsing. Using a parent proxy may also be necessary if the machine
1978 that <application>Privoxy</application> runs on has no direct Internet access.
1981 Note that parent proxies can severely decrease your privacy level.
1982 For example a parent proxy could add your IP address to the request
1983 headers and if it's a caching proxy it may add the <quote>Etag</quote>
1984 header to revalidation requests again, even though you configured Privoxy
1985 to remove it. It may also ignore Privoxy's header time randomization and use the
1986 original values which could be used by the server as cookie replacement
1987 to track your steps between visits.
1991 Also specified here are SOCKS proxies. <application>Privoxy</application>
1992 supports the SOCKS 4 and SOCKS 4A protocols.
1995 <sect3 renderas="sect4" id="forward"><title>forward</title>
1998 <term>Specifies:</term>
2001 To which parent HTTP proxy specific requests should be routed.
2006 <term>Type of value:</term>
2009 <replaceable class="parameter">target_pattern</replaceable>
2010 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2013 where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
2014 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2015 denote <quote>all URLs</quote>.
2016 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2017 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
2018 optionally followed by its listening port (default: 8000).
2019 Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
2024 <term>Default value:</term>
2026 <para><emphasis>Unset</emphasis></para>
2030 <term>Effect if unset:</term>
2033 Don't use parent HTTP proxies.
2041 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2042 forwarded to another HTTP proxy but are made directly to the web servers.
2045 <replaceable class="parameter">http_parent</replaceable> can be a
2046 numerical IPv6 address (if
2047 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2048 implemented). To prevent clashes with the port delimiter, the whole IP
2049 address has to be put into brackets. On the other hand a <replaceable
2050 class="parameter">target_pattern</replaceable> containing an IPv6 address
2051 has to be put into angle brackets (normal brackets are reserved for
2052 regular expressions already).
2055 Multiple lines are OK, they are checked in sequence, and the last match wins.
2060 <term>Examples:</term>
2063 Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
2067 forward / parent-proxy.example.org:8080
2072 Everything goes to our example ISP's caching proxy, except for requests
2073 to that ISP's sites:
2077 forward / caching-proxy.isp.example.net:8000
2078 forward .isp.example.net .
2082 Parent proxy specified by an IPv6 address:
2086 forward / [2001:DB8::1]:8000
2090 Suppose your parent proxy doesn't support IPv6:
2094 forward / parent-proxy.example.org:8000
2095 forward ipv6-server.example.org .
2096 forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
2105 <!-- ~~~~~ New section ~~~~~ -->
2106 <sect3 renderas="sect4" id="socks"><title>
2107 forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
2108 <anchor id="forward-socks4">
2109 <anchor id="forward-socks4a">
2113 <term>Specifies:</term>
2116 Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2121 <term>Type of value:</term>
2124 <replaceable class="parameter">target_pattern</replaceable>
2125 <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
2126 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2129 where <replaceable class="parameter">target_pattern</replaceable> is a
2130 <link linkend="af-patterns">URL pattern</link> that specifies to which
2131 requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2132 denote <quote>all URLs</quote>. <replaceable class="parameter">http_parent</replaceable>
2133 and <replaceable class="parameter">socks_proxy</replaceable>
2134 are IP addresses in dotted decimal notation or valid DNS names
2135 (<replaceable class="parameter">http_parent</replaceable>
2136 may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
2137 <replaceable class="parameter">port</replaceable> parameters are TCP ports,
2138 i.e. integer values from 1 to 65535
2143 <term>Default value:</term>
2145 <para><emphasis>Unset</emphasis></para>
2149 <term>Effect if unset:</term>
2152 Don't use SOCKS proxies.
2160 Multiple lines are OK, they are checked in sequence, and the last match wins.
2163 The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
2164 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2165 server, while in SOCKS 4 it happens locally.
2168 With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
2171 <literal>forward-socks5t</literal> works like vanilla <literal>forward-socks5</literal> but
2172 lets &my-app; additionally use Tor-specific SOCKS extensions. Currently the only supported
2173 SOCKS extension is optimistic data which can reduce the latency for the first request made
2174 on a newly created connection.
2177 <replaceable class="parameter">socks_proxy</replaceable> and
2178 <replaceable class="parameter">http_parent</replaceable> can be a
2179 numerical IPv6 address (if
2180 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2181 implemented). To prevent clashes with the port delimiter, the whole IP
2182 address has to be put into brackets. On the other hand a <replaceable
2183 class="parameter">target_pattern</replaceable> containing an IPv6 address
2184 has to be put into angle brackets (normal brackets are reserved for
2185 regular expressions already).
2188 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2189 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2195 <term>Examples:</term>
2198 From the company example.com, direct connections are made to all
2199 <quote>internal</quote> domains, but everything outbound goes through
2200 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2205 forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
2206 forward .example.com .
2210 A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2214 forward-socks4 / socks-gw.example.com:1080 .
2219 To chain Privoxy and Tor, both running on the same system, you would use
2224 forward-socks5t / 127.0.0.1:9050 .
2228 Note that if you got Tor through one of the bundles, you may
2229 have to change the port from 9050 to 9150 (or even another one).
2230 For details, please check the documentation on the
2231 <ulink url="https://torproject.org/">Tor website</ulink>.
2234 The public <application>Tor</application> network can't be used to
2235 reach your local network, if you need to access local servers you
2236 therefore might want to make some exceptions:
2240 forward 192.168.*.*/ .
2242 forward 127.*.*.*/ .
2246 Unencrypted connections to systems in these address ranges will
2247 be as (un)secure as the local network is, but the alternative is that you
2248 can't reach the local network through <application>Privoxy</application>
2249 at all. Of course this may actually be desired and there is no reason
2250 to make these exceptions if you aren't sure you need them.
2253 If you also want to be able to reach servers in your local network by
2254 using their names, you will need additional exceptions that look like
2259 forward localhost/ .
2268 <![%user-man;[ <!-- not included in config due to length -->
2269 <!-- ~~~~~ New section ~~~~~ -->
2270 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2273 If you have links to multiple ISPs that provide various special content
2274 only to their subscribers, you can configure multiple <application>Privoxies</application>
2275 which have connections to the respective ISPs to act as forwarders to each other, so that
2276 <emphasis>your</emphasis> users can see the internal content of all ISPs.
2280 Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2281 isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2282 configuration can look like this:
2292 forward .isp-b.example.net host-b:8118
2303 forward .isp-a.example.org host-a:8118
2308 Now, your users can set their browser's proxy to use either
2309 host-a or host-b and be able to browse the internal content
2310 of both isp-a and isp-b.
2314 If you intend to chain <application>Privoxy</application> and
2315 <application>squid</application> locally, then chaining as
2316 <literal>browser -> squid -> privoxy</literal> is the recommended way.
2320 Assuming that <application>Privoxy</application> and <application>squid</application>
2321 run on the same box, your <application>squid</application> configuration could then look like this:
2326 # Define Privoxy as parent proxy (without ICP)
2327 cache_peer 127.0.0.1 parent 8118 7 no-query
2329 # Define ACL for protocol FTP
2332 # Do not forward FTP requests to Privoxy
2333 always_direct allow ftp
2335 # Forward all the rest to Privoxy
2336 never_direct allow all</screen>
2340 You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2341 Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2345 You could just as well decide to only forward requests you suspect
2346 of leading to Windows executables through a virus-scanning parent proxy,
2347 say, on <literal>antivir.example.com</literal>, port 8010:
2353 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
2359 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2362 <term>Specifies:</term>
2365 How often Privoxy retries if a forwarded connection request fails.
2370 <term>Type of value:</term>
2373 <replaceable class="parameter">Number of retries.</replaceable>
2378 <term>Default value:</term>
2380 <para><emphasis>0</emphasis></para>
2384 <term>Effect if unset:</term>
2387 Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2395 <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2396 for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2397 The connection might have failed because of a DNS timeout in which case a retry makes sense,
2398 but it might also have failed because the server doesn't exist or isn't reachable. In this
2399 case the retry will just delay the appearance of Privoxy's error message.
2402 Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2403 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2406 Only use this option, if you are getting lots of forwarding-related error messages
2407 that go away when you try again manually. Start with a small value and check Privoxy's
2408 logfile from time to time, to see how many retries are usually needed.
2413 <term>Examples:</term>
2416 forwarded-connect-retries 1
2421 <![%config-file;[<literallayout>@@forwarded-connect-retries 0</literallayout>]]>
2427 <title>Miscellaneous</title>
2429 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2432 <term>Specifies:</term>
2435 Whether intercepted requests should be treated as valid.
2440 <term>Type of value:</term>
2443 <replaceable>0 or 1</replaceable>
2448 <term>Default value:</term>
2450 <para><emphasis>0</emphasis></para>
2454 <term>Effect if unset:</term>
2457 Only proxy requests are accepted, intercepted requests are treated as invalid.
2465 If you don't trust your clients and want to force them
2466 to use <application>Privoxy</application>, enable this
2467 option and configure your packet filter to redirect outgoing
2468 HTTP connections into <application>Privoxy</application>.
2471 Note that intercepting encrypted connections (HTTPS) isn't supported.
2474 Make sure that <application>Privoxy's</application> own requests
2475 aren't redirected as well. Additionally take care that
2476 <application>Privoxy</application> can't intentionally connect
2477 to itself, otherwise you could run into redirection loops if
2478 <application>Privoxy's</application> listening port is reachable
2479 by the outside or an attacker has access to the pages you visit.
2482 If you are running Privoxy as intercepting proxy without being
2483 able to intercept all client requests you may want to adjust
2484 the CGI templates to make sure they don't reference content from
2490 <term>Examples:</term>
2493 accept-intercepted-requests 1
2498 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2501 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2504 <term>Specifies:</term>
2507 Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2512 <term>Type of value:</term>
2515 <replaceable>0 or 1</replaceable>
2520 <term>Default value:</term>
2522 <para><emphasis>0</emphasis></para>
2526 <term>Effect if unset:</term>
2529 <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2537 By default <application>Privoxy</application> ignores block or redirect actions
2538 for its CGI pages. Intercepting these requests can be useful in multi-user
2539 setups to implement fine-grained access control, but it can also render the complete
2540 web interface useless and make debugging problems painful if done without care.
2543 Don't enable this option unless you're sure that you really need it.
2548 <term>Examples:</term>
2551 allow-cgi-request-crunching 1
2556 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2559 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2562 <term>Specifies:</term>
2565 Whether the CGI interface should stay compatible with broken HTTP clients.
2570 <term>Type of value:</term>
2573 <replaceable>0 or 1</replaceable>
2578 <term>Default value:</term>
2580 <para><emphasis>0</emphasis></para>
2584 <term>Effect if unset:</term>
2587 The CGI form generate long GET URLs.
2595 <application>Privoxy's</application> CGI forms can lead to
2596 rather long URLs. This isn't a problem as far as the HTTP
2597 standard is concerned, but it can confuse clients with arbitrary
2598 URL length limitations.
2601 Enabling split-large-forms causes <application>Privoxy</application>
2602 to divide big forms into smaller ones to keep the URL length down.
2603 It makes editing a lot less convenient and you can no longer
2604 submit all changes at once, but at least it works around this
2608 If you don't notice any editing problems, there is no reason
2609 to enable this option, but if one of the submit buttons appears
2610 to be broken, you should give it a try.
2615 <term>Examples:</term>
2623 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2626 <sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
2629 <term>Specifies:</term>
2632 Number of seconds after which an open connection will no longer be reused.
2637 <term>Type of value:</term>
2640 <replaceable>Time in seconds.</replaceable>
2645 <term>Default value:</term>
2651 <term>Effect if unset:</term>
2654 Connections are not kept alive.
2662 This option allows clients to keep the connection to &my-app;
2663 alive. If the server supports it, &my-app; will keep
2664 the connection to the server alive as well. Under certain
2665 circumstances this may result in speed-ups.
2668 By default, &my-app; will close the connection to the server if
2669 the client connection gets closed, or if the specified timeout
2670 has been reached without a new request coming in. This behaviour
2671 can be changed with the <ulink
2672 url="#CONNECTION-SHARING">connection-sharing</ulink> option.
2675 This option has no effect if <application>Privoxy</application>
2676 has been compiled without keep-alive support.
2679 Note that a timeout of five seconds as used in the default
2680 configuration file significantly decreases the number of
2681 connections that will be reused. The value is used because
2682 some browsers limit the number of connections they open to
2683 a single host and apply the same limit to proxies. This can
2684 result in a single website <quote>grabbing</quote> all the
2685 connections the browser allows, which means connections to
2686 other websites can't be opened until the connections currently
2690 Several users have reported this as a Privoxy bug, so the
2691 default value has been reduced. Consider increasing it to
2692 300 seconds or even more if you think your browser can handle
2693 it. If your browser appears to be hanging, it probably can't.
2698 <term>Examples:</term>
2701 keep-alive-timeout 300
2706 <![%config-file;[<literallayout>@@keep-alive-timeout 5</literallayout>]]>
2710 <sect3 renderas="sect4" id="tolerate-pipelining"><title>tolerate-pipelining</title>
2713 <term>Specifies:</term>
2716 Whether or not pipelined requests should be served.
2721 <term>Type of value:</term>
2724 <replaceable>0 or 1.</replaceable>
2729 <term>Default value:</term>
2735 <term>Effect if unset:</term>
2738 If Privoxy receives more than one request at once, it terminates the
2739 client connection after serving the first one.
2747 &my-app; currently doesn't pipeline outgoing requests,
2748 thus allowing pipelining on the client connection is not
2749 guaranteed to improve the performance.
2752 By default &my-app; tries to discourage clients from pipelining
2753 by discarding aggressively pipelined requests, which forces the
2754 client to resend them through a new connection.
2757 This option lets &my-app; tolerate pipelining. Whether or not
2758 that improves performance mainly depends on the client configuration.
2761 If you are seeing problems with pages not properly loading,
2762 disabling this option could work around the problem.
2767 <term>Examples:</term>
2770 tolerate-pipelining 1
2775 <![%config-file;[<literallayout>@@tolerate-pipelining 1</literallayout>]]>
2779 <sect3 renderas="sect4" id="default-server-timeout"><title>default-server-timeout</title>
2782 <term>Specifies:</term>
2785 Assumed server-side keep-alive timeout if not specified by the server.
2790 <term>Type of value:</term>
2793 <replaceable>Time in seconds.</replaceable>
2798 <term>Default value:</term>
2804 <term>Effect if unset:</term>
2807 Connections for which the server didn't specify the keep-alive
2808 timeout are not reused.
2816 Enabling this option significantly increases the number of connections
2817 that are reused, provided the <ulink
2818 url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> option
2822 While it also increases the number of connections problems
2823 when &my-app; tries to reuse a connection that already has
2824 been closed on the server side, or is closed while &my-app;
2825 is trying to reuse it, this should only be a problem if it
2826 happens for the first request sent by the client. If it happens
2827 for requests on reused client connections, &my-app; will simply
2828 close the connection and the client is supposed to retry the
2829 request without bothering the user.
2832 Enabling this option is therefore only recommended if the
2834 url="#CONNECTION-SHARING">connection-sharing</ulink> option
2838 It is an error to specify a value larger than the <ulink
2839 url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> value.
2842 This option has no effect if <application>Privoxy</application>
2843 has been compiled without keep-alive support.
2848 <term>Examples:</term>
2851 default-server-timeout 60
2856 <![%config-file;[<literallayout>@@#default-server-timeout 60</literallayout>]]>
2860 <sect3 renderas="sect4" id="connection-sharing"><title>connection-sharing</title>
2863 <term>Specifies:</term>
2866 Whether or not outgoing connections that have been kept alive
2867 should be shared between different incoming connections.
2872 <term>Type of value:</term>
2875 <replaceable>0 or 1</replaceable>
2880 <term>Default value:</term>
2886 <term>Effect if unset:</term>
2889 Connections are not shared.
2897 This option has no effect if <application>Privoxy</application>
2898 has been compiled without keep-alive support, or if it's disabled.
2906 Note that reusing connections doesn't necessary cause speedups.
2907 There are also a few privacy implications you should be aware of.
2910 If this option is effective, outgoing connections are shared between
2911 clients (if there are more than one) and closing the browser that initiated
2912 the outgoing connection does no longer affect the connection between &my-app;
2913 and the server unless the client's request hasn't been completed yet.
2916 If the outgoing connection is idle, it will not be closed until either
2917 <application>Privoxy's</application> or the server's timeout is reached.
2918 While it's open, the server knows that the system running &my-app; is still
2922 If there are more than one client (maybe even belonging to multiple users),
2923 they will be able to reuse each others connections. This is potentially
2924 dangerous in case of authentication schemes like NTLM where only the
2925 connection is authenticated, instead of requiring authentication for
2929 If there is only a single client, and if said client can keep connections
2930 alive on its own, enabling this option has next to no effect. If the client
2931 doesn't support connection keep-alive, enabling this option may make sense
2932 as it allows &my-app; to keep outgoing connections alive even if the client
2933 itself doesn't support it.
2936 You should also be aware that enabling this option increases the likelihood
2937 of getting the "No server or forwarder data" error message, especially if you
2938 are using a slow connection to the Internet.
2941 This option should only be used by experienced users who
2942 understand the risks and can weight them against the benefits.
2947 <term>Examples:</term>
2950 connection-sharing 1
2955 <![%config-file;[<literallayout>@@#connection-sharing 1</literallayout>]]>
2959 <sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
2962 <term>Specifies:</term>
2965 Number of seconds after which a socket times out if
2966 no data is received.
2971 <term>Type of value:</term>
2974 <replaceable>Time in seconds.</replaceable>
2979 <term>Default value:</term>
2985 <term>Effect if unset:</term>
2988 A default value of 300 seconds is used.
2996 The default is quite high and you probably want to reduce it.
2997 If you aren't using an occasionally slow proxy like Tor, reducing
2998 it to a few seconds should be fine.
3003 <term>Examples:</term>
3011 <![%config-file;[<literallayout>@@socket-timeout 300</literallayout>]]>
3015 <sect3 renderas="sect4" id="max-client-connections"><title>max-client-connections</title>
3018 <term>Specifies:</term>
3021 Maximum number of client connections that will be served.
3026 <term>Type of value:</term>
3029 <replaceable>Positive number.</replaceable>
3034 <term>Default value:</term>
3040 <term>Effect if unset:</term>
3043 Connections are served until a resource limit is reached.
3051 &my-app; creates one thread (or process) for every incoming client
3052 connection that isn't rejected based on the access control settings.
3055 If the system is powerful enough, &my-app; can theoretically deal with
3056 several hundred (or thousand) connections at the same time, but some
3057 operating systems enforce resource limits by shutting down offending
3058 processes and their default limits may be below the ones &my-app; would
3059 require under heavy load.
3062 Configuring &my-app; to enforce a connection limit below the thread
3063 or process limit used by the operating system makes sure this doesn't
3064 happen. Simply increasing the operating system's limit would work too,
3065 but if &my-app; isn't the only application running on the system,
3066 you may actually want to limit the resources used by &my-app;.
3069 If &my-app; is only used by a single trusted user, limiting the
3070 number of client connections is probably unnecessary. If there
3071 are multiple possibly untrusted users you probably still want to
3072 additionally use a packet filter to limit the maximal number of
3073 incoming connections per client. Otherwise a malicious user could
3074 intentionally create a high number of connections to prevent other
3075 users from using &my-app;.
3078 Obviously using this option only makes sense if you choose a limit
3079 below the one enforced by the operating system.
3082 One most POSIX-compliant systems &my-app; can't properly deal with
3083 more than FD_SETSIZE file descriptors at the same time and has to reject
3084 connections if the limit is reached. This will likely change in a
3085 future version, but currently this limit can't be increased without
3086 recompiling &my-app; with a different FD_SETSIZE limit.
3091 <term>Examples:</term>
3094 max-client-connections 256
3099 <![%config-file;[<literallayout>@@#max-client-connections 256</literallayout>]]>
3103 <sect3 renderas="sect4" id="handle-as-empty-doc-returns-ok"><title>handle-as-empty-doc-returns-ok</title>
3106 <term>Specifies:</term>
3109 The status code Privoxy returns for pages blocked with
3110 <!-- URL will only end up in the user manual so the relative link should work. -->
3111 <literal><ulink url="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">+handle-as-empty-document</ulink></literal>.
3116 <term>Type of value:</term>
3119 <replaceable>0 or 1</replaceable>
3124 <term>Default value:</term>
3130 <term>Effect if unset:</term>
3133 Privoxy returns a status 403(forbidden) for all blocked pages.
3138 <term>Effect if set:</term>
3141 Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
3142 and a status 403(Forbidden) for all other blocked pages.
3150 This directive was added as a work-around for Firefox bug 492459:
3151 <quote>Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.</quote>
3152 (<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
3153 >https://bugzilla.mozilla.org/show_bug.cgi?id=492459</ulink>),
3154 the bug has been fixed for quite some time, but this directive is also useful
3155 to make it harder for websites to detect whether or not resources are being
3161 <![%config-file;[<literallayout>@@#handle-as-empty-doc-returns-ok 1</literallayout>]]>
3165 <sect3 renderas="sect4" id="enable-compression"><title>enable-compression</title>
3168 <term>Specifies:</term>
3171 Whether or not buffered content is compressed before delivery.
3176 <term>Type of value:</term>
3179 <replaceable>0 or 1</replaceable>
3184 <term>Default value:</term>
3190 <term>Effect if unset:</term>
3193 Privoxy does not compress buffered content.
3198 <term>Effect if set:</term>
3201 Privoxy compresses buffered content before delivering it to the client,
3202 provided the client supports it.
3210 This directive is only supported if Privoxy has been compiled with
3211 FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB.
3214 Compressing buffered content is mainly useful if Privoxy and the
3215 client are running on different systems. If they are running on the
3216 same system, enabling compression is likely to slow things down.
3217 If you didn't measure otherwise, you should assume that it does
3218 and keep this option disabled.
3221 Privoxy will not compress buffered content below a certain length.
3226 <![%config-file;[<literallayout>@@#enable-compression 1</literallayout>]]>
3230 <sect3 renderas="sect4" id="compression-level"><title>compression-level</title>
3233 <term>Specifies:</term>
3236 The compression level that is passed to the zlib library when compressing buffered content.
3241 <term>Type of value:</term>
3244 <replaceable>Positive number ranging from 0 to 9.</replaceable>
3249 <term>Default value:</term>
3258 Compressing the data more takes usually longer than compressing
3259 it less or not compressing it at all. Which level is best depends
3260 on the connection between Privoxy and the client. If you can't
3261 be bothered to benchmark it for yourself, you should stick with
3262 the default and keep compression disabled.
3265 If compression is disabled, the compression level is irrelevant.
3270 <term>Examples:</term>
3274 # Best speed (compared to the other levels)
3278 # No compression. Only useful for testing as the added header
3279 # slightly increases the amount of data that has to be sent.
3280 # If your benchmark shows that using this compression level
3281 # is superior to using no compression at all, the benchmark
3282 # is likely to be flawed.
3289 <![%config-file;[<literallayout>@@#compression-level 1</literallayout>]]>
3293 <sect3 renderas="sect4" id="client-header-order"><title>client-header-order</title>
3296 <term>Specifies:</term>
3299 The order in which client headers are sorted before forwarding them.
3304 <term>Type of value:</term>
3307 <replaceable>Client header names delimited by spaces or tabs</replaceable>
3312 <term>Default value:</term>
3321 By default &my-app; leaves the client headers in the order they
3322 were sent by the client. Headers are modified in-place, new headers
3323 are added at the end of the already existing headers.
3326 The header order can be used to fingerprint client requests
3327 independently of other headers like the User-Agent.
3330 This directive allows to sort the headers differently to better
3331 mimic a different User-Agent. Client headers will be emitted
3332 in the order given, headers whose name isn't explicitly specified
3333 are added at the end.
3336 Note that sorting headers in an uncommon way will make fingerprinting
3337 actually easier. Encrypted headers are not affected by this directive.
3342 <![%config-file;[<literallayout>@@#client-header-order Host \
3359 <sect3 renderas="sect4" id="client-specific-tag"><title>client-specific-tag</title>
3362 <term>Specifies:</term>
3365 The name of a tag that will always be set for clients that
3366 requested it through the webinterface.
3371 <term>Type of value:</term>
3374 <replaceable>Tag name followed by a description that will be shown in the webinterface</replaceable>
3379 <term>Default value:</term>
3389 This is an experimental feature. The syntax is likely to change
3394 Client-specific tags allow Privoxy admins to create different
3395 profiles and let the users chose which one they want without
3396 impacting other users.
3399 One use case is allowing users to circumvent certain blocks
3400 without having to allow them to circumvent all blocks.
3401 This is not possible with the
3402 <link linkend="enable-remote-toggle">enable-remote-toggle feature</link>
3403 because it would bluntly disable all blocks for all users and also affect
3404 other actions like filters.
3405 It also is set globally which renders it useless in most multi-user setups.
3408 After a client-specific tag has been defined with the client-specific-tag
3409 directive, action sections can be activated based on the tag by using a
3410 <ulink url="actions-file.html#CLIENT-TAG-PATTERN">CLIENT-TAG</ulink> pattern.
3411 The CLIENT-TAG pattern is evaluated at the same priority
3412 as URL patterns, as a result the last matching pattern wins.
3413 Tags that are created based on client or server headers are evaluated
3414 later on and can overrule CLIENT-TAG and URL patterns!
3417 The tag is set for all requests that come from clients that requested
3419 Note that "clients" are differentiated by IP address,
3420 if the IP address changes the tag has to be requested again.
3423 Clients can request tags to be set by using the CGI interface <ulink
3424 url="http://config.privoxy.org/client-tags">http://config.privoxy.org/client-tags</ulink>.
3425 The specific tag description is only used on the web page and should
3426 be phrased in away that the user understand the effect of the tag.
3431 <term>Examples:</term>
3435 # Define a couple of tags, the described effect requires action sections
3436 # that are enabled based on CLIENT-TAG patterns.
3437 client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
3438 disable-content-filters Disable content-filters but do not affect other actions
3446 <!-- ~ End section ~ -->
3448 <sect3 renderas="sect4" id="client-tag-lifetime"><title>client-tag-lifetime</title>
3451 <term>Specifies:</term>
3454 How long a temporarily enabled tag remains enabled.
3459 <term>Type of value:</term>
3462 <replaceable>Time in seconds.</replaceable>
3467 <term>Default value:</term>
3477 This is an experimental feature. The syntax is likely to change
3482 In case of some tags users may not want to enable them permanently,
3483 but only for a short amount of time, for example to circumvent a block
3484 that is the result of an overly-broad URL pattern.
3487 The CGI interface <ulink
3488 url="http://config.privoxy.org/client-tags">http://config.privoxy.org/client-tags</ulink>
3489 therefore provides a "enable this tag temporarily" option.
3490 If it is used, the tag will be set until the client-tag-lifetime
3496 <term>Examples:</term>
3500 # Increase the time to life for temporarily enabled tags to 3 minutes
3501 client-tag-lifetime 180
3511 <!-- ~ End section ~ -->
3514 <!-- ~~~~~ New section ~~~~~ -->
3516 <sect2 id="windows-gui">
3517 <title>Windows GUI Options</title>
3519 <application>Privoxy</application> has a number of options specific to the
3520 Windows GUI interface:
3523 <anchor id="activity-animation">
3524 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3526 If <quote>activity-animation</quote> is set to 1, the
3527 <application>Privoxy</application> icon will animate when
3528 <quote>Privoxy</quote> is active. To turn off, set to 0.
3531 <![%config-file;[<literallayout>@@#activity-animation 1</literallayout>]]>
3537 <emphasis>activity-animation 1</emphasis>
3544 <anchor id="log-messages">
3545 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3547 If <quote>log-messages</quote> is set to 1,
3548 <application>Privoxy</application> copies log messages to the console
3550 The log detail depends on the <link linkend="debug">debug</link> directive.
3553 <![%config-file;[<literallayout>@@#log-messages 1</literallayout>]]>
3559 <emphasis>log-messages 1</emphasis>
3566 <anchor id="log-buffer-size">
3567 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3569 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
3570 i.e. the amount of memory used for the log messages displayed in the
3571 console window, will be limited to <quote>log-max-lines</quote> (see below).
3575 Warning: Setting this to 0 will result in the buffer to grow infinitely and
3576 eat up all your memory!
3579 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
3585 <emphasis>log-buffer-size 1</emphasis>
3592 <anchor id="log-max-lines">
3593 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3595 <application>log-max-lines</application> is the maximum number of lines held
3596 in the log buffer. See above.
3599 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
3605 <emphasis>log-max-lines 200</emphasis>
3612 <anchor id="log-highlight-messages">
3613 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3615 If <quote>log-highlight-messages</quote> is set to 1,
3616 <application>Privoxy</application> will highlight portions of the log
3617 messages with a bold-faced font:
3620 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
3626 <emphasis>log-highlight-messages 1</emphasis>
3633 <anchor id="log-font-name">
3634 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3636 The font used in the console window:
3639 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
3645 <emphasis>log-font-name Comic Sans MS</emphasis>
3652 <anchor id="log-font-size">
3653 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3655 Font size used in the console window:
3658 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
3664 <emphasis>log-font-size 8</emphasis>
3671 <anchor id="show-on-task-bar">
3672 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3674 <quote>show-on-task-bar</quote> controls whether or not
3675 <application>Privoxy</application> will appear as a button on the Task bar
3679 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
3685 <emphasis>show-on-task-bar 0</emphasis>
3692 <anchor id="close-button-minimizes">
3693 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3695 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
3696 button will minimize <application>Privoxy</application> instead of closing
3697 the program (close with the exit option on the File menu).
3700 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
3706 <emphasis>close-button-minimizes 1</emphasis>
3713 <anchor id="hide-console">
3714 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3716 The <quote>hide-console</quote> option is specific to the MS-Win console
3717 version of <application>Privoxy</application>. If this option is used,
3718 <application>Privoxy</application> will disconnect from and hide the
3722 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
3728 #<emphasis>hide-console</emphasis>
3738 <!-- end config content common to both outputs -->
3741 <!-- These are dummy anchors to keep the processor quiet -->
3742 <!-- when building config-file only (ie. they are used in u-m only) -->
3745 <anchor id="filter">
3746 <anchor id="filter-file">
3748 <anchor id="actions-file">
3749 <anchor id="af-patterns">
3753 <!-- eof p-config.sgml -->
projects / privoxy.git / blob