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