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