doc/source/p-config.sgml

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