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