2 File : doc/source/p-config.sgml
4 Purpose : Used with other docs and files only.
6 Copyright (C) 2001-2022 Privoxy Developers https://www.privoxy.org/
9 ========================================================================
10 NOTE: Please read developer-manual/documentation.html before touching
11 anything in this, or other Privoxy documentation.
12 ========================================================================
15 This file contains all the config file comments and options. It used to
16 build both the user-manual config sections, and all of config (yes, the main
19 Rationale: This is broken up into two files since a file with a prolog
20 (DTD, etc) cannot be sourced as a secondary file. config.sgml is basically
21 a wrapper for this file.
25 OPTIONS: The actual options are included in this file and prefixed with
26 '@@', and processed by the Makefile to strip the '@@'. Default options
27 that should appear commented out should be listed as: '@@#OPTION'.
28 Otherwise, as '@@OPTION'. Example:
30 @@listen-address 127.0.0.1:8118
32 The Makefile does significant other processing too. The final results
33 should be checked to make sure that the perl processing does not
34 fubar something!!! Makefile processing requires w3m, fmt (shell line
38 This file is included into:
41 config (the actual Privoxy config file)
46 <!-- This part only goes into user-manual -->
48 <title>The Main Configuration File</title>
51 By default, the main configuration file is named <filename>config</filename>,
52 with the exception of Windows, where it is named <filename>config.txt</filename>.
53 Configuration lines consist of an initial keyword followed by a list of
54 values, all separated by whitespace (any number of spaces or tabs). For
59 <emphasis>confdir /etc/privoxy</emphasis>
63 Assigns the value <literal>/etc/privoxy</literal> to the option
64 <literal>confdir</literal> and thus indicates that the configuration
65 directory is named <quote>/etc/privoxy/</quote>.
69 All options in the config file except for <literal>confdir</literal> and
70 <literal>logdir</literal> are optional. Watch out in the below description
71 for what happens if you leave them unset.
75 The main config file controls all aspects of <application>Privoxy</application>'s
76 operation that are not location dependent (i.e. they apply universally, no matter
77 where you may be surfing). Like the filter and action files, the config file is
78 a plain text file and can be modified with a text editor like emacs, vim or
86 <!-- This part only goes into the config file -->
89 @@TITLE<!-- between the @@ is stripped by Makefile -->@@
90 Sample Configuration File for Privoxy &p-version;
93 Copyright (C) 2001-2022 Privoxy Developers https://www.privoxy.org/
97 ##################################################################
102 II. FORMAT OF THE CONFIGURATION FILE #
104 1. LOCAL SET-UP DOCUMENTATION #
105 2. CONFIGURATION AND LOG FILE LOCATIONS #
107 4. ACCESS CONTROL AND SECURITY #
110 7. HTTPS INSPECTION (EXPERIMENTAL) #
111 8. WINDOWS GUI OPTIONS #
113 ##################################################################
121 This file holds Privoxy's main configuration. Privoxy detects
122 configuration changes automatically, so you don't have to restart it
123 unless you want to load a different configuration file.
126 The configuration will be reloaded with the first request after the
127 change was done, this request itself will still use the old configuration,
128 though. In other words: it takes two requests before you see the result of
129 your changes. Requests that are dropped due to ACL don't trigger reloads.
132 When starting Privoxy on Unix systems, give the location of this
133 file as last argument. On Windows systems, Privoxy will look for
134 this file with the name 'config.txt' in the current working directory
135 of the Privoxy process.
139 <literallayout><!-- funky spacing -->
141 II. FORMAT OF THE CONFIGURATION FILE
142 ====================================</literallayout>
145 Configuration lines consist of an initial keyword followed by a list
146 of values, all separated by whitespace (any number of spaces or
150 actionsfile default.action
153 Indicates that the actionsfile is named 'default.action'.
156 The '#' indicates a comment. Any part of a line following a '#' is
157 ignored, except if the '#' is preceded by a '\'.
160 Thus, by placing a # at the start of an existing configuration line,
161 you can make it a comment and it will be treated as if it weren't there.
162 This is called "commenting out" an option and can be useful. Removing
163 the # again is called "uncommenting".
166 Note that commenting out an option and leaving it at its default
167 are two completely different things! Most options behave very
168 differently when unset. See the "Effect if unset" explanation
169 in each option's description for details.
172 Long lines can be continued on the next line by using a `\' as
178 <!-- ************************************************ -->
179 <!-- The following is common to both outputs (mostly) -->
180 <!-- ************************************************ -->
184 <!-- ~~~~~ New section ~~~~~ -->
185 <sect2 id="local-set-up">
186 <title>Local Set-up Documentation</title>
189 If you intend to operate <application>Privoxy</application> for more users
190 than just yourself, it might be a good idea to let them know how to reach
191 you, what you block and why you do that, your policies, etc.
195 <!-- ~~~~~ New section ~~~~~ -->
196 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
199 <term>Specifies:</term>
202 Location of the <application>Privoxy</application> User Manual.
207 <term>Type of value:</term>
209 <para>A fully qualified URI</para>
213 <term>Default value:</term>
215 <para><emphasis>Unset</emphasis></para>
219 <term>Effect if unset:</term>
222 <ulink url="https://www.privoxy.org/user-manual/">https://www.privoxy.org/<replaceable class="parameter">version</replaceable>/user-manual/</ulink>
223 will be used, where <replaceable class="parameter">version</replaceable> is the <application>Privoxy</application> version.
231 The User Manual URI is the single best source of information on
232 <application>Privoxy</application>, and is used for help links from some
233 of the internal CGI pages. The manual itself is normally packaged with the
234 binary distributions, so you probably want to set this to a locally
242 Unix, in local filesystem (may not work with all browsers):
244 <screen>user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
246 Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
248 <screen>user-manual file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
250 Windows, UNC notation (with forward slashes):
252 <screen>user-manual file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
255 The best all purpose solution is simply to put the full local
256 <literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
259 <screen>user-manual /usr/share/doc/privoxy/user-manual</screen>
261 The User Manual is then available to anyone with access to
262 <application>Privoxy</application>, by following the built-in URL:
263 <literal>http://config.privoxy.org/user-manual/</literal>
264 (or the shortcut: <literal>http://p.p/user-manual/</literal>).
267 If the documentation is not on the local system, it can be accessed
268 from a remote server, as:
270 <screen>user-manual http://example.com/privoxy/user-manual/</screen>
272 <!-- this gets hammered in conversion to config. Text repeated below. -->
275 If set, this option should be <emphasis>the first option in the config
276 file</emphasis>, because it is used while the config file is being read
289 If set, this option should be the first option in the config
290 file, because it is used while the config file is being read.
299 <![%config-file;[<literallayout>@@#user-manual https://www.privoxy.org/user-manual/</literallayout>]]>
303 <!-- ~~~~~ New section ~~~~~ -->
304 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
308 <term>Specifies:</term>
311 A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
316 <term>Type of value:</term>
322 <term>Default value:</term>
324 <para><emphasis>Unset</emphasis></para>
328 <term>Effect if unset:</term>
331 No links are displayed on the "untrusted" error page.
339 The value of this option only matters if the experimental trust mechanism has been
340 activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> below.)
343 If you use the trust mechanism, it is a good idea to write up some on-line
344 documentation about your trust policy and to specify the URL(s) here.
345 Use multiple times for multiple URLs.
348 The URL(s) should be added to the trustfile as well, so users don't end up
349 locked out from the information on why they were locked out in the first place!
355 <![%config-file;[<literallayout>@@#trust-info-url http://www.example.com/why_we_block.html</literallayout>]]>
356 <![%config-file;[<literallayout>@@#trust-info-url http://www.example.com/what_we_allow.html</literallayout>]]>
360 <!-- ~~~~~ New section ~~~~~ -->
361 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
365 <term>Specifies:</term>
368 An email address to reach the <application>Privoxy</application> administrator.
373 <term>Type of value:</term>
375 <para>Email address</para>
379 <term>Default value:</term>
381 <para><emphasis>Unset</emphasis></para>
385 <term>Effect if unset:</term>
388 No email address is displayed on error pages and the CGI user interface.
396 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
397 are unset, the whole "Local Privoxy Support" box on all generated pages will
404 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
408 <!-- ~~~~~ New section ~~~~~ -->
409 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
413 <term>Specifies:</term>
416 A URL to documentation about the local <application>Privoxy</application> setup,
417 configuration or policies.
422 <term>Type of value:</term>
428 <term>Default value:</term>
430 <para><emphasis>Unset</emphasis></para>
434 <term>Effect if unset:</term>
437 No link to local documentation is displayed on error pages and the CGI user interface.
445 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
446 are unset, the whole "Local Privoxy Support" box on all generated pages will
450 This URL shouldn't be blocked ;-)
456 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
460 <!-- ~ End section ~ -->
464 <!-- ~~~~~ New section ~~~~~ -->
466 <sect2 id="conf-log-loc">
467 <title>Configuration and Log File Locations</title>
470 <application>Privoxy</application> can (and normally does) use a number of
471 other files for additional configuration, help and logging.
472 This section of the configuration file tells <application>Privoxy</application>
473 where to find those other files.
477 The user running <application>Privoxy</application>, must have read
478 permission for all configuration files, and write permission to any files
479 that would be modified, such as log files and actions files.
483 <!-- ~~~~~ New section ~~~~~ -->
484 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
488 <term>Specifies:</term>
490 <para>The directory where the other configuration files are located.</para>
494 <term>Type of value:</term>
496 <para>Path name</para>
500 <term>Default value:</term>
502 <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
506 <term>Effect if unset:</term>
508 <para><emphasis>Mandatory</emphasis></para>
515 No trailing <quote><literal>/</literal></quote>, please.
521 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
524 <!-- ~~~~~ New section ~~~~~ -->
525 <sect3 renderas="sect4" id="templdir"><title>templdir</title>
529 <term>Specifies:</term>
531 <para>An alternative directory where the templates are loaded from.</para>
535 <term>Type of value:</term>
537 <para>Path name</para>
541 <term>Default value:</term>
547 <term>Effect if unset:</term>
549 <para>The templates are assumed to be located in confdir/template.</para>
556 <application>Privoxy's</application> original templates are usually
557 overwritten with each update. Use this option to relocate customized
558 templates that should be kept. As template variables might change
559 between updates, you shouldn't expect templates to work with
560 <application>Privoxy</application> releases other than the one
561 they were part of, though.
567 <![%config-file;[<literallayout>@@#templdir .</literallayout>]]>
571 <!-- ~~~~~ New section ~~~~~ -->
572 <sect3 renderas="sect4" id="temporary-directory"><title>temporary-directory</title>
576 <term>Specifies:</term>
578 <para>A directory where Privoxy can create temporary files.</para>
582 <term>Type of value:</term>
584 <para>Path name</para>
588 <term>Default value:</term>
594 <term>Effect if unset:</term>
596 <para>No temporary files are created, external filters don't work.</para>
603 To execute <literal><ulink url="actions-file.html#EXTERNAL-FILTER">external filters</ulink></literal>,
604 <application>Privoxy</application> has to create temporary files.
605 This directive specifies the directory the temporary files should
609 It should be a directory only <application>Privoxy</application>
610 (and trusted users) can access.
616 <![%config-file;[<literallayout>@@#temporary-directory .</literallayout>]]>
620 <!-- ~~~~~ New section ~~~~~ -->
621 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
625 <term>Specifies:</term>
628 The directory where all logging takes place
629 (i.e. where the <filename>logfile</filename> is located).
634 <term>Type of value:</term>
636 <para>Path name</para>
640 <term>Default value:</term>
642 <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
646 <term>Effect if unset:</term>
648 <para><emphasis>Mandatory</emphasis></para>
655 No trailing <quote><literal>/</literal></quote>, please.
661 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
665 <!-- ~~~~~ New section ~~~~~ -->
666 <sect3 renderas="sect4" id="actionsfile"><title>
669 <anchor id="default.action">
670 <anchor id="standard.action">
671 <anchor id="user.action">
672 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
675 <term>Specifies:</term>
678 The <link linkend="actions-file">actions file(s)</link> to use
683 <term>Type of value:</term>
685 <para>Complete file name, relative to <literal>confdir</literal></para>
689 <term>Default values:</term>
693 <msgtext><literallayout> match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout></msgtext>
696 <msgtext><literallayout> default.action # Main actions file</literallayout></msgtext>
699 <msgtext><literallayout> user.action # User customizations</literallayout></msgtext>
705 <term>Effect if unset:</term>
708 No actions are taken at all. More or less neutral proxying.
716 Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
719 The default values are <filename>default.action</filename>, which is the
720 <quote>main</quote> actions file maintained by the developers, and
721 <filename>user.action</filename>, where you can make your personal additions.
724 Actions files contain all the per site and per URL configuration for
725 ad blocking, cookie management, privacy considerations, etc.
731 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
732 <!-- html -> text conversion, blah -->
733 <![%config-file;[<literallayout>@@actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout>]]>
734 <![%config-file;[<literallayout>@@actionsfile default.action # Main actions file</literallayout>]]>
736 XXX: Like user.filter, user.action should probably be commented out
737 by default as not all packages install it into the default directory.
740 <![%config-file;[<literallayout>@@actionsfile user.action # User customizations</literallayout>]]>
741 <![%config-file;[<literallayout>@@#actionsfile regression-tests.action # Tests for privoxy-regression-test</literallayout>]]>
744 <!-- ~~~~~ New section ~~~~~ -->
745 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
746 <anchor id="default.filter">
749 <term>Specifies:</term>
752 The <link linkend="filter-file">filter file(s)</link> to use
757 <term>Type of value:</term>
759 <para>File name, relative to <literal>confdir</literal></para>
763 <term>Default value:</term>
765 <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
769 <term>Effect if unset:</term>
772 No textual content filtering takes place, i.e. all
773 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
774 actions in the actions files are turned neutral.
782 Multiple <literal>filterfile</literal> lines are permitted.
785 The <link linkend="filter-file">filter files</link> contain content modification
786 rules that use <link linkend="regex">regular expressions</link>. These rules permit
787 powerful changes on the content of Web pages, and optionally the headers
788 as well, e.g., you could try to disable your favorite JavaScript annoyances,
789 re-write the actual displayed text, or just have some fun
790 playing buzzword bingo with web pages.
794 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
795 actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
796 to be defined in a filter file!
799 A pre-defined filter file called <filename>default.filter</filename> that contains
800 a number of useful filters for common problems is included in the distribution.
801 See the section on the <literal><link linkend="filter">filter</link></literal>
805 It is recommended to place any locally adapted filters into a separate
806 file, such as <filename>user.filter</filename>.
812 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
813 <![%config-file;[<literallayout>@@filterfile user.filter # User customizations</literallayout>]]>
817 <!-- ~~~~~ New section ~~~~~ -->
818 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
822 <term>Specifies:</term>
830 <term>Type of value:</term>
832 <para>File name, relative to <literal>logdir</literal></para>
836 <term>Default value:</term>
838 <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
842 <term>Effect if unset:</term>
845 No logfile is written.
853 The logfile is where all logging and error messages are written. The level
854 of detail and number of messages are set with the <literal>debug</literal>
855 option (see below). The logfile can be useful for tracking down a problem with
856 <application>Privoxy</application> (e.g., it's not blocking an ad you
857 think it should block) and it can help you to monitor what your browser
861 Depending on the debug options below, the logfile may be a privacy risk
862 if third parties can get access to it. As most users will never look
863 at it, <application>Privoxy</application> only logs fatal errors by default.
866 For most troubleshooting purposes, you will have to change that,
867 please refer to the debugging section for details.
870 Any log files must be writable by whatever user <application>Privoxy</application>
871 is being run as (on Unix, default user id is <quote>privoxy</quote>).
874 To prevent the logfile from growing indefinitely, it is recommended to
875 periodically rotate or shorten it. Many operating systems support log
876 rotation out of the box, some require additional software to do it.
877 For details, please refer to the documentation for your operating system.
883 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
887 <!-- ~~~~~ New section ~~~~~ -->
888 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
891 <term>Specifies:</term>
894 The name of the trust file to use
899 <term>Type of value:</term>
901 <para>File name, relative to <literal>confdir</literal></para>
905 <term>Default value:</term>
907 <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
911 <term>Effect if unset:</term>
914 The entire trust mechanism is disabled.
922 The trust mechanism is an experimental feature for building white-lists and should
923 be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
926 If you specify a trust file, <application>Privoxy</application> will only allow
927 access to sites that are specified in the trustfile. Sites can be listed
931 Prepending a <literal>~</literal> character limits access to this site
932 only (and any sub-paths within this site), e.g.
933 <literal>~www.example.com</literal> allows access to
934 <literal>~www.example.com/features/news.html</literal>, etc.
937 Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
938 prepending the name with a <literal>+</literal> character. The effect is that
939 access to untrusted sites will be granted -- but only if a link from this
940 trusted referrer was used to get there. The link target will then be added
941 to the <quote>trustfile</quote> so that future, direct accesses will be
942 granted. Sites added via this mechanism do not become trusted referrers
943 themselves (i.e. they are added with a <literal>~</literal> designation).
944 There is a limit of 512 such entries, after which new entries will not be
948 If you use the <literal>+</literal> operator in the trust file, it may grow
949 considerably over time.
952 It is recommended that <application>Privoxy</application> be compiled with
953 the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
954 <literal> --disable-editor</literal> options, if this feature is to be
958 Possible applications include limiting Internet access for children.
965 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
969 <!-- ~ End section ~ -->
971 <!-- ~~~~~ New section ~~~~~ -->
972 <sect2 id="debugging">
973 <title>Debugging</title>
976 These options are mainly useful when tracing a problem.
977 Note that you might also want to invoke
978 <application>Privoxy</application> with the <literal>--no-daemon</literal>
979 command line option when debugging.
982 <sect3 renderas="sect4" id="debug"><title>debug</title>
986 <term>Specifies:</term>
989 Key values that determine what information gets logged.
994 <term>Type of value:</term>
996 <para>Integer values</para>
1000 <term>Default value:</term>
1002 <para>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</para>
1006 <term>Effect if unset:</term>
1009 Default value is used (see above).
1017 The available debug levels are:
1020 debug 1 # Log the destination for each request. See also debug 1024.
1021 debug 2 # show each connection status
1022 debug 4 # show tagging-related messages
1023 debug 8 # show header parsing
1024 debug 16 # log all data written to the network
1025 debug 32 # debug force feature
1026 debug 64 # debug regular expression filters
1027 debug 128 # debug redirects
1028 debug 256 # debug GIF de-animation
1029 debug 512 # Common Log Format
1030 debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
1031 debug 2048 # CGI user interface
1032 debug 4096 # Startup banner and warnings.
1033 debug 8192 # Non-fatal errors
1034 debug 32768 # log all data read from the network
1035 debug 65536 # Log the applying actions
1038 To select multiple debug levels, you can either add them or use
1039 multiple <literal>debug</literal> lines.
1042 A debug level of 1 is informative because it will show you each request
1043 as it happens. <emphasis>1, 1024, 4096 and 8192 are recommended</emphasis>
1044 so that you will notice when things go wrong. The other levels are
1045 probably only of interest if you are hunting down a specific problem.
1046 They can produce a lot of output (especially 16).
1049 If you are used to the more verbose settings, simply enable the debug lines
1053 If you want to use pure CLF (Common Log Format), you should set <quote>debug
1054 512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1057 <application>Privoxy</application> has a hard-coded limit for the
1058 length of log messages. If it's reached, messages are logged truncated
1059 and marked with <quote>... [too long, truncated]</quote>.
1062 Please don't file any support requests without trying to reproduce
1063 the problem with increased debug level first. Once you read the log
1064 messages, you may even be able to solve the problem on your own.
1070 <![%config-file;[<literallayout>@@#debug 1 # Log the destination for each request. See also debug 1024.</literallayout>]]>
1071 <![%config-file;[<literallayout>@@#debug 2 # show each connection status</literallayout>]]>
1072 <![%config-file;[<literallayout>@@#debug 4 # show tagging-related messages</literallayout>]]>
1073 <![%config-file;[<literallayout>@@#debug 8 # show header parsing</literallayout>]]>
1074 <![%config-file;[<literallayout>@@#debug 128 # debug redirects</literallayout>]]>
1075 <![%config-file;[<literallayout>@@#debug 256 # debug GIF de-animation</literallayout>]]>
1076 <![%config-file;[<literallayout>@@#debug 512 # Common Log Format</literallayout>]]>
1077 <![%config-file;[<literallayout>@@#debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
1078 <![%config-file;[<literallayout>@@#debug 4096 # Startup banner and warnings</literallayout>]]>
1079 <![%config-file;[<literallayout>@@#debug 8192 # Non-fatal errors</literallayout>]]>
1080 <![%config-file;[<literallayout>@@#debug 65536 # Log applying actions</literallayout>]]>
1084 <!-- ~~~~~ New section ~~~~~ -->
1085 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1089 <term>Specifies:</term>
1092 Whether to run only one server thread.
1097 <term>Type of value:</term>
1099 <para><emphasis>1 or 0</emphasis></para>
1103 <term>Default value:</term>
1105 <para><emphasis>0</emphasis></para>
1109 <term>Effect if unset:</term>
1112 Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1113 serve multiple requests simultaneously.
1121 This option is only there for debugging purposes.
1122 <emphasis>It will drastically reduce performance.</emphasis>
1128 <![%config-file;[<literallayout>@@#single-threaded 1</literallayout>]]>
1131 <!-- ~~~~~ New section ~~~~~ -->
1132 <sect3 renderas="sect4" id="hostname"><title>hostname</title>
1136 <term>Specifies:</term>
1139 The hostname shown on the CGI pages.
1144 <term>Type of value:</term>
1150 <term>Default value:</term>
1152 <para><emphasis>Unset</emphasis></para>
1156 <term>Effect if unset:</term>
1159 The hostname provided by the operating system is used.
1167 On some misconfigured systems resolving the hostname fails or
1168 takes too much time and slows Privoxy down. Setting a fixed hostname
1169 works around the problem.
1172 In other circumstances it might be desirable to show a hostname
1173 other than the one returned by the operating system. For example
1174 if the system has several different hostnames and you don't want
1175 to use the first one.
1178 Note that Privoxy does not validate the specified hostname value.
1184 <![%config-file;[<literallayout>@@#hostname hostname.example.org</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 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>
1219 <para>[<replaceable class="parameter">Hostname</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1224 <term>Default value:</term>
1226 <para>127.0.0.1:8118</para>
1230 <term>Effect if unset:</term>
1233 Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable and
1234 recommended for home users who run <application>Privoxy</application> on
1235 the same machine as their browser.
1243 You will need to configure your browser(s) to this proxy address and port.
1246 If you already have another service running on port 8118, or if you want to
1247 serve requests from other machines (e.g. on your local network) as well, you
1248 will need to override the default.
1251 You can use this statement multiple times to make
1252 <application>Privoxy</application> listen on more ports or more
1253 <abbrev>IP</abbrev> addresses. Suitable if your operating system does not
1254 support sharing <abbrev>IPv6</abbrev> and <abbrev>IPv4</abbrev> protocols
1258 If a hostname is used instead of an IP address, <application>Privoxy</application>
1259 will try to resolve it to an IP address and if there are multiple, use the first
1263 If the address for the hostname isn't already known on the system
1264 (for example because it's in /etc/hostname), this may result in DNS
1268 If the specified address isn't available on the system, or if the
1269 hostname can't be resolved, <application>Privoxy</application>
1271 On GNU/Linux, and other platforms that can listen on not yet assigned IP
1272 addresses, Privoxy will start and will listen on the specified
1273 address whenever the IP address is assigned to the system
1276 IPv6 addresses containing colons have to be quoted by brackets.
1277 They can only be used if <application>Privoxy</application> has
1278 been compiled with IPv6 support. If you aren't sure if your version
1279 supports it, have a look at
1280 <ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>.
1283 Some operating systems will prefer IPv6 to IPv4 addresses even if the
1284 system has no IPv6 connectivity which is usually not expected by the user.
1285 Some even rely on DNS to resolve localhost which mean the "localhost" address
1286 used may not actually be local.
1289 It is therefore recommended to explicitly configure the intended IP address
1290 instead of relying on the operating system, unless there's a strong reason not to.
1293 If you leave out the address, <application>Privoxy</application> will bind to all
1294 IPv4 interfaces (addresses) on your machine and may become reachable from the
1295 Internet and/or the local network. Be aware that some GNU/Linux distributions
1296 modify that behaviour without updating the documentation. Check for non-standard
1297 patches if your <application>Privoxy</application> version behaves differently.
1300 If you configure <application>Privoxy</application> to be reachable from the
1301 network, consider using <link linkend="acls">access control lists</link>
1302 (ACL's, see below), and/or a firewall.
1305 If you open <application>Privoxy</application> to untrusted users, you should
1306 also make sure that the following actions are disabled: <literal><link
1307 linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1308 <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1313 <term>Example:</term>
1316 Suppose you are running <application>Privoxy</application> on
1317 a machine which has the address 192.168.0.1 on your local private network
1318 (192.168.0.0) and has another outside connection with a different address.
1319 You want it to serve requests from inside only:
1322 listen-address 192.168.0.1:8118
1325 Suppose you are running <application>Privoxy</application> on an
1326 IPv6-capable machine and you want it to listen on the IPv6 address
1327 of the loopback device:
1330 listen-address [::1]:8118
1336 <![%config-file;[<literallayout>@@listen-address 127.0.0.1:8118</literallayout>]]>
1340 <!-- ~~~~~ New section ~~~~~ -->
1341 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1345 <term>Specifies:</term>
1348 Initial state of "toggle" status
1353 <term>Type of value:</term>
1359 <term>Default value:</term>
1365 <term>Effect if unset:</term>
1368 Act as if toggled on
1376 If set to 0, <application>Privoxy</application> will start in
1377 <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1378 content-neutral proxy with both ad blocking and content filtering
1379 disabled. See <literal>enable-remote-toggle</literal> below.
1385 <![%config-file;[<literallayout>@@toggle 1</literallayout>]]>
1389 <!-- ~~~~~ New section ~~~~~ -->
1390 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1393 <term>Specifies:</term>
1396 Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1397 feature</ulink> may be used
1402 <term>Type of value:</term>
1408 <term>Default value:</term>
1414 <term>Effect if unset:</term>
1417 The web-based toggle feature is disabled.
1425 When toggled off, <application>Privoxy</application> mostly acts like a normal,
1426 content-neutral proxy, i.e. doesn't block ads or filter content.
1429 Access to the toggle feature can <emphasis>not</emphasis> be
1430 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1431 so that everybody who can access <application>Privoxy</application> (see
1432 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1433 toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1434 for multi-user environments with untrusted users.
1437 Note that malicious client side code (e.g Java) is also
1438 capable of using this option.
1441 As a lot of <application>Privoxy</application> users don't read
1442 documentation, this feature is disabled by default.
1445 Note that you must have compiled <application>Privoxy</application> with
1446 support for this feature, otherwise this option has no effect.
1452 <![%config-file;[<literallayout>@@enable-remote-toggle 0</literallayout>]]>
1456 <!-- ~~~~~ New section ~~~~~ -->
1457 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1460 <term>Specifies:</term>
1463 Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1468 <term>Type of value:</term>
1474 <term>Default value:</term>
1480 <term>Effect if unset:</term>
1483 Privoxy ignores special HTTP headers.
1491 When toggled on, the client can change <application>Privoxy's</application>
1492 behaviour by setting special HTTP headers. Currently the only supported
1493 special header is <quote>X-Filter: No</quote>, to disable filtering for
1494 the ongoing request, even if it is enabled in one of the action files.
1497 This feature is disabled by default. If you are using
1498 <application>Privoxy</application> in a environment with trusted clients,
1499 you may enable this feature at your discretion. Note that malicious client
1500 side code (e.g Java) is also capable of using this feature.
1503 This option will be removed in future releases as it has been obsoleted
1504 by the more general header taggers.
1510 <![%config-file;[<literallayout>@@enable-remote-http-toggle 0</literallayout>]]>
1514 <!-- ~~~~~ New section ~~~~~ -->
1515 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1518 <term>Specifies:</term>
1521 Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1522 file editor</ulink> may be used
1527 <term>Type of value:</term>
1533 <term>Default value:</term>
1539 <term>Effect if unset:</term>
1542 The web-based actions file editor is disabled.
1550 Access to the editor can <emphasis>not</emphasis> be
1551 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1552 so that everybody who can access <application>Privoxy</application> (see
1553 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1554 modify its configuration for all users.
1557 This option is <emphasis>not recommended</emphasis> for environments
1558 with untrusted users and as a lot of <application>Privoxy</application>
1559 users don't read documentation, this feature is disabled by default.
1562 Note that malicious client side code (e.g Java) is also
1563 capable of using the actions editor and you shouldn't enable
1564 this options unless you understand the consequences and are
1565 sure your browser is configured correctly.
1568 Note that you must have compiled <application>Privoxy</application> with
1569 support for this feature, otherwise this option has no effect.
1575 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1579 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1582 <term>Specifies:</term>
1585 Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1590 <term>Type of value:</term>
1593 <replaceable>0 or 1</replaceable>
1598 <term>Default value:</term>
1600 <para><emphasis>0</emphasis></para>
1604 <term>Effect if unset:</term>
1607 Blocks are not enforced.
1615 <application>Privoxy</application> is mainly used to block and filter
1616 requests as a service to the user, for example to block ads and other
1617 junk that clogs the pipes. <application>Privoxy's</application> configuration
1618 isn't perfect and sometimes innocent pages are blocked. In this situation it
1619 makes sense to allow the user to enforce the request and have
1620 <application>Privoxy</application> ignore the block.
1623 In the default configuration <application>Privoxy's</application>
1624 <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1625 link to adds a special string (the force prefix) to the request URL.
1626 If that link is used, <application>Privoxy</application> will
1627 detect the force prefix, remove it again and let the request pass.
1630 Of course <application>Privoxy</application> can also be used to enforce
1631 a network policy. In that case the user obviously should not be able to
1632 bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1633 option is for. If it's enabled, <application>Privoxy</application> hides
1634 the <quote>go there anyway</quote> link. If the user adds the force
1635 prefix by hand, it will not be accepted and the circumvention attempt
1641 <term>Example:</term>
1649 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1653 <!-- ~~~~~ New section ~~~~~ -->
1654 <sect3 renderas="sect4" id="acls"><title>
1655 ACLs: permit-access and deny-access</title>
1656 <anchor id="permit-access">
1657 <anchor id="deny-access">
1661 <term>Specifies:</term>
1664 Who can access what.
1669 <term>Type of value:</term>
1672 <replaceable class="parameter">src_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">src_masklen</replaceable>]
1673 [<replaceable class="parameter">dst_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">dst_masklen</replaceable>]]
1676 Where <replaceable class="parameter">src_addr</replaceable> and
1677 <replaceable class="parameter">dst_addr</replaceable> are IPv4 addresses in dotted decimal notation or valid
1678 DNS names, <replaceable class="parameter">port</replaceable> is a port
1679 number, and <replaceable class="parameter">src_masklen</replaceable> and
1680 <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1681 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1682 destination part are optional.
1685 If your system implements
1686 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink>, then
1687 <replaceable class="parameter">src_addr</replaceable> and <replaceable
1688 class="parameter">dst_addr</replaceable> can be IPv6 addresses delimited by
1689 brackets, <replaceable class="parameter">port</replaceable> can be a number
1690 or a service name, and
1691 <replaceable class="parameter">src_masklen</replaceable> and
1692 <replaceable class="parameter">dst_masklen</replaceable> can be a number
1698 <term>Default value:</term>
1700 <para><emphasis>Unset</emphasis></para>
1702 If no <replaceable class="parameter">port</replaceable> is specified,
1703 any port will match. If no <replaceable class="parameter">src_masklen</replaceable> or
1704 <replaceable class="parameter">src_masklen</replaceable> is given, the complete IP
1705 address has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1710 <term>Effect if unset:</term>
1713 Don't restrict access further than implied by <literal>listen-address</literal>
1721 Access controls are included at the request of ISPs and systems
1722 administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1723 For a typical home user, it will normally suffice to ensure that
1724 <application>Privoxy</application> only listens on the localhost
1725 (127.0.0.1) or internal (home) network address by means of the
1726 <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1730 Please see the warnings in the FAQ that <application>Privoxy</application>
1731 is not intended to be a substitute for a firewall or to encourage anyone
1732 to defer addressing basic security weaknesses.
1735 Multiple ACL lines are OK.
1736 If any ACLs are specified, <application>Privoxy</application> only talks
1737 to IP addresses that match at least one <literal>permit-access</literal> line
1738 and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1739 last match wins, with the default being <literal>deny-access</literal>.
1742 If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1743 for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1744 that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1745 of the ultimate target. This is necessary because it may be impossible for the local
1746 <application>Privoxy</application> to determine the IP address of the
1747 ultimate target (that's often what gateways are used for).
1750 You should prefer using IP addresses over DNS names, because the address lookups take
1751 time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1752 like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1753 IP addresses, only the first one is used.
1756 Some systems allow IPv4 clients to connect to IPv6 server sockets.
1757 Then the client's IPv4 address will be translated by the system into
1758 IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4
1759 mapped IPv6 address). <application>Privoxy</application> can handle it
1760 and maps such ACL addresses automatically.
1763 Denying access to particular sites by ACL may have undesired side effects
1764 if the site in question is hosted on a machine which also hosts other sites
1770 <term>Examples:</term>
1773 Explicitly define the default behavior if no ACL and
1774 <literal>listen-address</literal> are set: <quote>localhost</quote>
1775 is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1776 <emphasis>all</emphasis> destination addresses are OK:
1779 permit-access localhost
1782 Allow any host on the same class C subnet as www.privoxy.org access to
1783 nothing but www.example.com (or other domains hosted on the same system):
1786 permit-access www.privoxy.org/24 www.example.com/32
1789 Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1790 with the exception that 192.168.45.73 may not access the IP address behind
1791 www.dirty-stuff.example.com:
1794 permit-access 192.168.45.64/26
1795 deny-access 192.168.45.73 www.dirty-stuff.example.com
1798 Allow access from the IPv4 network 192.0.2.0/24 even if listening on
1799 an IPv6 wild card address (not supported on all platforms):
1802 permit-access 192.0.2.0/24
1805 This is equivalent to the following line even if listening on an
1806 IPv4 address (not supported on all platforms):
1809 permit-access [::ffff:192.0.2.0]/120
1817 <!-- ~~~~~ New section ~~~~~ -->
1818 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1822 <term>Specifies:</term>
1825 Maximum size of the buffer for content filtering.
1830 <term>Type of value:</term>
1832 <para>Size in Kbytes</para>
1836 <term>Default value:</term>
1842 <term>Effect if unset:</term>
1845 Use a 4MB (4096 KB) limit.
1853 For content filtering, i.e. the <literal>+filter</literal> and
1854 <literal>+deanimate-gif</literal> actions, it is necessary that
1855 <application>Privoxy</application> buffers the entire document body.
1856 This can be potentially dangerous, since a server could just keep sending
1857 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1861 When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1862 flushed to the client unfiltered and no further attempt to
1863 filter the rest of the document is made. Remember that there may be multiple threads
1864 running, which might require up to <literal>buffer-limit</literal> Kbytes
1865 <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1872 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1875 <!-- ~~~~~ New section ~~~~~ -->
1876 <sect3 renderas="sect4" id="enable-proxy-authentication-forwarding"><title>enable-proxy-authentication-forwarding</title>
1879 <term>Specifies:</term>
1882 Whether or not proxy authentication through &my-app; should work.
1887 <term>Type of value:</term>
1893 <term>Default value:</term>
1899 <term>Effect if unset:</term>
1902 Proxy authentication headers are removed.
1910 Privoxy itself does not support proxy authentication, but can
1911 allow clients to authenticate against Privoxy's parent proxy.
1914 By default Privoxy (3.0.21 and later) don't do that and remove
1915 Proxy-Authorization headers in requests and Proxy-Authenticate
1916 headers in responses to make it harder for malicious sites to
1917 trick inexperienced users into providing login information.
1920 If this option is enabled the headers are forwarded.
1923 Enabling this option is <emphasis>not recommended</emphasis> if there is
1924 no parent proxy that requires authentication or if the local network between
1925 Privoxy and the parent proxy isn't trustworthy. If proxy authentication is
1926 only required for some requests, it is recommended to use a client header filter
1927 to remove the authentication headers for requests where they aren't needed.
1933 <![%config-file;[<literallayout>@@enable-proxy-authentication-forwarding 0</literallayout>]]>
1936 <!-- ~~~~~ New section ~~~~~ -->
1937 <sect3 renderas="sect4" id="trusted-cgi-referer"><title>trusted-cgi-referer</title>
1940 <term>Specifies:</term>
1943 A trusted website or webpage whose links can be followed to reach sensitive CGI pages
1948 <term>Type of value:</term>
1950 <para>URL or URL prefix</para>
1954 <term>Default value:</term>
1960 <term>Effect if unset:</term>
1963 No external pages are considered trusted referers.
1971 Before &my-app; accepts configuration changes through CGI pages like
1972 <link linkend="client-specific-tag">client-tags</link> or the
1973 <link linkend="enable-remote-toggle">remote toggle</link>, it checks
1974 the Referer header to see if the request comes from a trusted source.
1977 By default only the webinterface domains
1978 <ulink url="http://config.privoxy.org/">config.privoxy.org</ulink>
1980 <ulink url="http://p.p/">p.p</ulink>
1981 are considered trustworthy.
1982 Requests originating from other domains are rejected to prevent
1983 third-parties from modifiying Privoxy's state by e.g. embedding
1984 images that result in CGI requests.
1987 In some environments it may be desirable to embed links to CGI pages
1988 on external pages, for example on an Intranet homepage the Privoxy admin
1992 The <quote>trusted-cgi-referer</quote> option can be used to add that page,
1993 or the whole domain, as trusted source so the resulting requests aren't
1995 Requests are accepted if the specified trusted-cgi-refer is the prefix
1999 If the trusted source is supposed to access the CGI pages via
2000 JavaScript the <link linkend="cors-allowed-origin">cors-allowed-origin</link>
2005 Declaring pages the admin doesn't control trustworthy may allow
2006 malicious third parties to modify Privoxy's internal state against
2007 the user's wishes and without the user's knowledge.
2014 <![%config-file;[<literallayout>@@#trusted-cgi-referer http://www.example.org/local-privoxy-control-page</literallayout>]]>
2018 <!-- ~~~~~ New section ~~~~~ -->
2019 <sect3 renderas="sect4" id="cors-allowed-origin"><title>cors-allowed-origin</title>
2022 <term>Specifies:</term>
2025 A trusted website which can access &my-app;'s CGI pages through JavaScript.
2030 <term>Type of value:</term>
2036 <term>Default value:</term>
2042 <term>Effect if unset:</term>
2045 No external sites get access via cross-origin resource sharing.
2053 Modern browsers by default prevent cross-origin requests made
2054 via JavaScript to &my-app;'s CGI interface even if &my-app;
2055 would trust the referer because it's white listed via the
2056 <link linkend="trusted-cgi-referer">trusted-cgi-referer</link>
2060 <ulink url="https://en.wikipedia.org/wiki/Cross-origin_resource_sharing"
2061 >Cross-origin resource sharing (CORS)</ulink> is a mechanism to allow
2062 cross-origin requests.
2065 The <quote>cors-allowed-origin</quote> option can be used to specify
2066 a domain that is allowed to make requests to Privoxy CGI interface
2067 via JavaScript. It is used in combination with the
2068 <link linkend="trusted-cgi-referer">trusted-cgi-referer</link>
2073 Declaring domains the admin doesn't control trustworthy may allow
2074 malicious third parties to modify Privoxy's internal state against
2075 the user's wishes and without the user's knowledge.
2082 <![%config-file;[<literallayout>@@#cors-allowed-origin http://www.example.org/</literallayout>]]>
2087 <!-- ~ End section ~ -->
2090 <!-- ~~~~~ New section ~~~~~ -->
2092 <sect2 id="forwarding">
2093 <title>Forwarding</title>
2096 This feature allows routing of HTTP requests through a chain of
2100 Forwarding can be used to chain Privoxy with a caching proxy to speed
2101 up browsing. Using a parent proxy may also be necessary if the machine
2102 that <application>Privoxy</application> runs on has no direct Internet access.
2105 Note that parent proxies can severely decrease your privacy level.
2106 For example a parent proxy could add your IP address to the request
2107 headers and if it's a caching proxy it may add the <quote>Etag</quote>
2108 header to revalidation requests again, even though you configured Privoxy
2109 to remove it. It may also ignore Privoxy's header time randomization and use the
2110 original values which could be used by the server as cookie replacement
2111 to track your steps between visits.
2115 Also specified here are SOCKS proxies. <application>Privoxy</application>
2116 supports the SOCKS 4 and SOCKS 4A protocols.
2119 <sect3 renderas="sect4" id="forward"><title>forward</title>
2122 <term>Specifies:</term>
2125 To which parent HTTP proxy specific requests should be routed.
2130 <term>Type of value:</term>
2133 <replaceable class="parameter">target_pattern</replaceable>
2134 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2137 where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
2138 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2139 denote <quote>all URLs</quote>.
2140 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2141 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
2142 optionally followed by its listening port (default: 8000).
2143 Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
2148 <term>Default value:</term>
2150 <para><emphasis>Unset</emphasis></para>
2154 <term>Effect if unset:</term>
2157 Don't use parent HTTP proxies.
2165 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2166 forwarded to another HTTP proxy but are made directly to the web servers.
2169 <replaceable class="parameter">http_parent</replaceable> can be a
2170 numerical IPv6 address (if
2171 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2172 implemented). To prevent clashes with the port delimiter, the whole IP
2173 address has to be put into brackets. On the other hand a <replaceable
2174 class="parameter">target_pattern</replaceable> containing an IPv6 address
2175 has to be put into angle brackets (normal brackets are reserved for
2176 regular expressions already).
2179 Multiple lines are OK, they are checked in sequence, and the last match wins.
2184 <term>Examples:</term>
2187 Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
2190 forward / parent-proxy.example.org:8080
2194 Everything goes to our example ISP's caching proxy, except for requests
2195 to that ISP's sites:
2198 forward / caching-proxy.isp.example.net:8000
2199 forward .isp.example.net .
2202 Parent proxy specified by an IPv6 address:
2205 forward / [2001:DB8::1]:8000
2208 Suppose your parent proxy doesn't support IPv6:
2211 forward / parent-proxy.example.org:8000
2212 forward ipv6-server.example.org .
2213 forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
2221 <!-- ~~~~~ New section ~~~~~ -->
2222 <sect3 renderas="sect4" id="socks"><title>
2223 forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
2224 <anchor id="forward-socks4">
2225 <anchor id="forward-socks4a">
2229 <term>Specifies:</term>
2232 Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2237 <term>Type of value:</term>
2240 <replaceable class="parameter">target_pattern</replaceable>
2241 [<replaceable class="parameter">user</replaceable>:<replaceable class="parameter">pass</replaceable>@]<replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
2242 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2245 where <replaceable class="parameter">target_pattern</replaceable> is a
2246 <link linkend="af-patterns">URL pattern</link> that specifies to which
2247 requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2248 denote <quote>all URLs</quote>. <replaceable class="parameter">http_parent</replaceable>
2249 and <replaceable class="parameter">socks_proxy</replaceable>
2250 are IP addresses in dotted decimal notation or valid DNS names
2251 (<replaceable class="parameter">http_parent</replaceable>
2252 may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
2253 <replaceable class="parameter">port</replaceable> parameters are TCP ports,
2254 i.e. integer values from 1 to 65535. <replaceable class="parameter">user</replaceable> and
2255 <replaceable class="parameter">pass</replaceable> can be used for SOCKS5 authentication if required.
2260 <term>Default value:</term>
2262 <para><emphasis>Unset</emphasis></para>
2266 <term>Effect if unset:</term>
2269 Don't use SOCKS proxies.
2277 Multiple lines are OK, they are checked in sequence, and the last match wins.
2280 The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
2281 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2282 server, while in SOCKS 4 it happens locally.
2285 With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
2288 <literal>forward-socks5t</literal> works like vanilla <literal>forward-socks5</literal> but
2289 lets &my-app; additionally use Tor-specific SOCKS extensions. Currently the only supported
2290 SOCKS extension is optimistic data which can reduce the latency for the first request made
2291 on a newly created connection.
2294 <replaceable class="parameter">socks_proxy</replaceable> and
2295 <replaceable class="parameter">http_parent</replaceable> can be a
2296 numerical IPv6 address (if
2297 <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2298 implemented). To prevent clashes with the port delimiter, the whole IP
2299 address has to be put into brackets. On the other hand a <replaceable
2300 class="parameter">target_pattern</replaceable> containing an IPv6 address
2301 has to be put into angle brackets (normal brackets are reserved for
2302 regular expressions already).
2305 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2306 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2312 <term>Examples:</term>
2315 From the company example.com, direct connections are made to all
2316 <quote>internal</quote> domains, but everything outbound goes through
2317 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2321 forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
2322 forward .example.com .
2325 A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2328 forward-socks4 / socks-gw.example.com:1080 .
2332 To connect SOCKS5 proxy which requires username/password authentication:
2335 forward-socks5 / user:pass@socks-gw.example.com:1080 .
2339 To chain Privoxy and Tor, both running on the same system, you would use
2343 forward-socks5t / 127.0.0.1:9050 .
2346 Note that if you got Tor through one of the bundles, you may
2347 have to change the port from 9050 to 9150 (or even another one).
2348 For details, please check the documentation on the
2349 <ulink url="https://torproject.org/">Tor website</ulink>.
2352 The public <application>Tor</application> network can't be used to
2353 reach your local network, if you need to access local servers you
2354 therefore might want to make some exceptions:
2357 forward 192.168.*.*/ .
2359 forward 127.*.*.*/ .
2362 Unencrypted connections to systems in these address ranges will
2363 be as (un)secure as the local network is, but the alternative is that you
2364 can't reach the local network through <application>Privoxy</application>
2365 at all. Of course this may actually be desired and there is no reason
2366 to make these exceptions if you aren't sure you need them.
2369 If you also want to be able to reach servers in your local network by
2370 using their names, you will need additional exceptions that look like
2374 forward localhost/ .
2382 <![%user-man;[ <!-- not included in config due to length -->
2383 <!-- ~~~~~ New section ~~~~~ -->
2384 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2387 If you have links to multiple ISPs that provide various special content
2388 only to their subscribers, you can configure multiple <application>Privoxies</application>
2389 which have connections to the respective ISPs to act as forwarders to each other, so that
2390 <emphasis>your</emphasis> users can see the internal content of all ISPs.
2394 Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2395 isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2396 configuration can look like this:
2405 forward .isp-b.example.net host-b:8118
2414 forward .isp-a.example.org host-a:8118
2418 Now, your users can set their browser's proxy to use either
2419 host-a or host-b and be able to browse the internal content
2420 of both isp-a and isp-b.
2424 If you intend to chain <application>Privoxy</application> and
2425 <application>squid</application> locally, then chaining as
2426 <literal>browser -> squid -> privoxy</literal> is the recommended way.
2430 Assuming that <application>Privoxy</application> and <application>squid</application>
2431 run on the same box, your <application>squid</application> configuration could then look like this:
2435 # Define Privoxy as parent proxy (without ICP)
2436 cache_peer 127.0.0.1 parent 8118 7 no-query
2438 # Define ACL for protocol FTP
2441 # Do not forward FTP requests to Privoxy
2442 always_direct allow ftp
2444 # Forward all the rest to Privoxy
2445 never_direct allow all
2449 You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2450 Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2454 You could just as well decide to only forward requests you suspect
2455 of leading to Windows executables through a virus-scanning parent proxy,
2456 say, on <literal>antivir.example.com</literal>, port 8010:
2461 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010
2467 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2470 <term>Specifies:</term>
2473 How often Privoxy retries if a forwarded connection request fails.
2478 <term>Type of value:</term>
2481 <replaceable class="parameter">Number of retries.</replaceable>
2486 <term>Default value:</term>
2488 <para><emphasis>0</emphasis></para>
2492 <term>Effect if unset:</term>
2495 Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2503 <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2504 for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2505 The connection might have failed because of a DNS timeout in which case a retry makes sense,
2506 but it might also have failed because the server doesn't exist or isn't reachable. In this
2507 case the retry will just delay the appearance of Privoxy's error message.
2510 Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2511 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2514 Only use this option, if you are getting lots of forwarding-related error messages
2515 that go away when you try again manually. Start with a small value and check Privoxy's
2516 logfile from time to time, to see how many retries are usually needed.
2521 <term>Example:</term>
2524 forwarded-connect-retries 1
2529 <![%config-file;[<literallayout>@@forwarded-connect-retries 0</literallayout>]]>
2535 <title>Miscellaneous</title>
2537 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2540 <term>Specifies:</term>
2543 Whether intercepted requests should be treated as valid.
2548 <term>Type of value:</term>
2551 <replaceable>0 or 1</replaceable>
2556 <term>Default value:</term>
2558 <para><emphasis>0</emphasis></para>
2562 <term>Effect if unset:</term>
2565 Only proxy requests are accepted, intercepted requests are treated as invalid.
2573 If you don't trust your clients and want to force them
2574 to use <application>Privoxy</application>, enable this
2575 option and configure your packet filter to redirect outgoing
2576 HTTP connections into <application>Privoxy</application>.
2579 Note that intercepting encrypted connections (HTTPS) isn't supported.
2582 Make sure that <application>Privoxy's</application> own requests
2583 aren't redirected as well. Additionally take care that
2584 <application>Privoxy</application> can't intentionally connect
2585 to itself, otherwise you could run into redirection loops if
2586 <application>Privoxy's</application> listening port is reachable
2587 by the outside or an attacker has access to the pages you visit.
2590 If you are running Privoxy as intercepting proxy without being
2591 able to intercept all client requests you may want to adjust
2592 the CGI templates to make sure they don't reference content from
2598 <term>Example:</term>
2601 accept-intercepted-requests 1
2606 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2609 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2612 <term>Specifies:</term>
2615 Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2620 <term>Type of value:</term>
2623 <replaceable>0 or 1</replaceable>
2628 <term>Default value:</term>
2630 <para><emphasis>0</emphasis></para>
2634 <term>Effect if unset:</term>
2637 <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2645 By default <application>Privoxy</application> ignores block or redirect actions
2646 for its CGI pages. Intercepting these requests can be useful in multi-user
2647 setups to implement fine-grained access control, but it can also render the complete
2648 web interface useless and make debugging problems painful if done without care.
2651 Don't enable this option unless you're sure that you really need it.
2656 <term>Example:</term>
2659 allow-cgi-request-crunching 1
2664 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2667 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2670 <term>Specifies:</term>
2673 Whether the CGI interface should stay compatible with broken HTTP clients.
2678 <term>Type of value:</term>
2681 <replaceable>0 or 1</replaceable>
2686 <term>Default value:</term>
2688 <para><emphasis>0</emphasis></para>
2692 <term>Effect if unset:</term>
2695 The CGI form generate long GET URLs.
2703 <application>Privoxy's</application> CGI forms can lead to
2704 rather long URLs. This isn't a problem as far as the HTTP
2705 standard is concerned, but it can confuse clients with arbitrary
2706 URL length limitations.
2709 Enabling split-large-forms causes <application>Privoxy</application>
2710 to divide big forms into smaller ones to keep the URL length down.
2711 It makes editing a lot less convenient and you can no longer
2712 submit all changes at once, but at least it works around this
2716 If you don't notice any editing problems, there is no reason
2717 to enable this option, but if one of the submit buttons appears
2718 to be broken, you should give it a try.
2723 <term>Example:</term>
2731 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2734 <sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
2737 <term>Specifies:</term>
2740 Number of seconds after which an open connection will no longer be reused.
2745 <term>Type of value:</term>
2748 <replaceable>Time in seconds.</replaceable>
2753 <term>Default value:</term>
2759 <term>Effect if unset:</term>
2762 Connections are not kept alive.
2770 This option allows clients to keep the connection to &my-app;
2771 alive. If the server supports it, &my-app; will keep
2772 the connection to the server alive as well. Under certain
2773 circumstances this may result in speed-ups.
2776 By default, &my-app; will close the connection to the server if
2777 the client connection gets closed, or if the specified timeout
2778 has been reached without a new request coming in. This behaviour
2779 can be changed with the <ulink
2780 url="#CONNECTION-SHARING">connection-sharing</ulink> option.
2783 This option has no effect if <application>Privoxy</application>
2784 has been compiled without keep-alive support.
2787 Note that a timeout of five seconds as used in the default
2788 configuration file significantly decreases the number of
2789 connections that will be reused. The value is used because
2790 some browsers limit the number of connections they open to
2791 a single host and apply the same limit to proxies. This can
2792 result in a single website <quote>grabbing</quote> all the
2793 connections the browser allows, which means connections to
2794 other websites can't be opened until the connections currently
2798 Several users have reported this as a Privoxy bug, so the
2799 default value has been reduced. Consider increasing it to
2800 300 seconds or even more if you think your browser can handle
2801 it. If your browser appears to be hanging, it probably can't.
2806 <term>Example:</term>
2809 keep-alive-timeout 300
2814 <![%config-file;[<literallayout>@@keep-alive-timeout 5</literallayout>]]>
2818 <sect3 renderas="sect4" id="tolerate-pipelining"><title>tolerate-pipelining</title>
2821 <term>Specifies:</term>
2824 Whether or not pipelined requests should be served.
2829 <term>Type of value:</term>
2832 <replaceable>0 or 1.</replaceable>
2837 <term>Default value:</term>
2843 <term>Effect if unset:</term>
2846 If Privoxy receives more than one request at once, it terminates the
2847 client connection after serving the first one.
2855 &my-app; currently doesn't pipeline outgoing requests,
2856 thus allowing pipelining on the client connection is not
2857 guaranteed to improve the performance.
2860 By default &my-app; tries to discourage clients from pipelining
2861 by discarding aggressively pipelined requests, which forces the
2862 client to resend them through a new connection.
2865 This option lets &my-app; tolerate pipelining. Whether or not
2866 that improves performance mainly depends on the client configuration.
2869 If you are seeing problems with pages not properly loading,
2870 disabling this option could work around the problem.
2875 <term>Example:</term>
2878 tolerate-pipelining 1
2883 <![%config-file;[<literallayout>@@tolerate-pipelining 1</literallayout>]]>
2887 <sect3 renderas="sect4" id="default-server-timeout"><title>default-server-timeout</title>
2890 <term>Specifies:</term>
2893 Assumed server-side keep-alive timeout if not specified by the server.
2898 <term>Type of value:</term>
2901 <replaceable>Time in seconds.</replaceable>
2906 <term>Default value:</term>
2912 <term>Effect if unset:</term>
2915 Connections for which the server didn't specify the keep-alive
2916 timeout are not reused.
2924 Enabling this option significantly increases the number of connections
2925 that are reused, provided the <ulink
2926 url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> option
2930 While it also increases the number of connections problems
2931 when &my-app; tries to reuse a connection that already has
2932 been closed on the server side, or is closed while &my-app;
2933 is trying to reuse it, this should only be a problem if it
2934 happens for the first request sent by the client. If it happens
2935 for requests on reused client connections, &my-app; will simply
2936 close the connection and the client is supposed to retry the
2937 request without bothering the user.
2940 Enabling this option is therefore only recommended if the
2942 url="#CONNECTION-SHARING">connection-sharing</ulink> option
2946 It is an error to specify a value larger than the <ulink
2947 url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> value.
2950 This option has no effect if <application>Privoxy</application>
2951 has been compiled without keep-alive support.
2956 <term>Example:</term>
2959 default-server-timeout 60
2964 <![%config-file;[<literallayout>@@#default-server-timeout 5</literallayout>]]>
2968 <sect3 renderas="sect4" id="connection-sharing"><title>connection-sharing</title>
2971 <term>Specifies:</term>
2974 Whether or not outgoing connections that have been kept alive
2975 should be shared between different incoming connections.
2980 <term>Type of value:</term>
2983 <replaceable>0 or 1</replaceable>
2988 <term>Default value:</term>
2994 <term>Effect if unset:</term>
2997 Connections are not shared.
3005 This option has no effect if <application>Privoxy</application>
3006 has been compiled without keep-alive support, or if it's disabled.
3014 Note that reusing connections doesn't necessary cause speedups.
3015 There are also a few privacy implications you should be aware of.
3018 If this option is enabled, outgoing connections are shared between
3019 clients (if there are more than one) and closing the browser that initiated
3020 the outgoing connection does not affect the connection between &my-app;
3021 and the server unless the client's request hasn't been completed yet.
3024 If the outgoing connection is idle, it will not be closed until either
3025 <application>Privoxy's</application> or the server's timeout is reached.
3026 While it's open, the server knows that the system running &my-app; is still
3030 If there are more than one client (maybe even belonging to multiple users),
3031 they will be able to reuse each others connections. This is potentially
3032 dangerous in case of authentication schemes like NTLM where only the
3033 connection is authenticated, instead of requiring authentication for
3037 If there is only a single client, and if said client can keep connections
3038 alive on its own, enabling this option has next to no effect. If the client
3039 doesn't support connection keep-alive, enabling this option may make sense
3040 as it allows &my-app; to keep outgoing connections alive even if the client
3041 itself doesn't support it.
3044 You should also be aware that enabling this option increases the likelihood
3045 of getting the "No server or forwarder data" error message, especially if you
3046 are using a slow connection to the Internet.
3049 This option should only be used by experienced users who
3050 understand the risks and can weight them against the benefits.
3055 <term>Example:</term>
3058 connection-sharing 1
3063 <![%config-file;[<literallayout>@@#connection-sharing 1</literallayout>]]>
3067 <sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
3070 <term>Specifies:</term>
3073 Number of seconds after which a socket times out if
3074 no data is received.
3079 <term>Type of value:</term>
3082 <replaceable>Time in seconds.</replaceable>
3087 <term>Default value:</term>
3093 <term>Effect if unset:</term>
3096 A default value of 300 seconds is used.
3104 The default is quite high and you probably want to reduce it.
3105 If you aren't using an occasionally slow proxy like Tor, reducing
3106 it to a few seconds should be fine.
3110 When a TLS library is being used to read or write data from a socket with
3111 <literal><ulink url="actions-file.html#HTTPS-INSPECTION">https-inspection</ulink></literal>
3112 enabled the socket-timeout currently isn't applied and the timeout
3113 used depends on the library (which may not even use a timeout).
3119 <term>Example:</term>
3127 <![%config-file;[<literallayout>@@socket-timeout 300</literallayout>]]>
3131 <sect3 renderas="sect4" id="max-client-connections"><title>max-client-connections</title>
3134 <term>Specifies:</term>
3137 Maximum number of client connections that will be served.
3142 <term>Type of value:</term>
3145 <replaceable>Positive number.</replaceable>
3150 <term>Default value:</term>
3159 Connections are served until a resource limit is reached.
3162 &my-app; creates one thread (or process) for every incoming client
3163 connection that isn't rejected based on the access control settings.
3166 If the system is powerful enough, &my-app; can theoretically deal with
3167 several hundred (or thousand) connections at the same time, but some
3168 operating systems enforce resource limits by shutting down offending
3169 processes and their default limits may be below the ones &my-app; would
3170 require under heavy load.
3173 Configuring &my-app; to enforce a connection limit below the thread
3174 or process limit used by the operating system makes sure this doesn't
3175 happen. Simply increasing the operating system's limit would work too,
3176 but if &my-app; isn't the only application running on the system,
3177 you may actually want to limit the resources used by &my-app;.
3180 If &my-app; is only used by a single trusted user, limiting the
3181 number of client connections is probably unnecessary. If there
3182 are multiple possibly untrusted users you probably still want to
3183 additionally use a packet filter to limit the maximal number of
3184 incoming connections per client. Otherwise a malicious user could
3185 intentionally create a high number of connections to prevent other
3186 users from using &my-app;.
3189 Obviously using this option only makes sense if you choose a limit
3190 below the one enforced by the operating system.
3193 One most POSIX-compliant systems &my-app; can't properly deal with
3194 more than FD_SETSIZE file descriptors if &my-app; has been configured
3195 to use select() and has to reject connections if the limit is reached.
3196 When using select() this limit therefore can't be increased without
3197 recompiling &my-app; with a different FD_SETSIZE limit unless &my-app;
3198 is running on Windows with _WIN32 defined.
3201 When &my-app; has been configured to use poll() the FD_SETSIZE limit
3207 <term>Example:</term>
3210 max-client-connections 256
3215 <![%config-file;[<literallayout>@@#max-client-connections 256</literallayout>]]>
3219 <sect3 renderas="sect4" id="listen-backlog"><title>listen-backlog</title>
3222 <term>Specifies:</term>
3225 Connection queue length requested from the operating system.
3230 <term>Type of value:</term>
3233 <replaceable>Number.</replaceable>
3238 <term>Default value:</term>
3244 <term>Effect if unset:</term>
3247 A connection queue length of 128 is requested from the operating system.
3255 Under high load incoming connection may queue up before Privoxy
3256 gets around to serve them. The queue length is limited by the
3257 operating system. Once the queue is full, additional connections
3258 are dropped before Privoxy can accept and serve them.
3261 Increasing the queue length allows Privoxy to accept more
3262 incoming connections that arrive roughly at the same time.
3265 Note that Privoxy can only request a certain queue length,
3266 whether or not the requested length is actually used depends
3267 on the operating system which may use a different length instead.
3270 On many operating systems a limit of -1 can be specified to
3271 instruct the operating system to use the maximum queue length
3272 allowed. Check the listen man page to see if your platform allows this.
3275 On some platforms you can use "netstat -Lan -p tcp" to see the effective
3279 Effectively using a value above 128 usually requires changing
3280 the system configuration as well. On FreeBSD-based system the
3281 limit is controlled by the kern.ipc.soacceptqueue sysctl.
3286 <term>Example:</term>
3294 <![%config-file;[<literallayout>@@#listen-backlog -1</literallayout>]]>
3298 <sect3 renderas="sect4" id="enable-accept-filter"><title>enable-accept-filter</title>
3301 <term>Specifies:</term>
3304 Whether or not Privoxy should use an accept filter
3309 <term>Type of value:</term>
3312 <replaceable>0 or 1</replaceable>
3317 <term>Default value:</term>
3323 <term>Effect if unset:</term>
3326 No accept filter is enabled.
3334 Accept filters reduce the number of context switches by not
3335 passing sockets for new connections to Privoxy until a complete
3336 HTTP request is available.
3339 As a result, Privoxy can process the whole request right away
3340 without having to wait for additional data first.
3343 For this option to work, Privoxy has to be compiled with
3344 FEATURE_ACCEPT_FILTER and the operating system has to support
3345 it (which may require loading a kernel module).
3348 Currently accept filters are only supported on FreeBSD-based
3350 <ulink url="https://www.freebsd.org/cgi/man.cgi?query=accf_http">accf_http(9)
3352 to learn how to enable the support in the operating system.
3357 <term>Example:</term>
3360 enable-accept-filter 1
3365 <![%config-file;[<literallayout>@@#enable-accept-filter 1</literallayout>]]>
3369 <sect3 renderas="sect4" id="handle-as-empty-doc-returns-ok"><title>handle-as-empty-doc-returns-ok</title>
3372 <term>Specifies:</term>
3375 The status code Privoxy returns for pages blocked with
3376 <!-- URL will only end up in the user manual so the relative link should work. -->
3377 <literal><ulink url="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">+handle-as-empty-document</ulink></literal>.
3382 <term>Type of value:</term>
3385 <replaceable>0 or 1</replaceable>
3390 <term>Default value:</term>
3396 <term>Effect if unset:</term>
3399 Privoxy returns a status 403(forbidden) for all blocked pages.
3404 <term>Effect if set:</term>
3407 Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
3408 and a status 403(Forbidden) for all other blocked pages.
3416 This directive was added as a work-around for Firefox bug 492459:
3417 <quote>Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.</quote>
3418 (<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=492459">
3419 https://bugzilla.mozilla.org/show_bug.cgi?id=492459</ulink>),
3420 the bug has been fixed for quite some time, but this directive is also useful
3421 to make it harder for websites to detect whether or not resources are being
3427 <![%config-file;[<literallayout>@@#handle-as-empty-doc-returns-ok 1</literallayout>]]>
3431 <sect3 renderas="sect4" id="enable-compression"><title>enable-compression</title>
3434 <term>Specifies:</term>
3437 Whether or not buffered content is compressed before delivery.
3442 <term>Type of value:</term>
3445 <replaceable>0 or 1</replaceable>
3450 <term>Default value:</term>
3456 <term>Effect if unset:</term>
3459 Privoxy does not compress buffered content.
3464 <term>Effect if set:</term>
3467 Privoxy compresses buffered content before delivering it to the client,
3468 provided the client supports it.
3476 This directive is only supported if Privoxy has been compiled with
3477 FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB.
3480 Compressing buffered content is mainly useful if Privoxy and the
3481 client are running on different systems. If they are running on the
3482 same system, enabling compression is likely to slow things down.
3483 If you didn't measure otherwise, you should assume that it does
3484 and keep this option disabled.
3487 Privoxy will not compress buffered content below a certain length.
3492 <![%config-file;[<literallayout>@@#enable-compression 1</literallayout>]]>
3496 <sect3 renderas="sect4" id="compression-level"><title>compression-level</title>
3499 <term>Specifies:</term>
3502 The compression level that is passed to the zlib library when compressing buffered content.
3507 <term>Type of value:</term>
3510 <replaceable>Positive number ranging from 0 to 9.</replaceable>
3515 <term>Default value:</term>
3524 Compressing the data more takes usually longer than compressing
3525 it less or not compressing it at all. Which level is best depends
3526 on the connection between Privoxy and the client. If you can't
3527 be bothered to benchmark it for yourself, you should stick with
3528 the default and keep compression disabled.
3531 If compression is disabled, the compression level is irrelevant.
3536 <term>Examples:</term>
3539 # Best speed (compared to the other levels)
3545 # No compression. Only useful for testing as the added header
3546 # slightly increases the amount of data that has to be sent.
3547 # If your benchmark shows that using this compression level
3548 # is superior to using no compression at all, the benchmark
3549 # is likely to be flawed.
3555 <![%config-file;[<literallayout>@@#compression-level 1</literallayout>]]>
3559 <sect3 renderas="sect4" id="client-header-order"><title>client-header-order</title>
3562 <term>Specifies:</term>
3565 The order in which client headers are sorted before forwarding them.
3570 <term>Type of value:</term>
3573 <replaceable>Client header names delimited by spaces or tabs</replaceable>
3578 <term>Default value:</term>
3587 By default &my-app; leaves the client headers in the order they
3588 were sent by the client. Headers are modified in-place, new headers
3589 are added at the end of the already existing headers.
3592 The header order can be used to fingerprint client requests
3593 independently of other headers like the User-Agent.
3596 This directive allows to sort the headers differently to better
3597 mimic a different User-Agent. Client headers will be emitted
3598 in the order given, headers whose name isn't explicitly specified
3599 are added at the end.
3602 Note that sorting headers in an uncommon way will make fingerprinting
3604 Encrypted headers are not affected by this directive unless
3605 <literal><ulink url="actions-file.html#HTTPS-INSPECTION">https-inspection</ulink></literal>
3611 <![%config-file;[<literallayout>@@#client-header-order Host \
3622 Upgrade-Insecure-Requests \
3632 <sect3 renderas="sect4" id="client-specific-tag"><title>client-specific-tag</title>
3635 <term>Specifies:</term>
3638 The name of a tag that will always be set for clients that
3639 requested it through the webinterface.
3644 <term>Type of value:</term>
3647 <replaceable>Tag name followed by a description that will be shown in the webinterface</replaceable>
3652 <term>Default value:</term>
3661 Client-specific tags allow Privoxy admins to create different
3662 profiles and let the users chose which one they want without
3663 impacting other users.
3666 One use case is allowing users to circumvent certain blocks
3667 without having to allow them to circumvent all blocks.
3668 This is not possible with the
3669 <link linkend="enable-remote-toggle">enable-remote-toggle feature</link>
3670 because it would bluntly disable all blocks for all users and also affect
3671 other actions like filters.
3672 It also is set globally which renders it useless in most multi-user setups.
3675 After a client-specific tag has been defined with the client-specific-tag
3676 directive, action sections can be activated based on the tag by using a
3677 <ulink url="actions-file.html#CLIENT-TAG-PATTERN">CLIENT-TAG</ulink> pattern.
3678 The CLIENT-TAG pattern is evaluated at the same priority
3679 as URL patterns, as a result the last matching pattern wins.
3680 Tags that are created based on client or server headers are evaluated
3681 later on and can overrule CLIENT-TAG and URL patterns!
3684 The tag is set for all requests that come from clients that requested
3686 Note that "clients" are differentiated by IP address,
3687 if the IP address changes the tag has to be requested again.
3690 Clients can request tags to be set by using the CGI interface <ulink
3691 url="http://config.privoxy.org/client-tags">http://config.privoxy.org/client-tags</ulink>.
3692 The specific tag description is only used on the web page and should
3693 be phrased in away that the user understands the effect of the tag.
3698 <term>Examples:</term>
3701 # Define a couple of tags, the described effect requires action sections
3702 # that are enabled based on CLIENT-TAG patterns.
3703 client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
3704 client-specific-tag disable-content-filters Disable content-filters but do not affect other actions
3705 client-specific-tag overrule-redirects Overrule redirect sections
3706 client-specific-tag allow-cookies Do not crunch cookies in either direction
3707 client-specific-tag change-tor-socks-port Change forward-socks5 settings to use a different Tor socks port (and circuits)
3708 client-specific-tag no-https-inspection Disable HTTPS inspection
3709 client-specific-tag no-tls-verification Don't verify certificates when http-inspection is enabled
3716 <!-- ~ End section ~ -->
3718 <sect3 renderas="sect4" id="client-tag-lifetime"><title>client-tag-lifetime</title>
3721 <term>Specifies:</term>
3724 How long a temporarily enabled tag remains enabled.
3729 <term>Type of value:</term>
3732 <replaceable>Time in seconds.</replaceable>
3737 <term>Default value:</term>
3746 In case of some tags users may not want to enable them permanently,
3747 but only for a short amount of time, for example to circumvent a block
3748 that is the result of an overly-broad URL pattern.
3751 The CGI interface <ulink
3752 url="http://config.privoxy.org/client-tags">http://config.privoxy.org/client-tags</ulink>
3753 therefore provides a "enable this tag temporarily" option.
3754 If it is used, the tag will be set until the client-tag-lifetime
3760 <term>Example:</term>
3763 # Increase the time to life for temporarily enabled tags to 3 minutes
3764 client-tag-lifetime 180
3771 <!-- ~ End section ~ -->
3773 <sect3 renderas="sect4" id="trust-x-forwarded-for"><title>trust-x-forwarded-for</title>
3776 <term>Specifies:</term>
3779 Whether or not Privoxy should use IP addresses specified with the X-Forwarded-For header
3784 <term>Type of value:</term>
3787 <replaceable>0 or one</replaceable>
3792 <term>Default value:</term>
3801 If clients reach Privoxy through another proxy, for example a load
3802 balancer, Privoxy can't tell the client's IP address from the connection.
3803 If multiple clients use the same proxy, they will share the same
3804 client tag settings which is usually not desired.
3807 This option lets Privoxy use the X-Forwarded-For header value as
3808 client IP address. If the proxy sets the header, multiple clients
3809 using the same proxy do not share the same client tag settings.
3812 This option should only be enabled if Privoxy can only be reached
3813 through a proxy and if the proxy can be trusted to set the header
3814 correctly. It is recommended that ACL are used to make sure only
3815 trusted systems can reach Privoxy.
3818 If access to Privoxy isn't limited to trusted systems, this option
3819 would allow malicious clients to change the client tags for other
3820 clients or increase Privoxy's memory requirements by registering
3821 lots of client tag settings for clients that don't exist.
3826 <term>Example:</term>
3829 # Allow systems that can reach Privoxy to provide the client
3830 # IP address with a X-Forwarded-For header.
3831 trust-x-forwarded-for 1
3838 <!-- ~ End section ~ -->
3840 <!-- ~~~~~ New section ~~~~~ -->
3842 <sect3 renderas="sect4" id="receive-buffer-size"><title>receive-buffer-size</title>
3845 <term>Specifies:</term>
3848 The size of the buffer Privoxy uses to receive data from the server.
3853 <term>Type of value:</term>
3856 <replaceable>Size in bytes</replaceable>
3861 <term>Default value:</term>
3870 Increasing the receive-buffer-size increases Privoxy's memory usage but
3871 can lower the number of context switches and thereby reduce the
3872 cpu usage and potentially increase the throughput.
3875 This is mostly relevant for fast network connections and
3876 large downloads that don't require filtering.
3879 Reducing the buffer size reduces the amount of memory Privoxy
3880 needs to handle the request but increases the number of systemcalls
3881 and may reduce the throughput.
3884 A dtrace command like:
3885 <quote>sudo dtrace -n 'syscall::read:return /execname == "privoxy"/ { @[execname] = llquantize(arg0, 10, 0, 5, 20); @m = max(arg0)}'</quote>
3886 can be used to properly tune the receive-buffer-size.
3887 On systems without dtrace, strace or truss may be used as
3888 less convenient alternatives.
3891 If the buffer is too large it will increase Privoxy's memory
3892 footprint without any benefit. As the memory is (currently)
3893 cleared before using it, a buffer that is too large can
3894 actually reduce the throughput.
3899 <term>Example:</term>
3902 # Increase the receive buffer size
3903 receive-buffer-size 32768
3910 <!-- ~ End section ~ -->
3915 <sect2 id="https-inspection-directives">
3916 <title>HTTPS Inspection (Experimental)</title>
3919 HTTPS inspection allows to filter encrypted requests and responses.
3920 This is only supported when <application>Privoxy</application>
3921 has been built with FEATURE_HTTPS_INSPECTION.
3922 If you aren't sure if your version supports it, have a look at
3923 <ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>.
3926 <!-- ~~~~~ New section ~~~~~ -->
3928 <sect3 renderas="sect4" id="ca-directory"><title>ca-directory</title>
3931 <term>Specifies:</term>
3934 Directory with the CA key, the CA certificate and the trusted CAs file.
3939 <term>Type of value:</term>
3947 <term>Default value:</term>
3949 <para><emphasis>./CA</emphasis></para>
3953 <term>Effect if unset:</term>
3956 Default value is used.
3964 This directive specifies the directory where the
3965 CA key, the CA certificate and the trusted CAs file
3969 The permissions should only let &my-app; and the &my-app;
3970 admin access the directory.
3975 <term>Example:</term>
3978 ca-directory /usr/local/etc/privoxy/CA
3983 <![%config-file;[<literallayout>@@#ca-directory /usr/local/etc/privoxy/CA</literallayout>]]>
3986 <!-- ~ End section ~ -->
3988 <!-- ~~~~~ New section ~~~~~ -->
3990 <sect3 renderas="sect4" id="ca-cert-file"><title>ca-cert-file</title>
3993 <term>Specifies:</term>
3996 The CA certificate file in ".crt" format.
4001 <term>Type of value:</term>
4009 <term>Default value:</term>
4011 <para><emphasis>cacert.crt</emphasis></para>
4015 <term>Effect if unset:</term>
4018 Default value is used.
4026 This directive specifies the name of the CA certificate file
4030 The file is used by &my-app; to generate website certificates
4031 when https inspection is enabled with the
4032 <literal><ulink url="actions-file.html#HTTPS-INSPECTION">https-inspection</ulink></literal>
4036 &my-app; clients should import the certificate so that they
4037 can validate the generated certificates.
4040 The file can be generated with:
4041 <command>openssl req -new -x509 -extensions v3_ca -keyout cakey.pem -out cacert.crt -days 3650</command>
4046 <term>Example:</term>
4049 ca-cert-file root.crt
4054 <![%config-file;[<literallayout>@@#ca-cert-file cacert.crt</literallayout>]]>
4057 <!-- ~ End section ~ -->
4059 <!-- ~~~~~ New section ~~~~~ -->
4061 <sect3 renderas="sect4" id="ca-key-file"><title>ca-key-file</title>
4064 <term>Specifies:</term>
4067 The CA key file in ".pem" format.
4072 <term>Type of value:</term>
4080 <term>Default value:</term>
4082 <para><emphasis>cacert.pem</emphasis></para>
4086 <term>Effect if unset:</term>
4089 Default value is used.
4097 This directive specifies the name of the CA key file in ".pem" format.
4098 The <ulink url="#CA-CERT-FILE">ca-cert-file section</ulink> contains
4099 a command to generate it.
4102 The CA key is used by &my-app; to sign generated certificates.
4105 Access to the key should be limited to Privoxy.
4110 <term>Example:</term>
4113 ca-key-file cakey.pem
4118 <![%config-file;[<literallayout>@@#ca-key-file cakey.pem</literallayout>]]>
4121 <!-- ~ End section ~ -->
4123 <!-- ~~~~~ New section ~~~~~ -->
4125 <sect3 renderas="sect4" id="ca-password"><title>ca-password</title>
4128 <term>Specifies:</term>
4131 The password for the CA keyfile.
4136 <term>Type of value:</term>
4144 <term>Default value:</term>
4146 <para><emphasis>Empty string</emphasis></para>
4150 <term>Effect if unset:</term>
4153 Default value is used.
4161 This directive specifies the password for the CA keyfile
4162 that is used when Privoxy generates certificates for intercepted
4167 Note that the password is shown on the CGI page so don't
4168 reuse an important one.
4171 If disclosure of the password is a compliance issue consider blocking
4172 the relevant CGI requests after enabling the <link linkend="enforce-blocks">enforce-blocks</link>
4173 and <link linkend="allow-cgi-request-crunching">allow-cgi-request-crunching</link>.
4179 <term>Example:</term>
4182 ca-password blafasel
4187 <![%config-file;[<literallayout>@@#ca-password swordfish</literallayout>]]>
4190 <!-- ~ End section ~ -->
4192 <!-- ~~~~~ New section ~~~~~ -->
4194 <sect3 renderas="sect4" id="certificate-directory"><title>certificate-directory</title>
4197 <term>Specifies:</term>
4200 Directory to save generated keys and certificates.
4205 <term>Type of value:</term>
4213 <term>Default value:</term>
4215 <para><emphasis>./certs</emphasis></para>
4219 <term>Effect if unset:</term>
4222 Default value is used.
4230 This directive specifies the directory where generated
4231 TLS/SSL keys and certificates are saved when https inspection
4233 <literal><ulink url="actions-file.html#HTTPS-INSPECTION">https-inspection</ulink></literal>
4237 The keys and certificates currently have to be deleted manually
4238 when changing the <ulink url="#CA-CERT-FILE">ca-cert-file</ulink>
4239 and the <ulink url="#CA-CERT-KEY">ca-cert-key</ulink>.
4242 The permissions should only let &my-app; and the &my-app;
4243 admin access the directory.
4247 &my-app; currently does not garbage-collect obsolete keys
4248 and certificates and does not keep track of how may keys
4249 and certificates exist.
4252 &my-app; admins should monitor the size of the directory
4253 and/or make sure there is sufficient space available.
4254 A cron job to limit the number of keys and certificates
4255 to a certain number may be worth considering.
4261 <term>Example:</term>
4264 certificate-directory /usr/local/var/privoxy/certs
4269 <![%config-file;[<literallayout>@@#certificate-directory /usr/local/var/privoxy/certs</literallayout>]]>
4272 <!-- ~ End section ~ -->
4274 <!-- ~~~~~ New section ~~~~~ -->
4276 <sect3 renderas="sect4" id="cipher-list"><title>cipher-list</title>
4279 <term>Specifies:</term>
4282 A list of ciphers to use in TLS handshakes
4287 <term>Type of value:</term>
4295 <term>Default value:</term>
4301 <term>Effect if unset:</term>
4304 A default value is inherited from the TLS library.
4312 This directive allows to specify a non-default list of ciphers to use
4313 in TLS handshakes with clients and servers.
4316 Ciphers are separated by colons. Which ciphers are supported
4317 depends on the TLS library. When using OpenSSL, unsupported ciphers
4318 are skipped. When using MbedTLS they are rejected.
4322 Specifying an unusual cipher list makes fingerprinting easier.
4323 Note that the default list provided by the TLS library may
4324 be unusual when compared to the one used by modern browsers
4331 <term>Examples:</term>
4334 # Explicitly set a couple of ciphers with names used by MbedTLS
4335 cipher-list cipher-list TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256:\
4336 TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256:\
4337 TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256:\
4338 TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256:\
4339 TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384:\
4340 TLS-ECDHE-ECDSA-WITH-AES-256-CCM:\
4341 TLS-ECDHE-ECDSA-WITH-AES-256-CCM-8:\
4342 TLS-ECDHE-ECDSA-WITH-AES-128-CCM:\
4343 TLS-ECDHE-ECDSA-WITH-AES-128-CCM-8:\
4344 TLS-ECDHE-ECDSA-WITH-CAMELLIA-128-GCM-SHA256:\
4345 TLS-ECDHE-ECDSA-WITH-CAMELLIA-256-GCM-SHA384:\
4346 TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256:\
4347 TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384:\
4348 TLS-ECDHE-RSA-WITH-CAMELLIA-128-GCM-SHA256:\
4349 TLS-ECDHE-RSA-WITH-CAMELLIA-256-GCM-SHA384:\
4350 TLS-DHE-RSA-WITH-AES-256-GCM-SHA384:\
4351 TLS-DHE-RSA-WITH-AES-128-GCM-SHA256:\
4352 TLS-DHE-RSA-WITH-AES-256-CCM:\
4353 TLS-DHE-RSA-WITH-AES-256-CCM-8:\
4354 TLS-DHE-RSA-WITH-AES-128-CCM:\
4355 TLS-DHE-RSA-WITH-AES-128-CCM-8:\
4356 TLS-DHE-RSA-WITH-CAMELLIA-128-GCM-SHA256:\
4357 TLS-DHE-RSA-WITH-CAMELLIA-256-GCM-SHA384:\
4358 TLS-ECDH-RSA-WITH-AES-128-GCM-SHA256:\
4359 TLS-ECDH-RSA-WITH-AES-256-GCM-SHA384:\
4360 TLS-ECDH-RSA-WITH-CAMELLIA-128-GCM-SHA256:\
4361 TLS-ECDH-RSA-WITH-CAMELLIA-256-GCM-SHA384:\
4362 TLS-ECDH-ECDSA-WITH-AES-128-GCM-SHA256:\
4363 TLS-ECDH-ECDSA-WITH-AES-256-GCM-SHA384:\
4364 TLS-ECDH-ECDSA-WITH-CAMELLIA-128-GCM-SHA256:\
4365 TLS-ECDH-ECDSA-WITH-CAMELLIA-256-GCM-SHA384
4368 # Explicitly set a couple of ciphers with names used by OpenSSL
4369 cipher-list ECDHE-RSA-AES256-GCM-SHA384:\
4370 ECDHE-ECDSA-AES256-GCM-SHA384:\
4371 DH-DSS-AES256-GCM-SHA384:\
4372 DHE-DSS-AES256-GCM-SHA384:\
4373 DH-RSA-AES256-GCM-SHA384:\
4374 DHE-RSA-AES256-GCM-SHA384:\
4375 ECDH-RSA-AES256-GCM-SHA384:\
4376 ECDH-ECDSA-AES256-GCM-SHA384:\
4377 ECDHE-RSA-AES128-GCM-SHA256:\
4378 ECDHE-ECDSA-AES128-GCM-SHA256:\
4379 DH-DSS-AES128-GCM-SHA256:\
4380 DHE-DSS-AES128-GCM-SHA256:\
4381 DH-RSA-AES128-GCM-SHA256:\
4382 DHE-RSA-AES128-GCM-SHA256:\
4383 ECDH-RSA-AES128-GCM-SHA256:\
4384 ECDH-ECDSA-AES128-GCM-SHA256:\
4385 ECDHE-RSA-AES256-GCM-SHA384:\
4389 # Use keywords instead of explicitly naming the ciphers (Does not work with MbedTLS)
4390 cipher-list ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
4397 <!-- ~ End section ~ -->
4399 <!-- ~~~~~ New section ~~~~~ -->
4401 <sect3 renderas="sect4" id="trusted-cas-file"><title>trusted-cas-file</title>
4404 <term>Specifies:</term>
4407 The trusted CAs file in ".pem" format.
4412 <term>Type of value:</term>
4415 File name relative to ca-directory
4420 <term>Default value:</term>
4422 <para><emphasis>trustedCAs.pem</emphasis></para>
4426 <term>Effect if unset:</term>
4429 Default value is used.
4437 This directive specifies the trusted CAs file that is used when validating
4438 certificates for intercepted TLS/SSL requests.
4441 An example file can be downloaded from
4442 <ulink url="https://curl.se/ca/cacert.pem">https://curl.se/ca/cacert.pem</ulink>.
4443 If you want to create the file yourself, please see:
4444 <ulink url="https://curl.se/docs/caextract.html">https://curl.se/docs/caextract.html</ulink>.
4449 <term>Example:</term>
4452 trusted-cas-file trusted_cas_file.pem
4457 <![%config-file;[<literallayout>@@#trusted-cas-file trustedCAs.pem</literallayout>]]>
4460 <!-- ~ End section ~ -->
4464 <!-- ~~~~~ New section ~~~~~ -->
4466 <sect2 id="windows-gui">
4467 <title>Windows GUI Options</title>
4469 <application>Privoxy</application> has a number of options specific to the
4470 Windows GUI interface:
4473 <anchor id="activity-animation">
4474 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
4476 If <quote>activity-animation</quote> is set to 1, the
4477 <application>Privoxy</application> icon will animate when
4478 <quote>Privoxy</quote> is active. To turn off, set to 0.
4481 <![%config-file;[<literallayout>@@#activity-animation 1</literallayout>]]>
4484 <emphasis>activity-animation 1</emphasis>
4488 <anchor id="log-messages">
4489 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
4491 If <quote>log-messages</quote> is set to 1,
4492 <application>Privoxy</application> copies log messages to the console
4494 The log detail depends on the <link linkend="debug">debug</link> directive.
4497 <![%config-file;[<literallayout>@@#log-messages 1</literallayout>]]>
4500 <emphasis>log-messages 1</emphasis>
4504 <anchor id="log-buffer-size">
4505 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
4507 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
4508 i.e. the amount of memory used for the log messages displayed in the
4509 console window, will be limited to <quote>log-max-lines</quote> (see below).
4513 Warning: Setting this to 0 will result in the buffer to grow infinitely and
4514 eat up all your memory!
4517 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
4520 <emphasis>log-buffer-size 1</emphasis>
4524 <anchor id="log-max-lines">
4525 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
4527 <application>log-max-lines</application> is the maximum number of lines held
4528 in the log buffer. See above.
4531 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
4534 <emphasis>log-max-lines 200</emphasis>
4538 <anchor id="log-highlight-messages">
4539 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
4541 If <quote>log-highlight-messages</quote> is set to 1,
4542 <application>Privoxy</application> will highlight portions of the log
4543 messages with a bold-faced font:
4546 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
4549 <emphasis>log-highlight-messages 1</emphasis>
4553 <anchor id="log-font-name">
4554 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
4556 The font used in the console window:
4559 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
4562 <emphasis>log-font-name Comic Sans MS</emphasis>
4566 <anchor id="log-font-size">
4567 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
4569 Font size used in the console window:
4572 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
4575 <emphasis>log-font-size 8</emphasis>
4579 <anchor id="show-on-task-bar">
4580 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
4582 <quote>show-on-task-bar</quote> controls whether or not
4583 <application>Privoxy</application> will appear as a button on the Task bar
4587 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
4590 <emphasis>show-on-task-bar 0</emphasis>
4594 <anchor id="close-button-minimizes">
4595 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
4597 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
4598 button will minimize <application>Privoxy</application> instead of closing
4599 the program (close with the exit option on the File menu).
4602 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
4605 <emphasis>close-button-minimizes 1</emphasis>
4609 <anchor id="hide-console">
4610 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
4612 The <quote>hide-console</quote> option is specific to the MS-Win console
4613 version of <application>Privoxy</application>. If this option is used,
4614 <application>Privoxy</application> will disconnect from and hide the
4618 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
4621 #<emphasis>hide-console</emphasis>
4628 <!-- end config content common to both outputs -->
4631 <!-- These are dummy anchors to keep the processor quiet -->
4632 <!-- when building config-file only (ie. they are used in u-m only) -->
4635 <anchor id="filter">
4636 <anchor id="filter-file">
4638 <anchor id="actions-file">
4639 <anchor id="af-patterns">
4643 <!-- eof p-config.sgml -->
projects / privoxy.git / blob