2 File : $Source: /cvsroot/ijbswa/current/doc/source/p-config.sgml,v $
4 Purpose : Used with other docs and files only.
6 $Id: p-config.sgml,v 2.6 2006/09/02 12:49:37 hal9 Exp $
8 Copyright (C) 2001-2006 Privoxy Developers <developers@privoxy.org>
11 ========================================================================
12 NOTE: Please read developer-manual/documentation.html before touching
13 anything in this, or other Privoxy documentation.
14 ========================================================================
17 This file contains all the config file comments and options. It used to
18 build both the user-manual config sections, and all of config (yes, the main
21 Rationale: This is broken up into two files since a file with a prolog
22 (DTD, etc) cannot be sourced as a secondary file. config.sgml is basically
23 a wrapper for this file.
27 OPTIONS: The actual options are included in this file and prefixed with
28 '@@', and processed by the Makefile to strip the '@@'. Default options
29 that should appear commented out should be listed as: '@@#OPTION'.
30 Otherwise, as '@@OPTION'. Example:
32 @@listen-address 127.0.0.1:8118
34 The Makefile does significant other processing too. The final results
35 should be checked to make sure that the perl processing does not
36 fubar something!!! Makefile processing requires w3m, fmt (shell line
40 This file is included into:
43 config (the actual Privoxy config file)
48 <!-- This part only goes into user-manual -->
50 <title>The Main Configuration File</title>
53 Again, the main configuration file is named <filename>config</filename> on
54 Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
55 Configuration lines consist of an initial keyword followed by a list of
56 values, all separated by whitespace (any number of spaces or tabs). For
64 <emphasis>confdir /etc/privoxy</emphasis></literallayout>
70 Assigns the value <literal>/etc/privoxy</literal> to the option
71 <literal>confdir</literal> and thus indicates that the configuration
72 directory is named <quote>/etc/privoxy/</quote>.
76 All options in the config file except for <literal>confdir</literal> and
77 <literal>logdir</literal> are optional. Watch out in the below description
78 for what happens if you leave them unset.
82 The main config file controls all aspects of <application>Privoxy</application>'s
83 operation that are not location dependent (i.e. they apply universally, no matter
84 where you may be surfing).
91 <!-- This part only goes into the config file -->
94 @@TITLE<!-- between the @@ is stripped by Makefile -->@@
95 Sample Configuration File for Privoxy v&p-version;
98 $Id: p-config.sgml,v 2.6 2006/09/02 12:49:37 hal9 Exp $
101 Copyright (C) 2001-2006 Privoxy Developers http://privoxy.org
106 #################################################################
111 II. FORMAT OF THE CONFIGURATION FILE #
113 1. CONFIGURATION AND LOG FILE LOCATIONS #
114 2. LOCAL SET-UP DOCUMENTATION #
116 4. ACCESS CONTROL AND SECURITY #
118 6. WINDOWS GUI OPTIONS #
120 #################################################################
124 <literallayout>I. INTRODUCTION
125 =============== <!-- fuck this madness --></literallayout>
128 This file holds the Privoxy configuration. If you modify this
129 file, you will need to send a couple of requests (of any kind) to the proxy
130 before any changes take effect.
133 When starting Privoxy on Unix systems, give the name of this
134 file as an argument. On Windows systems, Privoxy will look for
135 this file with the name 'config.txt' in the same directory where
136 Privoxy is installed.
140 <literallayout><!-- funky spacing -->
142 II. FORMAT OF THE CONFIGURATION FILE
143 ====================================</literallayout>
146 Configuration lines consist of an initial keyword followed by a list
147 of values, all separated by whitespace (any number of spaces or
151 actionsfile default.action
154 Indicates that the actionsfile is named 'default.action'.
157 The '#' indicates a comment. Any part of a line following a '#' is
158 ignored, except if the '#' is preceded by a '\'.
161 Thus, by placing a # at the start of an existing configuration line,
162 you can make it a comment and it will be treated as if it weren't there.
163 This is called "commenting out" an option and can be useful.
166 Note that commenting out and option and leaving it at its default
167 are two completely different things! Most options behave very
168 differently when unset. See the 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 <!-- ************************************************ -->
182 <!-- ~~~~~ New section ~~~~~ -->
184 <sect2 id="conf-log-loc">
185 <title>Configuration and Log File Locations</title>
188 <application>Privoxy</application> can (and normally does) use a number of
189 other files for additional configuration, help and logging.
190 This section of the configuration file tells <application>Privoxy</application>
191 where to find those other files.
195 The user running <application>Privoxy</application>, must have read
196 permission for all configuration files, and write permission to any files
197 that would be modified, such as log files and actions files.
201 <!-- ~~~~~ New section ~~~~~ -->
202 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
206 <term>Specifies:</term>
208 <para>The directory where the other configuration files are located</para>
212 <term>Type of value:</term>
214 <para>Path name</para>
218 <term>Default value:</term>
220 <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
224 <term>Effect if unset:</term>
226 <para><emphasis>Mandatory</emphasis></para>
233 No trailing <quote><literal>/</literal></quote>, please
236 When development goes modular and multi-user, the blocker, filter, and
237 per-user config will be stored in subdirectories of <quote>confdir</quote>.
238 For now, the configuration directory structure is flat, except for
239 <filename>confdir/templates</filename>, where the HTML templates for CGI
240 output reside (e.g. <application>Privoxy's</application> 404 error page).
246 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
250 <!-- ~~~~~ New section ~~~~~ -->
251 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
255 <term>Specifies:</term>
258 The directory where all logging takes place (i.e. where <filename>logfile</filename> and
259 <filename>jarfile</filename> are located)
264 <term>Type of value:</term>
266 <para>Path name</para>
270 <term>Default value:</term>
272 <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
276 <term>Effect if unset:</term>
278 <para><emphasis>Mandatory</emphasis></para>
285 No trailing <quote><literal>/</literal></quote>, please
291 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
295 <!-- ~~~~~ New section ~~~~~ -->
296 <sect3 renderas="sect4" id="actionsfile"><title>
299 <anchor id="default.action">
300 <anchor id="standard.action">
301 <anchor id="user.action">
302 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
305 <term>Specifies:</term>
308 The <link linkend="actions-file">actions file(s)</link> to use
313 <term>Type of value:</term>
315 <para>File name, relative to <literal>confdir</literal>, without the <literal>.action</literal> suffix</para>
319 <term>Default values:</term>
323 <msgtext><literallayout> standard # Internal purposes, no editing recommended</literallayout></msgtext>
326 <msgtext><literallayout> default # Main actions file</literallayout></msgtext>
329 <msgtext><literallayout> user # User customizations</literallayout></msgtext>
335 <term>Effect if unset:</term>
338 No actions are taken at all. Simple neutral proxying.
346 Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
349 The default values include standard.action, which is used for internal
350 purposes and should be loaded, default.action, which is the
351 <quote>main</quote> actions file maintained by the developers, and
352 <filename>user.action</filename>, where you can make your personal additions.
355 Actions files are where all the per site and per URL configuration is done for
356 ad blocking, cookie management, privacy considerations, etc.
357 There is no point in using <application>Privoxy</application> without at
358 least one actions file.
364 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
365 <!-- html -> text conversion, blah -->
366 <![%config-file;[<literallayout>@@actionsfile standard # Internal purpose, recommended</literallayout>]]>
367 <![%config-file;[<literallayout>@@actionsfile default # Main actions file</literallayout>]]>
368 <![%config-file;[<literallayout>@@actionsfile user # User customizations</literallayout>]]>
371 <!-- ~~~~~ New section ~~~~~ -->
372 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
373 <anchor id="default.filter">
376 <term>Specifies:</term>
379 The <link linkend="filter-file">filter file(s)</link> to use
384 <term>Type of value:</term>
386 <para>File name, relative to <literal>confdir</literal></para>
390 <term>Default value:</term>
392 <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
396 <term>Effect if unset:</term>
399 No textual content filtering takes place, i.e. all
400 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
401 actions in the actions files are turned neutral.
409 Multiple <literal>filterfile</literal> lines are permitted.
412 The <link linkend="filter-file">filter files</link> contain content modification
413 rules that use <link linkend="regex">regular expressions</link>. These rules permit
414 powerful changes on the content of Web pages, and optionally the headers
415 as well, e.g., you could disable your favorite JavaScript annoyances,
416 re-write the actual displayed text, or just have some fun
417 playing buzzword bingo with web pages.
421 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
422 actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
423 to be defined in a filter file!
426 A pre-defined filter file called <filename>default.filter</filename> that contains
427 a number of useful filters for common problems is included in the distribution.
428 See the section on the <literal><link linkend="filter">filter</link></literal>
432 It is recommended to place any locally adapted filters into a separate
433 file, such as <filename>user.filter</filename>.
439 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
440 <![%config-file;[<literallayout>@@filterfile user.filter # User customizations</literallayout>]]>
444 <!-- ~~~~~ New section ~~~~~ -->
445 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
449 <term>Specifies:</term>
457 <term>Type of value:</term>
459 <para>File name, relative to <literal>logdir</literal></para>
463 <term>Default value:</term>
465 <para>logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows)</para>
469 <term>Effect if unset:</term>
472 No log file is used, all log messages go to the console (<literal>STDERR</literal>).
480 removed per bug report 688728 02/20/03 HB
483 The windows version will additionally log to the console.
487 The logfile is where all logging and error messages are written. The level
488 of detail and number of messages are set with the <literal>debug</literal>
489 option (see below). The logfile can be useful for tracking down a problem with
490 <application>Privoxy</application> (e.g., it's not blocking an ad you
491 think it should block) but in most cases you probably will never look at it.
494 Your logfile will grow indefinitely, and you will probably want to
495 periodically remove it. On Unix systems, you can do this with a cron job
496 (see <quote>man cron</quote>). For Red Hat, a <command>logrotate</command>
497 script has been included.
500 On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
501 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
502 the effect that cron.daily will automatically archive, gzip, and empty the
503 log, when it exceeds 1M size.
506 Any log files must be writable by whatever user <application>Privoxy</application>
507 is being run as (default on UNIX, user id is <quote>privoxy</quote>).
513 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
517 <!-- ~~~~~ New section ~~~~~ -->
518 <sect3 renderas="sect4" id="jarfile"><title>jarfile</title>
522 <term>Specifies:</term>
525 The file to store intercepted cookies in
530 <term>Type of value:</term>
532 <para>File name, relative to <literal>logdir</literal></para>
536 <term>Default value:</term>
538 <para>Unset (commented out). When activated: jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows)</para>
542 <term>Effect if unset:</term>
545 Intercepted cookies are not stored in a dedicated log file.
553 The jarfile may grow to ridiculous sizes over time.
556 If debug 8 (show header parsing) is enabled, cookies are
557 written to the logfile with the rest of the headers.
563 <![%config-file;[<literallayout>@@#jarfile jarfile</literallayout>]]>
567 <!-- ~~~~~ New section ~~~~~ -->
568 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
571 <term>Specifies:</term>
574 The trust file to use
579 <term>Type of value:</term>
581 <para>File name, relative to <literal>confdir</literal></para>
585 <term>Default value:</term>
587 <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
591 <term>Effect if unset:</term>
594 The entire trust mechanism is turned off.
602 The trust mechanism is an experimental feature for building white-lists and should
603 be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
606 If you specify a trust file, <application>Privoxy</application> will only allow
607 access to sites that are specified in the trustfile. Sites can be listed
611 Prepending a <literal>~</literal> character limits access to this site
612 only (and any sub-paths within this site), e.g.
613 <literal>~www.example.com</literal>.
616 Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
617 prepending the name with a <literal>+</literal> character. The effect is that
618 access to untrusted sites will be granted -- but only if a link from this
619 trusted referrer was used. The link target will then be added to the
620 <quote>trustfile</quote> so that future, direct accesses will be granted.
621 Sites added via this mechanism do not become trusted referrers themselves
622 (i.e. they are added with a <literal>~</literal> designation).
625 If you use the <literal>+</literal> operator in the trust file, it may grow
626 considerably over time.
629 It is recommended that <application>Privoxy</application> be compiled with
630 the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
631 <literal> --disable-editor</literal> options, if this feature is to be
635 Possible applications include limiting Internet access for children.
642 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
646 <!-- ~ End section ~ -->
649 <!-- ~~~~~ New section ~~~~~ -->
650 <sect2 id="local-set-up">
651 <title>Local Set-up Documentation</title>
654 If you intend to operate <application>Privoxy</application> for more users
655 than just yourself, it might be a good idea to let them know how to reach
656 you, what you block and why you do that, your policies, etc.
660 <!-- ~~~~~ New section ~~~~~ -->
661 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
664 <term>Specifies:</term>
667 Location of the <application>Privoxy</application> User Manual.
672 <term>Type of value:</term>
674 <para>A fully qualified URI</para>
678 <term>Default value:</term>
680 <para><emphasis>Unset</emphasis></para>
684 <term>Effect if unset:</term>
687 <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/<replaceable class="parameter">version</replaceable>/user-manual/</ulink>
688 will be used, where <replaceable class="parameter">version</replaceable> is the <application>Privoxy</application> version.
696 The User Manual URI is used for help links from some of the internal CGI pages.
697 The manual itself is normally packaged with the binary distributions, so you probably want
698 to set this to a locally installed copy. For multi-user setups, you could provide a copy on
699 a local webserver for all your users and use the corresponding URL here.
705 Unix, in local filesystem:
708 <screen> user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
711 Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
714 <screen> user-manual file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
717 Windows, UNC notation (with forward slashes):
720 <screen> user-manual file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
723 Any platform, on local webserver (called <quote>local-webserver</quote>):
726 <screen> user-manual http://local-webserver/privoxy-user-manual/</screen>
729 <!-- this gets hammered in conversion to config. Text repeated below. -->
732 If set, this option should be <emphasis>the first option in the config
733 file</emphasis>, because it is used while the config file is being read.
745 If set, this option should be the first option in the config
746 file, because it is used while the config file is being read.
755 <![%config-file;[<literallayout>@@#user-manual http://www.privoxy.org/user-manual/</literallayout>]]>
759 <!-- ~~~~~ New section ~~~~~ -->
760 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
764 <term>Specifies:</term>
767 A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
772 <term>Type of value:</term>
778 <term>Default value:</term>
780 <para>Two example URL are provided</para>
784 <term>Effect if unset:</term>
787 No links are displayed on the "untrusted" error page.
795 The value of this option only matters if the experimental trust mechanism has been
796 activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> above.)
799 If you use the trust mechanism, it is a good idea to write up some on-line
800 documentation about your trust policy and to specify the URL(s) here.
801 Use multiple times for multiple URLs.
804 The URL(s) should be added to the trustfile as well, so users don't end up
805 locked out from the information on why they were locked out in the first place!
811 <![%config-file;[<literallayout>@@trust-info-url http://www.example.com/why_we_block.html</literallayout>]]>
812 <![%config-file;[<literallayout>@@trust-info-url http://www.example.com/what_we_allow.html</literallayout>]]>
816 <!-- ~~~~~ New section ~~~~~ -->
817 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
821 <term>Specifies:</term>
824 An email address to reach the proxy administrator.
829 <term>Type of value:</term>
831 <para>Email address</para>
835 <term>Default value:</term>
837 <para><emphasis>Unset</emphasis></para>
841 <term>Effect if unset:</term>
844 No email address is displayed on error pages and the CGI user interface.
852 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
853 are unset, the whole "Local Privoxy Support" box on all generated pages will
860 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
864 <!-- ~~~~~ New section ~~~~~ -->
865 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
869 <term>Specifies:</term>
872 A URL to documentation about the local <application>Privoxy</application> setup,
873 configuration or policies.
878 <term>Type of value:</term>
884 <term>Default value:</term>
886 <para><emphasis>Unset</emphasis></para>
890 <term>Effect if unset:</term>
893 No link to local documentation is displayed on error pages and the CGI user interface.
901 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
902 are unset, the whole "Local Privoxy Support" box on all generated pages will
906 This URL shouldn't be blocked ;-)
912 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
916 <!-- ~ End section ~ -->
918 <!-- ~~~~~ New section ~~~~~ -->
919 <sect2 id="debugging">
920 <title>Debugging</title>
923 These options are mainly useful when tracing a problem.
924 Note that you might also want to invoke
925 <application>Privoxy</application> with the <literal>--no-daemon</literal>
926 command line option when debugging.
929 <sect3 renderas="sect4" id="debug"><title>debug</title>
933 <term>Specifies:</term>
936 Key values that determine what information gets logged to the
937 <link linkend="logfile"><emphasis>logfile</emphasis></link>.
942 <term>Type of value:</term>
944 <para>Integer values</para>
948 <term>Default value:</term>
950 <para>12289 (i.e.: URLs plus informational and warning messages)</para>
954 <term>Effect if unset:</term>
965 The available debug levels are:
969 debug 1 # show each GET/POST/CONNECT request
970 debug 2 # show each connection status
971 debug 4 # show I/O status
972 debug 8 # show header parsing
973 debug 16 # log all data into the logfile
974 debug 32 # debug force feature
975 debug 64 # debug regular expression filter
976 debug 128 # debug fast redirects
977 debug 256 # debug GIF de-animation
978 debug 512 # Common Log Format
979 debug 1024 # debug kill pop-ups
980 debug 2048 # CGI user interface
981 debug 4096 # Startup banner and warnings.
982 debug 8192 # Non-fatal errors
986 To select multiple debug levels, you can either add them or use
987 multiple <literal>debug</literal> lines.
990 A debug level of 1 is informative because it will show you each request
991 as it happens. <emphasis>1, 4096 and 8192 are highly recommended</emphasis>
992 so that you will notice when things go wrong. The other levels are probably
993 only of interest if you are hunting down a specific problem. They can produce
994 a hell of an output (especially 16).
998 The reporting of <emphasis>fatal</emphasis> errors (i.e. ones which crash
999 <application>Privoxy</application>) is always on and cannot be disabled.
1002 If you want to use CLF (Common Log Format), you should set <quote>debug
1003 512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1009 <![%config-file;[<literallayout>@@debug 1 # show each GET/POST/CONNECT request</literallayout>]]>
1010 <![%config-file;[<literallayout>@@debug 4096 # Startup banner and warnings</literallayout>]]>
1011 <![%config-file;[<literallayout>@@debug 8192 # Errors - *we highly recommended enabling this*</literallayout>]]>
1015 <!-- ~~~~~ New section ~~~~~ -->
1016 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1020 <term>Specifies:</term>
1023 Whether to run only one server thread
1028 <term>Type of value:</term>
1030 <para><emphasis>None</emphasis></para>
1034 <term>Default value:</term>
1036 <para><emphasis>Unset</emphasis></para>
1040 <term>Effect if unset:</term>
1043 Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1044 serve multiple requests simultaneously.
1052 This option is only there for debug purposes and you should never
1053 need to use it. <emphasis>It will drastically reduce performance.</emphasis>
1059 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1064 <!-- ~ End section ~ -->
1067 <!-- ~~~~~ New section ~~~~~ -->
1068 <sect2 id="access-control">
1069 <title>Access Control and Security</title>
1072 This section of the config file controls the security-relevant aspects
1073 of <application>Privoxy</application>'s configuration.
1077 <!-- ~~~~~ New section ~~~~~ -->
1078 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1082 <term>Specifies:</term>
1085 The IP address and TCP port on which <application>Privoxy</application> will
1086 listen for client requests.
1091 <term>Type of value:</term>
1093 <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1098 <term>Default value:</term>
1100 <para>127.0.0.1:8118</para>
1104 <term>Effect if unset:</term>
1107 Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1108 home users who run <application>Privoxy</application> on the same machine as
1117 You will need to configure your browser(s) to this proxy address and port.
1120 If you already have another service running on port 8118, or if you want to
1121 serve requests from other machines (e.g. on your local network) as well, you
1122 will need to override the default.
1125 If you leave out the IP address, <application>Privoxy</application> will
1126 bind to all interfaces (addresses) on your machine and may become reachable
1127 from the Internet. In that case, consider using <link
1128 linkend="acls">access control lists</link> (ACL's, see below), and/or
1132 If you open <application>Privoxy</application> to untrusted users, you will
1133 also want to turn off the <literal><link
1134 linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1135 <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1141 <term>Example:</term>
1144 Suppose you are running <application>Privoxy</application> on
1145 a machine which has the address 192.168.0.1 on your local private network
1146 (192.168.0.0) and has another outside connection with a different address.
1147 You want it to serve requests from inside only:
1151 listen-address 192.168.0.1:8118
1158 <![%config-file;[<literallayout>@@listen-address 127.0.0.1:8118</literallayout>]]>
1162 <!-- ~~~~~ New section ~~~~~ -->
1163 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1167 <term>Specifies:</term>
1170 Initial state of "toggle" status
1175 <term>Type of value:</term>
1181 <term>Default value:</term>
1187 <term>Effect if unset:</term>
1190 Act as if toggled on
1198 If set to 0, <application>Privoxy</application> will start in
1199 <quote>toggled off</quote> mode, i.e. behave like a normal, content-neutral
1200 proxy where all ad blocking, filtering, etc are disabled. See
1201 <literal>enable-remote-toggle</literal> below. This is not really useful
1202 anymore, since toggling is much easier via <ulink
1203 url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1204 editing the <filename>conf</filename> file.
1207 The windows version will only display the toggle icon in the system tray
1208 if this option is present.
1214 <![%config-file;[<literallayout>@@toggle 1</literallayout>]]>
1218 <!-- ~~~~~ New section ~~~~~ -->
1219 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1222 <term>Specifies:</term>
1225 Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1226 feature</ulink> may be used
1231 <term>Type of value:</term>
1237 <term>Default value:</term>
1243 <term>Effect if unset:</term>
1246 The web-based toggle feature is disabled.
1254 When toggled off, <application>Privoxy</application> acts like a normal,
1255 content-neutral proxy, i.e. it acts as if none of the actions applied to
1259 For the time being, access to the toggle feature can <emphasis>not</emphasis> be
1260 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1261 so that everybody who can access <application>Privoxy</application> (see
1262 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1263 toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1264 for multi-user environments with untrusted users.
1267 Note that you must have compiled <application>Privoxy</application> with
1268 support for this feature, otherwise this option has no effect.
1274 <![%config-file;[<literallayout>@@enable-remote-toggle 1</literallayout>]]>
1278 <!-- ~~~~~ New section ~~~~~ -->
1279 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1282 <term>Specifies:</term>
1285 Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1286 file editor</ulink> may be used
1291 <term>Type of value:</term>
1297 <term>Default value:</term>
1303 <term>Effect if unset:</term>
1306 The web-based actions file editor is disabled.
1314 For the time being, access to the editor can <emphasis>not</emphasis> be
1315 controlled separately by <quote>ACLs</quote> or HTTP authentication,
1316 so that everybody who can access <application>Privoxy</application> (see
1317 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1318 modify its configuration for all users. So this option is <emphasis>not
1319 recommended</emphasis> for multi-user environments with untrusted users.
1322 Note that you must have compiled <application>Privoxy</application> with
1323 support for this feature, otherwise this option has no effect.
1329 <![%config-file;[<literallayout>@@enable-edit-actions 1</literallayout>]]>
1332 <!-- ~~~~~ New section ~~~~~ -->
1333 <sect3 renderas="sect4" id="acls"><title>
1334 ACLs: permit-access and deny-access</title>
1335 <anchor id="permit-access">
1336 <anchor id="deny-access">
1340 <term>Specifies:</term>
1343 Who can access what.
1348 <term>Type of value:</term>
1351 <replaceable class="parameter">src_addr</replaceable>[/<replaceable class="parameter">src_masklen</replaceable>]
1352 [<replaceable class="parameter">dst_addr</replaceable>[/<replaceable class="parameter">dst_masklen</replaceable>]]
1355 Where <replaceable class="parameter">src_addr</replaceable> and
1356 <replaceable class="parameter">dst_addr</replaceable> are IP addresses in dotted decimal notation or valid
1357 DNS names, and <replaceable class="parameter">src_masklen</replaceable> and
1358 <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1359 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1360 destination part are optional.
1365 <term>Default value:</term>
1367 <para><emphasis>Unset</emphasis></para>
1371 <term>Effect if unset:</term>
1374 Don't restrict access further than implied by <literal>listen-address</literal>
1382 Access controls are included at the request of ISPs and systems
1383 administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1384 For a typical home user, it will normally suffice to ensure that
1385 <application>Privoxy</application> only listens on the localhost
1386 (127.0.0.1) or internal (home) network address by means of the
1387 <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1391 Please see the warnings in the FAQ that this proxy is not intended to be a substitute
1392 for a firewall or to encourage anyone to defer addressing basic security
1396 Multiple ACL lines are OK.
1397 If any ACLs are specified, then the <application>Privoxy</application>
1398 talks only to IP addresses that match at least one <literal>permit-access</literal> line
1399 and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1400 last match wins, with the default being <literal>deny-access</literal>.
1403 If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1404 for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1405 that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1406 of the ultimate target. This is necessary because it may be impossible for the local
1407 <application>Privoxy</application> to determine the IP address of the
1408 ultimate target (that's often what gateways are used for).
1411 You should prefer using IP addresses over DNS names, because the address lookups take
1412 time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1413 like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1414 IP addresses, only the first one is used.
1417 Denying access to particular sites by ACL may have undesired side effects
1418 if the site in question is hosted on a machine which also hosts other sites.
1423 <term>Examples:</term>
1426 Explicitly define the default behavior if no ACL and
1427 <literal>listen-address</literal> are set: <quote>localhost</quote>
1428 is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1429 <emphasis>all</emphasis> destination addresses are OK:
1433 permit-access localhost
1437 Allow any host on the same class C subnet as www.privoxy.org access to
1438 nothing but www.example.com:
1442 permit-access www.privoxy.org/24 www.example.com/32
1446 Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1447 with the exception that 192.168.45.73 may not access www.dirty-stuff.example.com:
1451 permit-access 192.168.45.64/26
1452 deny-access 192.168.45.73 www.dirty-stuff.example.com
1461 <!-- ~~~~~ New section ~~~~~ -->
1462 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1466 <term>Specifies:</term>
1469 Maximum size of the buffer for content filtering.
1474 <term>Type of value:</term>
1476 <para>Size in Kbytes</para>
1480 <term>Default value:</term>
1486 <term>Effect if unset:</term>
1489 Use a 4MB (4096 KB) limit.
1497 For content filtering, i.e. the <literal>+filter</literal> and
1498 <literal>+deanimate-gif</literal> actions, it is necessary that
1499 <application>Privoxy</application> buffers the entire document body.
1500 This can be potentially dangerous, since a server could just keep sending
1501 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1505 When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1506 flushed to the client unfiltered and no further attempt to
1507 filter the rest of the document is made. Remember that there may be multiple threads
1508 running, which might require up to <literal>buffer-limit</literal> Kbytes
1509 <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1516 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1521 <!-- ~ End section ~ -->
1524 <!-- ~~~~~ New section ~~~~~ -->
1526 <sect2 id="forwarding">
1527 <title>Forwarding</title>
1530 This feature allows routing of HTTP requests through a chain of
1532 It can be used to better protect privacy and confidentiality when
1533 accessing specific domains by routing requests to those domains
1534 through an anonymous public proxy (see e.g. <ulink
1535 url="http://www.multiproxy.org/anon_list.htm">http://www.multiproxy.org/anon_list.htm</ulink>)
1536 Or to use a caching proxy to speed up browsing. Or chaining to a parent
1537 proxy may be necessary because the machine that <application>Privoxy</application>
1538 runs on has no direct Internet access.
1542 Also specified here are SOCKS proxies. <application>Privoxy</application>
1543 supports the SOCKS 4 and SOCKS 4A protocols.
1546 <sect3 renderas="sect4" id="forward"><title>forward</title>
1549 <term>Specifies:</term>
1552 To which parent HTTP proxy specific requests should be routed.
1557 <term>Type of value:</term>
1560 <replaceable class="parameter">target_pattern</replaceable>
1561 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1564 where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1565 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1566 denote <quote>all URLs</quote>.
1567 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1568 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1569 optionally followed by its listening port (default: 8080).
1570 Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1575 <term>Default value:</term>
1577 <para><emphasis>Unset</emphasis></para>
1581 <term>Effect if unset:</term>
1584 Don't use parent HTTP proxies.
1592 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1593 forwarded to another HTTP proxy but are made directly to the web servers.
1596 Multiple lines are OK, they are checked in sequence, and the last match wins.
1601 <term>Examples:</term>
1604 Everything goes to an example anonymizing proxy, except SSL on port 443 (which it doesn't handle):
1608 forward / anon-proxy.example.org:8080
1613 Everything goes to our example ISP's caching proxy, except for requests
1614 to that ISP's sites:
1618 forward / caching-proxy.example-isp.net:8000
1619 forward .example-isp.net .
1628 <!-- ~~~~~ New section ~~~~~ -->
1629 <sect3 renderas="sect4" id="socks"><title>
1630 forward-socks4 and forward-socks4a</title>
1631 <anchor id="forward-socks4">
1632 <anchor id="forward-socks4a">
1636 <term>Specifies:</term>
1639 Through which SOCKS proxy (and to which parent HTTP proxy) specific requests should be routed.
1644 <term>Type of value:</term>
1647 <replaceable class="parameter">target_pattern</replaceable>
1648 <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
1649 <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1652 where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1653 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1654 denote <quote>all URLs</quote>.
1655 <replaceable class="parameter">http_parent</replaceable> and <replaceable class="parameter">socks_proxy</replaceable>
1656 are IP addresses in dotted decimal notation or valid DNS names (<replaceable class="parameter">http_parent</replaceable>
1657 may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
1658 <replaceable class="parameter">port</replaceable> parameters are TCP ports, i.e. integer values from 1 to 64535
1663 <term>Default value:</term>
1665 <para><emphasis>Unset</emphasis></para>
1669 <term>Effect if unset:</term>
1672 Don't use SOCKS proxies.
1680 Multiple lines are OK, they are checked in sequence, and the last match wins.
1683 The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
1684 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
1685 server, while in SOCKS 4 it happens locally.
1688 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1689 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
1695 <term>Examples:</term>
1698 From the company example.com, direct connections are made to all
1699 <quote>internal</quote> domains, but everything outbound goes through
1700 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
1705 forward-socks4a / socks-gw.example.com:1080 www-cache.example-isp.net:8080
1706 forward .example.com .
1710 A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
1714 forward-socks4 / socks-gw.example.com:1080 .
1719 To chain Privoxy and Tor, both running on the same system, you should use
1724 forward-socks4 / 127.0.0.1:9050 .
1729 The public <application>Tor</application> network can't be used to reach your local network,
1730 therefore it's a good idea to make some exceptions:
1734 forward 192.168.*.*/ .
1736 forward 127.*.*.*/ .
1740 Unencrypted connections to systems in these address ranges will
1741 be as (un)secure as the local network is, but the alternative is that you
1742 can't reach the network at all.
1745 If you also want to be able to reach servers in your local network by
1746 using their names, you will need additional exceptions that look like
1751 forward localhost/ .
1760 <![%user-man;[ <!-- not included in config due to length -->
1761 <!-- ~~~~~ New section ~~~~~ -->
1762 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
1765 If you have links to multiple ISPs that provide various special content
1766 only to their subscribers, you can configure multiple <application>Privoxies</application>
1767 which have connections to the respective ISPs to act as forwarders to each other, so that
1768 <emphasis>your</emphasis> users can see the internal content of all ISPs.
1772 Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to
1773 isp-b.net. Both run <application>Privoxy</application>. Their forwarding
1774 configuration can look like this:
1784 forward .isp-b.net host-b:8118
1795 forward .isp-a.net host-a:8118
1800 Now, your users can set their browser's proxy to use either
1801 host-a or host-b and be able to browse the internal content
1802 of both isp-a and isp-b.
1806 If you intend to chain <application>Privoxy</application> and
1807 <application>squid</application> locally, then chain as
1808 <literal>browser -> squid -> privoxy</literal> is the recommended way.
1812 Assuming that <application>Privoxy</application> and <application>squid</application>
1813 run on the same box, your <application>squid</application> configuration could then look like this:
1818 # Define Privoxy as parent proxy (without ICP)
1819 cache_peer 127.0.0.1 parent 8118 7 no-query
1821 # Define ACL for protocol FTP
1824 # Do not forward FTP requests to Privoxy
1825 always_direct allow ftp
1827 # Forward all the rest to Privoxy
1828 never_direct allow all</screen>
1832 You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
1833 Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
1837 You could just as well decide to only forward requests for Windows executables through
1838 a virus-scanning parent proxy, say, on <literal>antivir.example.com</literal>, port 8010:
1844 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
1852 <!-- ~ End section ~ -->
1855 <!-- ~~~~~ New section ~~~~~ -->
1857 <sect2 id="windows-gui">
1858 <title>Windows GUI Options</title>
1860 <application>Privoxy</application> has a number of options specific to the
1861 Windows GUI interface:
1864 <anchor id="activity-animation">
1865 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1867 If <quote>activity-animation</quote> is set to 1, the
1868 <application>Privoxy</application> icon will animate when
1869 <quote>Privoxy</quote> is active. To turn off, set to 0.
1872 <![%config-file;[<literallayout>@@#activity-animation 1</literallayout>]]>
1878 <emphasis>activity-animation 1</emphasis>
1885 <anchor id="log-messages">
1886 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1888 If <quote>log-messages</quote> is set to 1,
1889 <application>Privoxy</application> will log messages to the console
1893 <![%config-file;[<literallayout>@@#log-messages 1</literallayout>]]>
1899 <emphasis>log-messages 1</emphasis>
1906 <anchor id="log-buffer-size">
1907 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1909 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1910 i.e. the amount of memory used for the log messages displayed in the
1911 console window, will be limited to <quote>log-max-lines</quote> (see below).
1915 Warning: Setting this to 0 will result in the buffer to grow infinitely and
1916 eat up all your memory!
1919 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
1925 <emphasis>log-buffer-size 1</emphasis>
1932 <anchor id="log-max-lines">
1933 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1935 <application>log-max-lines</application> is the maximum number of lines held
1936 in the log buffer. See above.
1939 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
1945 <emphasis>log-max-lines 200</emphasis>
1952 <anchor id="log-highlight-messages">
1953 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1955 If <quote>log-highlight-messages</quote> is set to 1,
1956 <application>Privoxy</application> will highlight portions of the log
1957 messages with a bold-faced font:
1960 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
1966 <emphasis>log-highlight-messages 1</emphasis>
1973 <anchor id="log-font-name">
1974 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1976 The font used in the console window:
1979 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
1985 <emphasis>log-font-name Comic Sans MS</emphasis>
1992 <anchor id="log-font-size">
1993 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1995 Font size used in the console window:
1998 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
2004 <emphasis>log-font-size 8</emphasis>
2011 <anchor id="show-on-task-bar">
2012 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2014 <quote>show-on-task-bar</quote> controls whether or not
2015 <application>Privoxy</application> will appear as a button on the Task bar
2019 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
2025 <emphasis>show-on-task-bar 0</emphasis>
2032 <anchor id="close-button-minimizes">
2033 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2035 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
2036 button will minimize <application>Privoxy</application> instead of closing
2037 the program (close with the exit option on the File menu).
2040 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
2046 <emphasis>close-button-minimizes 1</emphasis>
2053 <anchor id="hide-console">
2054 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2056 The <quote>hide-console</quote> option is specific to the MS-Win console
2057 version of <application>Privoxy</application>. If this option is used,
2058 <application>Privoxy</application> will disconnect from and hide the
2062 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
2068 #<emphasis>hide-console</emphasis>
2078 <!-- end config content common to both outputs -->
2081 <!-- These are dummy anchors to keep the processor quiet -->
2082 <!-- when building config-file only (ie. they are used in u-m only) -->
2085 <anchor id="filter">
2086 <anchor id="filter-file">
2088 <anchor id="actions-file">
2089 <anchor id="af-patterns">
2093 <!-- eof p-config.sgml -->