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.22 2007/11/09 20:26:58 fabiankeil 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.22 2007/11/09 20:26:58 fabiankeil 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
277 <application>Privoxy</application>, by following the built-in URL:
278 <literal>http://config.privoxy.org/user-manual/</literal>
279 (or the shortcut: <literal>http://p.p/user-manual/</literal>).
282 If the documentation is not on the local system, it can be accessed
283 from a remote server, as:
286 <screen> user-manual http://example.com/privoxy/user-manual/</screen>
289 <!-- this gets hammered in conversion to config. Text repeated below. -->
292 If set, this option should be <emphasis>the first option in the config
293 file</emphasis>, because it is used while the config file is being read
306 If set, this option should be the first option in the config
307 file, because it is used while the config file is being read.
316 <![%config-file;[<literallayout>@@#user-manual http://www.privoxy.org/user-manual/</literallayout>]]>
320 <!-- ~~~~~ New section ~~~~~ -->
321 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
325 <term>Specifies:</term>
328 A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
333 <term>Type of value:</term>
339 <term>Default value:</term>
341 <para>Two example URLs are provided</para>
345 <term>Effect if unset:</term>
348 No links are displayed on the "untrusted" error page.
356 The value of this option only matters if the experimental trust mechanism has been
357 activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> below.)
360 If you use the trust mechanism, it is a good idea to write up some on-line
361 documentation about your trust policy and to specify the URL(s) here.
362 Use multiple times for multiple URLs.
365 The URL(s) should be added to the trustfile as well, so users don't end up
366 locked out from the information on why they were locked out in the first place!
372 <![%config-file;[<literallayout>@@trust-info-url http://www.example.com/why_we_block.html</literallayout>]]>
373 <![%config-file;[<literallayout>@@trust-info-url http://www.example.com/what_we_allow.html</literallayout>]]>
377 <!-- ~~~~~ New section ~~~~~ -->
378 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
382 <term>Specifies:</term>
385 An email address to reach the <application>Privoxy</application> administrator.
390 <term>Type of value:</term>
392 <para>Email address</para>
396 <term>Default value:</term>
398 <para><emphasis>Unset</emphasis></para>
402 <term>Effect if unset:</term>
405 No email address is displayed on error pages and the CGI user interface.
413 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
414 are unset, the whole "Local Privoxy Support" box on all generated pages will
421 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
425 <!-- ~~~~~ New section ~~~~~ -->
426 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
430 <term>Specifies:</term>
433 A URL to documentation about the local <application>Privoxy</application> setup,
434 configuration or policies.
439 <term>Type of value:</term>
445 <term>Default value:</term>
447 <para><emphasis>Unset</emphasis></para>
451 <term>Effect if unset:</term>
454 No link to local documentation is displayed on error pages and the CGI user interface.
462 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
463 are unset, the whole "Local Privoxy Support" box on all generated pages will
467 This URL shouldn't be blocked ;-)
473 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
477 <!-- ~ End section ~ -->
481 <!-- ~~~~~ New section ~~~~~ -->
483 <sect2 id="conf-log-loc">
484 <title>Configuration and Log File Locations</title>
487 <application>Privoxy</application> can (and normally does) use a number of
488 other files for additional configuration, help and logging.
489 This section of the configuration file tells <application>Privoxy</application>
490 where to find those other files.
494 The user running <application>Privoxy</application>, must have read
495 permission for all configuration files, and write permission to any files
496 that would be modified, such as log files and actions files.
500 <!-- ~~~~~ New section ~~~~~ -->
501 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
505 <term>Specifies:</term>
507 <para>The directory where the other configuration files are located.</para>
511 <term>Type of value:</term>
513 <para>Path name</para>
517 <term>Default value:</term>
519 <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
523 <term>Effect if unset:</term>
525 <para><emphasis>Mandatory</emphasis></para>
532 No trailing <quote><literal>/</literal></quote>, please.
535 This is really outdated and not likely to happen. HB 09/20/06
537 When development goes modular and multi-user, the blocker, filter, and
538 per-user config will be stored in subdirectories of <quote>confdir</quote>.
539 For now, the configuration directory structure is flat, except for
540 <filename>confdir/templates</filename>, where the HTML templates for CGI
541 output reside (e.g. <application>Privoxy's</application> 404 error page).
548 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
551 <!-- ~~~~~ New section ~~~~~ -->
552 <sect3 renderas="sect4" id="templdir"><title>templdir</title>
556 <term>Specifies:</term>
558 <para>An alternative directory where the templates are loaded from.</para>
562 <term>Type of value:</term>
564 <para>Path name</para>
568 <term>Default value:</term>
574 <term>Effect if unset:</term>
576 <para>The templates are assumed to be located in confdir/template.</para>
583 <application>Privoxy's</application> original templates are usually
584 overwritten with each update. Use this option to relocate customized
585 templates that should be kept. As template variables might change
586 between updates, you shouldn't expect templates to work with
587 <application>Privoxy</application> releases other than the one
588 they were part of, though.
594 <![%config-file;[<literallayout>@@#templdir .</literallayout>]]>
598 <!-- ~~~~~ New section ~~~~~ -->
599 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
603 <term>Specifies:</term>
606 The directory where all logging takes place
607 (i.e. where <filename>logfile</filename> and
608 <filename>jarfile</filename> are located).
613 <term>Type of value:</term>
615 <para>Path name</para>
619 <term>Default value:</term>
621 <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
625 <term>Effect if unset:</term>
627 <para><emphasis>Mandatory</emphasis></para>
634 No trailing <quote><literal>/</literal></quote>, please.
640 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
644 <!-- ~~~~~ New section ~~~~~ -->
645 <sect3 renderas="sect4" id="actionsfile"><title>
648 <anchor id="default.action">
649 <anchor id="standard.action">
650 <anchor id="user.action">
651 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
654 <term>Specifies:</term>
657 The <link linkend="actions-file">actions file(s)</link> to use
662 <term>Type of value:</term>
664 <para>Complete file name, relative to <literal>confdir</literal></para>
668 <term>Default values:</term>
672 <msgtext><literallayout> standard.action # Internal purposes, no editing recommended</literallayout></msgtext>
675 <msgtext><literallayout> default.action # Main actions file</literallayout></msgtext>
678 <msgtext><literallayout> user.action # User customizations</literallayout></msgtext>
684 <term>Effect if unset:</term>
687 No actions are taken at all. More or less neutral proxying.
695 Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
698 The default values include <filename>standard.action</filename>, which is used
699 for internal purposes and should be loaded, <filename>default.action</filename>,
700 which is the <quote>main</quote> actions file maintained by the developers, and
701 <filename>user.action</filename>, where you can make your personal additions.
704 Actions files contain all the per site and per URL configuration for
705 ad blocking, cookie management, privacy considerations, etc.
706 There is no point in using <application>Privoxy</application> without at
707 least one actions file.
710 Note that since Privoxy 3.0.7, the complete filename, including the <quote>.action</quote>
711 extension has to be specified. The syntax change was necessary to be consistent
712 with the other file options and to allow previously forbidden characters.
718 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
719 <!-- html -> text conversion, blah -->
720 <![%config-file;[<literallayout>@@actionsfile standard.action # Internal purpose, recommended</literallayout>]]>
721 <![%config-file;[<literallayout>@@actionsfile default.action # Main actions file</literallayout>]]>
723 XXX: Like user.filter, user.action should probably be commented out
724 by default as not all packages install it into the default directory.
727 <![%config-file;[<literallayout>@@actionsfile user.action # User customizations</literallayout>]]>
730 <!-- ~~~~~ New section ~~~~~ -->
731 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
732 <anchor id="default.filter">
735 <term>Specifies:</term>
738 The <link linkend="filter-file">filter file(s)</link> to use
743 <term>Type of value:</term>
745 <para>File name, relative to <literal>confdir</literal></para>
749 <term>Default value:</term>
751 <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
755 <term>Effect if unset:</term>
758 No textual content filtering takes place, i.e. all
759 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
760 actions in the actions files are turned neutral.
768 Multiple <literal>filterfile</literal> lines are permitted.
771 The <link linkend="filter-file">filter files</link> contain content modification
772 rules that use <link linkend="regex">regular expressions</link>. These rules permit
773 powerful changes on the content of Web pages, and optionally the headers
774 as well, e.g., you could try to disable your favorite JavaScript annoyances,
775 re-write the actual displayed text, or just have some fun
776 playing buzzword bingo with web pages.
780 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
781 actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
782 to be defined in a filter file!
785 A pre-defined filter file called <filename>default.filter</filename> that contains
786 a number of useful filters for common problems is included in the distribution.
787 See the section on the <literal><link linkend="filter">filter</link></literal>
791 It is recommended to place any locally adapted filters into a separate
792 file, such as <filename>user.filter</filename>.
798 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
799 <![%config-file;[<literallayout>@@#filterfile user.filter # User customizations</literallayout>]]>
803 <!-- ~~~~~ New section ~~~~~ -->
804 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
808 <term>Specifies:</term>
816 <term>Type of value:</term>
818 <para>File name, relative to <literal>logdir</literal></para>
822 <term>Default value:</term>
824 <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
828 <term>Effect if unset:</term>
831 Logging is disabled unless <literal>--no-daemon</literal> mode is used.
839 removed per bug report 688728 02/20/03 HB
842 The windows version will additionally log to the console.
846 The logfile is where all logging and error messages are written. The level
847 of detail and number of messages are set with the <literal>debug</literal>
848 option (see below). The logfile can be useful for tracking down a problem with
849 <application>Privoxy</application> (e.g., it's not blocking an ad you
850 think it should block) and it can help you to monitor what your browser
854 Many users will never look at it, however, and it's a privacy risk
855 if third parties can get access to it. It is therefore disabled by
856 default in <application>Privoxy</application> 3.0.7 and later.
859 For troubleshooting purposes, you will have to explicitly enable it.
860 Please don't file any support requests without trying to reproduce
861 the problem with logging enabled first. Once you read the log messages,
862 you may even be able to solve the problem on your own.
865 Your logfile will grow indefinitely, and you will probably want to
866 periodically remove it. On Unix systems, you can do this with a cron job
867 (see <quote>man cron</quote>). For Red Hat based Linux distributions, a
868 <command>logrotate</command> script has been included.
871 No one cares enough about SuSE to build privoxy packages,
872 so most Privoxy users seem to use different platforms and
873 are thus unlikely to care about these instructions.
874 It's also questionable if they still work.
877 On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
878 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
879 the effect that cron.daily will automatically archive, gzip, and empty the
880 log, when it exceeds 1M size.
884 Any log files must be writable by whatever user <application>Privoxy</application>
885 is being run as (on Unix, default user id is <quote>privoxy</quote>).
891 <![%config-file;[<literallayout>@@#logfile logfile</literallayout>]]>
895 <!-- ~~~~~ New section ~~~~~ -->
896 <sect3 renderas="sect4" id="jarfile"><title>jarfile</title>
900 <term>Specifies:</term>
903 The file to store intercepted cookies in
908 <term>Type of value:</term>
910 <para>File name, relative to <literal>logdir</literal></para>
914 <term>Default value:</term>
916 <para><emphasis>Unset (commented out)</emphasis>. When activated: jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows).</para>
920 <term>Effect if unset:</term>
923 Intercepted cookies are not stored in a dedicated log file.
931 The jarfile may grow to ridiculous sizes over time.
934 If debug 8 (show header parsing) is enabled, cookies are
935 also written to the logfile with the rest of the headers.
936 Therefore this option isn't very useful and may be removed
937 in future releases. Please report to the developers if you
944 <![%config-file;[<literallayout>@@#jarfile jarfile</literallayout>]]>
948 <!-- ~~~~~ New section ~~~~~ -->
949 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
952 <term>Specifies:</term>
955 The name of the trust file to use
960 <term>Type of value:</term>
962 <para>File name, relative to <literal>confdir</literal></para>
966 <term>Default value:</term>
968 <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
972 <term>Effect if unset:</term>
975 The entire trust mechanism is disabled.
983 The trust mechanism is an experimental feature for building white-lists and should
984 be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
987 If you specify a trust file, <application>Privoxy</application> will only allow
988 access to sites that are specified in the trustfile. Sites can be listed
992 Prepending a <literal>~</literal> character limits access to this site
993 only (and any sub-paths within this site), e.g.
994 <literal>~www.example.com</literal> allows access to
995 <literal>~www.example.com/features/news.html</literal>, etc.
998 Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
999 prepending the name with a <literal>+</literal> character. The effect is that
1000 access to untrusted sites will be granted -- but only if a link from this
1001 trusted referrer was used to get there. The link target will then be added
1002 to the <quote>trustfile</quote> so that future, direct accesses will be
1003 granted. Sites added via this mechanism do not become trusted referrers
1004 themselves (i.e. they are added with a <literal>~</literal> designation).
1005 There is a limit of 512 such entries, after which new entries will not be
1009 If you use the <literal>+</literal> operator in the trust file, it may grow
1010 considerably over time.
1013 It is recommended that <application>Privoxy</application> be compiled with
1014 the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
1015 <literal> --disable-editor</literal> options, if this feature is to be
1019 Possible applications include limiting Internet access for children.
1026 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
1030 <!-- ~ End section ~ -->
1032 <!-- ~~~~~ New section ~~~~~ -->
1033 <sect2 id="debugging">
1034 <title>Debugging</title>
1037 These options are mainly useful when tracing a problem.
1038 Note that you might also want to invoke
1039 <application>Privoxy</application> with the <literal>--no-daemon</literal>
1040 command line option when debugging.
1043 <sect3 renderas="sect4" id="debug"><title>debug</title>
1047 <term>Specifies:</term>
1050 Key values that determine what information gets logged to the
1051 <link linkend="logfile"><emphasis>logfile</emphasis></link>.
1056 <term>Type of value:</term>
1058 <para>Integer values</para>
1062 <term>Default value:</term>
1064 <para>12289 (i.e.: URLs plus informational and warning messages)</para>
1068 <term>Effect if unset:</term>
1071 Nothing gets logged.
1079 The available debug levels are:
1083 debug 1 # show each GET/POST/CONNECT request
1084 debug 2 # show each connection status
1085 debug 4 # show I/O status
1086 debug 8 # show header parsing
1087 debug 16 # log all data written to the network into the logfile
1088 debug 32 # debug force feature
1089 debug 64 # debug regular expression filters
1090 debug 128 # debug redirects
1091 debug 256 # debug GIF de-animation
1092 debug 512 # Common Log Format
1093 debug 1024 # debug kill pop-ups
1094 debug 2048 # CGI user interface
1095 debug 4096 # Startup banner and warnings.
1096 debug 8192 # Non-fatal errors
1100 To select multiple debug levels, you can either add them or use
1101 multiple <literal>debug</literal> lines.
1104 A debug level of 1 is informative because it will show you each request
1105 as it happens. <emphasis>1, 4096 and 8192 are highly recommended</emphasis>
1106 so that you will notice when things go wrong. The other levels are probably
1107 only of interest if you are hunting down a specific problem. They can produce
1108 a hell of an output (especially 16).
1113 The reporting of <emphasis>fatal</emphasis> errors (i.e. ones which causes
1114 <application>Privoxy</application> to exit) is always on and cannot be disabled.
1116 It can be disabled by not logging at all (now the default)
1117 and I doubt that any user would care about not being able
1118 to disable it anyway.
1122 If you want to use CLF (Common Log Format), you should set <quote>debug
1123 512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1126 <application>Privoxy</application> has a hard-coded limit for the
1127 length of log messages. If it's reached, messages are logged truncated
1128 and marked with <quote>... [too long, truncated]</quote>.
1134 <![%config-file;[<literallayout>@@debug 1 # show each GET/POST/CONNECT request</literallayout>]]>
1135 <![%config-file;[<literallayout>@@debug 4096 # Startup banner and warnings</literallayout>]]>
1136 <![%config-file;[<literallayout>@@debug 8192 # Errors - *we highly recommended enabling this*</literallayout>]]>
1140 <!-- ~~~~~ New section ~~~~~ -->
1141 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1145 <term>Specifies:</term>
1148 Whether to run only one server thread.
1153 <term>Type of value:</term>
1155 <para><emphasis>None</emphasis></para>
1159 <term>Default value:</term>
1161 <para><emphasis>Unset</emphasis></para>
1165 <term>Effect if unset:</term>
1168 Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1169 serve multiple requests simultaneously.
1177 This option is only there for debugging purposes.
1178 <emphasis>It will drastically reduce performance.</emphasis>
1184 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1189 <!-- ~ End section ~ -->
1192 <!-- ~~~~~ New section ~~~~~ -->
1193 <sect2 id="access-control">
1194 <title>Access Control and Security</title>
1197 This section of the config file controls the security-relevant aspects
1198 of <application>Privoxy</application>'s configuration.
1202 <!-- ~~~~~ New section ~~~~~ -->
1203 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1207 <term>Specifies:</term>
1210 The IP address and TCP port on which <application>Privoxy</application> will
1211 listen for client requests.
1216 <term>Type of value:</term>
1218 <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1223 <term>Default value:</term>
1225 <para>127.0.0.1:8118</para>
1229 <term>Effect if unset:</term>
1232 Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1233 home users who run <application>Privoxy</application> on the same machine as
1242 You will need to configure your browser(s) to this proxy address and port.
1245 If you already have another service running on port 8118, or if you want to
1246 serve requests from other machines (e.g. on your local network) as well, you
1247 will need to override the default.
1250 If you leave out the IP address, <application>Privoxy</application> will
1251 bind to all interfaces (addresses) on your machine and may become reachable
1252 from the Internet. In that case, consider using <link
1253 linkend="acls">access control lists</link> (ACL's, see below), and/or
1257 If you open <application>Privoxy</application> to untrusted users, you will
1258 also want to make sure that the following actions are disabled: <literal><link
1259 linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1260 <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1265 <term>Example:</term>
1268 Suppose you are running <application>Privoxy</application> on
1269 a machine which has the address 192.168.0.1 on your local private network
1270 (192.168.0.0) and has another outside connection with a different address.
1271 You want it to serve requests from inside only:
1275 listen-address 192.168.0.1:8118
1282 <![%config-file;[<literallayout>@@listen-address 127.0.0.1:8118</literallayout>]]>
1286 <!-- ~~~~~ New section ~~~~~ -->
1287 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1291 <term>Specifies:</term>
1294 Initial state of "toggle" status
1299 <term>Type of value:</term>
1305 <term>Default value:</term>
1311 <term>Effect if unset:</term>
1314 Act as if toggled on
1322 If set to 0, <application>Privoxy</application> will start in
1323 <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1324 content-neutral proxy with both ad blocking and content filtering
1325 disabled. See <literal>enable-remote-toggle</literal> below.
1327 This is not really useful
1328 anymore, since toggling is much easier via <ulink
1329 url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1330 editing the <filename>conf</filename> file.
1332 Remote toggling is now disabled by default. fk 2007-11-07)
1336 The windows version will only display the toggle icon in the system tray
1337 if this option is present.
1343 <![%config-file;[<literallayout>@@toggle 1</literallayout>]]>
1347 <!-- ~~~~~ New section ~~~~~ -->
1348 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1351 <term>Specifies:</term>
1354 Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1355 feature</ulink> may be used
1360 <term>Type of value:</term>
1366 <term>Default value:</term>
1372 <term>Effect if unset:</term>
1375 The web-based toggle feature is disabled.
1383 When toggled off, <application>Privoxy</application> mostly acts like a normal,
1384 content-neutral proxy, i.e. doesn't block ads or filter content.
1387 Access to the toggle feature can <emphasis>not</emphasis> be
1388 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1389 so that everybody who can access <application>Privoxy</application> (see
1390 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1391 toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1392 for multi-user environments with untrusted users.
1395 Note that malicious client side code (e.g Java) is also
1396 capable of using this option.
1399 As a lot of <application>Privoxy</application> users don't read
1400 documentation, this feature is disabled by default.
1403 Note that you must have compiled <application>Privoxy</application> with
1404 support for this feature, otherwise this option has no effect.
1410 <![%config-file;[<literallayout>@@enable-remote-toggle 0</literallayout>]]>
1414 <!-- ~~~~~ New section ~~~~~ -->
1415 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1418 <term>Specifies:</term>
1421 Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1426 <term>Type of value:</term>
1432 <term>Default value:</term>
1438 <term>Effect if unset:</term>
1441 Privoxy ignores special HTTP headers.
1449 When toggled on, the client can change <application>Privoxy's</application>
1450 behaviour by setting special HTTP headers. Currently the only supported
1451 special header is <quote>X-Filter: No</quote>, to disable filtering for
1452 the ongoing request, even if it is enabled in one of the action files.
1455 This feature is disabled by default. If you are using
1456 <application>Privoxy</application> in a environment with trusted clients,
1457 you may enable this feature at your discretion. Note that malicious client
1458 side code (e.g Java) is also capable of using this feature.
1461 This option will be removed in future releases as it has been obsoleted
1462 by the more general header taggers.
1468 <![%config-file;[<literallayout>@@enable-remote-http-toggle 0</literallayout>]]>
1472 <!-- ~~~~~ New section ~~~~~ -->
1473 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1476 <term>Specifies:</term>
1479 Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1480 file editor</ulink> may be used
1485 <term>Type of value:</term>
1491 <term>Default value:</term>
1497 <term>Effect if unset:</term>
1500 The web-based actions file editor is disabled.
1508 Access to the editor can <emphasis>not</emphasis> be
1509 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1510 so that everybody who can access <application>Privoxy</application> (see
1511 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1512 modify its configuration for all users.
1515 This option is <emphasis>not recommended</emphasis> for environments
1516 with untrusted users and as a lot of <application>Privoxy</application>
1517 users don't read documentation, this feature is disabled by default.
1520 Note that malicious client side code (e.g Java) is also
1521 capable of using the actions editor and you shouldn't enable
1522 this options unless you understand the consequences and are
1523 sure your browser is configured correctly.
1526 Note that you must have compiled <application>Privoxy</application> with
1527 support for this feature, otherwise this option has no effect.
1533 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1537 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1540 <term>Specifies:</term>
1543 Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1548 <term>Type of value:</term>
1551 <replaceable>0 or 1</replaceable>
1556 <term>Default value:</term>
1558 <para><emphasis>0</emphasis></para>
1562 <term>Effect if unset:</term>
1565 Blocks are not enforced.
1573 <application>Privoxy</application> is mainly used to block and filter
1574 requests as a service to the user, for example to block ads and other
1575 junk that clogs the pipes. <application>Privoxy's</application> configuration
1576 isn't perfect and sometimes innocent pages are blocked. In this situation it
1577 makes sense to allow the user to enforce the request and have
1578 <application>Privoxy</application> ignore the block.
1581 In the default configuration <application>Privoxy's</application>
1582 <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1583 link to adds a special string (the force prefix) to the request URL.
1584 If that link is used, <application>Privoxy</application> will
1585 detect the force prefix, remove it again and let the request pass.
1588 Of course <application>Privoxy</application> can also be used to enforce
1589 a network policy. In that case the user obviously should not be able to
1590 bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1591 option is for. If it's enabled, <application>Privoxy</application> hides
1592 the <quote>go there anyway</quote> link. If the user adds the force
1593 prefix by hand, it will not be accepted and the circumvention attempt
1599 <term>Examples:</term>
1607 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1611 <!-- ~~~~~ New section ~~~~~ -->
1612 <sect3 renderas="sect4" id="acls"><title>
1613 ACLs: permit-access and deny-access</title>
1614 <anchor id="permit-access">
1615 <anchor id="deny-access">
1619 <term>Specifies:</term>
1622 Who can access what.
1627 <term>Type of value:</term>
1630 <replaceable class="parameter">src_addr</replaceable>[/<replaceable class="parameter">src_masklen</replaceable>]
1631 [<replaceable class="parameter">dst_addr</replaceable>[/<replaceable class="parameter">dst_masklen</replaceable>]]
1634 Where <replaceable class="parameter">src_addr</replaceable> and
1635 <replaceable class="parameter">dst_addr</replaceable> are IP addresses in dotted decimal notation or valid
1636 DNS names, and <replaceable class="parameter">src_masklen</replaceable> and
1637 <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1638 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1639 destination part are optional.
1644 <term>Default value:</term>
1646 <para><emphasis>Unset</emphasis></para>
1650 <term>Effect if unset:</term>
1653 Don't restrict access further than implied by <literal>listen-address</literal>
1661 Access controls are included at the request of ISPs and systems
1662 administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1663 For a typical home user, it will normally suffice to ensure that
1664 <application>Privoxy</application> only listens on the localhost
1665 (127.0.0.1) or internal (home) network address by means of the
1666 <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1670 Please see the warnings in the FAQ that <application>Privoxy</application>
1671 is not intended to be a substitute for a firewall or to encourage anyone
1672 to defer addressing basic security weaknesses.
1675 Multiple ACL lines are OK.
1676 If any ACLs are specified, <application>Privoxy</application> only talks
1677 to IP addresses that match at least one <literal>permit-access</literal> line
1678 and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1679 last match wins, with the default being <literal>deny-access</literal>.
1682 If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1683 for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1684 that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1685 of the ultimate target. This is necessary because it may be impossible for the local
1686 <application>Privoxy</application> to determine the IP address of the
1687 ultimate target (that's often what gateways are used for).
1690 You should prefer using IP addresses over DNS names, because the address lookups take
1691 time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1692 like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1693 IP addresses, only the first one is used.
1696 Denying access to particular sites by ACL may have undesired side effects
1697 if the site in question is hosted on a machine which also hosts other sites
1703 <term>Examples:</term>
1706 Explicitly define the default behavior if no ACL and
1707 <literal>listen-address</literal> are set: <quote>localhost</quote>
1708 is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1709 <emphasis>all</emphasis> destination addresses are OK:
1713 permit-access localhost
1717 Allow any host on the same class C subnet as www.privoxy.org access to
1718 nothing but www.example.com (or other domains hosted on the same system):
1722 permit-access www.privoxy.org/24 www.example.com/32
1726 Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1727 with the exception that 192.168.45.73 may not access the IP address behind
1728 www.dirty-stuff.example.com:
1732 permit-access 192.168.45.64/26
1733 deny-access 192.168.45.73 www.dirty-stuff.example.com
1742 <!-- ~~~~~ New section ~~~~~ -->
1743 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1747 <term>Specifies:</term>
1750 Maximum size of the buffer for content filtering.
1755 <term>Type of value:</term>
1757 <para>Size in Kbytes</para>
1761 <term>Default value:</term>
1767 <term>Effect if unset:</term>
1770 Use a 4MB (4096 KB) limit.
1778 For content filtering, i.e. the <literal>+filter</literal> and
1779 <literal>+deanimate-gif</literal> actions, it is necessary that
1780 <application>Privoxy</application> buffers the entire document body.
1781 This can be potentially dangerous, since a server could just keep sending
1782 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1786 When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1787 flushed to the client unfiltered and no further attempt to
1788 filter the rest of the document is made. Remember that there may be multiple threads
1789 running, which might require up to <literal>buffer-limit</literal> Kbytes
1790 <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1797 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1802 <!-- ~ End section ~ -->
1805 <!-- ~~~~~ New section ~~~~~ -->
1807 <sect2 id="forwarding">
1808 <title>Forwarding</title>
1811 This feature allows routing of HTTP requests through a chain of
1815 Forwarding can be used to chain Privoxy with a caching proxy to speed
1816 up browsing. Using a parent proxy may also be necessary if the machine
1817 that <application>Privoxy</application> runs on has no direct Internet access.
1820 Note that parent proxies can severely decrease your privacy level.
1821 For example a parent proxy could add your IP address to the request
1822 headers and if it's a caching proxy it may add the <quote>Etag</quote>
1823 header to revalidation requests again, even though you configured Privoxy
1824 to remove it. It may also ignore Privoxy's header time randomization and use the
1825 original values which could be used by the server as cookie replacement
1826 to track your steps between visits.
1830 Also specified here are SOCKS proxies. <application>Privoxy</application>
1831 supports the SOCKS 4 and SOCKS 4A protocols.
1834 <sect3 renderas="sect4" id="forward"><title>forward</title>
1837 <term>Specifies:</term>
1840 To which parent HTTP proxy specific requests should be routed.
1845 <term>Type of value:</term>
1848 <replaceable class="parameter">target_pattern</replaceable>
1849 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1852 where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1853 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1854 denote <quote>all URLs</quote>.
1855 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1856 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1857 optionally followed by its listening port (default: 8080).
1858 Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1863 <term>Default value:</term>
1865 <para><emphasis>Unset</emphasis></para>
1869 <term>Effect if unset:</term>
1872 Don't use parent HTTP proxies.
1880 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1881 forwarded to another HTTP proxy but are made directly to the web servers.
1884 Multiple lines are OK, they are checked in sequence, and the last match wins.
1889 <term>Examples:</term>
1892 Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
1896 forward / parent-proxy.example.org:8080
1901 Everything goes to our example ISP's caching proxy, except for requests
1902 to that ISP's sites:
1906 forward / caching-proxy.isp.example.net:8000
1907 forward .isp.example.net .
1916 <!-- ~~~~~ New section ~~~~~ -->
1917 <sect3 renderas="sect4" id="socks"><title>
1918 forward-socks4 and forward-socks4a</title>
1919 <anchor id="forward-socks4">
1920 <anchor id="forward-socks4a">
1924 <term>Specifies:</term>
1927 Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
1932 <term>Type of value:</term>
1935 <replaceable class="parameter">target_pattern</replaceable>
1936 <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
1937 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1940 where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1941 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1942 denote <quote>all URLs</quote>.
1943 <replaceable class="parameter">http_parent</replaceable> and <replaceable class="parameter">socks_proxy</replaceable>
1944 are IP addresses in dotted decimal notation or valid DNS names (<replaceable class="parameter">http_parent</replaceable>
1945 may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
1946 <replaceable class="parameter">port</replaceable> parameters are TCP ports, i.e. integer values from 1 to 64535
1951 <term>Default value:</term>
1953 <para><emphasis>Unset</emphasis></para>
1957 <term>Effect if unset:</term>
1960 Don't use SOCKS proxies.
1968 Multiple lines are OK, they are checked in sequence, and the last match wins.
1971 The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
1972 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
1973 server, while in SOCKS 4 it happens locally.
1976 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1977 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
1983 <term>Examples:</term>
1986 From the company example.com, direct connections are made to all
1987 <quote>internal</quote> domains, but everything outbound goes through
1988 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
1993 forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
1994 forward .example.com .
1998 A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2002 forward-socks4 / socks-gw.example.com:1080 .
2007 To chain Privoxy and Tor, both running on the same system, you would use
2012 forward-socks4a / 127.0.0.1:9050 .
2017 The public <application>Tor</application> network can't be used to
2018 reach your local network, if you need to access local servers you
2019 therefore might want to make some exceptions:
2023 forward 192.168.*.*/ .
2025 forward 127.*.*.*/ .
2029 Unencrypted connections to systems in these address ranges will
2030 be as (un)secure as the local network is, but the alternative is that you
2031 can't reach the local network through <application>Privoxy</application>
2032 at all. Of course this may actually be desired and there is no reason
2033 to make these exceptions if you aren't sure you need them.
2036 If you also want to be able to reach servers in your local network by
2037 using their names, you will need additional exceptions that look like
2042 forward localhost/ .
2051 <![%user-man;[ <!-- not included in config due to length -->
2052 <!-- ~~~~~ New section ~~~~~ -->
2053 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2056 If you have links to multiple ISPs that provide various special content
2057 only to their subscribers, you can configure multiple <application>Privoxies</application>
2058 which have connections to the respective ISPs to act as forwarders to each other, so that
2059 <emphasis>your</emphasis> users can see the internal content of all ISPs.
2063 Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2064 isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2065 configuration can look like this:
2075 forward .isp-b.example.net host-b:8118
2086 forward .isp-a.example.org host-a:8118
2091 Now, your users can set their browser's proxy to use either
2092 host-a or host-b and be able to browse the internal content
2093 of both isp-a and isp-b.
2097 If you intend to chain <application>Privoxy</application> and
2098 <application>squid</application> locally, then chaining as
2099 <literal>browser -> squid -> privoxy</literal> is the recommended way.
2103 Assuming that <application>Privoxy</application> and <application>squid</application>
2104 run on the same box, your <application>squid</application> configuration could then look like this:
2109 # Define Privoxy as parent proxy (without ICP)
2110 cache_peer 127.0.0.1 parent 8118 7 no-query
2112 # Define ACL for protocol FTP
2115 # Do not forward FTP requests to Privoxy
2116 always_direct allow ftp
2118 # Forward all the rest to Privoxy
2119 never_direct allow all</screen>
2123 You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2124 Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2128 You could just as well decide to only forward requests you suspect
2129 of leading to Windows executables through a virus-scanning parent proxy,
2130 say, on <literal>antivir.example.com</literal>, port 8010:
2136 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
2142 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2145 <term>Specifies:</term>
2148 How often Privoxy retries if a forwarded connection request fails.
2153 <term>Type of value:</term>
2156 <replaceable class="parameter">Number of retries.</replaceable>
2161 <term>Default value:</term>
2163 <para><emphasis>0</emphasis></para>
2167 <term>Effect if unset:</term>
2170 Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2178 <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2179 for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2180 The connection might have failed because of a DNS timeout in which case a retry makes sense,
2181 but it might also have failed because the server doesn't exist or isn't reachable. In this
2182 case the retry will just delay the appearance of Privoxy's error message.
2185 Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2186 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2189 Only use this option, if you are getting lots of forwarding-related error messages
2190 that go away when you try again manually. Start with a small value and check Privoxy's
2191 logfile from time to time, to see how many retries are usually needed.
2196 <term>Examples:</term>
2199 forwarded-connect-retries 1
2204 <![%config-file;[<literallayout>@@forwarded-connect-retries 0</literallayout>]]>
2207 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2210 <term>Specifies:</term>
2213 Whether intercepted requests should be treated as valid.
2218 <term>Type of value:</term>
2221 <replaceable>0 or 1</replaceable>
2226 <term>Default value:</term>
2228 <para><emphasis>0</emphasis></para>
2232 <term>Effect if unset:</term>
2235 Only proxy requests are accepted, intercepted requests are treated as invalid.
2243 If you don't trust your clients and want to force them
2244 to use <application>Privoxy</application>, enable this
2245 option and configure your packet filter to redirect outgoing
2246 HTTP connections into <application>Privoxy</application>.
2249 Make sure that <application>Privoxy's</application> own requests
2250 aren't redirected as well. Additionally take care that
2251 <application>Privoxy</application> can't intentionally connect
2252 to itself, otherwise you could run into redirection loops if
2253 <application>Privoxy's</application> listening port is reachable
2254 by the outside or an attacker has access to the pages you visit.
2259 <term>Examples:</term>
2262 accept-intercepted-requests 1
2267 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2270 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2273 <term>Specifies:</term>
2276 Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2281 <term>Type of value:</term>
2284 <replaceable>0 or 1</replaceable>
2289 <term>Default value:</term>
2291 <para><emphasis>0</emphasis></para>
2295 <term>Effect if unset:</term>
2298 <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2306 By default <application>Privoxy</application> ignores block or redirect actions
2307 for its CGI pages. Intercepting these requests can be useful in multi-user
2308 setups to implement fine-grained access control, but it can also render the complete
2309 web interface useless and make debugging problems painful if done without care.
2312 Don't enable this option unless you're sure that you really need it.
2317 <term>Examples:</term>
2320 allow-cgi-request-crunching 1
2325 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2328 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2331 <term>Specifies:</term>
2334 Whether the CGI interface should stay compatible with broken HTTP clients.
2339 <term>Type of value:</term>
2342 <replaceable>0 or 1</replaceable>
2347 <term>Default value:</term>
2349 <para><emphasis>0</emphasis></para>
2353 <term>Effect if unset:</term>
2356 The CGI form generate long GET URLs.
2364 <application>Privoxy's</application> CGI forms can lead to
2365 rather long URLs. This isn't a problem as far as the HTTP
2366 standard is concerned, but it can confuse clients with arbitrary
2367 URL length limitations.
2370 Enabling split-large-forms causes <application>Privoxy</application>
2371 to divide big forms into smaller ones to keep the URL length down.
2372 It makes editing a lot less convenient and you can no longer
2373 submit all changes at once, but at least it works around this
2377 If you don't notice any editing problems, there is no reason
2378 to enable this option, but if one of the submit buttons appears
2379 to be broken, you should give it a try.
2384 <term>Examples:</term>
2392 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2397 <!-- ~ End section ~ -->
2400 <!-- ~~~~~ New section ~~~~~ -->
2402 <sect2 id="windows-gui">
2403 <title>Windows GUI Options</title>
2405 <application>Privoxy</application> has a number of options specific to the
2406 Windows GUI interface:
2409 <anchor id="activity-animation">
2410 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2412 If <quote>activity-animation</quote> is set to 1, the
2413 <application>Privoxy</application> icon will animate when
2414 <quote>Privoxy</quote> is active. To turn off, set to 0.
2417 <![%config-file;[<literallayout>@@#activity-animation 1</literallayout>]]>
2423 <emphasis>activity-animation 1</emphasis>
2430 <anchor id="log-messages">
2431 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2433 If <quote>log-messages</quote> is set to 1,
2434 <application>Privoxy</application> will log messages to the console
2438 <![%config-file;[<literallayout>@@#log-messages 1</literallayout>]]>
2444 <emphasis>log-messages 1</emphasis>
2451 <anchor id="log-buffer-size">
2452 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2454 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
2455 i.e. the amount of memory used for the log messages displayed in the
2456 console window, will be limited to <quote>log-max-lines</quote> (see below).
2460 Warning: Setting this to 0 will result in the buffer to grow infinitely and
2461 eat up all your memory!
2464 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
2470 <emphasis>log-buffer-size 1</emphasis>
2477 <anchor id="log-max-lines">
2478 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2480 <application>log-max-lines</application> is the maximum number of lines held
2481 in the log buffer. See above.
2484 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
2490 <emphasis>log-max-lines 200</emphasis>
2497 <anchor id="log-highlight-messages">
2498 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2500 If <quote>log-highlight-messages</quote> is set to 1,
2501 <application>Privoxy</application> will highlight portions of the log
2502 messages with a bold-faced font:
2505 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
2511 <emphasis>log-highlight-messages 1</emphasis>
2518 <anchor id="log-font-name">
2519 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2521 The font used in the console window:
2524 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
2530 <emphasis>log-font-name Comic Sans MS</emphasis>
2537 <anchor id="log-font-size">
2538 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2540 Font size used in the console window:
2543 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
2549 <emphasis>log-font-size 8</emphasis>
2556 <anchor id="show-on-task-bar">
2557 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2559 <quote>show-on-task-bar</quote> controls whether or not
2560 <application>Privoxy</application> will appear as a button on the Task bar
2564 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
2570 <emphasis>show-on-task-bar 0</emphasis>
2577 <anchor id="close-button-minimizes">
2578 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2580 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
2581 button will minimize <application>Privoxy</application> instead of closing
2582 the program (close with the exit option on the File menu).
2585 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
2591 <emphasis>close-button-minimizes 1</emphasis>
2598 <anchor id="hide-console">
2599 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2601 The <quote>hide-console</quote> option is specific to the MS-Win console
2602 version of <application>Privoxy</application>. If this option is used,
2603 <application>Privoxy</application> will disconnect from and hide the
2607 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
2613 #<emphasis>hide-console</emphasis>
2623 <!-- end config content common to both outputs -->
2626 <!-- These are dummy anchors to keep the processor quiet -->
2627 <!-- when building config-file only (ie. they are used in u-m only) -->
2630 <anchor id="filter">
2631 <anchor id="filter-file">
2633 <anchor id="actions-file">
2634 <anchor id="af-patterns">
2638 <!-- eof p-config.sgml -->