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.19 2007/11/04 21:17:31 hal9 Exp $
8 Copyright (C) 2001-2007 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 Again, the main configuration file is named <filename>config</filename> on
54 Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
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).
91 <!-- This part only goes into the config file -->
94 @@TITLE<!-- between the @@ is stripped by Makefile -->@@
95 Sample Configuration File for Privoxy v&p-version;
98 $Id: p-config.sgml,v 2.19 2007/11/04 21:17:31 hal9 Exp $
101 Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
106 #################################################################
111 II. FORMAT OF THE CONFIGURATION FILE #
113 1. LOCAL SET-UP DOCUMENTATION #
114 2. CONFIGURATION AND LOG FILE LOCATIONS #
116 4. ACCESS CONTROL AND SECURITY #
118 6. WINDOWS GUI OPTIONS #
120 #################################################################
124 <literallayout>I. INTRODUCTION
125 =============== <!-- fuck this madness --></literallayout>
128 This file holds Privoxy's main configuration. Privoxy detects
129 configuration changes automatically, so you don't have to restart it
130 unless you want to load a different configuration file.
133 The configuration will be reloaded with the first request after the
134 change was done, this request itself will still use the old configuration,
135 though. In other words: it takes two requests before you see the result of
136 your changes. Requests that are dropped due to ACL don't trigger reloads.
139 When starting Privoxy on Unix systems, give the location of this
140 file as last argument. On Windows systems, Privoxy will look for
141 this file with the name 'config.txt' in the current working directory
142 of the Privoxy process.
146 <literallayout><!-- funky spacing -->
148 II. FORMAT OF THE CONFIGURATION FILE
149 ====================================</literallayout>
152 Configuration lines consist of an initial keyword followed by a list
153 of values, all separated by whitespace (any number of spaces or
157 actionsfile default.action
160 Indicates that the actionsfile is named 'default.action'.
163 The '#' indicates a comment. Any part of a line following a '#' is
164 ignored, except if the '#' is preceded by a '\'.
167 Thus, by placing a # at the start of an existing configuration line,
168 you can make it a comment and it will be treated as if it weren't there.
169 This is called "commenting out" an option and can be useful. Removing
170 the # again is called "uncommenting".
173 Note that commenting out an option and leaving it at its default
174 are two completely different things! Most options behave very
175 differently when unset. See the "Effect if unset" explanation
176 in each option's description for details.
179 Long lines can be continued on the next line by using a `\' as
185 <!-- ************************************************ -->
186 <!-- The following is common to both outputs (mostly) -->
187 <!-- ************************************************ -->
191 <!-- ~~~~~ New section ~~~~~ -->
192 <sect2 id="local-set-up">
193 <title>Local Set-up Documentation</title>
196 If you intend to operate <application>Privoxy</application> for more users
197 than just yourself, it might be a good idea to let them know how to reach
198 you, what you block and why you do that, your policies, etc.
202 <!-- ~~~~~ New section ~~~~~ -->
203 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
206 <term>Specifies:</term>
209 Location of the <application>Privoxy</application> User Manual.
214 <term>Type of value:</term>
216 <para>A fully qualified URI</para>
220 <term>Default value:</term>
222 <para><emphasis>Unset</emphasis></para>
226 <term>Effect if unset:</term>
229 <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/<replaceable class="parameter">version</replaceable>/user-manual/</ulink>
230 will be used, where <replaceable class="parameter">version</replaceable> is the <application>Privoxy</application> version.
238 The User Manual URI is the single best source of information on
239 <application>Privoxy</application>, and is used for help links from some
240 of the internal CGI pages. The manual itself is normally packaged with the
241 binary distributions, so you probably want to set this to a locally
249 Unix, in local filesystem (may not work with all browsers):
252 <screen> user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
255 Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
258 <screen> user-manual file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
261 Windows, UNC notation (with forward slashes):
264 <screen> user-manual file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
268 The best all purpose solution is simply to put the full local
269 <literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
273 <screen> user-manual /usr/share/doc/privoxy/user-manual</screen>
276 The User Manual is then available to anyone with access to the proxy, by
277 following the built-in URL: <literal>http://config.privoxy.org/user-manual/</literal>
278 (or the shortcut: <literal>http://p.p/user-manual/</literal>).
281 If the documentation is not on the local system, it can be accessed
282 from a remote server, as:
285 <screen> user-manual http://example.com/privoxy/user-manual/</screen>
288 <!-- this gets hammered in conversion to config. Text repeated below. -->
291 If set, this option should be <emphasis>the first option in the config
292 file</emphasis>, because it is used while the config file is being read
305 If set, this option should be the first option in the config
306 file, because it is used while the config file is being read.
315 <![%config-file;[<literallayout>@@#user-manual http://www.privoxy.org/user-manual/</literallayout>]]>
319 <!-- ~~~~~ New section ~~~~~ -->
320 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
324 <term>Specifies:</term>
327 A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
332 <term>Type of value:</term>
338 <term>Default value:</term>
340 <para>Two example URLs are provided</para>
344 <term>Effect if unset:</term>
347 No links are displayed on the "untrusted" error page.
355 The value of this option only matters if the experimental trust mechanism has been
356 activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> above.)
359 If you use the trust mechanism, it is a good idea to write up some on-line
360 documentation about your trust policy and to specify the URL(s) here.
361 Use multiple times for multiple URLs.
364 The URL(s) should be added to the trustfile as well, so users don't end up
365 locked out from the information on why they were locked out in the first place!
371 <![%config-file;[<literallayout>@@trust-info-url http://www.example.com/why_we_block.html</literallayout>]]>
372 <![%config-file;[<literallayout>@@trust-info-url http://www.example.com/what_we_allow.html</literallayout>]]>
376 <!-- ~~~~~ New section ~~~~~ -->
377 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
381 <term>Specifies:</term>
384 An email address to reach the proxy administrator.
389 <term>Type of value:</term>
391 <para>Email address</para>
395 <term>Default value:</term>
397 <para><emphasis>Unset</emphasis></para>
401 <term>Effect if unset:</term>
404 No email address is displayed on error pages and the CGI user interface.
412 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
413 are unset, the whole "Local Privoxy Support" box on all generated pages will
420 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
424 <!-- ~~~~~ New section ~~~~~ -->
425 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
429 <term>Specifies:</term>
432 A URL to documentation about the local <application>Privoxy</application> setup,
433 configuration or policies.
438 <term>Type of value:</term>
444 <term>Default value:</term>
446 <para><emphasis>Unset</emphasis></para>
450 <term>Effect if unset:</term>
453 No link to local documentation is displayed on error pages and the CGI user interface.
461 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
462 are unset, the whole "Local Privoxy Support" box on all generated pages will
466 This URL shouldn't be blocked ;-)
472 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
476 <!-- ~ End section ~ -->
480 <!-- ~~~~~ New section ~~~~~ -->
482 <sect2 id="conf-log-loc">
483 <title>Configuration and Log File Locations</title>
486 <application>Privoxy</application> can (and normally does) use a number of
487 other files for additional configuration, help and logging.
488 This section of the configuration file tells <application>Privoxy</application>
489 where to find those other files.
493 The user running <application>Privoxy</application>, must have read
494 permission for all configuration files, and write permission to any files
495 that would be modified, such as log files and actions files.
499 <!-- ~~~~~ New section ~~~~~ -->
500 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
504 <term>Specifies:</term>
506 <para>The directory where the other configuration files are located</para>
510 <term>Type of value:</term>
512 <para>Path name</para>
516 <term>Default value:</term>
518 <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
522 <term>Effect if unset:</term>
524 <para><emphasis>Mandatory</emphasis></para>
531 No trailing <quote><literal>/</literal></quote>, please
534 This is really outdated and not likely to happen. HB 09/20/06
536 When development goes modular and multi-user, the blocker, filter, and
537 per-user config will be stored in subdirectories of <quote>confdir</quote>.
538 For now, the configuration directory structure is flat, except for
539 <filename>confdir/templates</filename>, where the HTML templates for CGI
540 output reside (e.g. <application>Privoxy's</application> 404 error page).
547 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
550 <!-- ~~~~~ New section ~~~~~ -->
551 <sect3 renderas="sect4" id="templdir"><title>templdir</title>
555 <term>Specifies:</term>
557 <para>An alternative directory where the templates are loaded from</para>
561 <term>Type of value:</term>
563 <para>Path name</para>
567 <term>Default value:</term>
573 <term>Effect if unset:</term>
575 <para>The templates are assumed to be located in confdir/template.</para>
582 Privoxy's original templates are usually overwritten
583 with each update. Use this option to relocate customized templates
584 that should be kept. Note that you might be missing new features
585 if you use outdated templates.
591 <![%config-file;[<literallayout>@@#templdir .</literallayout>]]>
595 <!-- ~~~~~ New section ~~~~~ -->
596 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
600 <term>Specifies:</term>
603 The directory where all logging takes place (i.e. where <filename>logfile</filename> and
604 <filename>jarfile</filename> are located)
609 <term>Type of value:</term>
611 <para>Path name</para>
615 <term>Default value:</term>
617 <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
621 <term>Effect if unset:</term>
623 <para><emphasis>Mandatory</emphasis></para>
630 No trailing <quote><literal>/</literal></quote>, please
636 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
640 <!-- ~~~~~ New section ~~~~~ -->
641 <sect3 renderas="sect4" id="actionsfile"><title>
644 <anchor id="default.action">
645 <anchor id="standard.action">
646 <anchor id="user.action">
647 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
650 <term>Specifies:</term>
653 The <link linkend="actions-file">actions file(s)</link> to use
658 <term>Type of value:</term>
660 <para>Complete file name, relative to <literal>confdir</literal></para>
664 <term>Default values:</term>
668 <msgtext><literallayout> standard.action # Internal purposes, no editing recommended</literallayout></msgtext>
671 <msgtext><literallayout> default.action # Main actions file</literallayout></msgtext>
674 <msgtext><literallayout> user.action # User customizations</literallayout></msgtext>
680 <term>Effect if unset:</term>
683 No actions are taken at all. More or less neutral proxying.
691 Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
694 The default values include standard.action, which is used for internal
695 purposes and should be loaded, default.action, which is the
696 <quote>main</quote> actions file maintained by the developers, and
697 <filename>user.action</filename>, where you can make your personal additions.
700 Actions files are where all the per site and per URL configuration is done for
701 ad blocking, cookie management, privacy considerations, etc.
702 There is no point in using <application>Privoxy</application> without at
703 least one actions file.
706 Note that since Privoxy 3.0.7, the complete filename, including the <quote>.action</quote>
707 extension has to be specified. The syntax change was necessary to be consistent
708 with the other file options and to allow previously forbidden characters.
714 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
715 <!-- html -> text conversion, blah -->
716 <![%config-file;[<literallayout>@@actionsfile standard.action # Internal purpose, recommended</literallayout>]]>
717 <![%config-file;[<literallayout>@@actionsfile default.action # Main actions file</literallayout>]]>
718 <![%config-file;[<literallayout>@@actionsfile user.action # User customizations</literallayout>]]>
721 <!-- ~~~~~ New section ~~~~~ -->
722 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
723 <anchor id="default.filter">
726 <term>Specifies:</term>
729 The <link linkend="filter-file">filter file(s)</link> to use
734 <term>Type of value:</term>
736 <para>File name, relative to <literal>confdir</literal></para>
740 <term>Default value:</term>
742 <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
746 <term>Effect if unset:</term>
749 No textual content filtering takes place, i.e. all
750 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
751 actions in the actions files are turned neutral.
759 Multiple <literal>filterfile</literal> lines are permitted.
762 The <link linkend="filter-file">filter files</link> contain content modification
763 rules that use <link linkend="regex">regular expressions</link>. These rules permit
764 powerful changes on the content of Web pages, and optionally the headers
765 as well, e.g., you could disable your favorite JavaScript annoyances,
766 re-write the actual displayed text, or just have some fun
767 playing buzzword bingo with web pages.
771 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
772 actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
773 to be defined in a filter file!
776 A pre-defined filter file called <filename>default.filter</filename> that contains
777 a number of useful filters for common problems is included in the distribution.
778 See the section on the <literal><link linkend="filter">filter</link></literal>
782 It is recommended to place any locally adapted filters into a separate
783 file, such as <filename>user.filter</filename>.
789 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
790 <![%config-file;[<literallayout>@@#filterfile user.filter # User customizations</literallayout>]]>
794 <!-- ~~~~~ New section ~~~~~ -->
795 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
799 <term>Specifies:</term>
807 <term>Type of value:</term>
809 <para>File name, relative to <literal>logdir</literal></para>
813 <term>Default value:</term>
815 <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows)</para>
819 <term>Effect if unset:</term>
822 No log file is used, all log messages go to the console (<literal>STDERR</literal>).
830 removed per bug report 688728 02/20/03 HB
833 The windows version will additionally log to the console.
837 The logfile is where all logging and error messages are written. The level
838 of detail and number of messages are set with the <literal>debug</literal>
839 option (see below). The logfile can be useful for tracking down a problem with
840 <application>Privoxy</application> (e.g., it's not blocking an ad you
841 think it should block) but in most cases you probably will never look at
842 it. For this reason, it is disabled by default. For troubleshooting
843 purposes, you will have to explicitly enable it.
846 Your logfile will grow indefinitely, and you will probably want to
847 periodically remove it. On Unix systems, you can do this with a cron job
848 (see <quote>man cron</quote>). For Red Hat based Linux distributions, a
849 <command>logrotate</command> script has been included.
852 On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
853 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
854 the effect that cron.daily will automatically archive, gzip, and empty the
855 log, when it exceeds 1M size.
858 Any log files must be writable by whatever user <application>Privoxy</application>
859 is being run as (default on UNIX, user id is <quote>privoxy</quote>).
865 <![%config-file;[<literallayout>@@#logfile logfile</literallayout>]]>
869 <!-- ~~~~~ New section ~~~~~ -->
870 <sect3 renderas="sect4" id="jarfile"><title>jarfile</title>
874 <term>Specifies:</term>
877 The file to store intercepted cookies in
882 <term>Type of value:</term>
884 <para>File name, relative to <literal>logdir</literal></para>
888 <term>Default value:</term>
890 <para><emphasis>Unset (commented out)</emphasis>. When activated: jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows)</para>
894 <term>Effect if unset:</term>
897 Intercepted cookies are not stored in a dedicated log file.
905 The jarfile may grow to ridiculous sizes over time.
908 If debug 8 (show header parsing) is enabled, cookies are
909 written to the logfile with the rest of the headers.
915 <![%config-file;[<literallayout>@@#jarfile jarfile</literallayout>]]>
919 <!-- ~~~~~ New section ~~~~~ -->
920 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
923 <term>Specifies:</term>
926 The name of the trust file to use
931 <term>Type of value:</term>
933 <para>File name, relative to <literal>confdir</literal></para>
937 <term>Default value:</term>
939 <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
943 <term>Effect if unset:</term>
946 The entire trust mechanism is disabled.
954 The trust mechanism is an experimental feature for building white-lists and should
955 be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
958 If you specify a trust file, <application>Privoxy</application> will only allow
959 access to sites that are specified in the trustfile. Sites can be listed
963 Prepending a <literal>~</literal> character limits access to this site
964 only (and any sub-paths within this site), e.g.
965 <literal>~www.example.com</literal> allows access to
966 <literal>~www.example.com/features/news.html</literal>, etc.
969 Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
970 prepending the name with a <literal>+</literal> character. The effect is that
971 access to untrusted sites will be granted -- but only if a link from this
972 trusted referrer was used to get there. The link target will then be added
973 to the <quote>trustfile</quote> so that future, direct accesses will be
974 granted. Sites added via this mechanism do not become trusted referrers
975 themselves (i.e. they are added with a <literal>~</literal> designation).
976 There is a limit of 512 such entries, after which new entries will not be
980 If you use the <literal>+</literal> operator in the trust file, it may grow
981 considerably over time.
984 It is recommended that <application>Privoxy</application> be compiled with
985 the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
986 <literal> --disable-editor</literal> options, if this feature is to be
990 Possible applications include limiting Internet access for children.
997 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
1001 <!-- ~ End section ~ -->
1003 <!-- ~~~~~ New section ~~~~~ -->
1004 <sect2 id="debugging">
1005 <title>Debugging</title>
1008 These options are mainly useful when tracing a problem.
1009 Note that you might also want to invoke
1010 <application>Privoxy</application> with the <literal>--no-daemon</literal>
1011 command line option when debugging.
1014 <sect3 renderas="sect4" id="debug"><title>debug</title>
1018 <term>Specifies:</term>
1021 Key values that determine what information gets logged to the
1022 <link linkend="logfile"><emphasis>logfile</emphasis></link>.
1027 <term>Type of value:</term>
1029 <para>Integer values</para>
1033 <term>Default value:</term>
1035 <para>12289 (i.e.: URLs plus informational and warning messages)</para>
1039 <term>Effect if unset:</term>
1042 Nothing gets logged.
1050 The available debug levels are:
1054 debug 1 # show each GET/POST/CONNECT request
1055 debug 2 # show each connection status
1056 debug 4 # show I/O status
1057 debug 8 # show header parsing
1058 debug 16 # log all data written to the network into the logfile
1059 debug 32 # debug force feature
1060 debug 64 # debug regular expression filters
1061 debug 128 # debug redirects
1062 debug 256 # debug GIF de-animation
1063 debug 512 # Common Log Format
1064 debug 1024 # debug kill pop-ups
1065 debug 2048 # CGI user interface
1066 debug 4096 # Startup banner and warnings.
1067 debug 8192 # Non-fatal errors
1071 To select multiple debug levels, you can either add them or use
1072 multiple <literal>debug</literal> lines.
1075 A debug level of 1 is informative because it will show you each request
1076 as it happens. <emphasis>1, 4096 and 8192 are highly recommended</emphasis>
1077 so that you will notice when things go wrong. The other levels are probably
1078 only of interest if you are hunting down a specific problem. They can produce
1079 a hell of an output (especially 16).
1083 The reporting of <emphasis>fatal</emphasis> errors (i.e. ones which causes
1084 <application>Privoxy</application> to exit) is always on and cannot be disabled.
1087 If you want to use CLF (Common Log Format), you should set <quote>debug
1088 512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1091 <application>Privoxy</application> has a hard-coded limit for the
1092 length of log messages. If it's reached, messages are logged truncated
1093 and marked with <quote>... [too long, truncated]</quote>.
1099 <![%config-file;[<literallayout>@@debug 1 # show each GET/POST/CONNECT request</literallayout>]]>
1100 <![%config-file;[<literallayout>@@debug 4096 # Startup banner and warnings</literallayout>]]>
1101 <![%config-file;[<literallayout>@@debug 8192 # Errors - *we highly recommended enabling this*</literallayout>]]>
1105 <!-- ~~~~~ New section ~~~~~ -->
1106 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1110 <term>Specifies:</term>
1113 Whether to run only one server thread
1118 <term>Type of value:</term>
1120 <para><emphasis>None</emphasis></para>
1124 <term>Default value:</term>
1126 <para><emphasis>Unset</emphasis></para>
1130 <term>Effect if unset:</term>
1133 Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1134 serve multiple requests simultaneously.
1142 This option is only there for debug purposes and you should never
1143 need to use it. <emphasis>It will drastically reduce performance.</emphasis>
1149 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1154 <!-- ~ End section ~ -->
1157 <!-- ~~~~~ New section ~~~~~ -->
1158 <sect2 id="access-control">
1159 <title>Access Control and Security</title>
1162 This section of the config file controls the security-relevant aspects
1163 of <application>Privoxy</application>'s configuration.
1167 <!-- ~~~~~ New section ~~~~~ -->
1168 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1172 <term>Specifies:</term>
1175 The IP address and TCP port on which <application>Privoxy</application> will
1176 listen for client requests.
1181 <term>Type of value:</term>
1183 <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1188 <term>Default value:</term>
1190 <para>127.0.0.1:8118</para>
1194 <term>Effect if unset:</term>
1197 Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1198 home users who run <application>Privoxy</application> on the same machine as
1207 You will need to configure your browser(s) to this proxy address and port.
1210 If you already have another service running on port 8118, or if you want to
1211 serve requests from other machines (e.g. on your local network) as well, you
1212 will need to override the default.
1215 If you leave out the IP address, <application>Privoxy</application> will
1216 bind to all interfaces (addresses) on your machine and may become reachable
1217 from the Internet. In that case, consider using <link
1218 linkend="acls">access control lists</link> (ACL's, see below), and/or
1222 If you open <application>Privoxy</application> to untrusted users, you will
1223 also want to make sure that the following actions are disabled: <literal><link
1224 linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1225 <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1231 <term>Example:</term>
1234 Suppose you are running <application>Privoxy</application> on
1235 a machine which has the address 192.168.0.1 on your local private network
1236 (192.168.0.0) and has another outside connection with a different address.
1237 You want it to serve requests from inside only:
1241 listen-address 192.168.0.1:8118
1248 <![%config-file;[<literallayout>@@listen-address 127.0.0.1:8118</literallayout>]]>
1252 <!-- ~~~~~ New section ~~~~~ -->
1253 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1257 <term>Specifies:</term>
1260 Initial state of "toggle" status
1265 <term>Type of value:</term>
1271 <term>Default value:</term>
1277 <term>Effect if unset:</term>
1280 Act as if toggled on
1288 If set to 0, <application>Privoxy</application> will start in
1289 <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1290 content-neutral proxy where all ad blocking, filtering, etc are disabled. See
1291 <literal>enable-remote-toggle</literal> below. This is not really useful
1292 anymore, since toggling is much easier via <ulink
1293 url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1294 editing the <filename>conf</filename> file.
1297 The windows version will only display the toggle icon in the system tray
1298 if this option is present.
1304 <![%config-file;[<literallayout>@@toggle 1</literallayout>]]>
1308 <!-- ~~~~~ New section ~~~~~ -->
1309 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1312 <term>Specifies:</term>
1315 Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1316 feature</ulink> may be used
1321 <term>Type of value:</term>
1327 <term>Default value:</term>
1333 <term>Effect if unset:</term>
1336 The web-based toggle feature is disabled.
1344 When toggled off, <application>Privoxy</application> mostly acts like a normal,
1345 content-neutral proxy, i.e. it acts as if none of the actions applied to
1349 Access to the toggle feature can <emphasis>not</emphasis> be
1350 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1351 so that everybody who can access <application>Privoxy</application> (see
1352 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1353 toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1354 for multi-user environments with untrusted users. Because of
1355 the obvious security implications, this feature is off by default.
1356 Note that malicious client side code (e.g Java) is also potentially
1357 capable of changing <application>Privoxy's</application> intended
1361 Note that you must have compiled <application>Privoxy</application> with
1362 support for this feature, otherwise this option has no effect.
1368 <![%config-file;[<literallayout>@@enable-remote-toggle 0</literallayout>]]>
1372 <!-- ~~~~~ New section ~~~~~ -->
1373 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1376 <term>Specifies:</term>
1379 Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1384 <term>Type of value:</term>
1390 <term>Default value:</term>
1396 <term>Effect if unset:</term>
1399 Privoxy ignores special HTTP headers.
1407 When toggled on, the client can change <application>Privoxy's</application>
1408 behaviour by setting special HTTP headers. Currently the only supported
1409 special header is <quote>X-Filter: No</quote>, to disable filtering for
1410 the ongoing request, even if it is enabled in one of the action files.
1413 This feature is disabled by default. If you are using
1414 <application>Privoxy</application> in a environment with trusted clients,
1415 you may enable this feature at your discretion. Note that malicious client
1416 side code (e.g Java) is also potentially capable of changing
1417 <application>Privoxy's</application> intended behavior.
1423 <![%config-file;[<literallayout>@@enable-remote-http-toggle 0</literallayout>]]>
1427 <!-- ~~~~~ New section ~~~~~ -->
1428 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1431 <term>Specifies:</term>
1434 Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1435 file editor</ulink> may be used
1440 <term>Type of value:</term>
1446 <term>Default value:</term>
1452 <term>Effect if unset:</term>
1455 The web-based actions file editor is disabled.
1463 Access to the editor can <emphasis>not</emphasis> be
1464 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1465 so that everybody who can access <application>Privoxy</application> (see
1466 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1467 modify its configuration for all users. This option is <emphasis>not
1468 recommended</emphasis> for multi-user environments with untrusted users
1469 and is therefore disabled by default. Note that malicious client side code
1470 (e.g Java) is also potentially capable of changing
1471 <application>Privoxy's</application> intended behavior.
1474 Note that you must have compiled <application>Privoxy</application> with
1475 support for this feature, otherwise this option has no effect.
1481 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1485 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1488 <term>Specifies:</term>
1491 Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1496 <term>Type of value:</term>
1499 <replaceable>0 or 1</replaceable>
1504 <term>Default value:</term>
1506 <para><emphasis>0</emphasis></para>
1510 <term>Effect if unset:</term>
1513 Blocks are not enforced.
1521 <application>Privoxy</application> is mainly used to block and filter
1522 requests as a service to the user, for example to block ads and other
1523 junk that clogs the pipes. <application>Privoxy's</application> configuration
1524 isn't perfect and sometimes innocent pages are blocked. In this situation it
1525 makes sense to allow the user to enforce the request and have
1526 <application>Privoxy</application> ignore the block.
1529 In the default configuration <application>Privoxy's</application>
1530 <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1531 link to adds a special string (the force prefix) to the request URL.
1532 If that link is used, <application>Privoxy</application> will
1533 detect the force prefix, remove it again and let the request pass.
1536 Of course <application>Privoxy</application> can also be used to enforce
1537 a network policy. In that case the user obviously should not be able to
1538 bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1539 option is for. If it's enabled, <application>Privoxy</application> hides
1540 the <quote>go there anyway</quote> link. If the user adds the force
1541 prefix by hand, it will not be accepted and the circumvention attempt
1547 <term>Examples:</term>
1555 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1559 <!-- ~~~~~ New section ~~~~~ -->
1560 <sect3 renderas="sect4" id="acls"><title>
1561 ACLs: permit-access and deny-access</title>
1562 <anchor id="permit-access">
1563 <anchor id="deny-access">
1567 <term>Specifies:</term>
1570 Who can access what.
1575 <term>Type of value:</term>
1578 <replaceable class="parameter">src_addr</replaceable>[/<replaceable class="parameter">src_masklen</replaceable>]
1579 [<replaceable class="parameter">dst_addr</replaceable>[/<replaceable class="parameter">dst_masklen</replaceable>]]
1582 Where <replaceable class="parameter">src_addr</replaceable> and
1583 <replaceable class="parameter">dst_addr</replaceable> are IP addresses in dotted decimal notation or valid
1584 DNS names, and <replaceable class="parameter">src_masklen</replaceable> and
1585 <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1586 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1587 destination part are optional.
1592 <term>Default value:</term>
1594 <para><emphasis>Unset</emphasis></para>
1598 <term>Effect if unset:</term>
1601 Don't restrict access further than implied by <literal>listen-address</literal>
1609 Access controls are included at the request of ISPs and systems
1610 administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1611 For a typical home user, it will normally suffice to ensure that
1612 <application>Privoxy</application> only listens on the localhost
1613 (127.0.0.1) or internal (home) network address by means of the
1614 <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1618 Please see the warnings in the FAQ that this proxy is not intended to be a substitute
1619 for a firewall or to encourage anyone to defer addressing basic security
1623 Multiple ACL lines are OK.
1624 If any ACLs are specified, <application>Privoxy</application> only talks
1625 to IP addresses that match at least one <literal>permit-access</literal> line
1626 and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1627 last match wins, with the default being <literal>deny-access</literal>.
1630 If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1631 for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1632 that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1633 of the ultimate target. This is necessary because it may be impossible for the local
1634 <application>Privoxy</application> to determine the IP address of the
1635 ultimate target (that's often what gateways are used for).
1638 You should prefer using IP addresses over DNS names, because the address lookups take
1639 time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1640 like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1641 IP addresses, only the first one is used.
1644 Denying access to particular sites by ACL may have undesired side effects
1645 if the site in question is hosted on a machine which also hosts other sites
1651 <term>Examples:</term>
1654 Explicitly define the default behavior if no ACL and
1655 <literal>listen-address</literal> are set: <quote>localhost</quote>
1656 is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1657 <emphasis>all</emphasis> destination addresses are OK:
1661 permit-access localhost
1665 Allow any host on the same class C subnet as www.privoxy.org access to
1666 nothing but www.example.com (or other domains hosted on the same system):
1670 permit-access www.privoxy.org/24 www.example.com/32
1674 Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1675 with the exception that 192.168.45.73 may not access the IP address behind
1676 www.dirty-stuff.example.com:
1680 permit-access 192.168.45.64/26
1681 deny-access 192.168.45.73 www.dirty-stuff.example.com
1690 <!-- ~~~~~ New section ~~~~~ -->
1691 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1695 <term>Specifies:</term>
1698 Maximum size of the buffer for content filtering.
1703 <term>Type of value:</term>
1705 <para>Size in Kbytes</para>
1709 <term>Default value:</term>
1715 <term>Effect if unset:</term>
1718 Use a 4MB (4096 KB) limit.
1726 For content filtering, i.e. the <literal>+filter</literal> and
1727 <literal>+deanimate-gif</literal> actions, it is necessary that
1728 <application>Privoxy</application> buffers the entire document body.
1729 This can be potentially dangerous, since a server could just keep sending
1730 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1734 When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1735 flushed to the client unfiltered and no further attempt to
1736 filter the rest of the document is made. Remember that there may be multiple threads
1737 running, which might require up to <literal>buffer-limit</literal> Kbytes
1738 <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1745 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1750 <!-- ~ End section ~ -->
1753 <!-- ~~~~~ New section ~~~~~ -->
1755 <sect2 id="forwarding">
1756 <title>Forwarding</title>
1759 This feature allows routing of HTTP requests through a chain of
1763 Forwarding can be used to chain Privoxy with a caching proxy to speed
1764 up browsing. Using a parent proxy may also be necessary if the machine
1765 that <application>Privoxy</application> runs on has no direct Internet access.
1768 Note that parent proxies can severely decrease your privacy level.
1769 For example a parent proxy could add your IP address to the request
1770 headers and if it's a caching proxy it may add the <quote>Etag</quote>
1771 header to revalidation requests again, even though you configured Privoxy
1772 to remove it. It may also ignore Privoxy's header time randomization and use the
1773 original values which could be used by the server as cookie replacement
1774 to track your steps between visits.
1778 Also specified here are SOCKS proxies. <application>Privoxy</application>
1779 supports the SOCKS 4 and SOCKS 4A protocols.
1782 <sect3 renderas="sect4" id="forward"><title>forward</title>
1785 <term>Specifies:</term>
1788 To which parent HTTP proxy specific requests should be routed.
1793 <term>Type of value:</term>
1796 <replaceable class="parameter">target_pattern</replaceable>
1797 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1800 where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1801 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1802 denote <quote>all URLs</quote>.
1803 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1804 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1805 optionally followed by its listening port (default: 8080).
1806 Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1811 <term>Default value:</term>
1813 <para><emphasis>Unset</emphasis></para>
1817 <term>Effect if unset:</term>
1820 Don't use parent HTTP proxies.
1828 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1829 forwarded to another HTTP proxy but are made directly to the web servers.
1832 Multiple lines are OK, they are checked in sequence, and the last match wins.
1837 <term>Examples:</term>
1840 Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
1844 forward / parent-proxy.example.org:8080
1849 Everything goes to our example ISP's caching proxy, except for requests
1850 to that ISP's sites:
1854 forward / caching-proxy.example-isp.net:8000
1855 forward .example-isp.net .
1864 <!-- ~~~~~ New section ~~~~~ -->
1865 <sect3 renderas="sect4" id="socks"><title>
1866 forward-socks4 and forward-socks4a</title>
1867 <anchor id="forward-socks4">
1868 <anchor id="forward-socks4a">
1872 <term>Specifies:</term>
1875 Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
1880 <term>Type of value:</term>
1883 <replaceable class="parameter">target_pattern</replaceable>
1884 <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
1885 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1888 where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1889 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1890 denote <quote>all URLs</quote>.
1891 <replaceable class="parameter">http_parent</replaceable> and <replaceable class="parameter">socks_proxy</replaceable>
1892 are IP addresses in dotted decimal notation or valid DNS names (<replaceable class="parameter">http_parent</replaceable>
1893 may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
1894 <replaceable class="parameter">port</replaceable> parameters are TCP ports, i.e. integer values from 1 to 64535
1899 <term>Default value:</term>
1901 <para><emphasis>Unset</emphasis></para>
1905 <term>Effect if unset:</term>
1908 Don't use SOCKS proxies.
1916 Multiple lines are OK, they are checked in sequence, and the last match wins.
1919 The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
1920 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
1921 server, while in SOCKS 4 it happens locally.
1924 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1925 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
1931 <term>Examples:</term>
1934 From the company example.com, direct connections are made to all
1935 <quote>internal</quote> domains, but everything outbound goes through
1936 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
1941 forward-socks4a / socks-gw.example.com:1080 www-cache.example-isp.net:8080
1942 forward .example.com .
1946 A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
1950 forward-socks4 / socks-gw.example.com:1080 .
1955 To chain Privoxy and Tor, both running on the same system, you should use
1960 forward-socks4 / 127.0.0.1:9050 .
1965 The public <application>Tor</application> network can't be used to reach your local network,
1966 therefore it's a good idea to make some exceptions:
1970 forward 192.168.*.*/ .
1972 forward 127.*.*.*/ .
1976 Unencrypted connections to systems in these address ranges will
1977 be as (un)secure as the local network is, but the alternative is that you
1978 can't reach the network at all.
1981 If you also want to be able to reach servers in your local network by
1982 using their names, you will need additional exceptions that look like
1987 forward localhost/ .
1996 <![%user-man;[ <!-- not included in config due to length -->
1997 <!-- ~~~~~ New section ~~~~~ -->
1998 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2001 If you have links to multiple ISPs that provide various special content
2002 only to their subscribers, you can configure multiple <application>Privoxies</application>
2003 which have connections to the respective ISPs to act as forwarders to each other, so that
2004 <emphasis>your</emphasis> users can see the internal content of all ISPs.
2008 Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to
2009 isp-b.net. Both run <application>Privoxy</application>. Their forwarding
2010 configuration can look like this:
2020 forward .isp-b.net host-b:8118
2031 forward .isp-a.net host-a:8118
2036 Now, your users can set their browser's proxy to use either
2037 host-a or host-b and be able to browse the internal content
2038 of both isp-a and isp-b.
2042 If you intend to chain <application>Privoxy</application> and
2043 <application>squid</application> locally, then chain as
2044 <literal>browser -> squid -> privoxy</literal> is the recommended way.
2048 Assuming that <application>Privoxy</application> and <application>squid</application>
2049 run on the same box, your <application>squid</application> configuration could then look like this:
2054 # Define Privoxy as parent proxy (without ICP)
2055 cache_peer 127.0.0.1 parent 8118 7 no-query
2057 # Define ACL for protocol FTP
2060 # Do not forward FTP requests to Privoxy
2061 always_direct allow ftp
2063 # Forward all the rest to Privoxy
2064 never_direct allow all</screen>
2068 You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2069 Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2073 You could just as well decide to only forward requests for Windows executables through
2074 a virus-scanning parent proxy, say, on <literal>antivir.example.com</literal>, port 8010:
2080 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
2086 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2089 <term>Specifies:</term>
2092 How often Privoxy retries if a forwarded connection request fails.
2097 <term>Type of value:</term>
2100 <replaceable class="parameter">Number of retries.</replaceable>
2105 <term>Default value:</term>
2107 <para><emphasis>0</emphasis></para>
2111 <term>Effect if unset:</term>
2114 Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2122 <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2123 for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2124 The connection might have failed because of a DNS timeout in which case a retry makes sense,
2125 but it might also have failed because the server doesn't exist or isn't reachable. In this
2126 case the retry will just delay the appearance of Privoxy's error message.
2129 Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2130 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2133 Only use this option, if you are getting many forwarding related error messages,
2134 that go away when you try again manually. Start with a small value and check Privoxy's
2135 logfile from time to time, to see how many retries are usually needed.
2140 <term>Examples:</term>
2143 forwarded-connect-retries 1
2148 <![%config-file;[<literallayout>@@forwarded-connect-retries 0</literallayout>]]>
2151 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2154 <term>Specifies:</term>
2157 Whether intercepted requests should be treated as valid.
2162 <term>Type of value:</term>
2165 <replaceable>0 or 1</replaceable>
2170 <term>Default value:</term>
2172 <para><emphasis>0</emphasis></para>
2176 <term>Effect if unset:</term>
2179 Only proxy requests are accepted, intercepted requests are treated as invalid.
2187 If you don't trust your clients and want to force them
2188 to use <application>Privoxy</application>, enable this
2189 option and configure your packet filter to redirect outgoing
2190 HTTP connections into <application>Privoxy</application>.
2193 Make sure that <application>Privoxy's</application> own requests
2194 aren't redirected as well. Additionally take care that
2195 <application>Privoxy</application> can't intentionally connect
2196 to itself, otherwise you could run into redirection loops if
2197 <application>Privoxy's</application> listening port is reachable
2198 by the outside or an attacker has access to the pages you visit.
2203 <term>Examples:</term>
2206 accept-intercepted-requests 1
2211 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2214 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2217 <term>Specifies:</term>
2220 Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2225 <term>Type of value:</term>
2228 <replaceable>0 or 1</replaceable>
2233 <term>Default value:</term>
2235 <para><emphasis>0</emphasis></para>
2239 <term>Effect if unset:</term>
2242 <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2250 By default <application>Privoxy</application> ignores block or redirect actions
2251 for its CGI pages. Intercepting these requests can be useful in multi-user
2252 setups to implement fine-grained access control, but it can also render the complete
2253 web interface useless and make debugging problems painful if done without care.
2256 Don't enable this option unless you're sure that you really need it.
2261 <term>Examples:</term>
2264 allow-cgi-request-crunching 1
2269 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2272 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2275 <term>Specifies:</term>
2278 Whether the CGI interface should stay compatible with broken HTTP clients.
2283 <term>Type of value:</term>
2286 <replaceable>0 or 1</replaceable>
2291 <term>Default value:</term>
2293 <para><emphasis>0</emphasis></para>
2297 <term>Effect if unset:</term>
2300 The CGI form generate long GET URLs.
2308 <application>Privoxy's</application> CGI forms can lead to
2309 rather long URLs. This isn't a problem as far as the HTTP
2310 standard is concerned, but it can confuse clients with arbitrary
2311 URL lenght limitations.
2314 Enabling split-large-forms causes <application>Privoxy</application>
2315 to devide big forms into smaller ones to keep the URL length down.
2316 It makes editing a lot less convenient and you can no longer
2317 submit all changes at once, but at least it works around this
2321 If you don't notice any editing problems, there is no reason
2322 to enable this option, but if one of the submit buttons appears
2323 to be broken, you should give it a try.
2328 <term>Examples:</term>
2336 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2341 <!-- ~ End section ~ -->
2344 <!-- ~~~~~ New section ~~~~~ -->
2346 <sect2 id="windows-gui">
2347 <title>Windows GUI Options</title>
2349 <application>Privoxy</application> has a number of options specific to the
2350 Windows GUI interface:
2353 <anchor id="activity-animation">
2354 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2356 If <quote>activity-animation</quote> is set to 1, the
2357 <application>Privoxy</application> icon will animate when
2358 <quote>Privoxy</quote> is active. To turn off, set to 0.
2361 <![%config-file;[<literallayout>@@#activity-animation 1</literallayout>]]>
2367 <emphasis>activity-animation 1</emphasis>
2374 <anchor id="log-messages">
2375 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2377 If <quote>log-messages</quote> is set to 1,
2378 <application>Privoxy</application> will log messages to the console
2382 <![%config-file;[<literallayout>@@#log-messages 1</literallayout>]]>
2388 <emphasis>log-messages 1</emphasis>
2395 <anchor id="log-buffer-size">
2396 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2398 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
2399 i.e. the amount of memory used for the log messages displayed in the
2400 console window, will be limited to <quote>log-max-lines</quote> (see below).
2404 Warning: Setting this to 0 will result in the buffer to grow infinitely and
2405 eat up all your memory!
2408 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
2414 <emphasis>log-buffer-size 1</emphasis>
2421 <anchor id="log-max-lines">
2422 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2424 <application>log-max-lines</application> is the maximum number of lines held
2425 in the log buffer. See above.
2428 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
2434 <emphasis>log-max-lines 200</emphasis>
2441 <anchor id="log-highlight-messages">
2442 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2444 If <quote>log-highlight-messages</quote> is set to 1,
2445 <application>Privoxy</application> will highlight portions of the log
2446 messages with a bold-faced font:
2449 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
2455 <emphasis>log-highlight-messages 1</emphasis>
2462 <anchor id="log-font-name">
2463 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2465 The font used in the console window:
2468 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
2474 <emphasis>log-font-name Comic Sans MS</emphasis>
2481 <anchor id="log-font-size">
2482 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2484 Font size used in the console window:
2487 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
2493 <emphasis>log-font-size 8</emphasis>
2500 <anchor id="show-on-task-bar">
2501 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2503 <quote>show-on-task-bar</quote> controls whether or not
2504 <application>Privoxy</application> will appear as a button on the Task bar
2508 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
2514 <emphasis>show-on-task-bar 0</emphasis>
2521 <anchor id="close-button-minimizes">
2522 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2524 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
2525 button will minimize <application>Privoxy</application> instead of closing
2526 the program (close with the exit option on the File menu).
2529 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
2535 <emphasis>close-button-minimizes 1</emphasis>
2542 <anchor id="hide-console">
2543 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2545 The <quote>hide-console</quote> option is specific to the MS-Win console
2546 version of <application>Privoxy</application>. If this option is used,
2547 <application>Privoxy</application> will disconnect from and hide the
2551 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
2557 #<emphasis>hide-console</emphasis>
2567 <!-- end config content common to both outputs -->
2570 <!-- These are dummy anchors to keep the processor quiet -->
2571 <!-- when building config-file only (ie. they are used in u-m only) -->
2574 <anchor id="filter">
2575 <anchor id="filter-file">
2577 <anchor id="actions-file">
2578 <anchor id="af-patterns">
2582 <!-- eof p-config.sgml -->