e545a3afe12f180d04fb216f478ea325d6193bba
[privoxy.git] / doc / source / p-config.sgml
1 <!--
2  File        :  $Source: /cvsroot/ijbswa/current/doc/source/p-config.sgml,v $
3
4  Purpose     :  Used with other docs and files only.
5
6  $Id: p-config.sgml,v 2.105 2014/06/02 06:20:51 fabiankeil Exp $
7
8  Copyright (C) 2001-2014 Privoxy Developers http://www.privoxy.org/
9  See LICENSE.
10
11  ========================================================================
12  NOTE: Please read developer-manual/documentation.html before touching
13  anything in this, or other Privoxy documentation.
14  ========================================================================
15
16
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
19  config file) itself.
20
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.
24
25  IMPORTANT:
26
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:
31
32   @@listen-address  127.0.0.1:8118
33
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
37  formatter), and perl.
38
39
40  This file is included into:
41
42    user-manual.sgml
43    config   (the actual Privoxy config file)
44
45 -->
46
47 <![%user-man;[
48 <!-- This part only goes into user-manual -->
49 <sect1 id="config">
50 <title>The Main Configuration File</title>
51
52 <para>
53  By default, the main configuration file is named <filename>config</filename>,
54  with the exception of Windows, where it is named <filename>config.txt</filename>.
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
57  example:
58 </para>
59
60 <para>
61  <literal>
62   <msgtext>
63    <literallayout>
64   <emphasis>confdir /etc/privoxy</emphasis></literallayout>
65   </msgtext>
66  </literal>
67 </para>
68
69 <para>
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>.
73 </para>
74
75 <para>
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.
79 </para>
80
81 <para>
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). Like the filter and action files, the config file is
85  a plain text file and can be modified with a text editor like emacs, vim or
86  notepad.exe.
87 </para>
88
89 ]]>
90
91
92 <![%config-file;[
93 <!-- This part only goes into the config file -->
94 <sect1 id="config">
95 <title>
96  @@TITLE<!-- between the @@ is stripped by Makefile -->@@
97  Sample Configuration File for Privoxy &p-version;
98 </title>
99 <para>
100  $Id: p-config.sgml,v 2.105 2014/06/02 06:20:51 fabiankeil Exp $
101 </para>
102 <para>
103 Copyright (C) 2001-2014 Privoxy Developers http://www.privoxy.org/
104 </para>
105
106 <para>
107  <literallayout>
108 #################################################################
109                                                                 #
110                     Table of Contents                           #
111                                                                 #
112       I. INTRODUCTION                                           #
113      II. FORMAT OF THE CONFIGURATION FILE                       #
114                                                                 #
115       1. LOCAL SET-UP DOCUMENTATION                             #
116       2. CONFIGURATION AND LOG FILE LOCATIONS                   #
117       3. DEBUGGING                                              #
118       4. ACCESS CONTROL AND SECURITY                            #
119       5. FORWARDING                                             #
120       6. MISCELLANEOUS                                          #
121       7. WINDOWS GUI OPTIONS                                    #
122                                                                 #
123 #################################################################
124  </literallayout>
125 </para>
126
127 <literallayout>I. INTRODUCTION
128  ===============  <!-- fuck this madness --></literallayout>
129
130 <para>
131  This file holds Privoxy's main configuration.  Privoxy detects
132  configuration changes automatically, so you don't have to restart it
133  unless you want to load a different configuration file.
134 </para>
135 <para>
136  The configuration will be reloaded with the first request after the
137  change was done, this request itself will still use the old configuration,
138  though. In other words: it takes two requests before you see the result of
139  your changes. Requests that are dropped due to ACL don't trigger reloads.
140 </para>
141 <para>
142  When starting Privoxy on Unix systems, give the location of this
143  file as last argument.  On Windows systems, Privoxy will look for
144  this file with the name 'config.txt' in the current working directory
145  of the Privoxy process.
146 </para>
147
148 <para>
149  <literallayout><!-- funky spacing -->
150
151 II. FORMAT OF THE CONFIGURATION FILE
152 ====================================</literallayout>
153 </para>
154 <para>
155  Configuration lines consist of an initial keyword followed by a list
156  of values, all separated by whitespace (any number of spaces or
157  tabs).  For example,
158 </para>
159 <para>
160  actionsfile default.action
161 </para>
162 <para>
163  Indicates that the actionsfile is named 'default.action'.
164 </para>
165 <para>
166  The '#' indicates a comment.  Any part of a line following a '#' is
167  ignored, except if the '#' is preceded by a '\'.
168 </para>
169 <para>
170  Thus, by placing a # at the start of an existing configuration line,
171  you can make it a comment and it will be treated as if it weren't there.
172  This is called "commenting out" an option and can be useful. Removing
173  the # again is called "uncommenting".
174 </para>
175 <para>
176  Note that commenting out an option and leaving it at its default
177  are two completely different things! Most options behave very
178  differently when unset. See the "Effect if unset" explanation
179  in each option's description for details.
180 </para>
181 <para>
182  Long lines can be continued on the next line by using a `\' as
183  the last character.
184 </para>
185
186 ]]>
187
188 <!-- ************************************************ -->
189 <!-- The following is common to both outputs (mostly) -->
190 <!-- ************************************************ -->
191
192
193
194 <!--   ~~~~~       New section      ~~~~~     -->
195 <sect2 id="local-set-up">
196 <title>Local Set-up Documentation</title>
197
198   <para>
199     If you intend to operate <application>Privoxy</application> for more users
200     than just yourself, it might be a good idea to let them know how to reach
201     you, what you block and why you do that, your policies, etc.
202    </para>
203
204
205 <!--   ~~~~~       New section      ~~~~~     -->
206 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
207 <variablelist>
208  <varlistentry>
209   <term>Specifies:</term>
210   <listitem>
211    <para>
212     Location of the <application>Privoxy</application> User Manual.
213    </para>
214   </listitem>
215  </varlistentry>
216  <varlistentry>
217   <term>Type of value:</term>
218   <listitem>
219    <para>A fully qualified URI</para>
220   </listitem>
221  </varlistentry>
222  <varlistentry>
223   <term>Default value:</term>
224   <listitem>
225    <para><emphasis>Unset</emphasis></para>
226   </listitem>
227  </varlistentry>
228  <varlistentry>
229   <term>Effect if unset:</term>
230   <listitem>
231    <para>
232     <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/<replaceable class="parameter">version</replaceable>/user-manual/</ulink>
233     will be used, where <replaceable class="parameter">version</replaceable> is the <application>Privoxy</application> version.
234    </para>
235   </listitem>
236  </varlistentry>
237  <varlistentry>
238   <term>Notes:</term>
239   <listitem>
240     <para>
241     The User Manual URI is the single best source of information on
242     <application>Privoxy</application>, and is used for help links from some
243     of the internal CGI pages. The manual itself is normally packaged with the
244     binary distributions, so you probably want to set this to a locally
245     installed copy.
246    </para>
247    <para>
248     Examples:
249    </para>
250   <!--
251   <para>
252    Unix, in local filesystem (may not work with all browsers):
253   </para>
254   <para>
255    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
256   </para>
257   <para>
258    Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
259   </para>
260   <para>
261    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
262   </para>
263   <para>
264    Windows, UNC notation (with forward slashes):
265   </para>
266   <para>
267    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
268   </para>
269  -->
270   <para>
271    The best all purpose solution is simply to put the full local
272    <literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
273    located:
274   </para>
275   <para>
276    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;/usr/share/doc/privoxy/user-manual</screen>
277   </para>
278   <para>
279    The User Manual is then available to anyone with access to
280    <application>Privoxy</application>, by following the built-in URL:
281    <literal>http://config.privoxy.org/user-manual/</literal>
282    (or the shortcut: <literal>http://p.p/user-manual/</literal>).
283   </para>
284   <para>
285    If the documentation is not on the local system, it can be accessed
286    from a remote server, as:
287   </para>
288   <para>
289    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;http://example.com/privoxy/user-manual/</screen>
290   </para>
291   <![%user-man;[
292    <!-- this gets hammered in conversion to config. Text repeated below. -->
293   <warning>
294    <para>
295      If set, this option should be <emphasis>the first option in the config
296      file</emphasis>, because it is used while the config file is being read
297      on start-up.
298    </para>
299   </warning>
300   ]]>
301
302   <![%config-file;[
303    <!-- alternate -->
304    <para>
305     WARNING!!!
306    </para>
307    <blockquote>
308     <para>
309      If set, this option should be the first option in the config
310      file, because it is used while the config file is being read.
311     </para>
312    </blockquote>
313   ]]>
314
315  </listitem>
316  </varlistentry>
317 </variablelist>
318
319 <![%config-file;[<literallayout>@@#user-manual http://www.privoxy.org/user-manual/</literallayout>]]>
320 </sect3>
321
322
323 <!--   ~~~~~       New section      ~~~~~     -->
324 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
325
326 <variablelist>
327  <varlistentry>
328   <term>Specifies:</term>
329   <listitem>
330    <para>
331     A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
332    </para>
333   </listitem>
334  </varlistentry>
335  <varlistentry>
336   <term>Type of value:</term>
337   <listitem>
338    <para>URL</para>
339   </listitem>
340  </varlistentry>
341  <varlistentry>
342   <term>Default value:</term>
343   <listitem>
344    <para><emphasis>Unset</emphasis></para>
345   </listitem>
346  </varlistentry>
347  <varlistentry>
348   <term>Effect if unset:</term>
349   <listitem>
350    <para>
351     No links are displayed on the "untrusted" error page.
352    </para>
353   </listitem>
354  </varlistentry>
355  <varlistentry>
356   <term>Notes:</term>
357   <listitem>
358    <para>
359     The value of this option only matters if the experimental trust mechanism has been
360     activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> below.)
361    </para>
362    <para>
363     If you use the trust mechanism, it is a good idea to write up some on-line
364     documentation about your trust policy and to specify the URL(s) here.
365     Use multiple times for multiple URLs.
366    </para>
367    <para>
368     The URL(s) should be added to the trustfile as well, so users don't end up
369     locked out from the information on why they were locked out in the first place!
370    </para>
371   </listitem>
372  </varlistentry>
373 </variablelist>
374
375 <![%config-file;[<literallayout>@@#trust-info-url  http://www.example.com/why_we_block.html</literallayout>]]>
376 <![%config-file;[<literallayout>@@#trust-info-url  http://www.example.com/what_we_allow.html</literallayout>]]>
377 </sect3>
378
379
380 <!--   ~~~~~       New section      ~~~~~     -->
381 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
382
383 <variablelist>
384  <varlistentry>
385   <term>Specifies:</term>
386   <listitem>
387    <para>
388     An email address to reach the <application>Privoxy</application> administrator.
389    </para>
390   </listitem>
391  </varlistentry>
392  <varlistentry>
393   <term>Type of value:</term>
394   <listitem>
395    <para>Email address</para>
396   </listitem>
397  </varlistentry>
398  <varlistentry>
399   <term>Default value:</term>
400   <listitem>
401    <para><emphasis>Unset</emphasis></para>
402   </listitem>
403  </varlistentry>
404  <varlistentry>
405   <term>Effect if unset:</term>
406   <listitem>
407    <para>
408     No email address is displayed on error pages and the CGI user interface.
409    </para>
410   </listitem>
411  </varlistentry>
412  <varlistentry>
413   <term>Notes:</term>
414   <listitem>
415    <para>
416     If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
417     are unset, the whole "Local Privoxy Support" box on all generated pages will
418     not be shown.
419    </para>
420   </listitem>
421  </varlistentry>
422 </variablelist>
423
424 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
425 </sect3>
426
427
428 <!--   ~~~~~       New section      ~~~~~     -->
429 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
430
431 <variablelist>
432  <varlistentry>
433   <term>Specifies:</term>
434   <listitem>
435    <para>
436     A URL to documentation about the local <application>Privoxy</application> setup,
437     configuration or policies.
438    </para>
439   </listitem>
440  </varlistentry>
441  <varlistentry>
442   <term>Type of value:</term>
443   <listitem>
444    <para>URL</para>
445   </listitem>
446  </varlistentry>
447  <varlistentry>
448   <term>Default value:</term>
449   <listitem>
450    <para><emphasis>Unset</emphasis></para>
451   </listitem>
452  </varlistentry>
453  <varlistentry>
454   <term>Effect if unset:</term>
455   <listitem>
456    <para>
457     No link to local documentation is displayed on error pages and the CGI user interface.
458    </para>
459   </listitem>
460  </varlistentry>
461  <varlistentry>
462   <term>Notes:</term>
463   <listitem>
464    <para>
465     If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
466     are unset, the whole "Local Privoxy Support" box on all generated pages will
467     not be shown.
468    </para>
469    <para>
470     This URL shouldn't be blocked ;-)
471    </para>
472   </listitem>
473  </varlistentry>
474 </variablelist>
475
476 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
477 </sect3>
478
479 </sect2>
480 <!--  ~  End section  ~  -->
481
482
483
484 <!--   ~~~~~       New section      ~~~~~     -->
485
486 <sect2 id="conf-log-loc">
487 <title>Configuration and Log File Locations</title>
488
489 <para>
490  <application>Privoxy</application> can (and normally does) use a number of
491  other files for additional configuration, help and logging.
492  This section of the configuration file tells <application>Privoxy</application>
493  where to find those other files.
494 </para>
495
496 <para>
497  The user running <application>Privoxy</application>, must have read
498  permission for all configuration files, and write permission to any files
499  that would be modified, such as log files and actions files.
500 </para>
501
502
503 <!--   ~~~~~       New section      ~~~~~     -->
504 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
505
506 <variablelist>
507  <varlistentry>
508   <term>Specifies:</term>
509   <listitem>
510    <para>The directory where the other configuration files are located.</para>
511   </listitem>
512  </varlistentry>
513  <varlistentry>
514   <term>Type of value:</term>
515   <listitem>
516    <para>Path name</para>
517   </listitem>
518  </varlistentry>
519  <varlistentry>
520   <term>Default value:</term>
521   <listitem>
522    <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
523   </listitem>
524  </varlistentry>
525  <varlistentry>
526   <term>Effect if unset:</term>
527   <listitem>
528    <para><emphasis>Mandatory</emphasis></para>
529   </listitem>
530  </varlistentry>
531  <varlistentry>
532   <term>Notes:</term>
533   <listitem>
534    <para>
535     No trailing <quote><literal>/</literal></quote>, please.
536    </para>
537   </listitem>
538  </varlistentry>
539 </variablelist>
540
541 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
542 </sect3>
543
544 <!--   ~~~~~       New section      ~~~~~     -->
545 <sect3 renderas="sect4" id="templdir"><title>templdir</title>
546
547 <variablelist>
548  <varlistentry>
549   <term>Specifies:</term>
550   <listitem>
551    <para>An alternative directory where the templates are loaded from.</para>
552   </listitem>
553  </varlistentry>
554  <varlistentry>
555   <term>Type of value:</term>
556   <listitem>
557    <para>Path name</para>
558   </listitem>
559  </varlistentry>
560  <varlistentry>
561   <term>Default value:</term>
562   <listitem>
563    <para>unset</para>
564   </listitem>
565  </varlistentry>
566  <varlistentry>
567   <term>Effect if unset:</term>
568   <listitem>
569    <para>The templates are assumed to be located in confdir/template.</para>
570   </listitem>
571  </varlistentry>
572  <varlistentry>
573   <term>Notes:</term>
574   <listitem>
575    <para>
576     <application>Privoxy's</application> original templates are usually
577     overwritten with each update. Use this option to relocate customized
578     templates that should be kept. As template variables might change
579     between updates, you shouldn't expect templates to work with
580     <application>Privoxy</application> releases other than the one
581     they were part of, though.
582    </para>
583   </listitem>
584  </varlistentry>
585 </variablelist>
586
587 <![%config-file;[<literallayout>@@#templdir .</literallayout>]]>
588 </sect3>
589
590
591 <!--   ~~~~~       New section      ~~~~~     -->
592 <sect3 renderas="sect4" id="temporary-directory"><title>temporary-directory</title>
593
594 <variablelist>
595  <varlistentry>
596   <term>Specifies:</term>
597   <listitem>
598    <para>A directory where Privoxy can create temporary files.</para>
599   </listitem>
600  </varlistentry>
601  <varlistentry>
602   <term>Type of value:</term>
603   <listitem>
604    <para>Path name</para>
605   </listitem>
606  </varlistentry>
607  <varlistentry>
608   <term>Default value:</term>
609   <listitem>
610    <para>unset</para>
611   </listitem>
612  </varlistentry>
613  <varlistentry>
614   <term>Effect if unset:</term>
615   <listitem>
616    <para>No temporary files are created, external filters don't work.</para>
617   </listitem>
618  </varlistentry>
619  <varlistentry>
620   <term>Notes:</term>
621   <listitem>
622    <para>
623     To execute <literal><ulink url="actions-file.html#EXTERNAL-FILTER">external filters</ulink></literal>,
624     <application>Privoxy</application> has to create temporary files.
625     This directive specifies the directory the temporary files should
626     be written to.
627    </para>
628    <para>
629     It should be a directory only <application>Privoxy</application>
630     (and trusted users) can access.
631    </para>
632   </listitem>
633  </varlistentry>
634 </variablelist>
635
636 <![%config-file;[<literallayout>@@#temporary-directory .</literallayout>]]>
637 </sect3>
638
639
640 <!--   ~~~~~       New section      ~~~~~     -->
641 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
642
643 <variablelist>
644  <varlistentry>
645   <term>Specifies:</term>
646   <listitem>
647    <para>
648     The directory where all logging takes place
649     (i.e. where the <filename>logfile</filename> is located).
650    </para>
651   </listitem>
652  </varlistentry>
653  <varlistentry>
654   <term>Type of value:</term>
655   <listitem>
656    <para>Path name</para>
657   </listitem>
658  </varlistentry>
659  <varlistentry>
660   <term>Default value:</term>
661   <listitem>
662    <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
663   </listitem>
664  </varlistentry>
665  <varlistentry>
666   <term>Effect if unset:</term>
667   <listitem>
668    <para><emphasis>Mandatory</emphasis></para>
669   </listitem>
670  </varlistentry>
671  <varlistentry>
672   <term>Notes:</term>
673   <listitem>
674    <para>
675     No trailing <quote><literal>/</literal></quote>, please.
676    </para>
677   </listitem>
678  </varlistentry>
679 </variablelist>
680
681 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
682 </sect3>
683
684
685 <!--   ~~~~~       New section      ~~~~~     -->
686 <sect3 renderas="sect4" id="actionsfile"><title>
687 actionsfile
688 </title>
689 <anchor id="default.action">
690 <anchor id="standard.action">
691 <anchor id="user.action">
692 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
693 <variablelist>
694  <varlistentry>
695   <term>Specifies:</term>
696   <listitem>
697    <para>
698     The <link linkend="actions-file">actions file(s)</link> to use
699    </para>
700   </listitem>
701  </varlistentry>
702  <varlistentry>
703   <term>Type of value:</term>
704   <listitem>
705    <para>Complete file name, relative to <literal>confdir</literal></para>
706   </listitem>
707  </varlistentry>
708  <varlistentry>
709   <term>Default values:</term>
710   <listitem>
711    <simplelist>
712     <member>
713      <msgtext><literallayout>  match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout></msgtext>
714     </member>
715     <member>
716      <msgtext><literallayout>  default.action   # Main actions file</literallayout></msgtext>
717     </member>
718     <member>
719      <msgtext><literallayout>  user.action      # User customizations</literallayout></msgtext>
720     </member>
721    </simplelist>
722   </listitem>
723  </varlistentry>
724  <varlistentry>
725   <term>Effect if unset:</term>
726   <listitem>
727    <para>
728     No actions are taken at all. More or less neutral proxying.
729    </para>
730   </listitem>
731  </varlistentry>
732  <varlistentry>
733   <term>Notes:</term>
734   <listitem>
735    <para>
736     Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
737    </para>
738    <para>
739     The default values are <filename>default.action</filename>, which is the
740     <quote>main</quote> actions file maintained by the developers, and
741     <filename>user.action</filename>, where you can make your personal additions.
742    </para>
743    <para>
744     Actions files contain all the per site and per URL configuration for
745     ad blocking, cookie management, privacy considerations, etc.
746     There is no point in using <application>Privoxy</application> without at
747     least one actions file.
748    </para>
749    <para>
750     Note that since Privoxy 3.0.7, the complete filename, including the <quote>.action</quote>
751     extension has to be specified.  The syntax change was necessary to be consistent
752     with the other file options and to allow previously forbidden characters.
753    </para>
754   </listitem>
755  </varlistentry>
756 </variablelist>
757
758 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
759 <!-- html -> text conversion, blah -->
760 <![%config-file;[<literallayout>@@actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout>]]>
761 <![%config-file;[<literallayout>@@actionsfile default.action   # Main actions file</literallayout>]]>
762 <!--
763  XXX: Like user.filter, user.action should probably be commented out
764  by default as not all packages install it into the default directory.
765  fk 2007-11-07
766 -->
767 <![%config-file;[<literallayout>@@actionsfile user.action      # User customizations</literallayout>]]>
768 </sect3>
769
770 <!--   ~~~~~       New section      ~~~~~     -->
771 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
772 <anchor id="default.filter">
773 <variablelist>
774  <varlistentry>
775   <term>Specifies:</term>
776   <listitem>
777    <para>
778     The <link linkend="filter-file">filter file(s)</link> to use
779    </para>
780   </listitem>
781  </varlistentry>
782  <varlistentry>
783   <term>Type of value:</term>
784   <listitem>
785    <para>File name, relative to <literal>confdir</literal></para>
786   </listitem>
787  </varlistentry>
788  <varlistentry>
789   <term>Default value:</term>
790   <listitem>
791    <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
792   </listitem>
793  </varlistentry>
794  <varlistentry>
795   <term>Effect if unset:</term>
796   <listitem>
797    <para>
798     No textual content filtering takes place, i.e. all
799     <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
800     actions in the actions files are turned neutral.
801    </para>
802   </listitem>
803  </varlistentry>
804  <varlistentry>
805   <term>Notes:</term>
806   <listitem>
807    <para>
808     Multiple <literal>filterfile</literal> lines are permitted.
809    </para>
810    <para>
811     The <link linkend="filter-file">filter files</link> contain content modification
812     rules that use <link linkend="regex">regular expressions</link>. These rules permit
813     powerful changes on the content of Web pages, and optionally the headers
814     as well, e.g., you could try to disable your favorite JavaScript annoyances,
815     re-write the actual displayed text, or just have some fun
816     playing buzzword bingo with web pages.
817    </para>
818    <para>
819     The
820     <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
821     actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
822     to be defined in a filter file!
823    </para>
824    <para>
825     A pre-defined filter file called <filename>default.filter</filename> that contains
826     a number of useful filters for common problems is included in the distribution.
827     See the section on the <literal><link linkend="filter">filter</link></literal>
828     action for a list.
829    </para>
830    <para>
831     It is recommended to place any locally adapted filters into a separate
832     file, such as <filename>user.filter</filename>.
833    </para>
834   </listitem>
835  </varlistentry>
836 </variablelist>
837
838 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
839 <![%config-file;[<literallayout>@@filterfile user.filter      # User customizations</literallayout>]]>
840 </sect3>
841
842
843 <!--   ~~~~~       New section      ~~~~~     -->
844 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
845
846 <variablelist>
847  <varlistentry>
848   <term>Specifies:</term>
849   <listitem>
850    <para>
851     The log file to use
852    </para>
853   </listitem>
854  </varlistentry>
855  <varlistentry>
856   <term>Type of value:</term>
857   <listitem>
858    <para>File name, relative to <literal>logdir</literal></para>
859   </listitem>
860  </varlistentry>
861  <varlistentry>
862   <term>Default value:</term>
863   <listitem>
864    <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
865   </listitem>
866  </varlistentry>
867  <varlistentry>
868   <term>Effect if unset:</term>
869   <listitem>
870    <para>
871     No logfile is written.
872    </para>
873   </listitem>
874  </varlistentry>
875  <varlistentry>
876   <term>Notes:</term>
877   <listitem>
878    <para>
879     The logfile is where all logging and error messages are written. The level
880     of detail and number of messages are set with the <literal>debug</literal>
881     option (see below). The logfile can be useful for tracking down a problem with
882     <application>Privoxy</application> (e.g., it's not blocking an ad you
883     think it should block) and it can help you to monitor what your browser
884     is doing.
885    </para>
886    <para>
887     Depending on the debug options below, the logfile may be a privacy risk
888     if third parties can get access to it. As most users will never look
889     at it, <application>Privoxy</application> 3.0.7 and later only log fatal
890     errors by default.
891    </para>
892    <para>
893     For most troubleshooting purposes, you will have to change that,
894     please refer to the debugging section for details.
895    </para>
896    <para>
897     Your logfile will grow indefinitely, and you will probably want to
898     periodically remove it.  On Unix systems, you can do this with a cron job
899     (see <quote>man cron</quote>).
900    </para>
901    <para>
902     Any log files must be writable by whatever user <application>Privoxy</application>
903     is being run as (on Unix, default user id is <quote>privoxy</quote>).
904    </para>
905   </listitem>
906  </varlistentry>
907 </variablelist>
908
909 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
910 </sect3>
911
912
913 <!--   ~~~~~       New section      ~~~~~     -->
914 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
915 <variablelist>
916  <varlistentry>
917   <term>Specifies:</term>
918   <listitem>
919    <para>
920     The name of the trust file to use
921    </para>
922   </listitem>
923  </varlistentry>
924  <varlistentry>
925   <term>Type of value:</term>
926   <listitem>
927    <para>File name, relative to <literal>confdir</literal></para>
928   </listitem>
929  </varlistentry>
930  <varlistentry>
931   <term>Default value:</term>
932   <listitem>
933    <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
934   </listitem>
935  </varlistentry>
936  <varlistentry>
937   <term>Effect if unset:</term>
938   <listitem>
939    <para>
940     The entire trust mechanism is disabled.
941    </para>
942   </listitem>
943  </varlistentry>
944  <varlistentry>
945   <term>Notes:</term>
946   <listitem>
947    <para>
948     The trust mechanism is an experimental feature for building white-lists and should
949     be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
950    </para>
951    <para>
952     If you specify a trust file, <application>Privoxy</application> will only allow
953     access to sites that are specified in the trustfile. Sites can be listed
954     in one of two ways:
955    </para>
956    <para>
957     Prepending a <literal>~</literal> character limits access to this site
958     only (and any sub-paths within this site), e.g.
959     <literal>~www.example.com</literal> allows access to
960     <literal>~www.example.com/features/news.html</literal>, etc.
961    </para>
962    <para>
963     Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
964     prepending the name with a <literal>+</literal> character. The effect is that
965     access to untrusted sites will be granted -- but only if a link from this
966     trusted referrer was used to get there. The link target will then be added
967     to the <quote>trustfile</quote> so that future, direct accesses will be
968     granted. Sites added via this mechanism do not become trusted referrers
969     themselves (i.e. they are added with a <literal>~</literal> designation).
970     There is a limit of 512 such entries, after which new entries will not be
971     made.
972    </para>
973    <para>
974     If you use the <literal>+</literal> operator in the trust file, it may grow
975     considerably over time.
976    </para>
977    <para>
978     It is recommended that <application>Privoxy</application> be compiled with
979     the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
980     <literal> --disable-editor</literal> options, if this feature is to be
981     used.
982    </para>
983    <para>
984     Possible applications include limiting Internet access for children.
985    </para>
986
987   </listitem>
988  </varlistentry>
989 </variablelist>
990
991 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
992 </sect3>
993 </sect2>
994
995 <!--  ~  End section  ~  -->
996
997 <!--   ~~~~~       New section      ~~~~~     -->
998 <sect2 id="debugging">
999 <title>Debugging</title>
1000
1001  <para>
1002   These options are mainly useful when tracing a problem.
1003   Note that you might also want to invoke
1004   <application>Privoxy</application> with the <literal>--no-daemon</literal>
1005   command line option when debugging.
1006  </para>
1007
1008 <sect3 renderas="sect4" id="debug"><title>debug</title>
1009
1010 <variablelist>
1011  <varlistentry>
1012   <term>Specifies:</term>
1013   <listitem>
1014    <para>
1015     Key values that determine what information gets logged.
1016    </para>
1017   </listitem>
1018  </varlistentry>
1019  <varlistentry>
1020   <term>Type of value:</term>
1021   <listitem>
1022    <para>Integer values</para>
1023   </listitem>
1024  </varlistentry>
1025  <varlistentry>
1026   <term>Default value:</term>
1027   <listitem>
1028    <para>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</para>
1029   </listitem>
1030  </varlistentry>
1031  <varlistentry>
1032   <term>Effect if unset:</term>
1033   <listitem>
1034    <para>
1035     Default value is used (see above).
1036    </para>
1037   </listitem>
1038  </varlistentry>
1039  <varlistentry>
1040   <term>Notes:</term>
1041   <listitem>
1042    <para>
1043     The available debug levels are:
1044    </para>
1045    <para>
1046     <programlisting>
1047   debug     1 # Log the destination for each request &my-app; let through. See also debug 1024.
1048   debug     2 # show each connection status
1049   debug     4 # show I/O status
1050   debug     8 # show header parsing
1051   debug    16 # log all data written to the network
1052   debug    32 # debug force feature
1053   debug    64 # debug regular expression filters
1054   debug   128 # debug redirects
1055   debug   256 # debug GIF de-animation
1056   debug   512 # Common Log Format
1057   debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
1058   debug  2048 # CGI user interface
1059   debug  4096 # Startup banner and warnings.
1060   debug  8192 # Non-fatal errors
1061   debug 32768 # log all data read from the network
1062   debug 65536 # Log the applying actions
1063 </programlisting>
1064    </para>
1065    <para>
1066     To select multiple debug levels, you can either add them or use
1067     multiple <literal>debug</literal> lines.
1068    </para>
1069    <para>
1070     A debug level of 1 is informative because it will show you each request
1071     as it happens. <emphasis>1, 1024, 4096 and 8192 are recommended</emphasis>
1072     so that you will notice when things go wrong. The other levels are
1073     probably only of interest if you are hunting down a specific problem.
1074     They can produce a hell of an output (especially 16).
1075     <!-- LOL -->
1076    </para>
1077    <para>
1078     &my-app; used to ship with the debug levels recommended above enabled by
1079     default, but due to privacy concerns 3.0.7 and later are configured to
1080     only log fatal errors.
1081    </para>
1082    <para>
1083     If you are used to the more verbose settings, simply enable the debug lines
1084     below again.
1085    </para>
1086    <para>
1087     If you want to use pure CLF (Common Log Format), you should set <quote>debug
1088     512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1089    </para>
1090    <para>
1091     <application>Privoxy</application> has a hard-coded limit for the
1092     length of log messages. If it's reached, messages are logged truncated
1093     and marked with <quote>... [too long, truncated]</quote>.
1094    </para>
1095    <para>
1096     Please don't file any support requests without trying to reproduce
1097     the problem with increased debug level first. Once you read the log
1098     messages, you may even be able to solve the problem on your own.
1099    </para>
1100   </listitem>
1101  </varlistentry>
1102 </variablelist>
1103
1104 <![%config-file;[<literallayout>@@#debug     1 # Log the destination for each request &my-app; let through.</literallayout>]]>
1105 <![%config-file;[<literallayout>@@#debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
1106 <![%config-file;[<literallayout>@@#debug  4096 # Startup banner and warnings</literallayout>]]>
1107 <![%config-file;[<literallayout>@@#debug  8192 # Non-fatal errors</literallayout>]]>
1108 </sect3>
1109
1110
1111 <!--   ~~~~~       New section      ~~~~~     -->
1112 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1113
1114 <variablelist>
1115  <varlistentry>
1116   <term>Specifies:</term>
1117   <listitem>
1118    <para>
1119     Whether to run only one server thread.
1120    </para>
1121   </listitem>
1122  </varlistentry>
1123  <varlistentry>
1124   <term>Type of value:</term>
1125   <listitem>
1126    <para><emphasis>1 or 0</emphasis></para>
1127   </listitem>
1128  </varlistentry>
1129  <varlistentry>
1130   <term>Default value:</term>
1131   <listitem>
1132    <para><emphasis>0</emphasis></para>
1133   </listitem>
1134  </varlistentry>
1135  <varlistentry>
1136   <term>Effect if unset:</term>
1137   <listitem>
1138    <para>
1139     Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1140     serve multiple requests simultaneously.
1141    </para>
1142   </listitem>
1143  </varlistentry>
1144  <varlistentry>
1145   <term>Notes:</term>
1146   <listitem>
1147    <para>
1148     This option is only there for debugging purposes.
1149     <emphasis>It will drastically reduce performance.</emphasis>
1150    </para>
1151   </listitem>
1152  </varlistentry>
1153 </variablelist>
1154
1155 <![%config-file;[<literallayout>@@#single-threaded 1</literallayout>]]>
1156 </sect3>
1157
1158 <!--   ~~~~~       New section      ~~~~~     -->
1159 <sect3 renderas="sect4" id="hostname"><title>hostname</title>
1160
1161 <variablelist>
1162  <varlistentry>
1163   <term>Specifies:</term>
1164   <listitem>
1165    <para>
1166     The hostname shown on the CGI pages.
1167    </para>
1168   </listitem>
1169  </varlistentry>
1170  <varlistentry>
1171   <term>Type of value:</term>
1172   <listitem>
1173    <para>Text</para>
1174   </listitem>
1175  </varlistentry>
1176  <varlistentry>
1177   <term>Default value:</term>
1178   <listitem>
1179    <para><emphasis>Unset</emphasis></para>
1180   </listitem>
1181  </varlistentry>
1182  <varlistentry>
1183   <term>Effect if unset:</term>
1184   <listitem>
1185    <para>
1186     The hostname provided by the operating system is used.
1187    </para>
1188   </listitem>
1189  </varlistentry>
1190  <varlistentry>
1191   <term>Notes:</term>
1192   <listitem>
1193    <para>
1194     On some misconfigured systems resolving the hostname fails or
1195     takes too much time and slows Privoxy down. Setting a fixed hostname
1196     works around the problem.
1197    </para>
1198    <para>
1199     In other circumstances it might be desirable to show a hostname
1200     other than the one returned by the operating system. For example
1201     if the system has several different hostnames and you don't want
1202     to use the first one.
1203    </para>
1204    <para>
1205     Note that Privoxy does not validate the specified hostname value.
1206    </para>
1207   </listitem>
1208  </varlistentry>
1209 </variablelist>
1210
1211 <![%config-file;[<literallayout>@@#hostname hostname.example.org</literallayout>]]>
1212 </sect3>
1213
1214 </sect2>
1215
1216 <!--  ~  End section  ~  -->
1217
1218
1219 <!--   ~~~~~       New section      ~~~~~     -->
1220 <sect2 id="access-control">
1221 <title>Access Control and Security</title>
1222
1223  <para>
1224   This section of the config file controls the security-relevant aspects
1225   of <application>Privoxy</application>'s configuration.
1226  </para>
1227
1228
1229 <!--   ~~~~~       New section      ~~~~~     -->
1230 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1231
1232 <variablelist>
1233  <varlistentry>
1234   <term>Specifies:</term>
1235   <listitem>
1236    <para>
1237     The address and TCP port on which <application>Privoxy</application> will
1238     listen for client requests.
1239    </para>
1240   </listitem>
1241  </varlistentry>
1242  <varlistentry>
1243   <term>Type of value:</term>
1244   <listitem>
1245    <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1246    <para>[<replaceable class="parameter">Hostname</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1247   </listitem>
1248  </varlistentry>
1249
1250  <varlistentry>
1251   <term>Default value:</term>
1252   <listitem>
1253    <para>127.0.0.1:8118</para>
1254   </listitem>
1255  </varlistentry>
1256  <varlistentry>
1257   <term>Effect if unset:</term>
1258   <listitem>
1259    <para>
1260     Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable and
1261     recommended for home users who run <application>Privoxy</application> on
1262     the same machine as their browser.
1263    </para>
1264   </listitem>
1265  </varlistentry>
1266  <varlistentry>
1267   <term>Notes:</term>
1268   <listitem>
1269    <para>
1270     You will need to configure your browser(s) to this proxy address and port.
1271    </para>
1272    <para>
1273     If you already have another service running on port 8118, or if you want to
1274     serve requests from other machines (e.g. on your local network) as well, you
1275     will need to override the default.
1276    </para>
1277    <para>
1278     You can use this statement multiple times to make
1279     <application>Privoxy</application> listen on more ports or more
1280     <abbrev>IP</abbrev> addresses. Suitable if your operating system does not
1281     support sharing <abbrev>IPv6</abbrev> and <abbrev>IPv4</abbrev> protocols
1282     on the same socket.
1283    </para>
1284    <para>
1285     If a hostname is used instead of an IP address, <application>Privoxy</application>
1286     will try to resolve it to an IP address and if there are multiple, use the first
1287     one returned.
1288    </para>
1289    <para>
1290     If the address for the hostname isn't already known on the system
1291     (for example because it's in /etc/hostname), this may result in DNS
1292     traffic.
1293    </para>
1294    <para>
1295     If the specified address isn't available on the system, or if the
1296     hostname can't be resolved, <application>Privoxy</application>
1297     will fail to start.
1298    </para>
1299    <para>
1300     IPv6 addresses containing colons have to be quoted by brackets.
1301     They can only be used if <application>Privoxy</application> has
1302     been compiled with IPv6 support. If you aren't sure if your version
1303     supports it, have a look at
1304     <literal>http://config.privoxy.org/show-status</literal>.
1305    </para>
1306    <para>
1307     Some operating systems will prefer IPv6 to IPv4 addresses even if the
1308     system has no IPv6 connectivity which is usually not expected by the user.
1309     Some even rely on DNS to resolve localhost which mean the "localhost" address
1310     used may not actually be local.
1311    </para>
1312    <para>
1313     It is therefore recommended to explicitly configure the intended IP address
1314     instead of relying on the operating system, unless there's a strong reason not to.
1315    </para>
1316    <para>
1317     If you leave out the address, <application>Privoxy</application> will bind to all
1318     IPv4 interfaces (addresses) on your machine and may become reachable from the
1319     Internet and/or the local network. Be aware that some GNU/Linux distributions
1320     modify that behaviour without updating the documentation. Check for non-standard
1321     patches if your <application>Privoxy</application> version behaves differently.
1322    </para>
1323    <para>
1324     If you configure <application>Privoxy</application> to be reachable from the
1325     network, consider using <link linkend="acls">access control lists</link>
1326     (ACL's, see below), and/or a firewall.
1327    </para>
1328    <para>
1329     If you open <application>Privoxy</application> to untrusted users, you will
1330     also want to make sure that the following actions are disabled:  <literal><link
1331     linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1332     <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1333    </para>
1334   </listitem>
1335  </varlistentry>
1336  <varlistentry>
1337   <term>Example:</term>
1338   <listitem>
1339    <para>
1340      Suppose you are running <application>Privoxy</application> on
1341      a machine which has the address 192.168.0.1 on your local private network
1342      (192.168.0.0) and has another outside connection with a different address.
1343      You want it to serve requests from inside only:
1344    </para>
1345    <para>
1346     <programlisting>
1347   listen-address  192.168.0.1:8118
1348 </programlisting>
1349    </para>
1350    <para>
1351     Suppose you are running <application>Privoxy</application> on an
1352     IPv6-capable machine and you want it to listen on the IPv6 address
1353     of the loopback device:
1354    </para>
1355    <para>
1356     <programlisting>
1357   listen-address [::1]:8118
1358 </programlisting>
1359    </para>
1360   </listitem>
1361  </varlistentry>
1362 </variablelist>
1363
1364 <![%config-file;[<literallayout>@@listen-address  127.0.0.1:8118</literallayout>]]>
1365 </sect3>
1366
1367
1368 <!--   ~~~~~       New section      ~~~~~     -->
1369 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1370
1371 <variablelist>
1372  <varlistentry>
1373   <term>Specifies:</term>
1374   <listitem>
1375    <para>
1376     Initial state of "toggle" status
1377    </para>
1378   </listitem>
1379  </varlistentry>
1380  <varlistentry>
1381   <term>Type of value:</term>
1382   <listitem>
1383    <para>1 or 0</para>
1384   </listitem>
1385  </varlistentry>
1386  <varlistentry>
1387   <term>Default value:</term>
1388   <listitem>
1389    <para>1</para>
1390   </listitem>
1391  </varlistentry>
1392  <varlistentry>
1393   <term>Effect if unset:</term>
1394   <listitem>
1395    <para>
1396     Act as if toggled on
1397    </para>
1398   </listitem>
1399  </varlistentry>
1400  <varlistentry>
1401   <term>Notes:</term>
1402   <listitem>
1403    <para>
1404     If set to 0, <application>Privoxy</application> will start in
1405     <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1406     content-neutral proxy with both ad blocking and content filtering
1407     disabled. See <literal>enable-remote-toggle</literal> below.
1408    </para>
1409   </listitem>
1410  </varlistentry>
1411 </variablelist>
1412
1413 <![%config-file;[<literallayout>@@toggle  1</literallayout>]]>
1414 </sect3>
1415
1416
1417 <!--   ~~~~~       New section      ~~~~~     -->
1418 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1419 <variablelist>
1420  <varlistentry>
1421   <term>Specifies:</term>
1422   <listitem>
1423    <para>
1424     Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1425     feature</ulink> may be used
1426    </para>
1427   </listitem>
1428  </varlistentry>
1429  <varlistentry>
1430   <term>Type of value:</term>
1431   <listitem>
1432    <para>0 or 1</para>
1433   </listitem>
1434  </varlistentry>
1435  <varlistentry>
1436   <term>Default value:</term>
1437   <listitem>
1438    <para>0</para>
1439   </listitem>
1440  </varlistentry>
1441  <varlistentry>
1442   <term>Effect if unset:</term>
1443   <listitem>
1444    <para>
1445     The web-based toggle feature is disabled.
1446    </para>
1447   </listitem>
1448  </varlistentry>
1449  <varlistentry>
1450   <term>Notes:</term>
1451   <listitem>
1452    <para>
1453     When toggled off, <application>Privoxy</application> mostly acts like a normal,
1454     content-neutral proxy, i.e. doesn't block ads or filter content.
1455    </para>
1456    <para>
1457     Access to the toggle feature can <emphasis>not</emphasis> be
1458     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1459     so that everybody who can access <application>Privoxy</application> (see
1460     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1461     toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1462     for multi-user environments with untrusted users.
1463    </para>
1464    <para>
1465     Note that malicious client side code (e.g Java) is also
1466     capable of using this option.
1467    </para>
1468    <para>
1469     As a lot of <application>Privoxy</application> users don't read
1470     documentation, this feature is disabled by default.
1471    </para>
1472    <para>
1473     Note that you must have compiled <application>Privoxy</application> with
1474     support for this feature, otherwise this option has no effect.
1475    </para>
1476   </listitem>
1477  </varlistentry>
1478 </variablelist>
1479
1480 <![%config-file;[<literallayout>@@enable-remote-toggle  0</literallayout>]]>
1481 </sect3>
1482
1483
1484 <!--   ~~~~~       New section      ~~~~~     -->
1485 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1486 <variablelist>
1487  <varlistentry>
1488   <term>Specifies:</term>
1489   <listitem>
1490    <para>
1491     Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1492    </para>
1493   </listitem>
1494  </varlistentry>
1495  <varlistentry>
1496   <term>Type of value:</term>
1497   <listitem>
1498    <para>0 or 1</para>
1499   </listitem>
1500  </varlistentry>
1501  <varlistentry>
1502   <term>Default value:</term>
1503   <listitem>
1504    <para>0</para>
1505   </listitem>
1506  </varlistentry>
1507  <varlistentry>
1508   <term>Effect if unset:</term>
1509   <listitem>
1510    <para>
1511     Privoxy ignores special HTTP headers.
1512    </para>
1513   </listitem>
1514  </varlistentry>
1515  <varlistentry>
1516   <term>Notes:</term>
1517   <listitem>
1518    <para>
1519     When toggled on, the client can change <application>Privoxy's</application>
1520     behaviour by setting special HTTP headers. Currently the only supported
1521     special header is <quote>X-Filter: No</quote>, to disable filtering for
1522     the ongoing request, even if it is enabled in one of the action files.
1523    </para>
1524    <para>
1525     This feature is disabled by default. If you are using
1526     <application>Privoxy</application> in a environment with trusted clients,
1527     you may enable this feature at your discretion. Note that malicious client
1528     side code (e.g Java) is also capable of using this feature.
1529    </para>
1530    <para>
1531     This option will be removed in future releases as it has been obsoleted
1532     by the more general header taggers.
1533    </para>
1534   </listitem>
1535  </varlistentry>
1536 </variablelist>
1537
1538 <![%config-file;[<literallayout>@@enable-remote-http-toggle  0</literallayout>]]>
1539 </sect3>
1540
1541
1542 <!--   ~~~~~       New section      ~~~~~     -->
1543 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1544 <variablelist>
1545  <varlistentry>
1546   <term>Specifies:</term>
1547   <listitem>
1548    <para>
1549     Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1550     file editor</ulink> may be used
1551    </para>
1552   </listitem>
1553  </varlistentry>
1554  <varlistentry>
1555   <term>Type of value:</term>
1556   <listitem>
1557    <para>0 or 1</para>
1558   </listitem>
1559  </varlistentry>
1560  <varlistentry>
1561   <term>Default value:</term>
1562   <listitem>
1563    <para>0</para>
1564   </listitem>
1565  </varlistentry>
1566  <varlistentry>
1567   <term>Effect if unset:</term>
1568   <listitem>
1569    <para>
1570     The web-based actions file editor is disabled.
1571    </para>
1572   </listitem>
1573  </varlistentry>
1574  <varlistentry>
1575   <term>Notes:</term>
1576   <listitem>
1577    <para>
1578     Access to the editor can <emphasis>not</emphasis> be
1579     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1580     so that everybody who can access <application>Privoxy</application> (see
1581     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1582     modify its configuration for all users.
1583    </para>
1584    <para>
1585     This option is <emphasis>not recommended</emphasis> for environments
1586     with untrusted users and as a lot of <application>Privoxy</application>
1587     users don't read documentation, this feature is disabled by default.
1588    </para>
1589    <para>
1590     Note that malicious client side code (e.g Java) is also
1591     capable of using the actions editor and you shouldn't enable
1592     this options unless you understand the consequences and are
1593     sure your browser is configured correctly.
1594    </para>
1595    <para>
1596     Note that you must have compiled <application>Privoxy</application> with
1597     support for this feature, otherwise this option has no effect.
1598    </para>
1599   </listitem>
1600  </varlistentry>
1601 </variablelist>
1602
1603 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1604 </sect3>
1605
1606
1607 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1608 <variablelist>
1609  <varlistentry>
1610   <term>Specifies:</term>
1611   <listitem>
1612    <para>
1613     Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1614    </para>
1615   </listitem>
1616  </varlistentry>
1617  <varlistentry>
1618   <term>Type of value:</term>
1619   <listitem>
1620    <para>
1621     <replaceable>0 or 1</replaceable>
1622    </para>
1623   </listitem>
1624  </varlistentry>
1625  <varlistentry>
1626   <term>Default value:</term>
1627   <listitem>
1628    <para><emphasis>0</emphasis></para>
1629   </listitem>
1630  </varlistentry>
1631  <varlistentry>
1632   <term>Effect if unset:</term>
1633   <listitem>
1634    <para>
1635     Blocks are not enforced.
1636    </para>
1637   </listitem>
1638  </varlistentry>
1639  <varlistentry>
1640   <term>Notes:</term>
1641   <listitem>
1642    <para>
1643     <application>Privoxy</application> is mainly used to block and filter
1644     requests as a service to the user, for example to block ads and other
1645     junk that clogs the pipes. <application>Privoxy's</application> configuration
1646     isn't perfect and sometimes innocent pages are blocked. In this situation it
1647     makes sense to allow the user to enforce the request and have
1648     <application>Privoxy</application> ignore the block.
1649    </para>
1650    <para>
1651     In the default configuration <application>Privoxy's</application>
1652     <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1653     link to adds a special string (the force prefix) to the request URL.
1654     If that link is used, <application>Privoxy</application> will
1655     detect the force prefix, remove it again and let the request pass.
1656    </para>
1657    <para>
1658     Of course <application>Privoxy</application> can also be used to enforce
1659     a network policy. In that case the user obviously should not be able to
1660     bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1661     option is for. If it's enabled, <application>Privoxy</application> hides
1662     the <quote>go there anyway</quote> link. If the user adds the force
1663     prefix by hand, it will not be accepted and the circumvention attempt
1664     is logged.
1665    </para>
1666   </listitem>
1667  </varlistentry>
1668  <varlistentry>
1669   <term>Examples:</term>
1670   <listitem>
1671    <para>
1672     enforce-blocks 1
1673    </para>
1674   </listitem>
1675  </varlistentry>
1676 </variablelist>
1677 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1678 </sect3>
1679
1680
1681 <!--   ~~~~~       New section      ~~~~~     -->
1682 <sect3 renderas="sect4" id="acls"><title>
1683 ACLs: permit-access and deny-access</title>
1684 <anchor id="permit-access">
1685 <anchor id="deny-access">
1686
1687 <variablelist>
1688  <varlistentry>
1689   <term>Specifies:</term>
1690   <listitem>
1691    <para>
1692     Who can access what.
1693    </para>
1694   </listitem>
1695  </varlistentry>
1696  <varlistentry>
1697   <term>Type of value:</term>
1698   <listitem>
1699    <para>
1700     <replaceable class="parameter">src_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">src_masklen</replaceable>]
1701     [<replaceable class="parameter">dst_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">dst_masklen</replaceable>]]
1702    </para>
1703    <para>
1704     Where <replaceable class="parameter">src_addr</replaceable> and
1705    <replaceable class="parameter">dst_addr</replaceable> are IPv4 addresses in dotted decimal notation or valid
1706     DNS names, <replaceable class="parameter">port</replaceable> is a port
1707     number, and <replaceable class="parameter">src_masklen</replaceable> and
1708     <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1709     values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1710     destination part are optional.
1711    </para>
1712    <para>
1713     If your system implements
1714     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink>, then
1715     <replaceable class="parameter">src_addr</replaceable> and <replaceable
1716     class="parameter">dst_addr</replaceable> can be IPv6 addresses delimeted by
1717     brackets, <replaceable class="parameter">port</replaceable> can be a number
1718     or a service name, and
1719     <replaceable class="parameter">src_masklen</replaceable> and
1720     <replaceable class="parameter">dst_masklen</replaceable> can be a number
1721     from 0 to 128.
1722    </para>
1723   </listitem>
1724  </varlistentry>
1725  <varlistentry>
1726   <term>Default value:</term>
1727   <listitem>
1728    <para><emphasis>Unset</emphasis></para>
1729    <para>
1730     If no <replaceable class="parameter">port</replaceable> is specified,
1731     any port will match. If no <replaceable class="parameter">src_masklen</replaceable> or
1732     <replaceable class="parameter">src_masklen</replaceable> is given, the complete IP
1733     address has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1734    </para>
1735   </listitem>
1736  </varlistentry>
1737  <varlistentry>
1738   <term>Effect if unset:</term>
1739   <listitem>
1740    <para>
1741     Don't restrict access further than implied by <literal>listen-address</literal>
1742    </para>
1743   </listitem>
1744  </varlistentry>
1745  <varlistentry>
1746   <term>Notes:</term>
1747   <listitem>
1748    <para>
1749     Access controls are included at the request of ISPs and systems
1750     administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1751     For a typical home user, it will normally suffice to ensure that
1752     <application>Privoxy</application> only listens on the localhost
1753     (127.0.0.1) or internal (home) network address by means of the
1754     <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1755     option.
1756    </para>
1757    <para>
1758     Please see the warnings in the FAQ that <application>Privoxy</application>
1759     is not intended to be a substitute for a firewall or to encourage anyone
1760     to defer addressing basic security weaknesses.
1761    </para>
1762    <para>
1763     Multiple ACL lines are OK.
1764     If any ACLs are specified, <application>Privoxy</application> only talks
1765     to IP addresses that match at least one <literal>permit-access</literal> line
1766     and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1767     last match wins, with the default being <literal>deny-access</literal>.
1768    </para>
1769    <para>
1770     If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1771     for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1772     that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1773     of the ultimate target. This is necessary because it may be impossible for the local
1774     <application>Privoxy</application> to determine the IP address of the
1775     ultimate target (that's often what gateways are used for).
1776    </para>
1777    <para>
1778     You should prefer using IP addresses over DNS names, because the address lookups take
1779     time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1780     like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1781     IP addresses, only the first one is used.
1782    </para>
1783    <para>
1784      Some systems allow IPv4 clients to connect to IPv6 server sockets.
1785      Then the client's IPv4 address will be translated by the system into
1786      IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4
1787      mapped IPv6 address). <application>Privoxy</application> can handle it
1788      and maps such ACL addresses automatically.
1789    </para>
1790    <para>
1791     Denying access to particular sites by ACL may have undesired side effects
1792     if the site in question is hosted on a machine which also hosts other sites
1793     (most sites are).
1794    </para>
1795   </listitem>
1796  </varlistentry>
1797  <varlistentry>
1798   <term>Examples:</term>
1799   <listitem>
1800    <para>
1801     Explicitly define the default behavior if no ACL and
1802     <literal>listen-address</literal> are set: <quote>localhost</quote>
1803     is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1804     <emphasis>all</emphasis> destination addresses are OK:
1805    </para>
1806    <para>
1807     <screen>
1808   permit-access  localhost
1809 </screen>
1810    </para>
1811    <para>
1812     Allow any host on the same class C subnet as www.privoxy.org access to
1813     nothing but www.example.com (or other domains hosted on the same system):
1814    </para>
1815    <para>
1816     <screen>
1817   permit-access  www.privoxy.org/24 www.example.com/32
1818 </screen>
1819    </para>
1820    <para>
1821     Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1822     with the exception that 192.168.45.73 may not access the IP address behind
1823     www.dirty-stuff.example.com:
1824    </para>
1825    <para>
1826     <screen>
1827   permit-access  192.168.45.64/26
1828   deny-access    192.168.45.73    www.dirty-stuff.example.com
1829 </screen>
1830    </para>
1831    <para>
1832      Allow access from the IPv4 network 192.0.2.0/24 even if listening on
1833      an IPv6 wild card address (not supported on all platforms):
1834    </para>
1835    <para>
1836     <programlisting>
1837   permit-access  192.0.2.0/24
1838 </programlisting>
1839    </para>
1840    <para>
1841      This is equivalent to the following line even if listening on an
1842      IPv4 address (not supported on all platforms):
1843    </para>
1844    <para>
1845     <programlisting>
1846   permit-access  [::ffff:192.0.2.0]/120
1847 </programlisting>
1848    </para>
1849   </listitem>
1850  </varlistentry>
1851 </variablelist>
1852 </sect3>
1853
1854
1855 <!--   ~~~~~       New section      ~~~~~     -->
1856 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1857
1858 <variablelist>
1859  <varlistentry>
1860   <term>Specifies:</term>
1861   <listitem>
1862    <para>
1863     Maximum size of the buffer for content filtering.
1864    </para>
1865   </listitem>
1866  </varlistentry>
1867  <varlistentry>
1868   <term>Type of value:</term>
1869   <listitem>
1870    <para>Size in Kbytes</para>
1871   </listitem>
1872  </varlistentry>
1873  <varlistentry>
1874   <term>Default value:</term>
1875   <listitem>
1876    <para>4096</para>
1877   </listitem>
1878  </varlistentry>
1879  <varlistentry>
1880   <term>Effect if unset:</term>
1881   <listitem>
1882    <para>
1883     Use a 4MB (4096 KB) limit.
1884    </para>
1885   </listitem>
1886  </varlistentry>
1887  <varlistentry>
1888   <term>Notes:</term>
1889   <listitem>
1890    <para>
1891     For content filtering, i.e. the <literal>+filter</literal> and
1892     <literal>+deanimate-gif</literal> actions, it is necessary that
1893     <application>Privoxy</application> buffers the entire document body.
1894     This can be potentially dangerous, since a server could just keep sending
1895     data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1896     Hence this option.
1897    </para>
1898    <para>
1899     When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1900     flushed to the client unfiltered and no further attempt to
1901     filter the rest of the document is made. Remember that there may be multiple threads
1902     running, which might require up to <literal>buffer-limit</literal> Kbytes
1903     <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1904     above.
1905    </para>
1906   </listitem>
1907  </varlistentry>
1908 </variablelist>
1909
1910 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1911 </sect3>
1912
1913 <!--   ~~~~~       New section      ~~~~~     -->
1914 <sect3 renderas="sect4" id="enable-proxy-authentication-forwarding"><title>enable-proxy-authentication-forwarding</title>
1915 <variablelist>
1916  <varlistentry>
1917   <term>Specifies:</term>
1918   <listitem>
1919    <para>
1920     Whether or not proxy authentication through &my-app; should work.
1921    </para>
1922   </listitem>
1923  </varlistentry>
1924  <varlistentry>
1925   <term>Type of value:</term>
1926   <listitem>
1927    <para>0 or 1</para>
1928   </listitem>
1929  </varlistentry>
1930  <varlistentry>
1931   <term>Default value:</term>
1932   <listitem>
1933    <para>0</para>
1934   </listitem>
1935  </varlistentry>
1936  <varlistentry>
1937   <term>Effect if unset:</term>
1938   <listitem>
1939    <para>
1940     Proxy authentication headers are removed.
1941    </para>
1942   </listitem>
1943  </varlistentry>
1944  <varlistentry>
1945   <term>Notes:</term>
1946   <listitem>
1947    <para>
1948     Privoxy itself does not support proxy authentication, but can
1949     allow clients to authenticate against Privoxy's parent proxy.
1950    </para>
1951    <para>
1952     By default Privoxy (3.0.21 and later) don't do that and remove
1953     Proxy-Authorization headers in requests and Proxy-Authenticate
1954     headers in responses to make it harder for malicious sites to
1955     trick inexperienced users into providing login information.
1956    </para>
1957    <para>
1958     If this option is enabled the headers are forwarded.
1959    </para>
1960    <para>
1961     Enabling this option is <emphasis>not recommended</emphasis> if there is
1962     no parent proxy that requires authentication or if the local network between
1963     Privoxy and the parent proxy isn't trustworthy. If proxy authentication is
1964     only required for some requests, it is recommended to use a client header filter
1965     to remove the authentication headers for requests where they aren't needed.
1966    </para>
1967   </listitem>
1968  </varlistentry>
1969 </variablelist>
1970
1971 <![%config-file;[<literallayout>@@enable-proxy-authentication-forwarding 0</literallayout>]]>
1972 </sect3>
1973
1974 </sect2>
1975
1976 <!--  ~  End section  ~  -->
1977
1978
1979 <!--   ~~~~~       New section      ~~~~~     -->
1980
1981 <sect2 id="forwarding">
1982 <title>Forwarding</title>
1983
1984 <para>
1985  This feature allows routing of HTTP requests through a chain of
1986  multiple proxies.
1987 </para>
1988 <para>
1989  Forwarding can be used to chain Privoxy with a caching proxy to speed
1990  up browsing. Using a parent proxy may also be necessary if the machine
1991  that <application>Privoxy</application> runs on has no direct Internet access.
1992 </para>
1993 <para>
1994  Note that parent proxies can severely decrease your privacy level.
1995  For example a parent proxy could add your IP address to the request
1996  headers and if it's a caching proxy it may add the <quote>Etag</quote>
1997  header to revalidation requests again, even though you configured Privoxy
1998  to remove it. It may also ignore Privoxy's header time randomization and use the
1999  original values which could be used by the server as cookie replacement
2000  to track your steps between visits.
2001 </para>
2002
2003 <para>
2004  Also specified here are SOCKS proxies. <application>Privoxy</application>
2005  supports the SOCKS 4 and SOCKS 4A protocols.
2006 </para>
2007
2008 <sect3 renderas="sect4" id="forward"><title>forward</title>
2009 <variablelist>
2010  <varlistentry>
2011   <term>Specifies:</term>
2012   <listitem>
2013    <para>
2014     To which parent HTTP proxy specific requests should be routed.
2015    </para>
2016   </listitem>
2017  </varlistentry>
2018  <varlistentry>
2019   <term>Type of value:</term>
2020   <listitem>
2021    <para>
2022     <replaceable class="parameter">target_pattern</replaceable>
2023     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2024    </para>
2025    <para>
2026     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
2027     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2028     denote <quote>all URLs</quote>.
2029     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2030     is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
2031     optionally followed by its listening port (default: 8000).
2032     Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
2033    </para>
2034   </listitem>
2035  </varlistentry>
2036  <varlistentry>
2037   <term>Default value:</term>
2038   <listitem>
2039    <para><emphasis>Unset</emphasis></para>
2040   </listitem>
2041  </varlistentry>
2042  <varlistentry>
2043   <term>Effect if unset:</term>
2044   <listitem>
2045    <para>
2046     Don't use parent HTTP proxies.
2047    </para>
2048   </listitem>
2049  </varlistentry>
2050  <varlistentry>
2051   <term>Notes:</term>
2052   <listitem>
2053    <para>
2054     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2055     forwarded to another HTTP proxy but are made directly to the web servers.
2056    </para>
2057    <para>
2058     <replaceable class="parameter">http_parent</replaceable> can be a
2059      numerical IPv6 address (if
2060     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2061     implemented). To prevent clashes with the port delimiter, the whole IP
2062     address has to be put into brackets. On the other hand a <replaceable
2063     class="parameter">target_pattern</replaceable> containing an IPv6 address
2064     has to be put into angle brackets (normal brackets are reserved for
2065     regular expressions already).
2066    </para>
2067    <para>
2068     Multiple lines are OK, they are checked in sequence, and the last match wins.
2069    </para>
2070   </listitem>
2071  </varlistentry>
2072  <varlistentry>
2073   <term>Examples:</term>
2074   <listitem>
2075    <para>
2076     Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
2077    </para>
2078    <para>
2079     <screen>
2080   forward   /      parent-proxy.example.org:8080
2081   forward   :443   .
2082 </screen>
2083    </para>
2084    <para>
2085     Everything goes to our example ISP's caching proxy, except for requests
2086     to that ISP's sites:
2087    </para>
2088    <para>
2089     <screen>
2090   forward   /                  caching-proxy.isp.example.net:8000
2091   forward   .isp.example.net   .
2092 </screen>
2093    </para>
2094    <para>
2095     Parent proxy specified by an IPv6 address:
2096    </para>
2097    <para>
2098     <programlisting>
2099   forward   /                   [2001:DB8::1]:8000
2100 </programlisting>
2101    </para>
2102    <para>
2103     Suppose your parent proxy doesn't support IPv6:
2104    </para>
2105    <para>
2106     <programlisting>
2107   forward  /                        parent-proxy.example.org:8000
2108   forward  ipv6-server.example.org  .
2109   forward  &lt;[2-3][0-9a-f][0-9a-f][0-9a-f]:*&gt;   .
2110 </programlisting>
2111    </para>
2112   </listitem>
2113  </varlistentry>
2114 </variablelist>
2115 </sect3>
2116
2117
2118 <!--   ~~~~~       New section      ~~~~~     -->
2119 <sect3 renderas="sect4" id="socks"><title>
2120 forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
2121 <anchor id="forward-socks4">
2122 <anchor id="forward-socks4a">
2123
2124 <variablelist>
2125  <varlistentry>
2126   <term>Specifies:</term>
2127   <listitem>
2128    <para>
2129     Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2130    </para>
2131   </listitem>
2132  </varlistentry>
2133  <varlistentry>
2134   <term>Type of value:</term>
2135   <listitem>
2136    <para>
2137     <replaceable class="parameter">target_pattern</replaceable>
2138     <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
2139     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2140    </para>
2141    <para>
2142     where <replaceable class="parameter">target_pattern</replaceable> is a
2143     <link linkend="af-patterns">URL pattern</link> that specifies to which
2144     requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2145     denote <quote>all URLs</quote>. <replaceable class="parameter">http_parent</replaceable>
2146     and <replaceable class="parameter">socks_proxy</replaceable>
2147     are IP addresses in dotted decimal notation or valid DNS names
2148     (<replaceable class="parameter">http_parent</replaceable>
2149     may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
2150     <replaceable class="parameter">port</replaceable> parameters are TCP ports,
2151     i.e. integer values from 1 to 65535
2152    </para>
2153   </listitem>
2154  </varlistentry>
2155  <varlistentry>
2156   <term>Default value:</term>
2157   <listitem>
2158    <para><emphasis>Unset</emphasis></para>
2159   </listitem>
2160  </varlistentry>
2161  <varlistentry>
2162   <term>Effect if unset:</term>
2163   <listitem>
2164    <para>
2165     Don't use SOCKS proxies.
2166    </para>
2167   </listitem>
2168  </varlistentry>
2169  <varlistentry>
2170   <term>Notes:</term>
2171   <listitem>
2172    <para>
2173     Multiple lines are OK, they are checked in sequence, and the last match wins.
2174    </para>
2175    <para>
2176     The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
2177     is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2178     server, while in SOCKS 4 it happens locally.
2179    </para>
2180    <para>
2181     With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
2182    </para>
2183    <para>
2184     <literal>forward-socks5t</literal> works like vanilla <literal>forward-socks5</literal> but
2185     lets &my-app; additionally use Tor-specific SOCKS extensions. Currently the only supported
2186     SOCKS extension is optimistic data which can reduce the latency for the first request made
2187     on a newly created connection.
2188    </para>
2189    <para>
2190     <replaceable class="parameter">socks_proxy</replaceable> and
2191     <replaceable class="parameter">http_parent</replaceable> can be a
2192      numerical IPv6 address (if
2193     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2194     implemented). To prevent clashes with the port delimiter, the whole IP
2195     address has to be put into brackets. On the other hand a <replaceable
2196     class="parameter">target_pattern</replaceable> containing an IPv6 address
2197     has to be put into angle brackets (normal brackets are reserved for
2198     regular expressions already).
2199    </para>
2200    <para>
2201     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2202     forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2203     a SOCKS proxy.
2204    </para>
2205   </listitem>
2206  </varlistentry>
2207  <varlistentry>
2208   <term>Examples:</term>
2209   <listitem>
2210    <para>
2211      From the company example.com, direct connections are made to all
2212      <quote>internal</quote> domains, but everything outbound goes through
2213      their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2214      the Internet.
2215    </para>
2216    <para>
2217     <screen>
2218   forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
2219   forward           .example.com   .
2220 </screen>
2221    </para>
2222    <para>
2223     A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2224    </para>
2225    <para>
2226     <screen>
2227   forward-socks4   /               socks-gw.example.com:1080  .
2228 </screen>
2229    </para>
2230
2231     <para>
2232     To chain Privoxy and Tor, both running on the same system, you would use
2233     something like:
2234    </para>
2235    <para>
2236     <screen>
2237   forward-socks5t   /               127.0.0.1:9050 .
2238 </screen>
2239    </para>
2240
2241     <para>
2242     The public <application>Tor</application> network can't be used to
2243     reach your local network, if you need to access local servers you
2244     therefore might want to make some exceptions:
2245    </para>
2246    <para>
2247     <screen>
2248   forward         192.168.*.*/     .
2249   forward            10.*.*.*/     .
2250   forward           127.*.*.*/     .
2251 </screen>
2252    </para>
2253    <para>
2254     Unencrypted connections to systems in these address ranges will
2255     be as (un)secure as the local network is, but the alternative is that you
2256     can't reach the local network through <application>Privoxy</application>
2257     at all. Of course this may actually be desired and there is no reason
2258     to make these exceptions if you aren't sure you need them.
2259    </para>
2260    <para>
2261     If you also want to be able to reach servers in your local network by
2262     using their names, you will need additional exceptions that look like
2263     this:
2264    </para>
2265    <para>
2266     <screen>
2267  forward           localhost/     .
2268 </screen>
2269    </para>
2270
2271   </listitem>
2272  </varlistentry>
2273 </variablelist>
2274 </sect3>
2275
2276 <![%user-man;[     <!-- not included in config due to length -->
2277 <!--   ~~~~~       New section      ~~~~~     -->
2278 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2279
2280 <para>
2281  If you have links to multiple ISPs that provide various special content
2282  only to their subscribers, you can configure multiple <application>Privoxies</application>
2283  which have connections to the respective ISPs to act as forwarders to each other, so that
2284  <emphasis>your</emphasis> users can see the internal content of all ISPs.
2285 </para>
2286
2287 <para>
2288  Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2289  isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2290  configuration can look like this:
2291 </para>
2292
2293 <para>
2294  host-a:
2295 </para>
2296
2297 <para>
2298  <screen>
2299   forward    /           .
2300   forward    .isp-b.example.net  host-b:8118
2301 </screen>
2302 </para>
2303
2304 <para>
2305  host-b:
2306 </para>
2307
2308 <para>
2309  <screen>
2310   forward    /           .
2311   forward    .isp-a.example.org  host-a:8118
2312 </screen>
2313 </para>
2314
2315 <para>
2316  Now, your users can set their browser's proxy to use either
2317  host-a or host-b and be able to browse the internal content
2318  of both isp-a and isp-b.
2319 </para>
2320
2321 <para>
2322  If you intend to chain <application>Privoxy</application> and
2323  <application>squid</application> locally, then chaining as
2324  <literal>browser -> squid -> privoxy</literal> is the recommended way.
2325 </para>
2326
2327 <para>
2328  Assuming that <application>Privoxy</application> and <application>squid</application>
2329  run on the same box, your <application>squid</application> configuration could then look like this:
2330 </para>
2331
2332 <para>
2333  <screen>
2334   # Define Privoxy as parent proxy (without ICP)
2335   cache_peer 127.0.0.1 parent 8118 7 no-query
2336
2337   # Define ACL for protocol FTP
2338   acl ftp proto FTP
2339
2340   # Do not forward FTP requests to Privoxy
2341   always_direct allow ftp
2342
2343   # Forward all the rest to Privoxy
2344   never_direct allow all</screen>
2345 </para>
2346
2347 <para>
2348  You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2349  Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2350 </para>
2351
2352 <para>
2353  You could just as well decide to only forward requests you suspect
2354  of leading to Windows executables through a virus-scanning parent proxy,
2355  say, on <literal>antivir.example.com</literal>, port 8010:
2356 </para>
2357
2358 <para>
2359  <screen>
2360   forward   /                          .
2361   forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010</screen>
2362 </para>
2363
2364 </sect3>
2365 ]]>
2366
2367 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2368 <variablelist>
2369  <varlistentry>
2370   <term>Specifies:</term>
2371   <listitem>
2372    <para>
2373     How often Privoxy retries if a forwarded connection request fails.
2374    </para>
2375   </listitem>
2376  </varlistentry>
2377  <varlistentry>
2378   <term>Type of value:</term>
2379   <listitem>
2380    <para>
2381     <replaceable class="parameter">Number of retries.</replaceable>
2382    </para>
2383   </listitem>
2384  </varlistentry>
2385  <varlistentry>
2386   <term>Default value:</term>
2387   <listitem>
2388    <para><emphasis>0</emphasis></para>
2389   </listitem>
2390  </varlistentry>
2391  <varlistentry>
2392   <term>Effect if unset:</term>
2393   <listitem>
2394    <para>
2395     Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2396    </para>
2397   </listitem>
2398  </varlistentry>
2399  <varlistentry>
2400   <term>Notes:</term>
2401   <listitem>
2402    <para>
2403     <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2404     for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2405     The connection might have failed because of a DNS timeout in which case a retry makes sense,
2406     but it might also have failed because the server doesn't exist or isn't reachable. In this
2407     case the retry will just delay the appearance of Privoxy's error message.
2408    </para>
2409    <para>
2410     Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2411     that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2412    </para>
2413    <para>
2414     Only use this option, if you are getting lots of forwarding-related error messages
2415     that go away when you try again manually. Start with a small value and check Privoxy's
2416     logfile from time to time, to see how many retries are usually needed.
2417    </para>
2418   </listitem>
2419  </varlistentry>
2420  <varlistentry>
2421   <term>Examples:</term>
2422   <listitem>
2423    <para>
2424     forwarded-connect-retries 1
2425    </para>
2426   </listitem>
2427  </varlistentry>
2428 </variablelist>
2429 <![%config-file;[<literallayout>@@forwarded-connect-retries  0</literallayout>]]>
2430 </sect3>
2431
2432 </sect2>
2433
2434 <sect2 id="misc">
2435 <title>Miscellaneous</title>
2436
2437 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2438 <variablelist>
2439  <varlistentry>
2440   <term>Specifies:</term>
2441   <listitem>
2442    <para>
2443     Whether intercepted requests should be treated as valid.
2444    </para>
2445   </listitem>
2446  </varlistentry>
2447  <varlistentry>
2448   <term>Type of value:</term>
2449   <listitem>
2450    <para>
2451     <replaceable>0 or 1</replaceable>
2452    </para>
2453   </listitem>
2454  </varlistentry>
2455  <varlistentry>
2456   <term>Default value:</term>
2457   <listitem>
2458    <para><emphasis>0</emphasis></para>
2459   </listitem>
2460  </varlistentry>
2461  <varlistentry>
2462   <term>Effect if unset:</term>
2463   <listitem>
2464    <para>
2465     Only proxy requests are accepted, intercepted requests are treated as invalid.
2466    </para>
2467   </listitem>
2468  </varlistentry>
2469  <varlistentry>
2470   <term>Notes:</term>
2471   <listitem>
2472    <para>
2473     If you don't trust your clients and want to force them
2474     to use <application>Privoxy</application>, enable this
2475     option and configure your packet filter to redirect outgoing
2476     HTTP connections into <application>Privoxy</application>.
2477    </para>
2478    <para>
2479     Note that intercepting encrypted connections (HTTPS) isn't supported.
2480    </para>
2481    <para>
2482     Make sure that <application>Privoxy's</application> own requests
2483     aren't redirected as well. Additionally take care that
2484     <application>Privoxy</application> can't intentionally connect
2485     to itself, otherwise you could run into redirection loops if
2486     <application>Privoxy's</application> listening port is reachable
2487     by the outside or an attacker has access to the pages you visit.
2488    </para>
2489   </listitem>
2490  </varlistentry>
2491  <varlistentry>
2492   <term>Examples:</term>
2493   <listitem>
2494    <para>
2495     accept-intercepted-requests 1
2496    </para>
2497   </listitem>
2498  </varlistentry>
2499 </variablelist>
2500 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2501 </sect3>
2502
2503 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2504 <variablelist>
2505  <varlistentry>
2506   <term>Specifies:</term>
2507   <listitem>
2508    <para>
2509     Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2510    </para>
2511   </listitem>
2512  </varlistentry>
2513  <varlistentry>
2514   <term>Type of value:</term>
2515   <listitem>
2516    <para>
2517     <replaceable>0 or 1</replaceable>
2518    </para>
2519   </listitem>
2520  </varlistentry>
2521  <varlistentry>
2522   <term>Default value:</term>
2523   <listitem>
2524    <para><emphasis>0</emphasis></para>
2525   </listitem>
2526  </varlistentry>
2527  <varlistentry>
2528   <term>Effect if unset:</term>
2529   <listitem>
2530    <para>
2531     <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2532    </para>
2533   </listitem>
2534  </varlistentry>
2535  <varlistentry>
2536   <term>Notes:</term>
2537   <listitem>
2538    <para>
2539     By default <application>Privoxy</application> ignores block or redirect actions
2540     for its CGI pages. Intercepting these requests can be useful in multi-user
2541     setups to implement fine-grained access control, but it can also render the complete
2542     web interface useless and make debugging problems painful if done without care.
2543    </para>
2544    <para>
2545     Don't enable this option unless you're sure that you really need it.
2546    </para>
2547   </listitem>
2548  </varlistentry>
2549  <varlistentry>
2550   <term>Examples:</term>
2551   <listitem>
2552    <para>
2553     allow-cgi-request-crunching 1
2554    </para>
2555   </listitem>
2556  </varlistentry>
2557 </variablelist>
2558 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2559 </sect3>
2560
2561 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2562 <variablelist>
2563  <varlistentry>
2564   <term>Specifies:</term>
2565   <listitem>
2566    <para>
2567     Whether the CGI interface should stay compatible with broken HTTP clients.
2568    </para>
2569   </listitem>
2570  </varlistentry>
2571  <varlistentry>
2572   <term>Type of value:</term>
2573   <listitem>
2574    <para>
2575     <replaceable>0 or 1</replaceable>
2576    </para>
2577   </listitem>
2578  </varlistentry>
2579  <varlistentry>
2580   <term>Default value:</term>
2581   <listitem>
2582    <para><emphasis>0</emphasis></para>
2583   </listitem>
2584  </varlistentry>
2585  <varlistentry>
2586   <term>Effect if unset:</term>
2587   <listitem>
2588    <para>
2589     The CGI form generate long GET URLs.
2590    </para>
2591   </listitem>
2592  </varlistentry>
2593  <varlistentry>
2594   <term>Notes:</term>
2595   <listitem>
2596    <para>
2597     <application>Privoxy's</application> CGI forms can lead to
2598     rather long URLs. This isn't a problem as far as the HTTP
2599     standard is concerned, but it can confuse clients with arbitrary
2600     URL length limitations.
2601    </para>
2602    <para>
2603     Enabling split-large-forms causes <application>Privoxy</application>
2604     to divide big forms into smaller ones to keep the URL length down.
2605     It makes editing a lot less convenient and you can no longer
2606     submit all changes at once, but at least it works around this
2607     browser bug.
2608    </para>
2609    <para>
2610     If you don't notice any editing problems, there is no reason
2611     to enable this option, but if one of the submit buttons appears
2612     to be broken, you should give it a try.
2613    </para>
2614   </listitem>
2615  </varlistentry>
2616  <varlistentry>
2617   <term>Examples:</term>
2618   <listitem>
2619    <para>
2620     split-large-forms 1
2621    </para>
2622   </listitem>
2623  </varlistentry>
2624 </variablelist>
2625 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2626 </sect3>
2627
2628 <sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
2629 <variablelist>
2630  <varlistentry>
2631   <term>Specifies:</term>
2632   <listitem>
2633    <para>
2634     Number of seconds after which an open connection will no longer be reused.
2635    </para>
2636   </listitem>
2637  </varlistentry>
2638  <varlistentry>
2639   <term>Type of value:</term>
2640   <listitem>
2641    <para>
2642     <replaceable>Time in seconds.</replaceable>
2643    </para>
2644   </listitem>
2645  </varlistentry>
2646  <varlistentry>
2647   <term>Default value:</term>
2648   <listitem>
2649    <para>None</para>
2650   </listitem>
2651  </varlistentry>
2652  <varlistentry>
2653   <term>Effect if unset:</term>
2654   <listitem>
2655    <para>
2656     Connections are not kept alive.
2657    </para>
2658   </listitem>
2659  </varlistentry>
2660  <varlistentry>
2661   <term>Notes:</term>
2662   <listitem>
2663    <para>
2664     This option allows clients to keep the connection to &my-app;
2665     alive. If the server supports it, &my-app; will keep
2666     the connection to the server alive as well. Under certain
2667     circumstances this may result in speed-ups.
2668    </para>
2669    <para>
2670     By default, &my-app; will close the connection to the server if
2671     the client connection gets closed, or if the specified timeout
2672     has been reached without a new request coming in. This behaviour
2673     can be changed with the <ulink
2674      url="#CONNECTION-SHARING">connection-sharing</ulink> option.
2675    </para>
2676    <para>
2677     This option has no effect if <application>Privoxy</application>
2678     has been compiled without keep-alive support.
2679    </para>
2680    <para>
2681     Note that a timeout of five seconds as used in the default
2682     configuration file significantly decreases the number of
2683     connections that will be reused. The value is used because
2684     some browsers limit the number of connections they open to
2685     a single host and apply the same limit to proxies. This can
2686     result in a single website <quote>grabbing</quote> all the
2687     connections the browser allows, which means connections to
2688     other websites can't be opened until the connections currently
2689     in use time out.
2690    </para>
2691    <para>
2692     Several users have reported this as a Privoxy bug, so the
2693     default value has been reduced. Consider increasing it to
2694     300 seconds or even more if you think your browser can handle
2695     it. If your browser appears to be hanging, it probably can't.
2696    </para>
2697   </listitem>
2698  </varlistentry>
2699  <varlistentry>
2700   <term>Examples:</term>
2701   <listitem>
2702    <para>
2703     keep-alive-timeout 300
2704    </para>
2705   </listitem>
2706  </varlistentry>
2707 </variablelist>
2708 <![%config-file;[<literallayout>@@keep-alive-timeout 5</literallayout>]]>
2709 </sect3>
2710
2711
2712 <sect3 renderas="sect4" id="tolerate-pipelining"><title>tolerate-pipelining</title>
2713 <variablelist>
2714  <varlistentry>
2715   <term>Specifies:</term>
2716   <listitem>
2717    <para>
2718     Whether or not pipelined requests should be served.
2719    </para>
2720   </listitem>
2721  </varlistentry>
2722  <varlistentry>
2723   <term>Type of value:</term>
2724   <listitem>
2725    <para>
2726     <replaceable>0 or 1.</replaceable>
2727    </para>
2728   </listitem>
2729  </varlistentry>
2730  <varlistentry>
2731   <term>Default value:</term>
2732   <listitem>
2733    <para>None</para>
2734   </listitem>
2735  </varlistentry>
2736  <varlistentry>
2737   <term>Effect if unset:</term>
2738   <listitem>
2739    <para>
2740     If Privoxy receives more than one request at once, it terminates the
2741     client connection after serving the first one.
2742    </para>
2743   </listitem>
2744  </varlistentry>
2745  <varlistentry>
2746   <term>Notes:</term>
2747   <listitem>
2748    <para>
2749     &my-app; currently doesn't pipeline outgoing requests,
2750     thus allowing pipelining on the client connection is not
2751     guaranteed to improve the performance.
2752    </para>
2753    <para>
2754     By default &my-app; tries to discourage clients from pipelining
2755     by discarding aggressively pipelined requests, which forces the
2756     client to resend them through a new connection.
2757    </para>
2758    <para>
2759     This option lets &my-app; tolerate pipelining. Whether or not
2760     that improves performance mainly depends on the client configuration.
2761    </para>
2762    <para>
2763     If you are seeing problems with pages not properly loading,
2764     disabling this option could work around the problem.
2765    </para>
2766   </listitem>
2767  </varlistentry>
2768  <varlistentry>
2769   <term>Examples:</term>
2770   <listitem>
2771    <para>
2772     tolerate-pipelining 1
2773    </para>
2774   </listitem>
2775  </varlistentry>
2776 </variablelist>
2777 <![%config-file;[<literallayout>@@tolerate-pipelining 1</literallayout>]]>
2778 </sect3>
2779
2780
2781 <sect3 renderas="sect4" id="default-server-timeout"><title>default-server-timeout</title>
2782 <variablelist>
2783  <varlistentry>
2784   <term>Specifies:</term>
2785   <listitem>
2786    <para>
2787     Assumed server-side keep-alive timeout if not specified by the server.
2788    </para>
2789   </listitem>
2790  </varlistentry>
2791  <varlistentry>
2792   <term>Type of value:</term>
2793   <listitem>
2794    <para>
2795     <replaceable>Time in seconds.</replaceable>
2796    </para>
2797   </listitem>
2798  </varlistentry>
2799  <varlistentry>
2800   <term>Default value:</term>
2801   <listitem>
2802    <para>None</para>
2803   </listitem>
2804  </varlistentry>
2805  <varlistentry>
2806   <term>Effect if unset:</term>
2807   <listitem>
2808    <para>
2809     Connections for which the server didn't specify the keep-alive
2810     timeout are not reused.
2811    </para>
2812   </listitem>
2813  </varlistentry>
2814  <varlistentry>
2815   <term>Notes:</term>
2816   <listitem>
2817    <para>
2818     Enabling this option significantly increases the number of connections
2819     that are reused, provided the <ulink
2820      url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> option
2821     is also enabled.
2822    </para>
2823    <para>
2824     While it also increases the number of connections problems
2825     when &my-app; tries to reuse a connection that already has
2826     been closed on the server side, or is closed while &my-app;
2827     is trying to reuse it, this should only be a problem if it
2828     happens for the first request sent by the client. If it happens
2829     for requests on reused client connections, &my-app; will simply
2830     close the connection and the client is supposed to retry the
2831     request without bothering the user.
2832    </para>
2833    <para>
2834     Enabling this option is therefore only recommended if the
2835     <ulink
2836      url="#CONNECTION-SHARING">connection-sharing</ulink> option
2837     is disabled.
2838    </para>
2839    <para>
2840     It is an error to specify a value larger than the <ulink
2841      url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> value.
2842    </para>
2843    <para>
2844     This option has no effect if <application>Privoxy</application>
2845     has been compiled without keep-alive support.
2846    </para>
2847   </listitem>
2848  </varlistentry>
2849  <varlistentry>
2850   <term>Examples:</term>
2851   <listitem>
2852    <para>
2853     default-server-timeout 60
2854    </para>
2855   </listitem>
2856  </varlistentry>
2857 </variablelist>
2858 <![%config-file;[<literallayout>@@#default-server-timeout 60</literallayout>]]>
2859 </sect3>
2860
2861
2862 <sect3 renderas="sect4" id="connection-sharing"><title>connection-sharing</title>
2863 <variablelist>
2864  <varlistentry>
2865   <term>Specifies:</term>
2866   <listitem>
2867    <para>
2868     Whether or not outgoing connections that have been kept alive
2869     should be shared between different incoming connections.
2870    </para>
2871   </listitem>
2872  </varlistentry>
2873  <varlistentry>
2874   <term>Type of value:</term>
2875   <listitem>
2876    <para>
2877     <replaceable>0 or 1</replaceable>
2878    </para>
2879   </listitem>
2880  </varlistentry>
2881  <varlistentry>
2882   <term>Default value:</term>
2883   <listitem>
2884    <para>None</para>
2885   </listitem>
2886  </varlistentry>
2887  <varlistentry>
2888   <term>Effect if unset:</term>
2889   <listitem>
2890    <para>
2891     Connections are not shared.
2892    </para>
2893   </listitem>
2894  </varlistentry>
2895  <varlistentry>
2896   <term>Notes:</term>
2897   <listitem>
2898    <para>
2899     This option has no effect if <application>Privoxy</application>
2900     has been compiled without keep-alive support, or if it's disabled.
2901    </para>
2902   </listitem>
2903  </varlistentry>
2904  <varlistentry>
2905   <term>Notes:</term>
2906   <listitem>
2907    <para>
2908     Note that reusing connections doesn't necessary cause speedups.
2909     There are also a few privacy implications you should be aware of.
2910    </para>
2911    <para>
2912     If this option is effective, outgoing connections are shared between
2913     clients (if there are more than one) and closing the browser that initiated
2914     the outgoing connection does no longer affect the connection between &my-app;
2915     and the server unless the client's request hasn't been completed yet.
2916    </para>
2917    <para>
2918     If the outgoing connection  is idle, it will not be closed until either
2919     <application>Privoxy's</application> or the server's timeout is reached.
2920     While it's open, the server knows that the system running &my-app; is still
2921     there.
2922    </para>
2923    <para>
2924     If there are more than one client (maybe even belonging to multiple users),
2925     they will be able to reuse each others connections. This is potentially
2926     dangerous in case of authentication schemes like NTLM where only the
2927     connection is authenticated, instead of requiring authentication for
2928     each request.
2929    </para>
2930    <para>
2931     If there is only a single client, and if said client can keep connections
2932     alive on its own, enabling this option has next to no effect. If the client
2933     doesn't support connection keep-alive, enabling this option may make sense
2934     as it allows &my-app; to keep outgoing connections alive even if the client
2935     itself doesn't support it.
2936    </para>
2937    <para>
2938     You should also be aware that enabling this option increases the likelihood
2939     of getting the "No server or forwarder data" error message, especially if you
2940     are using a slow connection to the Internet.
2941    </para>
2942    <para>
2943     This option should only be used by experienced users who
2944     understand the risks and can weight them against the benefits.
2945    </para>
2946   </listitem>
2947  </varlistentry>
2948  <varlistentry>
2949   <term>Examples:</term>
2950   <listitem>
2951    <para>
2952     connection-sharing 1
2953    </para>
2954   </listitem>
2955  </varlistentry>
2956 </variablelist>
2957 <![%config-file;[<literallayout>@@#connection-sharing 1</literallayout>]]>
2958 </sect3>
2959
2960
2961 <sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
2962 <variablelist>
2963  <varlistentry>
2964   <term>Specifies:</term>
2965   <listitem>
2966    <para>
2967     Number of seconds after which a socket times out if
2968     no data is received.
2969    </para>
2970   </listitem>
2971  </varlistentry>
2972  <varlistentry>
2973   <term>Type of value:</term>
2974   <listitem>
2975    <para>
2976     <replaceable>Time in seconds.</replaceable>
2977    </para>
2978   </listitem>
2979  </varlistentry>
2980  <varlistentry>
2981   <term>Default value:</term>
2982   <listitem>
2983    <para>None</para>
2984   </listitem>
2985  </varlistentry>
2986  <varlistentry>
2987   <term>Effect if unset:</term>
2988   <listitem>
2989    <para>
2990     A default value of 300 seconds is used.
2991    </para>
2992   </listitem>
2993  </varlistentry>
2994  <varlistentry>
2995   <term>Notes:</term>
2996   <listitem>
2997    <para>
2998     The default is quite high and you probably want to reduce it.
2999     If you aren't using an occasionally slow proxy like Tor, reducing
3000     it to a few seconds should be fine.
3001    </para>
3002   </listitem>
3003  </varlistentry>
3004  <varlistentry>
3005   <term>Examples:</term>
3006   <listitem>
3007    <para>
3008     socket-timeout 300
3009    </para>
3010   </listitem>
3011  </varlistentry>
3012 </variablelist>
3013 <![%config-file;[<literallayout>@@socket-timeout 300</literallayout>]]>
3014 </sect3>
3015
3016
3017 <sect3 renderas="sect4" id="max-client-connections"><title>max-client-connections</title>
3018 <variablelist>
3019  <varlistentry>
3020   <term>Specifies:</term>
3021   <listitem>
3022    <para>
3023     Maximum number of client connections that will be served.
3024    </para>
3025   </listitem>
3026  </varlistentry>
3027  <varlistentry>
3028   <term>Type of value:</term>
3029   <listitem>
3030    <para>
3031     <replaceable>Positive number.</replaceable>
3032    </para>
3033   </listitem>
3034  </varlistentry>
3035  <varlistentry>
3036   <term>Default value:</term>
3037   <listitem>
3038    <para>128</para>
3039   </listitem>
3040  </varlistentry>
3041  <varlistentry>
3042   <term>Effect if unset:</term>
3043   <listitem>
3044    <para>
3045     Connections are served until a resource limit is reached.
3046    </para>
3047   </listitem>
3048  </varlistentry>
3049  <varlistentry>
3050   <term>Notes:</term>
3051   <listitem>
3052    <para>
3053     &my-app; creates one thread (or process) for every incoming client
3054     connection that isn't rejected based on the access control settings.
3055    </para>
3056    <para>
3057     If the system is powerful enough, &my-app; can theoretically deal with
3058     several hundred (or thousand) connections at the same time, but some
3059     operating systems enforce resource limits by shutting down offending
3060     processes and their default limits may be below the ones &my-app; would
3061     require under heavy load.
3062    </para>
3063    <para>
3064     Configuring &my-app; to enforce a connection limit below the thread
3065     or process limit used by the operating system makes sure this doesn't
3066     happen. Simply increasing the operating system's limit would work too,
3067     but if &my-app; isn't the only application running on the system,
3068     you may actually want to limit the resources used by &my-app;.
3069    </para>
3070    <para>
3071     If &my-app; is only used by a single trusted user, limiting the
3072     number of client connections is probably unnecessary. If there
3073     are multiple possibly untrusted users you probably still want to
3074     additionally use a packet filter to limit the maximal number of
3075     incoming connections per client. Otherwise a malicious user could
3076     intentionally create a high number of connections to prevent other
3077     users from using &my-app;.
3078    </para>
3079    <para>
3080     Obviously using this option only makes sense if you choose a limit
3081     below the one enforced by the operating system.
3082    </para>
3083    <para>
3084     One most POSIX-compliant systems &my-app; can't properly deal with
3085     more than FD_SETSIZE file descriptors at the same time and has to reject
3086     connections if the limit is reached. This will likely change in a
3087     future version, but currently this limit can't be increased without
3088     recompiling &my-app; with a different FD_SETSIZE limit.
3089    </para>
3090   </listitem>
3091  </varlistentry>
3092  <varlistentry>
3093   <term>Examples:</term>
3094   <listitem>
3095    <para>
3096     max-client-connections 256
3097    </para>
3098   </listitem>
3099  </varlistentry>
3100 </variablelist>
3101 <![%config-file;[<literallayout>@@#max-client-connections 256</literallayout>]]>
3102 </sect3>
3103
3104
3105 <sect3 renderas="sect4" id="handle-as-empty-doc-returns-ok"><title>handle-as-empty-doc-returns-ok</title>
3106 <variablelist>
3107  <varlistentry>
3108   <term>Specifies:</term>
3109   <listitem>
3110    <para>
3111     The status code Privoxy returns for pages blocked with
3112     <!--  URL will only end up in the user manual so the relative link should work. -->
3113     <literal><ulink url="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">+handle-as-empty-document</ulink></literal>.
3114    </para>
3115   </listitem>
3116  </varlistentry>
3117  <varlistentry>
3118   <term>Type of value:</term>
3119   <listitem>
3120    <para>
3121     <replaceable>0 or 1</replaceable>
3122    </para>
3123   </listitem>
3124  </varlistentry>
3125  <varlistentry>
3126   <term>Default value:</term>
3127   <listitem>
3128    <para>0</para>
3129   </listitem>
3130  </varlistentry>
3131  <varlistentry>
3132   <term>Effect if unset:</term>
3133   <listitem>
3134    <para>
3135     Privoxy returns a status 403(forbidden) for all blocked pages.
3136    </para>
3137   </listitem>
3138  </varlistentry>
3139  <varlistentry>
3140   <term>Effect if set:</term>
3141   <listitem>
3142    <para>
3143     Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
3144     and a status 403(Forbidden) for all other blocked pages.
3145    </para>
3146   </listitem>
3147  </varlistentry>
3148  <varlistentry>
3149   <term>Notes:</term>
3150   <listitem>
3151    <para>
3152     This is a work-around for Firefox bug 492459:
3153     <quote>
3154     Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.
3155     </quote>
3156     (<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
3157         >https://bugzilla.mozilla.org/show_bug.cgi?id=492459</ulink>)
3158     As the bug has been fixed for quite some time this option should no longer
3159     be needed and will be removed in a future release. Please speak up if you
3160     have a reason why the option should be kept around.
3161    </para>
3162   </listitem>
3163  </varlistentry>
3164 </variablelist>
3165 <![%config-file;[<literallayout>@@#handle-as-empty-doc-returns-ok 1</literallayout>]]>
3166 </sect3>
3167
3168
3169 <sect3 renderas="sect4" id="enable-compression"><title>enable-compression</title>
3170 <variablelist>
3171  <varlistentry>
3172   <term>Specifies:</term>
3173   <listitem>
3174    <para>
3175     Whether or not buffered content is compressed before delivery.
3176    </para>
3177   </listitem>
3178  </varlistentry>
3179  <varlistentry>
3180   <term>Type of value:</term>
3181   <listitem>
3182    <para>
3183     <replaceable>0 or 1</replaceable>
3184    </para>
3185   </listitem>
3186  </varlistentry>
3187  <varlistentry>
3188   <term>Default value:</term>
3189   <listitem>
3190    <para>0</para>
3191   </listitem>
3192  </varlistentry>
3193  <varlistentry>
3194   <term>Effect if unset:</term>
3195   <listitem>
3196    <para>
3197     Privoxy does not compress buffered content.
3198    </para>
3199   </listitem>
3200  </varlistentry>
3201  <varlistentry>
3202   <term>Effect if set:</term>
3203   <listitem>
3204    <para>
3205     Privoxy compresses buffered content before delivering it to the client,
3206     provided the client supports it.
3207    </para>
3208   </listitem>
3209  </varlistentry>
3210  <varlistentry>
3211   <term>Notes:</term>
3212   <listitem>
3213    <para>
3214     This directive is only supported if Privoxy has been compiled with
3215     FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB.
3216    </para>
3217    <para>
3218     Compressing buffered content is mainly useful if Privoxy and the
3219     client are running on different systems. If they are running on the
3220     same system, enabling compression is likely to slow things down.
3221     If you didn't measure otherwise, you should assume that it does
3222     and keep this option disabled.
3223    </para>
3224    <para>
3225     Privoxy will not compress buffered content below a certain length.
3226    </para>
3227   </listitem>
3228  </varlistentry>
3229 </variablelist>
3230 <![%config-file;[<literallayout>@@#enable-compression 1</literallayout>]]>
3231 </sect3>
3232
3233
3234 <sect3 renderas="sect4" id="compression-level"><title>compression-level</title>
3235 <variablelist>
3236  <varlistentry>
3237   <term>Specifies:</term>
3238   <listitem>
3239    <para>
3240     The compression level that is passed to the zlib library when compressing buffered content.
3241    </para>
3242   </listitem>
3243  </varlistentry>
3244  <varlistentry>
3245   <term>Type of value:</term>
3246   <listitem>
3247    <para>
3248     <replaceable>Positive number ranging from 0 to 9.</replaceable>
3249    </para>
3250   </listitem>
3251  </varlistentry>
3252  <varlistentry>
3253   <term>Default value:</term>
3254   <listitem>
3255    <para>1</para>
3256   </listitem>
3257  </varlistentry>
3258  <varlistentry>
3259   <term>Notes:</term>
3260   <listitem>
3261    <para>
3262      Compressing the data more takes usually longer than compressing
3263      it less or not compressing it at all. Which level is best depends
3264      on the connection between Privoxy and the client. If you can't
3265      be bothered to benchmark it for yourself, you should stick with
3266      the default and keep compression disabled.
3267    </para>
3268    <para>
3269      If compression is disabled, the compression level is irrelevant.
3270    </para>
3271   </listitem>
3272  </varlistentry>
3273  <varlistentry>
3274   <term>Examples:</term>
3275   <listitem>
3276    <para>
3277     <screen>
3278     # Best speed (compared to the other levels)
3279     compression-level 1
3280     # Best compression
3281     compression-level 9
3282     # No compression. Only useful for testing as the added header
3283     # slightly increases the amount of data that has to be sent.
3284     # If your benchmark shows that using this compression level
3285     # is superior to using no compression at all, the benchmark
3286     # is likely to be flawed.
3287     compression-level 0
3288     </screen>
3289    </para>
3290   </listitem>
3291  </varlistentry>
3292 </variablelist>
3293 <![%config-file;[<literallayout>@@#compression-level 1</literallayout>]]>
3294 </sect3>
3295
3296
3297 <sect3 renderas="sect4" id="client-header-order"><title>client-header-order</title>
3298 <variablelist>
3299  <varlistentry>
3300   <term>Specifies:</term>
3301   <listitem>
3302    <para>
3303     The order in which client headers are sorted before forwarding them.
3304    </para>
3305   </listitem>
3306  </varlistentry>
3307  <varlistentry>
3308   <term>Type of value:</term>
3309   <listitem>
3310    <para>
3311     <replaceable>Client header names delimited by spaces or tabs</replaceable>
3312    </para>
3313   </listitem>
3314  </varlistentry>
3315  <varlistentry>
3316   <term>Default value:</term>
3317   <listitem>
3318    <para>None</para>
3319   </listitem>
3320  </varlistentry>
3321  <varlistentry>
3322   <term>Notes:</term>
3323   <listitem>
3324    <para>
3325      By default &my-app; leaves the client headers in the order they
3326      were sent by the client. Headers are modified in-place, new headers
3327      are added at the end of the already existing headers.
3328    </para>
3329    <para>
3330      The header order can be used to fingerprint client requests
3331      independently of other headers like the User-Agent.
3332    </para>
3333    <para>
3334      This directive allows to sort the headers differently to better
3335      mimic a different User-Agent. Client headers will be emitted
3336      in the order given, headers whose name isn't explicitly specified
3337      are added at the end.
3338    </para>
3339    <para>
3340      Note that sorting headers in an uncommon way will make fingerprinting
3341      actually easier. Encrypted headers are not affected by this directive.
3342    </para>
3343   </listitem>
3344  </varlistentry>
3345 </variablelist>
3346 <![%config-file;[<literallayout>@@#client-header-order Host \
3347  User-Agent \
3348  Accept \
3349  Accept-Language \
3350  Accept-Encoding \
3351  Proxy-Connection \
3352  Referer \
3353  Cookie \
3354  DNT \
3355  If-Modified-Since \
3356  Cache-Control \
3357  Content-Length \
3358  Content-Type
3359 </literallayout>]]>
3360 </sect3>
3361
3362
3363 </sect2>
3364
3365 <!--  ~  End section  ~  -->
3366
3367
3368 <!--   ~~~~~       New section      ~~~~~     -->
3369
3370 <sect2 id="windows-gui">
3371 <title>Windows GUI Options</title>
3372 <para>
3373  <application>Privoxy</application> has a number of options specific to the
3374  Windows GUI interface:
3375 </para>
3376
3377 <anchor id="activity-animation">
3378 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3379 <para>
3380  If <quote>activity-animation</quote> is set to 1, the
3381  <application>Privoxy</application> icon will animate when
3382  <quote>Privoxy</quote> is active. To turn off, set to 0.
3383 </para>
3384
3385 <![%config-file;[<literallayout>@@#activity-animation   1</literallayout>]]>
3386 <![%user-man;[
3387 <para>
3388  <literal>
3389   <msgtext>
3390    <literallayout>
3391   <emphasis>activity-animation   1</emphasis>
3392    </literallayout>
3393   </msgtext>
3394  </literal>
3395 </para>
3396 ]]>
3397
3398 <anchor id="log-messages">
3399 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3400 <para>
3401  If <quote>log-messages</quote> is set to 1,
3402  <application>Privoxy</application> copies log messages to the console
3403  window.
3404  The log detail depends on the <link linkend="debug">debug</link> directive.
3405 </para>
3406
3407 <![%config-file;[<literallayout>@@#log-messages   1</literallayout>]]>
3408 <![%user-man;[
3409 <para>
3410  <literal>
3411   <msgtext>
3412    <literallayout>
3413   <emphasis>log-messages       1</emphasis>
3414    </literallayout>
3415   </msgtext>
3416  </literal>
3417 </para>
3418 ]]>
3419
3420 <anchor id="log-buffer-size">
3421 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3422 <para>
3423  If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
3424  i.e. the amount of memory used for the log messages displayed in the
3425  console window, will be limited to <quote>log-max-lines</quote> (see below).
3426 </para>
3427
3428 <para>
3429  Warning: Setting this to 0 will result in the buffer to grow infinitely and
3430  eat up all your memory!
3431 </para>
3432
3433 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
3434 <![%user-man;[
3435 <para>
3436  <literal>
3437   <msgtext>
3438    <literallayout>
3439   <emphasis>log-buffer-size      1</emphasis>
3440    </literallayout>
3441   </msgtext>
3442  </literal>
3443 </para>
3444 ]]>
3445
3446 <anchor id="log-max-lines">
3447 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3448 <para>
3449  <application>log-max-lines</application> is the maximum number of lines held
3450  in the log buffer. See above.
3451 </para>
3452
3453 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
3454 <![%user-man;[
3455 <para>
3456  <literal>
3457   <msgtext>
3458    <literallayout>
3459   <emphasis>log-max-lines      200</emphasis>
3460    </literallayout>
3461   </msgtext>
3462  </literal>
3463 </para>
3464 ]]>
3465
3466 <anchor id="log-highlight-messages">
3467 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3468 <para>
3469  If <quote>log-highlight-messages</quote> is set to 1,
3470  <application>Privoxy</application> will highlight portions of the log
3471  messages with a bold-faced font:
3472 </para>
3473
3474 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
3475 <![%user-man;[
3476 <para>
3477  <literal>
3478   <msgtext>
3479    <literallayout>
3480   <emphasis>log-highlight-messages   1</emphasis>
3481    </literallayout>
3482   </msgtext>
3483  </literal>
3484 </para>
3485 ]]>
3486
3487 <anchor id="log-font-name">
3488 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3489 <para>
3490  The font used in the console window:
3491 </para>
3492
3493 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
3494 <![%user-man;[
3495 <para>
3496  <literal>
3497   <msgtext>
3498    <literallayout>
3499   <emphasis>log-font-name        Comic Sans MS</emphasis>
3500    </literallayout>
3501   </msgtext>
3502  </literal>
3503 </para>
3504 ]]>
3505
3506 <anchor id="log-font-size">
3507 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3508 <para>
3509  Font size used in the console window:
3510 </para>
3511
3512 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
3513 <![%user-man;[
3514 <para>
3515  <literal>
3516   <msgtext>
3517    <literallayout>
3518   <emphasis>log-font-size        8</emphasis>
3519    </literallayout>
3520   </msgtext>
3521  </literal>
3522 </para>
3523 ]]>
3524
3525 <anchor id="show-on-task-bar">
3526 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3527 <para>
3528  <quote>show-on-task-bar</quote> controls whether or not
3529  <application>Privoxy</application> will appear as a button on the Task bar
3530  when minimized:
3531 </para>
3532
3533 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
3534 <![%user-man;[
3535 <para>
3536  <literal>
3537   <msgtext>
3538    <literallayout>
3539   <emphasis>show-on-task-bar     0</emphasis>
3540    </literallayout>
3541   </msgtext>
3542  </literal>
3543 </para>
3544 ]]>
3545
3546 <anchor id="close-button-minimizes">
3547 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3548 <para>
3549  If <quote>close-button-minimizes</quote> is set to 1, the Windows close
3550  button will minimize <application>Privoxy</application> instead of closing
3551  the program (close with the exit option on the File menu).
3552 </para>
3553
3554 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
3555 <![%user-man;[
3556 <para>
3557  <literal>
3558   <msgtext>
3559    <literallayout>
3560   <emphasis>close-button-minimizes  1</emphasis>
3561    </literallayout>
3562   </msgtext>
3563  </literal>
3564 </para>
3565 ]]>
3566
3567 <anchor id="hide-console">
3568 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3569 <para>
3570  The <quote>hide-console</quote> option is specific to the MS-Win console
3571  version of <application>Privoxy</application>. If this option is used,
3572  <application>Privoxy</application> will disconnect from and hide the
3573  command console.
3574 </para>
3575
3576 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
3577 <![%user-man;[
3578 <para>
3579  <literal>
3580   <msgtext>
3581    <literallayout>
3582   #<emphasis>hide-console</emphasis>
3583    </literallayout>
3584   </msgtext>
3585  </literal>
3586 </para>
3587 ]]>
3588
3589 </sect2>
3590 </sect1>
3591
3592 <!-- end config content common to both outputs -->
3593
3594 <![%config-file;[
3595 <!-- These are dummy anchors to keep the processor quiet            -->
3596 <!-- when building config-file only (ie. they are used in u-m only) -->
3597 <sect1 label="">
3598 <title></title>
3599 <anchor id="filter">
3600 <anchor id="filter-file">
3601 <anchor id="regex">
3602 <anchor id="actions-file">
3603 <anchor id="af-patterns">
3604 </sect1>
3605 ]]>
3606
3607 <!-- eof p-config.sgml -->