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.44 2009/04/17 11:27:49 fabiankeil Exp $
8 Copyright (C) 2001-2009 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.44 2009/04/17 11:27:49 fabiankeil Exp $
101 Copyright (C) 2001-2009 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><emphasis>Unset</emphasis></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 the <filename>logfile</filename> is located).
612 <term>Type of value:</term>
614 <para>Path name</para>
618 <term>Default value:</term>
620 <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
624 <term>Effect if unset:</term>
626 <para><emphasis>Mandatory</emphasis></para>
633 No trailing <quote><literal>/</literal></quote>, please.
639 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
643 <!-- ~~~~~ New section ~~~~~ -->
644 <sect3 renderas="sect4" id="actionsfile"><title>
647 <anchor id="default.action">
648 <anchor id="standard.action">
649 <anchor id="user.action">
650 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
653 <term>Specifies:</term>
656 The <link linkend="actions-file">actions file(s)</link> to use
661 <term>Type of value:</term>
663 <para>Complete file name, relative to <literal>confdir</literal></para>
667 <term>Default values:</term>
671 <msgtext><literallayout> match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout></msgtext>
674 <msgtext><literallayout> default.action # Main actions file</literallayout></msgtext>
677 <msgtext><literallayout> user.action # User customizations</literallayout></msgtext>
683 <term>Effect if unset:</term>
686 No actions are taken at all. More or less neutral proxying.
694 Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
697 The default values are <filename>default.action</filename>, which is the
698 <quote>main</quote> actions file maintained by the developers, and
699 <filename>user.action</filename>, where you can make your personal additions.
702 Actions files contain all the per site and per URL configuration for
703 ad blocking, cookie management, privacy considerations, etc.
704 There is no point in using <application>Privoxy</application> without at
705 least one actions file.
708 Note that since Privoxy 3.0.7, the complete filename, including the <quote>.action</quote>
709 extension has to be specified. The syntax change was necessary to be consistent
710 with the other file options and to allow previously forbidden characters.
716 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
717 <!-- html -> text conversion, blah -->
718 <![%config-file;[<literallayout>@@actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout>]]>
719 <![%config-file;[<literallayout>@@actionsfile default.action # Main actions file</literallayout>]]>
721 XXX: Like user.filter, user.action should probably be commented out
722 by default as not all packages install it into the default directory.
725 <![%config-file;[<literallayout>@@actionsfile user.action # User customizations</literallayout>]]>
728 <!-- ~~~~~ New section ~~~~~ -->
729 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
730 <anchor id="default.filter">
733 <term>Specifies:</term>
736 The <link linkend="filter-file">filter file(s)</link> to use
741 <term>Type of value:</term>
743 <para>File name, relative to <literal>confdir</literal></para>
747 <term>Default value:</term>
749 <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
753 <term>Effect if unset:</term>
756 No textual content filtering takes place, i.e. all
757 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
758 actions in the actions files are turned neutral.
766 Multiple <literal>filterfile</literal> lines are permitted.
769 The <link linkend="filter-file">filter files</link> contain content modification
770 rules that use <link linkend="regex">regular expressions</link>. These rules permit
771 powerful changes on the content of Web pages, and optionally the headers
772 as well, e.g., you could try to disable your favorite JavaScript annoyances,
773 re-write the actual displayed text, or just have some fun
774 playing buzzword bingo with web pages.
778 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
779 actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
780 to be defined in a filter file!
783 A pre-defined filter file called <filename>default.filter</filename> that contains
784 a number of useful filters for common problems is included in the distribution.
785 See the section on the <literal><link linkend="filter">filter</link></literal>
789 It is recommended to place any locally adapted filters into a separate
790 file, such as <filename>user.filter</filename>.
796 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
797 <![%config-file;[<literallayout>@@#filterfile user.filter # User customizations</literallayout>]]>
801 <!-- ~~~~~ New section ~~~~~ -->
802 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
806 <term>Specifies:</term>
814 <term>Type of value:</term>
816 <para>File name, relative to <literal>logdir</literal></para>
820 <term>Default value:</term>
822 <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
826 <term>Effect if unset:</term>
829 No logfile is written.
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) and it can help you to monitor what your browser
845 Depending on the debug options below, the logfile may be a privacy risk
846 if third parties can get access to it. As most users will never look
847 at it, <application>Privoxy</application> 3.0.7 and later only log fatal
851 For most troubleshooting purposes, you will have to change that,
852 please refer to the debugging section for details.
855 Your logfile will grow indefinitely, and you will probably want to
856 periodically remove it. On Unix systems, you can do this with a cron job
857 (see <quote>man cron</quote>). For Red Hat based Linux distributions, a
858 <command>logrotate</command> script has been included.
861 Any log files must be writable by whatever user <application>Privoxy</application>
862 is being run as (on Unix, default user id is <quote>privoxy</quote>).
868 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
872 <!-- ~~~~~ New section ~~~~~ -->
873 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
876 <term>Specifies:</term>
879 The name of the trust file to use
884 <term>Type of value:</term>
886 <para>File name, relative to <literal>confdir</literal></para>
890 <term>Default value:</term>
892 <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
896 <term>Effect if unset:</term>
899 The entire trust mechanism is disabled.
907 The trust mechanism is an experimental feature for building white-lists and should
908 be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
911 If you specify a trust file, <application>Privoxy</application> will only allow
912 access to sites that are specified in the trustfile. Sites can be listed
916 Prepending a <literal>~</literal> character limits access to this site
917 only (and any sub-paths within this site), e.g.
918 <literal>~www.example.com</literal> allows access to
919 <literal>~www.example.com/features/news.html</literal>, etc.
922 Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
923 prepending the name with a <literal>+</literal> character. The effect is that
924 access to untrusted sites will be granted -- but only if a link from this
925 trusted referrer was used to get there. The link target will then be added
926 to the <quote>trustfile</quote> so that future, direct accesses will be
927 granted. Sites added via this mechanism do not become trusted referrers
928 themselves (i.e. they are added with a <literal>~</literal> designation).
929 There is a limit of 512 such entries, after which new entries will not be
933 If you use the <literal>+</literal> operator in the trust file, it may grow
934 considerably over time.
937 It is recommended that <application>Privoxy</application> be compiled with
938 the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
939 <literal> --disable-editor</literal> options, if this feature is to be
943 Possible applications include limiting Internet access for children.
950 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
954 <!-- ~ End section ~ -->
956 <!-- ~~~~~ New section ~~~~~ -->
957 <sect2 id="debugging">
958 <title>Debugging</title>
961 These options are mainly useful when tracing a problem.
962 Note that you might also want to invoke
963 <application>Privoxy</application> with the <literal>--no-daemon</literal>
964 command line option when debugging.
967 <sect3 renderas="sect4" id="debug"><title>debug</title>
971 <term>Specifies:</term>
974 Key values that determine what information gets logged.
979 <term>Type of value:</term>
981 <para>Integer values</para>
985 <term>Default value:</term>
987 <para>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</para>
991 <term>Effect if unset:</term>
994 Default value is used (see above).
1002 The available debug levels are:
1006 debug 1 # Log the destination for each request &my-app; let through. See also debug 1024.
1007 debug 2 # show each connection status
1008 debug 4 # show I/O status
1009 debug 8 # show header parsing
1010 debug 16 # log all data written to the network into the logfile
1011 debug 32 # debug force feature
1012 debug 64 # debug regular expression filters
1013 debug 128 # debug redirects
1014 debug 256 # debug GIF de-animation
1015 debug 512 # Common Log Format
1016 debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
1017 debug 2048 # CGI user interface
1018 debug 4096 # Startup banner and warnings.
1019 debug 8192 # Non-fatal errors
1023 To select multiple debug levels, you can either add them or use
1024 multiple <literal>debug</literal> lines.
1027 A debug level of 1 is informative because it will show you each request
1028 as it happens. <emphasis>1, 1024, 4096 and 8192 are recommended</emphasis>
1029 so that you will notice when things go wrong. The other levels are
1030 probably only of interest if you are hunting down a specific problem.
1031 They can produce a hell of an output (especially 16).
1035 &my-app; used to ship with the debug levels recommended above enabled by
1036 default, but due to privacy concerns 3.0.7 and later are configured to
1037 only log fatal errors.
1040 If you are used to the more verbose settings, simply enable the debug lines
1044 If you want to use pure CLF (Common Log Format), you should set <quote>debug
1045 512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1048 <application>Privoxy</application> has a hard-coded limit for the
1049 length of log messages. If it's reached, messages are logged truncated
1050 and marked with <quote>... [too long, truncated]</quote>.
1053 Please don't file any support requests without trying to reproduce
1054 the problem with increased debug level first. Once you read the log
1055 messages, you may even be able to solve the problem on your own.
1061 <![%config-file;[<literallayout>@@#debug 1 # Log the destination for each request &my-app; let through.</literallayout>]]>
1062 <![%config-file;[<literallayout>@@#debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
1063 <![%config-file;[<literallayout>@@#debug 4096 # Startup banner and warnings</literallayout>]]>
1064 <![%config-file;[<literallayout>@@#debug 8192 # Non-fatal errors</literallayout>]]>
1068 <!-- ~~~~~ New section ~~~~~ -->
1069 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1073 <term>Specifies:</term>
1076 Whether to run only one server thread.
1081 <term>Type of value:</term>
1083 <para><emphasis>None</emphasis></para>
1087 <term>Default value:</term>
1089 <para><emphasis>Unset</emphasis></para>
1093 <term>Effect if unset:</term>
1096 Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1097 serve multiple requests simultaneously.
1105 This option is only there for debugging purposes.
1106 <emphasis>It will drastically reduce performance.</emphasis>
1112 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1115 <!-- ~~~~~ New section ~~~~~ -->
1116 <sect3 renderas="sect4" id="hostname"><title>hostname</title>
1120 <term>Specifies:</term>
1123 The hostname shown on the CGI pages.
1128 <term>Type of value:</term>
1134 <term>Default value:</term>
1136 <para><emphasis>Unset</emphasis></para>
1140 <term>Effect if unset:</term>
1143 The hostname provided by the operating system is used.
1151 On some misconfigured systems resolving the hostname fails or
1152 takes too much time and slows Privoxy down. Setting a fixed hostname
1153 works around the problem.
1156 In other circumstances it might be desirable to show a hostname
1157 other than the one returned by the operating system. For example
1158 if the system has several different hostnames and you don't want
1159 to use the first one.
1162 Note that Privoxy does not validate the specified hostname value.
1168 <![%config-file;[<literallayout>@@#hostname hostname.example.org</literallayout>]]>
1173 <!-- ~ End section ~ -->
1176 <!-- ~~~~~ New section ~~~~~ -->
1177 <sect2 id="access-control">
1178 <title>Access Control and Security</title>
1181 This section of the config file controls the security-relevant aspects
1182 of <application>Privoxy</application>'s configuration.
1186 <!-- ~~~~~ New section ~~~~~ -->
1187 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1191 <term>Specifies:</term>
1194 The IP address and TCP port on which <application>Privoxy</application> will
1195 listen for client requests.
1200 <term>Type of value:</term>
1202 <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1207 <term>Default value:</term>
1209 <para>127.0.0.1:8118</para>
1213 <term>Effect if unset:</term>
1216 Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable and
1217 recommended for home users who run <application>Privoxy</application> on
1218 the same machine as their browser.
1226 You will need to configure your browser(s) to this proxy address and port.
1229 If you already have another service running on port 8118, or if you want to
1230 serve requests from other machines (e.g. on your local network) as well, you
1231 will need to override the default.
1234 IPv6 addresses containing colons have to be quoted by brackets.
1237 If you leave out the IP address, <application>Privoxy</application> will
1238 bind to all interfaces (addresses) on your machine and may become reachable
1239 from the Internet. In that case, consider using <link
1240 linkend="acls">access control lists</link> (ACL's, see below), and/or
1244 If you open <application>Privoxy</application> to untrusted users, you will
1245 also want to make sure that the following actions are disabled: <literal><link
1246 linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1247 <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1252 <term>Example:</term>
1255 Suppose you are running <application>Privoxy</application> on
1256 a machine which has the address 192.168.0.1 on your local private network
1257 (192.168.0.0) and has another outside connection with a different address.
1258 You want it to serve requests from inside only:
1262 listen-address 192.168.0.1:8118
1266 Suppose you are running <application>Privoxy</application> on an
1267 IPv6-capable machine and you want it to listen on the IPv6 address
1268 of the loopback device:
1272 listen-address [::1]:8118
1279 <![%config-file;[<literallayout>@@listen-address 127.0.0.1:8118</literallayout>]]>
1283 <!-- ~~~~~ New section ~~~~~ -->
1284 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1288 <term>Specifies:</term>
1291 Initial state of "toggle" status
1296 <term>Type of value:</term>
1302 <term>Default value:</term>
1308 <term>Effect if unset:</term>
1311 Act as if toggled on
1319 If set to 0, <application>Privoxy</application> will start in
1320 <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1321 content-neutral proxy with both ad blocking and content filtering
1322 disabled. See <literal>enable-remote-toggle</literal> below.
1324 This is not really useful
1325 anymore, since toggling is much easier via <ulink
1326 url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1327 editing the <filename>conf</filename> file.
1329 Remote toggling is now disabled by default. fk 2007-11-07)
1333 The windows version will only display the toggle icon in the system tray
1334 if this option is present.
1340 <![%config-file;[<literallayout>@@toggle 1</literallayout>]]>
1344 <!-- ~~~~~ New section ~~~~~ -->
1345 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1348 <term>Specifies:</term>
1351 Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1352 feature</ulink> may be used
1357 <term>Type of value:</term>
1363 <term>Default value:</term>
1369 <term>Effect if unset:</term>
1372 The web-based toggle feature is disabled.
1380 When toggled off, <application>Privoxy</application> mostly acts like a normal,
1381 content-neutral proxy, i.e. doesn't block ads or filter content.
1384 Access to the toggle feature can <emphasis>not</emphasis> be
1385 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1386 so that everybody who can access <application>Privoxy</application> (see
1387 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1388 toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1389 for multi-user environments with untrusted users.
1392 Note that malicious client side code (e.g Java) is also
1393 capable of using this option.
1396 As a lot of <application>Privoxy</application> users don't read
1397 documentation, this feature is disabled by default.
1400 Note that you must have compiled <application>Privoxy</application> with
1401 support for this feature, otherwise this option has no effect.
1407 <![%config-file;[<literallayout>@@enable-remote-toggle 0</literallayout>]]>
1411 <!-- ~~~~~ New section ~~~~~ -->
1412 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1415 <term>Specifies:</term>
1418 Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1423 <term>Type of value:</term>
1429 <term>Default value:</term>
1435 <term>Effect if unset:</term>
1438 Privoxy ignores special HTTP headers.
1446 When toggled on, the client can change <application>Privoxy's</application>
1447 behaviour by setting special HTTP headers. Currently the only supported
1448 special header is <quote>X-Filter: No</quote>, to disable filtering for
1449 the ongoing request, even if it is enabled in one of the action files.
1452 This feature is disabled by default. If you are using
1453 <application>Privoxy</application> in a environment with trusted clients,
1454 you may enable this feature at your discretion. Note that malicious client
1455 side code (e.g Java) is also capable of using this feature.
1458 This option will be removed in future releases as it has been obsoleted
1459 by the more general header taggers.
1465 <![%config-file;[<literallayout>@@enable-remote-http-toggle 0</literallayout>]]>
1469 <!-- ~~~~~ New section ~~~~~ -->
1470 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1473 <term>Specifies:</term>
1476 Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1477 file editor</ulink> may be used
1482 <term>Type of value:</term>
1488 <term>Default value:</term>
1494 <term>Effect if unset:</term>
1497 The web-based actions file editor is disabled.
1505 Access to the editor can <emphasis>not</emphasis> be
1506 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1507 so that everybody who can access <application>Privoxy</application> (see
1508 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1509 modify its configuration for all users.
1512 This option is <emphasis>not recommended</emphasis> for environments
1513 with untrusted users and as a lot of <application>Privoxy</application>
1514 users don't read documentation, this feature is disabled by default.
1517 Note that malicious client side code (e.g Java) is also
1518 capable of using the actions editor and you shouldn't enable
1519 this options unless you understand the consequences and are
1520 sure your browser is configured correctly.
1523 Note that you must have compiled <application>Privoxy</application> with
1524 support for this feature, otherwise this option has no effect.
1530 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1534 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1537 <term>Specifies:</term>
1540 Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1545 <term>Type of value:</term>
1548 <replaceable>0 or 1</replaceable>
1553 <term>Default value:</term>
1555 <para><emphasis>0</emphasis></para>
1559 <term>Effect if unset:</term>
1562 Blocks are not enforced.
1570 <application>Privoxy</application> is mainly used to block and filter
1571 requests as a service to the user, for example to block ads and other
1572 junk that clogs the pipes. <application>Privoxy's</application> configuration
1573 isn't perfect and sometimes innocent pages are blocked. In this situation it
1574 makes sense to allow the user to enforce the request and have
1575 <application>Privoxy</application> ignore the block.
1578 In the default configuration <application>Privoxy's</application>
1579 <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1580 link to adds a special string (the force prefix) to the request URL.
1581 If that link is used, <application>Privoxy</application> will
1582 detect the force prefix, remove it again and let the request pass.
1585 Of course <application>Privoxy</application> can also be used to enforce
1586 a network policy. In that case the user obviously should not be able to
1587 bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1588 option is for. If it's enabled, <application>Privoxy</application> hides
1589 the <quote>go there anyway</quote> link. If the user adds the force
1590 prefix by hand, it will not be accepted and the circumvention attempt
1596 <term>Examples:</term>
1604 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1608 <!-- ~~~~~ New section ~~~~~ -->
1609 <sect3 renderas="sect4" id="acls"><title>
1610 ACLs: permit-access and deny-access</title>
1611 <anchor id="permit-access">
1612 <anchor id="deny-access">
1616 <term>Specifies:</term>
1619 Who can access what.
1624 <term>Type of value:</term>
1627 <replaceable class="parameter">src_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">src_masklen</replaceable>]
1628 [<replaceable class="parameter">dst_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">dst_masklen</replaceable>]]
1631 Where <replaceable class="parameter">src_addr</replaceable> and
1632 <replaceable class="parameter">dst_addr</replaceable> are IPv4 addresses in dotted decimal notation or valid
1633 DNS names, <replaceable class="parameter">port</replaceable> is a port
1634 number, and <replaceable class="parameter">src_masklen</replaceable> and
1635 <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1636 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1637 destination part are optional.
1640 If your system implements
1641 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink>, then
1642 <replaceable class="parameter">src_addr</replaceable> and <replaceable
1643 class="parameter">dst_addr</replaceable> can be IPv6 addresses delimeted by
1644 brackets, <replaceable class="parameter">port</replaceable> can be a number
1645 or a service name, and
1646 <replaceable class="parameter">src_masklen</replaceable> and
1647 <replaceable class="parameter">dst_masklen</replaceable> can be a number
1653 <term>Default value:</term>
1655 <para><emphasis>Unset</emphasis></para>
1657 If no <replaceable class="parameter">port</replaceable> is specified,
1658 any port will match. If no <replaceable class="parameter">src_masklen</replaceable> or
1659 <replaceable class="parameter">src_masklen</replaceable> is given, the complete IP
1660 address has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1665 <term>Effect if unset:</term>
1668 Don't restrict access further than implied by <literal>listen-address</literal>
1676 Access controls are included at the request of ISPs and systems
1677 administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1678 For a typical home user, it will normally suffice to ensure that
1679 <application>Privoxy</application> only listens on the localhost
1680 (127.0.0.1) or internal (home) network address by means of the
1681 <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1685 Please see the warnings in the FAQ that <application>Privoxy</application>
1686 is not intended to be a substitute for a firewall or to encourage anyone
1687 to defer addressing basic security weaknesses.
1690 Multiple ACL lines are OK.
1691 If any ACLs are specified, <application>Privoxy</application> only talks
1692 to IP addresses that match at least one <literal>permit-access</literal> line
1693 and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1694 last match wins, with the default being <literal>deny-access</literal>.
1697 If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1698 for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1699 that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1700 of the ultimate target. This is necessary because it may be impossible for the local
1701 <application>Privoxy</application> to determine the IP address of the
1702 ultimate target (that's often what gateways are used for).
1705 You should prefer using IP addresses over DNS names, because the address lookups take
1706 time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1707 like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1708 IP addresses, only the first one is used.
1711 Some systems allows IPv4 client to connect to IPv6 server socket.
1712 Then the client's IPv4 address will be translated by system into
1713 IPv6 address space with special prefix ::ffff/96 (so called IPv4
1714 mapped IPv6 address). <application>Privoxy</application> can handle it
1715 and maps such ACL addresses automatically.
1718 Denying access to particular sites by ACL may have undesired side effects
1719 if the site in question is hosted on a machine which also hosts other sites
1725 <term>Examples:</term>
1728 Explicitly define the default behavior if no ACL and
1729 <literal>listen-address</literal> are set: <quote>localhost</quote>
1730 is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1731 <emphasis>all</emphasis> destination addresses are OK:
1735 permit-access localhost
1739 Allow any host on the same class C subnet as www.privoxy.org access to
1740 nothing but www.example.com (or other domains hosted on the same system):
1744 permit-access www.privoxy.org/24 www.example.com/32
1748 Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1749 with the exception that 192.168.45.73 may not access the IP address behind
1750 www.dirty-stuff.example.com:
1754 permit-access 192.168.45.64/26
1755 deny-access 192.168.45.73 www.dirty-stuff.example.com
1759 Allow access from the IPv4 network 192.0.2.0/24 even if listening on
1760 an IPv6 wild card address (not supported on all platforms):
1764 permit-access 192.0.2.0/24
1768 This is equivalent to the following line even if listening on an
1769 IPv4 address (not supported on all platforms):
1773 permit-access [::ffff:192.0.2.0]/120
1782 <!-- ~~~~~ New section ~~~~~ -->
1783 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1787 <term>Specifies:</term>
1790 Maximum size of the buffer for content filtering.
1795 <term>Type of value:</term>
1797 <para>Size in Kbytes</para>
1801 <term>Default value:</term>
1807 <term>Effect if unset:</term>
1810 Use a 4MB (4096 KB) limit.
1818 For content filtering, i.e. the <literal>+filter</literal> and
1819 <literal>+deanimate-gif</literal> actions, it is necessary that
1820 <application>Privoxy</application> buffers the entire document body.
1821 This can be potentially dangerous, since a server could just keep sending
1822 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1826 When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1827 flushed to the client unfiltered and no further attempt to
1828 filter the rest of the document is made. Remember that there may be multiple threads
1829 running, which might require up to <literal>buffer-limit</literal> Kbytes
1830 <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1837 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1842 <!-- ~ End section ~ -->
1845 <!-- ~~~~~ New section ~~~~~ -->
1847 <sect2 id="forwarding">
1848 <title>Forwarding</title>
1851 This feature allows routing of HTTP requests through a chain of
1855 Forwarding can be used to chain Privoxy with a caching proxy to speed
1856 up browsing. Using a parent proxy may also be necessary if the machine
1857 that <application>Privoxy</application> runs on has no direct Internet access.
1860 Note that parent proxies can severely decrease your privacy level.
1861 For example a parent proxy could add your IP address to the request
1862 headers and if it's a caching proxy it may add the <quote>Etag</quote>
1863 header to revalidation requests again, even though you configured Privoxy
1864 to remove it. It may also ignore Privoxy's header time randomization and use the
1865 original values which could be used by the server as cookie replacement
1866 to track your steps between visits.
1870 Also specified here are SOCKS proxies. <application>Privoxy</application>
1871 supports the SOCKS 4 and SOCKS 4A protocols.
1874 <sect3 renderas="sect4" id="forward"><title>forward</title>
1877 <term>Specifies:</term>
1880 To which parent HTTP proxy specific requests should be routed.
1885 <term>Type of value:</term>
1888 <replaceable class="parameter">target_pattern</replaceable>
1889 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1892 where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1893 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1894 denote <quote>all URLs</quote>.
1895 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1896 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1897 optionally followed by its listening port (default: 8000).
1898 Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1903 <term>Default value:</term>
1905 <para><emphasis>Unset</emphasis></para>
1909 <term>Effect if unset:</term>
1912 Don't use parent HTTP proxies.
1920 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1921 forwarded to another HTTP proxy but are made directly to the web servers.
1924 <replaceable class="parameter">http_parent</replaceable> can be a
1925 numerical IPv6 address (if
1926 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
1927 implemented). To prevent clashes with the port delimiter, the whole IP
1928 address has to be put into brackets. On the other hand a <replaceable
1929 class="parameter">target_pattern</replaceable> containing an IPv6 address
1930 has to be put into angle brackets (normal brackets are reserved for
1931 regular expressions already).
1934 Multiple lines are OK, they are checked in sequence, and the last match wins.
1939 <term>Examples:</term>
1942 Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
1946 forward / parent-proxy.example.org:8080
1951 Everything goes to our example ISP's caching proxy, except for requests
1952 to that ISP's sites:
1956 forward / caching-proxy.isp.example.net:8000
1957 forward .isp.example.net .
1961 Parent proxy specified by an IPv6 address:
1965 foward / [2001:DB8::1]:8000
1969 Suppose your parent proxy doesn't support IPv6:
1973 forward / parent-proxy.example.org:8000
1974 forward ipv6-server.example.org .
1975 forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
1984 <!-- ~~~~~ New section ~~~~~ -->
1985 <sect3 renderas="sect4" id="socks"><title>
1986 forward-socks4, forward-socks4a and forward-socks5</title>
1987 <anchor id="forward-socks4">
1988 <anchor id="forward-socks4a">
1992 <term>Specifies:</term>
1995 Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2000 <term>Type of value:</term>
2003 <replaceable class="parameter">target_pattern</replaceable>
2004 <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
2005 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2008 where <replaceable class="parameter">target_pattern</replaceable> is a
2009 <link linkend="af-patterns">URL pattern</link> that specifies to which
2010 requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2011 denote <quote>all URLs</quote>. <replaceable class="parameter">http_parent</replaceable>
2012 and <replaceable class="parameter">socks_proxy</replaceable>
2013 are IP addresses in dotted decimal notation or valid DNS names
2014 (<replaceable class="parameter">http_parent</replaceable>
2015 may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
2016 <replaceable class="parameter">port</replaceable> parameters are TCP ports,
2017 i.e. integer values from 1 to 65535
2022 <term>Default value:</term>
2024 <para><emphasis>Unset</emphasis></para>
2028 <term>Effect if unset:</term>
2031 Don't use SOCKS proxies.
2039 Multiple lines are OK, they are checked in sequence, and the last match wins.
2042 The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
2043 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2044 server, while in SOCKS 4 it happens locally.
2047 With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
2050 <replaceable class="parameter">socks_proxy</replaceable> and
2051 <replaceable class="parameter">http_parent</replaceable> can be a
2052 numerical IPv6 address (if
2053 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2054 implemented). To prevent clashes with the port delimiter, the whole IP
2055 address has to be put into brackets. On the other hand a <replaceable
2056 class="parameter">target_pattern</replaceable> containing an IPv6 address
2057 has to be put into angle brackets (normal brackets are reserved for
2058 regular expressions already).
2061 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2062 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2068 <term>Examples:</term>
2071 From the company example.com, direct connections are made to all
2072 <quote>internal</quote> domains, but everything outbound goes through
2073 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2078 forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
2079 forward .example.com .
2083 A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2087 forward-socks4 / socks-gw.example.com:1080 .
2092 To chain Privoxy and Tor, both running on the same system, you would use
2097 forward-socks5 / 127.0.0.1:9050 .
2102 The public <application>Tor</application> network can't be used to
2103 reach your local network, if you need to access local servers you
2104 therefore might want to make some exceptions:
2108 forward 192.168.*.*/ .
2110 forward 127.*.*.*/ .
2114 Unencrypted connections to systems in these address ranges will
2115 be as (un)secure as the local network is, but the alternative is that you
2116 can't reach the local network through <application>Privoxy</application>
2117 at all. Of course this may actually be desired and there is no reason
2118 to make these exceptions if you aren't sure you need them.
2121 If you also want to be able to reach servers in your local network by
2122 using their names, you will need additional exceptions that look like
2127 forward localhost/ .
2136 <![%user-man;[ <!-- not included in config due to length -->
2137 <!-- ~~~~~ New section ~~~~~ -->
2138 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2141 If you have links to multiple ISPs that provide various special content
2142 only to their subscribers, you can configure multiple <application>Privoxies</application>
2143 which have connections to the respective ISPs to act as forwarders to each other, so that
2144 <emphasis>your</emphasis> users can see the internal content of all ISPs.
2148 Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2149 isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2150 configuration can look like this:
2160 forward .isp-b.example.net host-b:8118
2171 forward .isp-a.example.org host-a:8118
2176 Now, your users can set their browser's proxy to use either
2177 host-a or host-b and be able to browse the internal content
2178 of both isp-a and isp-b.
2182 If you intend to chain <application>Privoxy</application> and
2183 <application>squid</application> locally, then chaining as
2184 <literal>browser -> squid -> privoxy</literal> is the recommended way.
2188 Assuming that <application>Privoxy</application> and <application>squid</application>
2189 run on the same box, your <application>squid</application> configuration could then look like this:
2194 # Define Privoxy as parent proxy (without ICP)
2195 cache_peer 127.0.0.1 parent 8118 7 no-query
2197 # Define ACL for protocol FTP
2200 # Do not forward FTP requests to Privoxy
2201 always_direct allow ftp
2203 # Forward all the rest to Privoxy
2204 never_direct allow all</screen>
2208 You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2209 Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2213 You could just as well decide to only forward requests you suspect
2214 of leading to Windows executables through a virus-scanning parent proxy,
2215 say, on <literal>antivir.example.com</literal>, port 8010:
2221 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
2227 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2230 <term>Specifies:</term>
2233 How often Privoxy retries if a forwarded connection request fails.
2238 <term>Type of value:</term>
2241 <replaceable class="parameter">Number of retries.</replaceable>
2246 <term>Default value:</term>
2248 <para><emphasis>0</emphasis></para>
2252 <term>Effect if unset:</term>
2255 Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2263 <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2264 for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2265 The connection might have failed because of a DNS timeout in which case a retry makes sense,
2266 but it might also have failed because the server doesn't exist or isn't reachable. In this
2267 case the retry will just delay the appearance of Privoxy's error message.
2270 Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2271 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2274 Only use this option, if you are getting lots of forwarding-related error messages
2275 that go away when you try again manually. Start with a small value and check Privoxy's
2276 logfile from time to time, to see how many retries are usually needed.
2281 <term>Examples:</term>
2284 forwarded-connect-retries 1
2289 <![%config-file;[<literallayout>@@forwarded-connect-retries 0</literallayout>]]>
2292 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2295 <term>Specifies:</term>
2298 Whether intercepted requests should be treated as valid.
2303 <term>Type of value:</term>
2306 <replaceable>0 or 1</replaceable>
2311 <term>Default value:</term>
2313 <para><emphasis>0</emphasis></para>
2317 <term>Effect if unset:</term>
2320 Only proxy requests are accepted, intercepted requests are treated as invalid.
2328 If you don't trust your clients and want to force them
2329 to use <application>Privoxy</application>, enable this
2330 option and configure your packet filter to redirect outgoing
2331 HTTP connections into <application>Privoxy</application>.
2334 Make sure that <application>Privoxy's</application> own requests
2335 aren't redirected as well. Additionally take care that
2336 <application>Privoxy</application> can't intentionally connect
2337 to itself, otherwise you could run into redirection loops if
2338 <application>Privoxy's</application> listening port is reachable
2339 by the outside or an attacker has access to the pages you visit.
2344 <term>Examples:</term>
2347 accept-intercepted-requests 1
2352 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2355 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2358 <term>Specifies:</term>
2361 Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2366 <term>Type of value:</term>
2369 <replaceable>0 or 1</replaceable>
2374 <term>Default value:</term>
2376 <para><emphasis>0</emphasis></para>
2380 <term>Effect if unset:</term>
2383 <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2391 By default <application>Privoxy</application> ignores block or redirect actions
2392 for its CGI pages. Intercepting these requests can be useful in multi-user
2393 setups to implement fine-grained access control, but it can also render the complete
2394 web interface useless and make debugging problems painful if done without care.
2397 Don't enable this option unless you're sure that you really need it.
2402 <term>Examples:</term>
2405 allow-cgi-request-crunching 1
2410 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2413 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2416 <term>Specifies:</term>
2419 Whether the CGI interface should stay compatible with broken HTTP clients.
2424 <term>Type of value:</term>
2427 <replaceable>0 or 1</replaceable>
2432 <term>Default value:</term>
2434 <para><emphasis>0</emphasis></para>
2438 <term>Effect if unset:</term>
2441 The CGI form generate long GET URLs.
2449 <application>Privoxy's</application> CGI forms can lead to
2450 rather long URLs. This isn't a problem as far as the HTTP
2451 standard is concerned, but it can confuse clients with arbitrary
2452 URL length limitations.
2455 Enabling split-large-forms causes <application>Privoxy</application>
2456 to divide big forms into smaller ones to keep the URL length down.
2457 It makes editing a lot less convenient and you can no longer
2458 submit all changes at once, but at least it works around this
2462 If you don't notice any editing problems, there is no reason
2463 to enable this option, but if one of the submit buttons appears
2464 to be broken, you should give it a try.
2469 <term>Examples:</term>
2477 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2480 <sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
2483 <term>Specifies:</term>
2486 Number of seconds after which an open connection will no longer be reused.
2491 <term>Type of value:</term>
2494 <replaceable>Time in seconds.</replaceable>
2499 <term>Default value:</term>
2505 <term>Effect if unset:</term>
2508 Connections are not reused.
2516 This option has no effect if <application>Privoxy</application>
2517 has been compiled without keep-alive support.
2525 Note that reusing connections doesn't necessary cause speedups.
2526 There are also a few privacy implications you should be aware of.
2529 Outgoing connections are shared between clients (if there are more
2530 than one) and closing the client that initiated the outgoing connection
2531 does not affect the connection between &my-app; and the server unless
2532 the client's request hasn't been completed yet. If the outgoing connection
2533 is idle, it will not be closed until either <application>Privoxy's</application>
2534 or the server's timeout is reached. While it's open, the server knows
2535 that the system running &my-app; is still there.
2540 <term>Examples:</term>
2543 keep-alive-timeout 300
2548 <![%config-file;[<literallayout>@@keep-alive-timeout 300</literallayout>]]>
2552 <sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
2555 <term>Specifies:</term>
2558 Number of seconds after which a socket times out if
2559 no data is received.
2564 <term>Type of value:</term>
2567 <replaceable>Time in seconds.</replaceable>
2572 <term>Default value:</term>
2578 <term>Effect if unset:</term>
2581 A default value of 300 seconds is used.
2589 For SOCKS requests the timeout currently doesn't start until
2590 the SOCKS server accepted the request. This will be fixed in
2596 <term>Examples:</term>
2604 <![%config-file;[<literallayout>@@socket-timeout 300</literallayout>]]>
2610 <!-- ~ End section ~ -->
2613 <!-- ~~~~~ New section ~~~~~ -->
2615 <sect2 id="windows-gui">
2616 <title>Windows GUI Options</title>
2618 <application>Privoxy</application> has a number of options specific to the
2619 Windows GUI interface:
2622 <anchor id="activity-animation">
2623 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2625 If <quote>activity-animation</quote> is set to 1, the
2626 <application>Privoxy</application> icon will animate when
2627 <quote>Privoxy</quote> is active. To turn off, set to 0.
2630 <![%config-file;[<literallayout>@@#activity-animation 1</literallayout>]]>
2636 <emphasis>activity-animation 1</emphasis>
2643 <anchor id="log-messages">
2644 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2646 If <quote>log-messages</quote> is set to 1,
2647 <application>Privoxy</application> will log messages to the console
2651 <![%config-file;[<literallayout>@@#log-messages 1</literallayout>]]>
2657 <emphasis>log-messages 1</emphasis>
2664 <anchor id="log-buffer-size">
2665 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2667 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
2668 i.e. the amount of memory used for the log messages displayed in the
2669 console window, will be limited to <quote>log-max-lines</quote> (see below).
2673 Warning: Setting this to 0 will result in the buffer to grow infinitely and
2674 eat up all your memory!
2677 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
2683 <emphasis>log-buffer-size 1</emphasis>
2690 <anchor id="log-max-lines">
2691 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2693 <application>log-max-lines</application> is the maximum number of lines held
2694 in the log buffer. See above.
2697 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
2703 <emphasis>log-max-lines 200</emphasis>
2710 <anchor id="log-highlight-messages">
2711 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2713 If <quote>log-highlight-messages</quote> is set to 1,
2714 <application>Privoxy</application> will highlight portions of the log
2715 messages with a bold-faced font:
2718 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
2724 <emphasis>log-highlight-messages 1</emphasis>
2731 <anchor id="log-font-name">
2732 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2734 The font used in the console window:
2737 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
2743 <emphasis>log-font-name Comic Sans MS</emphasis>
2750 <anchor id="log-font-size">
2751 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2753 Font size used in the console window:
2756 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
2762 <emphasis>log-font-size 8</emphasis>
2769 <anchor id="show-on-task-bar">
2770 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2772 <quote>show-on-task-bar</quote> controls whether or not
2773 <application>Privoxy</application> will appear as a button on the Task bar
2777 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
2783 <emphasis>show-on-task-bar 0</emphasis>
2790 <anchor id="close-button-minimizes">
2791 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2793 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
2794 button will minimize <application>Privoxy</application> instead of closing
2795 the program (close with the exit option on the File menu).
2798 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
2804 <emphasis>close-button-minimizes 1</emphasis>
2811 <anchor id="hide-console">
2812 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2814 The <quote>hide-console</quote> option is specific to the MS-Win console
2815 version of <application>Privoxy</application>. If this option is used,
2816 <application>Privoxy</application> will disconnect from and hide the
2820 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
2826 #<emphasis>hide-console</emphasis>
2836 <!-- end config content common to both outputs -->
2839 <!-- These are dummy anchors to keep the processor quiet -->
2840 <!-- when building config-file only (ie. they are used in u-m only) -->
2843 <anchor id="filter">
2844 <anchor id="filter-file">
2846 <anchor id="actions-file">
2847 <anchor id="af-patterns">
2851 <!-- eof p-config.sgml -->