doc/source/p-config.sgml

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