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.82 2012/07/27 17:36:06 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.82 2012/07/27 17:36:06 fabiankeil Exp $
 101 </para>
 102 <para>
 103 Copyright (C) 2001-2011 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>). For Red Hat based Linux distributions, a
 860     <command>logrotate</command> script has been included.
 861    </para>
 862    <para>
 863     Any log files must be writable by whatever user <application>Privoxy</application>
 864     is being run as (on Unix, default user id is <quote>privoxy</quote>).
 865    </para>
 866   </listitem>
 867  </varlistentry>
 868 </variablelist>
 869
 870 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
 871 </sect3>
 872
 873
 874 <!--   ~~~~~       New section      ~~~~~     -->
 875 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
 876 <variablelist>
 877  <varlistentry>
 878   <term>Specifies:</term>
 879   <listitem>
 880    <para>
 881     The name of the trust file to use
 882    </para>
 883   </listitem>
 884  </varlistentry>
 885  <varlistentry>
 886   <term>Type of value:</term>
 887   <listitem>
 888    <para>File name, relative to <literal>confdir</literal></para>
 889   </listitem>
 890  </varlistentry>
 891  <varlistentry>
 892   <term>Default value:</term>
 893   <listitem>
 894    <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
 895   </listitem>
 896  </varlistentry>
 897  <varlistentry>
 898   <term>Effect if unset:</term>
 899   <listitem>
 900    <para>
 901     The entire trust mechanism is disabled.
 902    </para>
 903   </listitem>
 904  </varlistentry>
 905  <varlistentry>
 906   <term>Notes:</term>
 907   <listitem>
 908    <para>
 909     The trust mechanism is an experimental feature for building white-lists and should
 910     be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
 911    </para>
 912    <para>
 913     If you specify a trust file, <application>Privoxy</application> will only allow
 914     access to sites that are specified in the trustfile. Sites can be listed
 915     in one of two ways:
 916    </para>
 917    <para>
 918     Prepending a <literal>~</literal> character limits access to this site
 919     only (and any sub-paths within this site), e.g.
 920     <literal>~www.example.com</literal> allows access to
 921     <literal>~www.example.com/features/news.html</literal>, etc.
 922    </para>
 923    <para>
 924     Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
 925     prepending the name with a <literal>+</literal> character. The effect is that
 926     access to untrusted sites will be granted -- but only if a link from this
 927     trusted referrer was used to get there. The link target will then be added
 928     to the <quote>trustfile</quote> so that future, direct accesses will be
 929     granted. Sites added via this mechanism do not become trusted referrers
 930     themselves (i.e. they are added with a <literal>~</literal> designation).
 931     There is a limit of 512 such entries, after which new entries will not be
 932     made.
 933    </para>
 934    <para>
 935     If you use the <literal>+</literal> operator in the trust file, it may grow
 936     considerably over time.
 937    </para>
 938    <para>
 939     It is recommended that <application>Privoxy</application> be compiled with
 940     the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
 941     <literal> --disable-editor</literal> options, if this feature is to be
 942     used.
 943    </para>
 944    <para>
 945     Possible applications include limiting Internet access for children.
 946    </para>
 947
 948   </listitem>
 949  </varlistentry>
 950 </variablelist>
 951
 952 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
 953 </sect3>
 954 </sect2>
 955
 956 <!--  ~  End section  ~  -->
 957
 958 <!--   ~~~~~       New section      ~~~~~     -->
 959 <sect2 id="debugging">
 960 <title>Debugging</title>
 961
 962  <para>
 963   These options are mainly useful when tracing a problem.
 964   Note that you might also want to invoke
 965   <application>Privoxy</application> with the <literal>--no-daemon</literal>
 966   command line option when debugging.
 967  </para>
 968
 969 <sect3 renderas="sect4" id="debug"><title>debug</title>
 970
 971 <variablelist>
 972  <varlistentry>
 973   <term>Specifies:</term>
 974   <listitem>
 975    <para>
 976     Key values that determine what information gets logged.
 977    </para>
 978   </listitem>
 979  </varlistentry>
 980  <varlistentry>
 981   <term>Type of value:</term>
 982   <listitem>
 983    <para>Integer values</para>
 984   </listitem>
 985  </varlistentry>
 986  <varlistentry>
 987   <term>Default value:</term>
 988   <listitem>
 989    <para>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</para>
 990   </listitem>
 991  </varlistentry>
 992  <varlistentry>
 993   <term>Effect if unset:</term>
 994   <listitem>
 995    <para>
 996     Default value is used (see above).
 997    </para>
 998   </listitem>
 999  </varlistentry>
1000  <varlistentry>
1001   <term>Notes:</term>
1002   <listitem>
1003    <para>
1004     The available debug levels are:
1005    </para>
1006    <para>
1007     <programlisting>
1008   debug     1 # Log the destination for each request &my-app; let through. See also debug 1024.
1009   debug     2 # show each connection status
1010   debug     4 # show I/O status
1011   debug     8 # show header parsing
1012   debug    16 # log all data written to the network
1013   debug    32 # debug force feature
1014   debug    64 # debug regular expression filters
1015   debug   128 # debug redirects
1016   debug   256 # debug GIF de-animation
1017   debug   512 # Common Log Format
1018   debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
1019   debug  2048 # CGI user interface
1020   debug  4096 # Startup banner and warnings.
1021   debug  8192 # Non-fatal errors
1022   debug 32768 # log all data read from the network
1023   debug 65536 # Log the applying actions
1024 </programlisting>
1025    </para>
1026    <para>
1027     To select multiple debug levels, you can either add them or use
1028     multiple <literal>debug</literal> lines.
1029    </para>
1030    <para>
1031     A debug level of 1 is informative because it will show you each request
1032     as it happens. <emphasis>1, 1024, 4096 and 8192 are recommended</emphasis>
1033     so that you will notice when things go wrong. The other levels are
1034     probably only of interest if you are hunting down a specific problem.
1035     They can produce a hell of an output (especially 16).
1036     <!-- LOL -->
1037    </para>
1038    <para>
1039     &my-app; used to ship with the debug levels recommended above enabled by
1040     default, but due to privacy concerns 3.0.7 and later are configured to
1041     only log fatal errors.
1042    </para>
1043    <para>
1044     If you are used to the more verbose settings, simply enable the debug lines
1045     below again.
1046    </para>
1047    <para>
1048     If you want to use pure CLF (Common Log Format), you should set <quote>debug
1049     512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1050    </para>
1051    <para>
1052     <application>Privoxy</application> has a hard-coded limit for the
1053     length of log messages. If it's reached, messages are logged truncated
1054     and marked with <quote>... [too long, truncated]</quote>.
1055    </para>
1056    <para>
1057     Please don't file any support requests without trying to reproduce
1058     the problem with increased debug level first. Once you read the log
1059     messages, you may even be able to solve the problem on your own.
1060    </para>
1061   </listitem>
1062  </varlistentry>
1063 </variablelist>
1064
1065 <![%config-file;[<literallayout>@@#debug     1 # Log the destination for each request &my-app; let through.</literallayout>]]>
1066 <![%config-file;[<literallayout>@@#debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
1067 <![%config-file;[<literallayout>@@#debug  4096 # Startup banner and warnings</literallayout>]]>
1068 <![%config-file;[<literallayout>@@#debug  8192 # Non-fatal errors</literallayout>]]>
1069 </sect3>
1070
1071
1072 <!--   ~~~~~       New section      ~~~~~     -->
1073 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1074
1075 <variablelist>
1076  <varlistentry>
1077   <term>Specifies:</term>
1078   <listitem>
1079    <para>
1080     Whether to run only one server thread.
1081    </para>
1082   </listitem>
1083  </varlistentry>
1084  <varlistentry>
1085   <term>Type of value:</term>
1086   <listitem>
1087    <para><emphasis>None</emphasis></para>
1088   </listitem>
1089  </varlistentry>
1090  <varlistentry>
1091   <term>Default value:</term>
1092   <listitem>
1093    <para><emphasis>Unset</emphasis></para>
1094   </listitem>
1095  </varlistentry>
1096  <varlistentry>
1097   <term>Effect if unset:</term>
1098   <listitem>
1099    <para>
1100     Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1101     serve multiple requests simultaneously.
1102    </para>
1103   </listitem>
1104  </varlistentry>
1105  <varlistentry>
1106   <term>Notes:</term>
1107   <listitem>
1108    <para>
1109     This option is only there for debugging purposes.
1110     <emphasis>It will drastically reduce performance.</emphasis>
1111    </para>
1112   </listitem>
1113  </varlistentry>
1114 </variablelist>
1115
1116 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1117 </sect3>
1118
1119 <!--   ~~~~~       New section      ~~~~~     -->
1120 <sect3 renderas="sect4" id="hostname"><title>hostname</title>
1121
1122 <variablelist>
1123  <varlistentry>
1124   <term>Specifies:</term>
1125   <listitem>
1126    <para>
1127     The hostname shown on the CGI pages.
1128    </para>
1129   </listitem>
1130  </varlistentry>
1131  <varlistentry>
1132   <term>Type of value:</term>
1133   <listitem>
1134    <para>Text</para>
1135   </listitem>
1136  </varlistentry>
1137  <varlistentry>
1138   <term>Default value:</term>
1139   <listitem>
1140    <para><emphasis>Unset</emphasis></para>
1141   </listitem>
1142  </varlistentry>
1143  <varlistentry>
1144   <term>Effect if unset:</term>
1145   <listitem>
1146    <para>
1147     The hostname provided by the operating system is used.
1148    </para>
1149   </listitem>
1150  </varlistentry>
1151  <varlistentry>
1152   <term>Notes:</term>
1153   <listitem>
1154    <para>
1155     On some misconfigured systems resolving the hostname fails or
1156     takes too much time and slows Privoxy down. Setting a fixed hostname
1157     works around the problem.
1158    </para>
1159    <para>
1160     In other circumstances it might be desirable to show a hostname
1161     other than the one returned by the operating system. For example
1162     if the system has several different hostnames and you don't want
1163     to use the first one.
1164    </para>
1165    <para>
1166     Note that Privoxy does not validate the specified hostname value.
1167    </para>
1168   </listitem>
1169  </varlistentry>
1170 </variablelist>
1171
1172 <![%config-file;[<literallayout>@@#hostname hostname.example.org</literallayout>]]>
1173 </sect3>
1174
1175 </sect2>
1176
1177 <!--  ~  End section  ~  -->
1178
1179
1180 <!--   ~~~~~       New section      ~~~~~     -->
1181 <sect2 id="access-control">
1182 <title>Access Control and Security</title>
1183
1184  <para>
1185   This section of the config file controls the security-relevant aspects
1186   of <application>Privoxy</application>'s configuration.
1187  </para>
1188
1189
1190 <!--   ~~~~~       New section      ~~~~~     -->
1191 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1192
1193 <variablelist>
1194  <varlistentry>
1195   <term>Specifies:</term>
1196   <listitem>
1197    <para>
1198     The address and TCP port on which <application>Privoxy</application> will
1199     listen for client requests.
1200    </para>
1201   </listitem>
1202  </varlistentry>
1203  <varlistentry>
1204   <term>Type of value:</term>
1205   <listitem>
1206    <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1207    <para>[<replaceable class="parameter">Hostname</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1208   </listitem>
1209  </varlistentry>
1210
1211  <varlistentry>
1212   <term>Default value:</term>
1213   <listitem>
1214    <para>127.0.0.1:8118</para>
1215   </listitem>
1216  </varlistentry>
1217  <varlistentry>
1218   <term>Effect if unset:</term>
1219   <listitem>
1220    <para>
1221     Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable and
1222     recommended for home users who run <application>Privoxy</application> on
1223     the same machine as their browser.
1224    </para>
1225   </listitem>
1226  </varlistentry>
1227  <varlistentry>
1228   <term>Notes:</term>
1229   <listitem>
1230    <para>
1231     You will need to configure your browser(s) to this proxy address and port.
1232    </para>
1233    <para>
1234     If you already have another service running on port 8118, or if you want to
1235     serve requests from other machines (e.g. on your local network) as well, you
1236     will need to override the default.
1237    </para>
1238    <para>
1239     You can use this statement multiple times to make
1240     <application>Privoxy</application> listen on more ports or more
1241     <abbrev>IP</abbrev> addresses. Suitable if your operating system does not
1242     support sharing <abbrev>IPv6</abbrev> and <abbrev>IPv4</abbrev> protocols
1243     on the same socket.
1244    </para>
1245    <para>
1246     If a hostname is used instead of an IP address, <application>Privoxy</application>
1247     will try to resolve it to an IP address and if there are multiple, use the first
1248     one returned.
1249    </para>
1250    <para>
1251     If the address for the hostname isn't already known on the system
1252     (for example because it's in /etc/hostname), this may result in DNS
1253     traffic.
1254    </para>
1255    <para>
1256     If the specified address isn't available on the system, or if the
1257     hostname can't be resolved, <application>Privoxy</application>
1258     will fail to start.
1259    </para>
1260    <para>
1261     IPv6 addresses containing colons have to be quoted by brackets.
1262     They can only be used if <application>Privoxy</application> has
1263     been compiled with IPv6 support. If you aren't sure if your version
1264     supports it, have a look at
1265     <literal>http://config.privoxy.org/show-status</literal>.
1266    </para>
1267    <para>
1268     Some operating systems will prefer IPv6 to IPv4 addresses even if the
1269     system has no IPv6 connectivity which is usually not expected by the user.
1270     Some even rely on DNS to resolve localhost which mean the "localhost" address
1271     used may not actually be local.
1272    </para>
1273    <para>
1274     It is therefore recommended to explicitly configure the intended IP address
1275     instead of relying on the operating system, unless there's a strong reason not to.
1276    </para>
1277    <para>
1278     If you leave out the address, <application>Privoxy</application> will bind to all
1279     IPv4 interfaces (addresses) on your machine and may become reachable from the
1280     Internet and/or the local network. Be aware that some GNU/Linux distributions
1281     modify that behaviour without updating the documentation. Check for non-standard
1282     patches if your <application>Privoxy</application> version behaves differently.
1283    </para>
1284    <para>
1285     If you configure <application>Privoxy</application> to be reachable from the
1286     network, consider using <link linkend="acls">access control lists</link>
1287     (ACL's, see below), and/or a firewall.
1288    </para>
1289    <para>
1290     If you open <application>Privoxy</application> to untrusted users, you will
1291     also want to make sure that the following actions are disabled:  <literal><link
1292     linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1293     <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1294    </para>
1295   </listitem>
1296  </varlistentry>
1297  <varlistentry>
1298   <term>Example:</term>
1299   <listitem>
1300    <para>
1301      Suppose you are running <application>Privoxy</application> on
1302      a machine which has the address 192.168.0.1 on your local private network
1303      (192.168.0.0) and has another outside connection with a different address.
1304      You want it to serve requests from inside only:
1305    </para>
1306    <para>
1307     <programlisting>
1308   listen-address  192.168.0.1:8118
1309 </programlisting>
1310    </para>
1311    <para>
1312     Suppose you are running <application>Privoxy</application> on an
1313     IPv6-capable machine and you want it to listen on the IPv6 address
1314     of the loopback device:
1315    </para>
1316    <para>
1317     <programlisting>
1318   listen-address [::1]:8118
1319 </programlisting>
1320    </para>
1321   </listitem>
1322  </varlistentry>
1323 </variablelist>
1324
1325 <![%config-file;[<literallayout>@@listen-address  127.0.0.1:8118</literallayout>]]>
1326 </sect3>
1327
1328
1329 <!--   ~~~~~       New section      ~~~~~     -->
1330 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1331
1332 <variablelist>
1333  <varlistentry>
1334   <term>Specifies:</term>
1335   <listitem>
1336    <para>
1337     Initial state of "toggle" status
1338    </para>
1339   </listitem>
1340  </varlistentry>
1341  <varlistentry>
1342   <term>Type of value:</term>
1343   <listitem>
1344    <para>1 or 0</para>
1345   </listitem>
1346  </varlistentry>
1347  <varlistentry>
1348   <term>Default value:</term>
1349   <listitem>
1350    <para>1</para>
1351   </listitem>
1352  </varlistentry>
1353  <varlistentry>
1354   <term>Effect if unset:</term>
1355   <listitem>
1356    <para>
1357     Act as if toggled on
1358    </para>
1359   </listitem>
1360  </varlistentry>
1361  <varlistentry>
1362   <term>Notes:</term>
1363   <listitem>
1364    <para>
1365     If set to 0, <application>Privoxy</application> will start in
1366     <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1367     content-neutral proxy with both ad blocking and content filtering
1368     disabled. See <literal>enable-remote-toggle</literal> below.
1369 <!--
1370     This is not really useful
1371     anymore, since toggling is much easier via <ulink
1372     url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1373     editing the <filename>conf</filename> file.
1374
1375     Remote toggling is now disabled by default. fk 2007-11-07)
1376 -->
1377    </para>
1378    <para>
1379     The windows version will only display the toggle icon in the system tray
1380     if this option is present.
1381    </para>
1382   </listitem>
1383  </varlistentry>
1384 </variablelist>
1385
1386 <![%config-file;[<literallayout>@@toggle  1</literallayout>]]>
1387 </sect3>
1388
1389
1390 <!--   ~~~~~       New section      ~~~~~     -->
1391 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1392 <variablelist>
1393  <varlistentry>
1394   <term>Specifies:</term>
1395   <listitem>
1396    <para>
1397     Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1398     feature</ulink> may be used
1399    </para>
1400   </listitem>
1401  </varlistentry>
1402  <varlistentry>
1403   <term>Type of value:</term>
1404   <listitem>
1405    <para>0 or 1</para>
1406   </listitem>
1407  </varlistentry>
1408  <varlistentry>
1409   <term>Default value:</term>
1410   <listitem>
1411    <para>0</para>
1412   </listitem>
1413  </varlistentry>
1414  <varlistentry>
1415   <term>Effect if unset:</term>
1416   <listitem>
1417    <para>
1418     The web-based toggle feature is disabled.
1419    </para>
1420   </listitem>
1421  </varlistentry>
1422  <varlistentry>
1423   <term>Notes:</term>
1424   <listitem>
1425    <para>
1426     When toggled off, <application>Privoxy</application> mostly acts like a normal,
1427     content-neutral proxy, i.e. doesn't block ads or filter content.
1428    </para>
1429    <para>
1430     Access to the toggle feature can <emphasis>not</emphasis> be
1431     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1432     so that everybody who can access <application>Privoxy</application> (see
1433     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1434     toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1435     for multi-user environments with untrusted users.
1436    </para>
1437    <para>
1438     Note that malicious client side code (e.g Java) is also
1439     capable of using this option.
1440    </para>
1441    <para>
1442     As a lot of <application>Privoxy</application> users don't read
1443     documentation, this feature is disabled by default.
1444    </para>
1445    <para>
1446     Note that you must have compiled <application>Privoxy</application> with
1447     support for this feature, otherwise this option has no effect.
1448    </para>
1449   </listitem>
1450  </varlistentry>
1451 </variablelist>
1452
1453 <![%config-file;[<literallayout>@@enable-remote-toggle  0</literallayout>]]>
1454 </sect3>
1455
1456
1457 <!--   ~~~~~       New section      ~~~~~     -->
1458 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1459 <variablelist>
1460  <varlistentry>
1461   <term>Specifies:</term>
1462   <listitem>
1463    <para>
1464     Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1465    </para>
1466   </listitem>
1467  </varlistentry>
1468  <varlistentry>
1469   <term>Type of value:</term>
1470   <listitem>
1471    <para>0 or 1</para>
1472   </listitem>
1473  </varlistentry>
1474  <varlistentry>
1475   <term>Default value:</term>
1476   <listitem>
1477    <para>0</para>
1478   </listitem>
1479  </varlistentry>
1480  <varlistentry>
1481   <term>Effect if unset:</term>
1482   <listitem>
1483    <para>
1484     Privoxy ignores special HTTP headers.
1485    </para>
1486   </listitem>
1487  </varlistentry>
1488  <varlistentry>
1489   <term>Notes:</term>
1490   <listitem>
1491    <para>
1492     When toggled on, the client can change <application>Privoxy's</application>
1493     behaviour by setting special HTTP headers. Currently the only supported
1494     special header is <quote>X-Filter: No</quote>, to disable filtering for
1495     the ongoing request, even if it is enabled in one of the action files.
1496    </para>
1497    <para>
1498     This feature is disabled by default. If you are using
1499     <application>Privoxy</application> in a environment with trusted clients,
1500     you may enable this feature at your discretion. Note that malicious client
1501     side code (e.g Java) is also capable of using this feature.
1502    </para>
1503    <para>
1504     This option will be removed in future releases as it has been obsoleted
1505     by the more general header taggers.
1506    </para>
1507   </listitem>
1508  </varlistentry>
1509 </variablelist>
1510
1511 <![%config-file;[<literallayout>@@enable-remote-http-toggle  0</literallayout>]]>
1512 </sect3>
1513
1514
1515 <!--   ~~~~~       New section      ~~~~~     -->
1516 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1517 <variablelist>
1518  <varlistentry>
1519   <term>Specifies:</term>
1520   <listitem>
1521    <para>
1522     Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1523     file editor</ulink> may be used
1524    </para>
1525   </listitem>
1526  </varlistentry>
1527  <varlistentry>
1528   <term>Type of value:</term>
1529   <listitem>
1530    <para>0 or 1</para>
1531   </listitem>
1532  </varlistentry>
1533  <varlistentry>
1534   <term>Default value:</term>
1535   <listitem>
1536    <para>0</para>
1537   </listitem>
1538  </varlistentry>
1539  <varlistentry>
1540   <term>Effect if unset:</term>
1541   <listitem>
1542    <para>
1543     The web-based actions file editor is disabled.
1544    </para>
1545   </listitem>
1546  </varlistentry>
1547  <varlistentry>
1548   <term>Notes:</term>
1549   <listitem>
1550    <para>
1551     Access to the editor can <emphasis>not</emphasis> be
1552     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1553     so that everybody who can access <application>Privoxy</application> (see
1554     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1555     modify its configuration for all users.
1556    </para>
1557    <para>
1558     This option is <emphasis>not recommended</emphasis> for environments
1559     with untrusted users and as a lot of <application>Privoxy</application>
1560     users don't read documentation, this feature is disabled by default.
1561    </para>
1562    <para>
1563     Note that malicious client side code (e.g Java) is also
1564     capable of using the actions editor and you shouldn't enable
1565     this options unless you understand the consequences and are
1566     sure your browser is configured correctly.
1567    </para>
1568    <para>
1569     Note that you must have compiled <application>Privoxy</application> with
1570     support for this feature, otherwise this option has no effect.
1571    </para>
1572   </listitem>
1573  </varlistentry>
1574 </variablelist>
1575
1576 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1577 </sect3>
1578
1579
1580 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1581 <variablelist>
1582  <varlistentry>
1583   <term>Specifies:</term>
1584   <listitem>
1585    <para>
1586     Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1587    </para>
1588   </listitem>
1589  </varlistentry>
1590  <varlistentry>
1591   <term>Type of value:</term>
1592   <listitem>
1593    <para>
1594     <replaceable>0 or 1</replaceable>
1595    </para>
1596   </listitem>
1597  </varlistentry>
1598  <varlistentry>
1599   <term>Default value:</term>
1600   <listitem>
1601    <para><emphasis>0</emphasis></para>
1602   </listitem>
1603  </varlistentry>
1604  <varlistentry>
1605   <term>Effect if unset:</term>
1606   <listitem>
1607    <para>
1608     Blocks are not enforced.
1609    </para>
1610   </listitem>
1611  </varlistentry>
1612  <varlistentry>
1613   <term>Notes:</term>
1614   <listitem>
1615    <para>
1616     <application>Privoxy</application> is mainly used to block and filter
1617     requests as a service to the user, for example to block ads and other
1618     junk that clogs the pipes. <application>Privoxy's</application> configuration
1619     isn't perfect and sometimes innocent pages are blocked. In this situation it
1620     makes sense to allow the user to enforce the request and have
1621     <application>Privoxy</application> ignore the block.
1622    </para>
1623    <para>
1624     In the default configuration <application>Privoxy's</application>
1625     <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1626     link to adds a special string (the force prefix) to the request URL.
1627     If that link is used, <application>Privoxy</application> will
1628     detect the force prefix, remove it again and let the request pass.
1629    </para>
1630    <para>
1631     Of course <application>Privoxy</application> can also be used to enforce
1632     a network policy. In that case the user obviously should not be able to
1633     bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1634     option is for. If it's enabled, <application>Privoxy</application> hides
1635     the <quote>go there anyway</quote> link. If the user adds the force
1636     prefix by hand, it will not be accepted and the circumvention attempt
1637     is logged.
1638    </para>
1639   </listitem>
1640  </varlistentry>
1641  <varlistentry>
1642   <term>Examples:</term>
1643   <listitem>
1644    <para>
1645     enforce-blocks 1
1646    </para>
1647   </listitem>
1648  </varlistentry>
1649 </variablelist>
1650 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1651 </sect3>
1652
1653
1654 <!--   ~~~~~       New section      ~~~~~     -->
1655 <sect3 renderas="sect4" id="acls"><title>
1656 ACLs: permit-access and deny-access</title>
1657 <anchor id="permit-access">
1658 <anchor id="deny-access">
1659
1660 <variablelist>
1661  <varlistentry>
1662   <term>Specifies:</term>
1663   <listitem>
1664    <para>
1665     Who can access what.
1666    </para>
1667   </listitem>
1668  </varlistentry>
1669  <varlistentry>
1670   <term>Type of value:</term>
1671   <listitem>
1672    <para>
1673     <replaceable class="parameter">src_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">src_masklen</replaceable>]
1674     [<replaceable class="parameter">dst_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">dst_masklen</replaceable>]]
1675    </para>
1676    <para>
1677     Where <replaceable class="parameter">src_addr</replaceable> and
1678    <replaceable class="parameter">dst_addr</replaceable> are IPv4 addresses in dotted decimal notation or valid
1679     DNS names, <replaceable class="parameter">port</replaceable> is a port
1680     number, and <replaceable class="parameter">src_masklen</replaceable> and
1681     <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1682     values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1683     destination part are optional.
1684    </para>
1685    <para>
1686     If your system implements
1687     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink>, then
1688     <replaceable class="parameter">src_addr</replaceable> and <replaceable
1689     class="parameter">dst_addr</replaceable> can be IPv6 addresses delimeted by
1690     brackets, <replaceable class="parameter">port</replaceable> can be a number
1691     or a service name, and
1692     <replaceable class="parameter">src_masklen</replaceable> and
1693     <replaceable class="parameter">dst_masklen</replaceable> can be a number
1694     from 0 to 128.
1695    </para>
1696   </listitem>
1697  </varlistentry>
1698  <varlistentry>
1699   <term>Default value:</term>
1700   <listitem>
1701    <para><emphasis>Unset</emphasis></para>
1702    <para>
1703     If no <replaceable class="parameter">port</replaceable> is specified,
1704     any port will match. If no <replaceable class="parameter">src_masklen</replaceable> or
1705     <replaceable class="parameter">src_masklen</replaceable> is given, the complete IP
1706     address has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1707    </para>
1708   </listitem>
1709  </varlistentry>
1710  <varlistentry>
1711   <term>Effect if unset:</term>
1712   <listitem>
1713    <para>
1714     Don't restrict access further than implied by <literal>listen-address</literal>
1715    </para>
1716   </listitem>
1717  </varlistentry>
1718  <varlistentry>
1719   <term>Notes:</term>
1720   <listitem>
1721    <para>
1722     Access controls are included at the request of ISPs and systems
1723     administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1724     For a typical home user, it will normally suffice to ensure that
1725     <application>Privoxy</application> only listens on the localhost
1726     (127.0.0.1) or internal (home) network address by means of the
1727     <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1728     option.
1729    </para>
1730    <para>
1731     Please see the warnings in the FAQ that <application>Privoxy</application>
1732     is not intended to be a substitute for a firewall or to encourage anyone
1733     to defer addressing basic security weaknesses.
1734    </para>
1735    <para>
1736     Multiple ACL lines are OK.
1737     If any ACLs are specified, <application>Privoxy</application> only talks
1738     to IP addresses that match at least one <literal>permit-access</literal> line
1739     and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1740     last match wins, with the default being <literal>deny-access</literal>.
1741    </para>
1742    <para>
1743     If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1744     for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1745     that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1746     of the ultimate target. This is necessary because it may be impossible for the local
1747     <application>Privoxy</application> to determine the IP address of the
1748     ultimate target (that's often what gateways are used for).
1749    </para>
1750    <para>
1751     You should prefer using IP addresses over DNS names, because the address lookups take
1752     time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1753     like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1754     IP addresses, only the first one is used.
1755    </para>
1756    <para>
1757      Some systems allow IPv4 clients to connect to IPv6 server sockets.
1758      Then the client's IPv4 address will be translated by the system into
1759      IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4
1760      mapped IPv6 address). <application>Privoxy</application> can handle it
1761      and maps such ACL addresses automatically.
1762    </para>
1763    <para>
1764     Denying access to particular sites by ACL may have undesired side effects
1765     if the site in question is hosted on a machine which also hosts other sites
1766     (most sites are).
1767    </para>
1768   </listitem>
1769  </varlistentry>
1770  <varlistentry>
1771   <term>Examples:</term>
1772   <listitem>
1773    <para>
1774     Explicitly define the default behavior if no ACL and
1775     <literal>listen-address</literal> are set: <quote>localhost</quote>
1776     is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1777     <emphasis>all</emphasis> destination addresses are OK:
1778    </para>
1779    <para>
1780     <screen>
1781   permit-access  localhost
1782 </screen>
1783    </para>
1784    <para>
1785     Allow any host on the same class C subnet as www.privoxy.org access to
1786     nothing but www.example.com (or other domains hosted on the same system):
1787    </para>
1788    <para>
1789     <screen>
1790   permit-access  www.privoxy.org/24 www.example.com/32
1791 </screen>
1792    </para>
1793    <para>
1794     Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1795     with the exception that 192.168.45.73 may not access the IP address behind
1796     www.dirty-stuff.example.com:
1797    </para>
1798    <para>
1799     <screen>
1800   permit-access  192.168.45.64/26
1801   deny-access    192.168.45.73    www.dirty-stuff.example.com
1802 </screen>
1803    </para>
1804    <para>
1805      Allow access from the IPv4 network 192.0.2.0/24 even if listening on
1806      an IPv6 wild card address (not supported on all platforms):
1807    </para>
1808    <para>
1809     <programlisting>
1810   permit-access  192.0.2.0/24
1811 </programlisting>
1812    </para>
1813    <para>
1814      This is equivalent to the following line even if listening on an
1815      IPv4 address (not supported on all platforms):
1816    </para>
1817    <para>
1818     <programlisting>
1819   permit-access  [::ffff:192.0.2.0]/120
1820 </programlisting>
1821    </para>
1822   </listitem>
1823  </varlistentry>
1824 </variablelist>
1825 </sect3>
1826
1827
1828 <!--   ~~~~~       New section      ~~~~~     -->
1829 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1830
1831 <variablelist>
1832  <varlistentry>
1833   <term>Specifies:</term>
1834   <listitem>
1835    <para>
1836     Maximum size of the buffer for content filtering.
1837    </para>
1838   </listitem>
1839  </varlistentry>
1840  <varlistentry>
1841   <term>Type of value:</term>
1842   <listitem>
1843    <para>Size in Kbytes</para>
1844   </listitem>
1845  </varlistentry>
1846  <varlistentry>
1847   <term>Default value:</term>
1848   <listitem>
1849    <para>4096</para>
1850   </listitem>
1851  </varlistentry>
1852  <varlistentry>
1853   <term>Effect if unset:</term>
1854   <listitem>
1855    <para>
1856     Use a 4MB (4096 KB) limit.
1857    </para>
1858   </listitem>
1859  </varlistentry>
1860  <varlistentry>
1861   <term>Notes:</term>
1862   <listitem>
1863    <para>
1864     For content filtering, i.e. the <literal>+filter</literal> and
1865     <literal>+deanimate-gif</literal> actions, it is necessary that
1866     <application>Privoxy</application> buffers the entire document body.
1867     This can be potentially dangerous, since a server could just keep sending
1868     data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1869     Hence this option.
1870    </para>
1871    <para>
1872     When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1873     flushed to the client unfiltered and no further attempt to
1874     filter the rest of the document is made. Remember that there may be multiple threads
1875     running, which might require up to <literal>buffer-limit</literal> Kbytes
1876     <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1877     above.
1878    </para>
1879   </listitem>
1880  </varlistentry>
1881 </variablelist>
1882
1883 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1884 </sect3>
1885
1886 </sect2>
1887
1888 <!--  ~  End section  ~  -->
1889
1890
1891 <!--   ~~~~~       New section      ~~~~~     -->
1892
1893 <sect2 id="forwarding">
1894 <title>Forwarding</title>
1895
1896 <para>
1897  This feature allows routing of HTTP requests through a chain of
1898  multiple proxies.
1899 </para>
1900 <para>
1901  Forwarding can be used to chain Privoxy with a caching proxy to speed
1902  up browsing. Using a parent proxy may also be necessary if the machine
1903  that <application>Privoxy</application> runs on has no direct Internet access.
1904 </para>
1905 <para>
1906  Note that parent proxies can severely decrease your privacy level.
1907  For example a parent proxy could add your IP address to the request
1908  headers and if it's a caching proxy it may add the <quote>Etag</quote>
1909  header to revalidation requests again, even though you configured Privoxy
1910  to remove it. It may also ignore Privoxy's header time randomization and use the
1911  original values which could be used by the server as cookie replacement
1912  to track your steps between visits.
1913 </para>
1914
1915 <para>
1916  Also specified here are SOCKS proxies. <application>Privoxy</application>
1917  supports the SOCKS 4 and SOCKS 4A protocols.
1918 </para>
1919
1920 <sect3 renderas="sect4" id="forward"><title>forward</title>
1921 <variablelist>
1922  <varlistentry>
1923   <term>Specifies:</term>
1924   <listitem>
1925    <para>
1926     To which parent HTTP proxy specific requests should be routed.
1927    </para>
1928   </listitem>
1929  </varlistentry>
1930  <varlistentry>
1931   <term>Type of value:</term>
1932   <listitem>
1933    <para>
1934     <replaceable class="parameter">target_pattern</replaceable>
1935     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1936    </para>
1937    <para>
1938     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1939     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1940     denote <quote>all URLs</quote>.
1941     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1942     is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1943     optionally followed by its listening port (default: 8000).
1944     Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1945    </para>
1946   </listitem>
1947  </varlistentry>
1948  <varlistentry>
1949   <term>Default value:</term>
1950   <listitem>
1951    <para><emphasis>Unset</emphasis></para>
1952   </listitem>
1953  </varlistentry>
1954  <varlistentry>
1955   <term>Effect if unset:</term>
1956   <listitem>
1957    <para>
1958     Don't use parent HTTP proxies.
1959    </para>
1960   </listitem>
1961  </varlistentry>
1962  <varlistentry>
1963   <term>Notes:</term>
1964   <listitem>
1965    <para>
1966     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1967     forwarded to another HTTP proxy but are made directly to the web servers.
1968    </para>
1969    <para>
1970     <replaceable class="parameter">http_parent</replaceable> can be a
1971      numerical IPv6 address (if
1972     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
1973     implemented). To prevent clashes with the port delimiter, the whole IP
1974     address has to be put into brackets. On the other hand a <replaceable
1975     class="parameter">target_pattern</replaceable> containing an IPv6 address
1976     has to be put into angle brackets (normal brackets are reserved for
1977     regular expressions already).
1978    </para>
1979    <para>
1980     Multiple lines are OK, they are checked in sequence, and the last match wins.
1981    </para>
1982   </listitem>
1983  </varlistentry>
1984  <varlistentry>
1985   <term>Examples:</term>
1986   <listitem>
1987    <para>
1988     Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
1989    </para>
1990    <para>
1991     <screen>
1992   forward   /      parent-proxy.example.org:8080
1993   forward   :443   .
1994 </screen>
1995    </para>
1996    <para>
1997     Everything goes to our example ISP's caching proxy, except for requests
1998     to that ISP's sites:
1999    </para>
2000    <para>
2001     <screen>
2002   forward   /                  caching-proxy.isp.example.net:8000
2003   forward   .isp.example.net   .
2004 </screen>
2005    </para>
2006    <para>
2007     Parent proxy specified by an IPv6 address:
2008    </para>
2009    <para>
2010     <programlisting>
2011   forward   /                   [2001:DB8::1]:8000
2012 </programlisting>
2013    </para>
2014    <para>
2015     Suppose your parent proxy doesn't support IPv6:
2016    </para>
2017    <para>
2018     <programlisting>
2019   forward  /                        parent-proxy.example.org:8000
2020   forward  ipv6-server.example.org  .
2021   forward  &lt;[2-3][0-9a-f][0-9a-f][0-9a-f]:*&gt;   .
2022 </programlisting>
2023    </para>
2024   </listitem>
2025  </varlistentry>
2026 </variablelist>
2027 </sect3>
2028
2029
2030 <!--   ~~~~~       New section      ~~~~~     -->
2031 <sect3 renderas="sect4" id="socks"><title>
2032 forward-socks4, forward-socks4a and forward-socks5</title>
2033 <anchor id="forward-socks4">
2034 <anchor id="forward-socks4a">
2035
2036 <variablelist>
2037  <varlistentry>
2038   <term>Specifies:</term>
2039   <listitem>
2040    <para>
2041     Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2042    </para>
2043   </listitem>
2044  </varlistentry>
2045  <varlistentry>
2046   <term>Type of value:</term>
2047   <listitem>
2048    <para>
2049     <replaceable class="parameter">target_pattern</replaceable>
2050     <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
2051     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2052    </para>
2053    <para>
2054     where <replaceable class="parameter">target_pattern</replaceable> is a
2055     <link linkend="af-patterns">URL pattern</link> that specifies to which
2056     requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2057     denote <quote>all URLs</quote>. <replaceable class="parameter">http_parent</replaceable>
2058     and <replaceable class="parameter">socks_proxy</replaceable>
2059     are IP addresses in dotted decimal notation or valid DNS names
2060     (<replaceable class="parameter">http_parent</replaceable>
2061     may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
2062     <replaceable class="parameter">port</replaceable> parameters are TCP ports,
2063     i.e. integer values from 1 to 65535
2064    </para>
2065   </listitem>
2066  </varlistentry>
2067  <varlistentry>
2068   <term>Default value:</term>
2069   <listitem>
2070    <para><emphasis>Unset</emphasis></para>
2071   </listitem>
2072  </varlistentry>
2073  <varlistentry>
2074   <term>Effect if unset:</term>
2075   <listitem>
2076    <para>
2077     Don't use SOCKS proxies.
2078    </para>
2079   </listitem>
2080  </varlistentry>
2081  <varlistentry>
2082   <term>Notes:</term>
2083   <listitem>
2084    <para>
2085     Multiple lines are OK, they are checked in sequence, and the last match wins.
2086    </para>
2087    <para>
2088     The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
2089     is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2090     server, while in SOCKS 4 it happens locally.
2091    </para>
2092    <para>
2093     With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
2094    </para>
2095    <para>
2096     <replaceable class="parameter">socks_proxy</replaceable> and
2097     <replaceable class="parameter">http_parent</replaceable> can be a
2098      numerical IPv6 address (if
2099     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2100     implemented). To prevent clashes with the port delimiter, the whole IP
2101     address has to be put into brackets. On the other hand a <replaceable
2102     class="parameter">target_pattern</replaceable> containing an IPv6 address
2103     has to be put into angle brackets (normal brackets are reserved for
2104     regular expressions already).
2105    </para>
2106    <para>
2107     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2108     forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2109     a SOCKS proxy.
2110    </para>
2111   </listitem>
2112  </varlistentry>
2113  <varlistentry>
2114   <term>Examples:</term>
2115   <listitem>
2116    <para>
2117      From the company example.com, direct connections are made to all
2118      <quote>internal</quote> domains, but everything outbound goes through
2119      their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2120      the Internet.
2121    </para>
2122    <para>
2123     <screen>
2124   forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
2125   forward           .example.com   .
2126 </screen>
2127    </para>
2128    <para>
2129     A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2130    </para>
2131    <para>
2132     <screen>
2133   forward-socks4   /               socks-gw.example.com:1080  .
2134 </screen>
2135    </para>
2136
2137     <para>
2138     To chain Privoxy and Tor, both running on the same system, you would use
2139     something like:
2140    </para>
2141    <para>
2142     <screen>
2143   forward-socks5   /               127.0.0.1:9050 .
2144 </screen>
2145    </para>
2146
2147     <para>
2148     The public <application>Tor</application> network can't be used to
2149     reach your local network, if you need to access local servers you
2150     therefore might want to make some exceptions:
2151    </para>
2152    <para>
2153     <screen>
2154   forward         192.168.*.*/     .
2155   forward            10.*.*.*/     .
2156   forward           127.*.*.*/     .
2157 </screen>
2158    </para>
2159    <para>
2160     Unencrypted connections to systems in these address ranges will
2161     be as (un)secure as the local network is, but the alternative is that you
2162     can't reach the local network through <application>Privoxy</application>
2163     at all. Of course this may actually be desired and there is no reason
2164     to make these exceptions if you aren't sure you need them.
2165    </para>
2166    <para>
2167     If you also want to be able to reach servers in your local network by
2168     using their names, you will need additional exceptions that look like
2169     this:
2170    </para>
2171    <para>
2172     <screen>
2173  forward           localhost/     .
2174 </screen>
2175    </para>
2176
2177   </listitem>
2178  </varlistentry>
2179 </variablelist>
2180 </sect3>
2181
2182 <![%user-man;[     <!-- not included in config due to length -->
2183 <!--   ~~~~~       New section      ~~~~~     -->
2184 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2185
2186 <para>
2187  If you have links to multiple ISPs that provide various special content
2188  only to their subscribers, you can configure multiple <application>Privoxies</application>
2189  which have connections to the respective ISPs to act as forwarders to each other, so that
2190  <emphasis>your</emphasis> users can see the internal content of all ISPs.
2191 </para>
2192
2193 <para>
2194  Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2195  isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2196  configuration can look like this:
2197 </para>
2198
2199 <para>
2200  host-a:
2201 </para>
2202
2203 <para>
2204  <screen>
2205   forward    /           .
2206   forward    .isp-b.example.net  host-b:8118
2207 </screen>
2208 </para>
2209
2210 <para>
2211  host-b:
2212 </para>
2213
2214 <para>
2215  <screen>
2216   forward    /           .
2217   forward    .isp-a.example.org  host-a:8118
2218 </screen>
2219 </para>
2220
2221 <para>
2222  Now, your users can set their browser's proxy to use either
2223  host-a or host-b and be able to browse the internal content
2224  of both isp-a and isp-b.
2225 </para>
2226
2227 <para>
2228  If you intend to chain <application>Privoxy</application> and
2229  <application>squid</application> locally, then chaining as
2230  <literal>browser -> squid -> privoxy</literal> is the recommended way.
2231 </para>
2232
2233 <para>
2234  Assuming that <application>Privoxy</application> and <application>squid</application>
2235  run on the same box, your <application>squid</application> configuration could then look like this:
2236 </para>
2237
2238 <para>
2239  <screen>
2240   # Define Privoxy as parent proxy (without ICP)
2241   cache_peer 127.0.0.1 parent 8118 7 no-query
2242
2243   # Define ACL for protocol FTP
2244   acl ftp proto FTP
2245
2246   # Do not forward FTP requests to Privoxy
2247   always_direct allow ftp
2248
2249   # Forward all the rest to Privoxy
2250   never_direct allow all</screen>
2251 </para>
2252
2253 <para>
2254  You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2255  Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2256 </para>
2257
2258 <para>
2259  You could just as well decide to only forward requests you suspect
2260  of leading to Windows executables through a virus-scanning parent proxy,
2261  say, on <literal>antivir.example.com</literal>, port 8010:
2262 </para>
2263
2264 <para>
2265  <screen>
2266   forward   /                          .
2267   forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010</screen>
2268 </para>
2269
2270 </sect3>
2271 ]]>
2272
2273 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2274 <variablelist>
2275  <varlistentry>
2276   <term>Specifies:</term>
2277   <listitem>
2278    <para>
2279     How often Privoxy retries if a forwarded connection request fails.
2280    </para>
2281   </listitem>
2282  </varlistentry>
2283  <varlistentry>
2284   <term>Type of value:</term>
2285   <listitem>
2286    <para>
2287     <replaceable class="parameter">Number of retries.</replaceable>
2288    </para>
2289   </listitem>
2290  </varlistentry>
2291  <varlistentry>
2292   <term>Default value:</term>
2293   <listitem>
2294    <para><emphasis>0</emphasis></para>
2295   </listitem>
2296  </varlistentry>
2297  <varlistentry>
2298   <term>Effect if unset:</term>
2299   <listitem>
2300    <para>
2301     Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2302    </para>
2303   </listitem>
2304  </varlistentry>
2305  <varlistentry>
2306   <term>Notes:</term>
2307   <listitem>
2308    <para>
2309     <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2310     for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2311     The connection might have failed because of a DNS timeout in which case a retry makes sense,
2312     but it might also have failed because the server doesn't exist or isn't reachable. In this
2313     case the retry will just delay the appearance of Privoxy's error message.
2314    </para>
2315    <para>
2316     Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2317     that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2318    </para>
2319    <para>
2320     Only use this option, if you are getting lots of forwarding-related error messages
2321     that go away when you try again manually. Start with a small value and check Privoxy's
2322     logfile from time to time, to see how many retries are usually needed.
2323    </para>
2324   </listitem>
2325  </varlistentry>
2326  <varlistentry>
2327   <term>Examples:</term>
2328   <listitem>
2329    <para>
2330     forwarded-connect-retries 1
2331    </para>
2332   </listitem>
2333  </varlistentry>
2334 </variablelist>
2335 <![%config-file;[<literallayout>@@forwarded-connect-retries  0</literallayout>]]>
2336 </sect3>
2337
2338 </sect2>
2339
2340 <sect2 id="misc">
2341 <title>Miscellaneous</title>
2342
2343 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2344 <variablelist>
2345  <varlistentry>
2346   <term>Specifies:</term>
2347   <listitem>
2348    <para>
2349     Whether intercepted requests should be treated as valid.
2350    </para>
2351   </listitem>
2352  </varlistentry>
2353  <varlistentry>
2354   <term>Type of value:</term>
2355   <listitem>
2356    <para>
2357     <replaceable>0 or 1</replaceable>
2358    </para>
2359   </listitem>
2360  </varlistentry>
2361  <varlistentry>
2362   <term>Default value:</term>
2363   <listitem>
2364    <para><emphasis>0</emphasis></para>
2365   </listitem>
2366  </varlistentry>
2367  <varlistentry>
2368   <term>Effect if unset:</term>
2369   <listitem>
2370    <para>
2371     Only proxy requests are accepted, intercepted requests are treated as invalid.
2372    </para>
2373   </listitem>
2374  </varlistentry>
2375  <varlistentry>
2376   <term>Notes:</term>
2377   <listitem>
2378    <para>
2379     If you don't trust your clients and want to force them
2380     to use <application>Privoxy</application>, enable this
2381     option and configure your packet filter to redirect outgoing
2382     HTTP connections into <application>Privoxy</application>.
2383    </para>
2384    <para>
2385     Make sure that <application>Privoxy's</application> own requests
2386     aren't redirected as well. Additionally take care that
2387     <application>Privoxy</application> can't intentionally connect
2388     to itself, otherwise you could run into redirection loops if
2389     <application>Privoxy's</application> listening port is reachable
2390     by the outside or an attacker has access to the pages you visit.
2391    </para>
2392   </listitem>
2393  </varlistentry>
2394  <varlistentry>
2395   <term>Examples:</term>
2396   <listitem>
2397    <para>
2398     accept-intercepted-requests 1
2399    </para>
2400   </listitem>
2401  </varlistentry>
2402 </variablelist>
2403 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2404 </sect3>
2405
2406 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2407 <variablelist>
2408  <varlistentry>
2409   <term>Specifies:</term>
2410   <listitem>
2411    <para>
2412     Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2413    </para>
2414   </listitem>
2415  </varlistentry>
2416  <varlistentry>
2417   <term>Type of value:</term>
2418   <listitem>
2419    <para>
2420     <replaceable>0 or 1</replaceable>
2421    </para>
2422   </listitem>
2423  </varlistentry>
2424  <varlistentry>
2425   <term>Default value:</term>
2426   <listitem>
2427    <para><emphasis>0</emphasis></para>
2428   </listitem>
2429  </varlistentry>
2430  <varlistentry>
2431   <term>Effect if unset:</term>
2432   <listitem>
2433    <para>
2434     <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2435    </para>
2436   </listitem>
2437  </varlistentry>
2438  <varlistentry>
2439   <term>Notes:</term>
2440   <listitem>
2441    <para>
2442     By default <application>Privoxy</application> ignores block or redirect actions
2443     for its CGI pages. Intercepting these requests can be useful in multi-user
2444     setups to implement fine-grained access control, but it can also render the complete
2445     web interface useless and make debugging problems painful if done without care.
2446    </para>
2447    <para>
2448     Don't enable this option unless you're sure that you really need it.
2449    </para>
2450   </listitem>
2451  </varlistentry>
2452  <varlistentry>
2453   <term>Examples:</term>
2454   <listitem>
2455    <para>
2456     allow-cgi-request-crunching 1
2457    </para>
2458   </listitem>
2459  </varlistentry>
2460 </variablelist>
2461 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2462 </sect3>
2463
2464 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2465 <variablelist>
2466  <varlistentry>
2467   <term>Specifies:</term>
2468   <listitem>
2469    <para>
2470     Whether the CGI interface should stay compatible with broken HTTP clients.
2471    </para>
2472   </listitem>
2473  </varlistentry>
2474  <varlistentry>
2475   <term>Type of value:</term>
2476   <listitem>
2477    <para>
2478     <replaceable>0 or 1</replaceable>
2479    </para>
2480   </listitem>
2481  </varlistentry>
2482  <varlistentry>
2483   <term>Default value:</term>
2484   <listitem>
2485    <para><emphasis>0</emphasis></para>
2486   </listitem>
2487  </varlistentry>
2488  <varlistentry>
2489   <term>Effect if unset:</term>
2490   <listitem>
2491    <para>
2492     The CGI form generate long GET URLs.
2493    </para>
2494   </listitem>
2495  </varlistentry>
2496  <varlistentry>
2497   <term>Notes:</term>
2498   <listitem>
2499    <para>
2500     <application>Privoxy's</application> CGI forms can lead to
2501     rather long URLs. This isn't a problem as far as the HTTP
2502     standard is concerned, but it can confuse clients with arbitrary
2503     URL length limitations.
2504    </para>
2505    <para>
2506     Enabling split-large-forms causes <application>Privoxy</application>
2507     to divide big forms into smaller ones to keep the URL length down.
2508     It makes editing a lot less convenient and you can no longer
2509     submit all changes at once, but at least it works around this
2510     browser bug.
2511    </para>
2512    <para>
2513     If you don't notice any editing problems, there is no reason
2514     to enable this option, but if one of the submit buttons appears
2515     to be broken, you should give it a try.
2516    </para>
2517   </listitem>
2518  </varlistentry>
2519  <varlistentry>
2520   <term>Examples:</term>
2521   <listitem>
2522    <para>
2523     split-large-forms 1
2524    </para>
2525   </listitem>
2526  </varlistentry>
2527 </variablelist>
2528 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2529 </sect3>
2530
2531 <sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
2532 <variablelist>
2533  <varlistentry>
2534   <term>Specifies:</term>
2535   <listitem>
2536    <para>
2537     Number of seconds after which an open connection will no longer be reused.
2538    </para>
2539   </listitem>
2540  </varlistentry>
2541  <varlistentry>
2542   <term>Type of value:</term>
2543   <listitem>
2544    <para>
2545     <replaceable>Time in seconds.</replaceable>
2546    </para>
2547   </listitem>
2548  </varlistentry>
2549  <varlistentry>
2550   <term>Default value:</term>
2551   <listitem>
2552    <para>None</para>
2553   </listitem>
2554  </varlistentry>
2555  <varlistentry>
2556   <term>Effect if unset:</term>
2557   <listitem>
2558    <para>
2559     Connections are not kept alive.
2560    </para>
2561   </listitem>
2562  </varlistentry>
2563  <varlistentry>
2564   <term>Notes:</term>
2565   <listitem>
2566    <para>
2567     This option allows clients to keep the connection to &my-app;
2568     alive. If the server supports it, &my-app; will keep
2569     the connection to the server alive as well. Under certain
2570     circumstances this may result in speed-ups.
2571    </para>
2572    <para>
2573     By default, &my-app; will close the connection to the server if
2574     the client connection gets closed, or if the specified timeout
2575     has been reached without a new request coming in. This behaviour
2576     can be changed with the <ulink
2577      url="#CONNECTION-SHARING">connection-sharing</ulink> option.
2578    </para>
2579    <para>
2580     This option has no effect if <application>Privoxy</application>
2581     has been compiled without keep-alive support.
2582    </para>
2583    <para>
2584     Note that a timeout of five seconds as used in the default
2585     configuration file significantly decreases the number of
2586     connections that will be reused. The value is used because
2587     some browsers limit the number of connections they open to
2588     a single host and apply the same limit to proxies. This can
2589     result in a single website <quote>grabbing</quote> all the
2590     connections the browser allows, which means connections to
2591     other websites can't be opened until the connections currently
2592     in use time out.
2593    </para>
2594    <para>
2595     Several users have reported this as a Privoxy bug, so the
2596     default value has been reduced. Consider increasing it to
2597     300 seconds or even more if you think your browser can handle
2598     it. If your browser appears to be hanging it can't.
2599    </para>
2600   </listitem>
2601  </varlistentry>
2602  <varlistentry>
2603   <term>Examples:</term>
2604   <listitem>
2605    <para>
2606     keep-alive-timeout 300
2607    </para>
2608   </listitem>
2609  </varlistentry>
2610 </variablelist>
2611 <![%config-file;[<literallayout>@@keep-alive-timeout 5</literallayout>]]>
2612 </sect3>
2613
2614
2615 <sect3 renderas="sect4" id="default-server-timeout"><title>default-server-timeout</title>
2616 <variablelist>
2617  <varlistentry>
2618   <term>Specifies:</term>
2619   <listitem>
2620    <para>
2621     Assumed server-side keep-alive timeout if not specified by the server.
2622    </para>
2623   </listitem>
2624  </varlistentry>
2625  <varlistentry>
2626   <term>Type of value:</term>
2627   <listitem>
2628    <para>
2629     <replaceable>Time in seconds.</replaceable>
2630    </para>
2631   </listitem>
2632  </varlistentry>
2633  <varlistentry>
2634   <term>Default value:</term>
2635   <listitem>
2636    <para>None</para>
2637   </listitem>
2638  </varlistentry>
2639  <varlistentry>
2640   <term>Effect if unset:</term>
2641   <listitem>
2642    <para>
2643     Connections for which the server didn't specify the keep-alive
2644     timeout are not reused.
2645    </para>
2646   </listitem>
2647  </varlistentry>
2648  <varlistentry>
2649   <term>Notes:</term>
2650   <listitem>
2651    <para>
2652     Enabling this option significantly increases the number of connections
2653     that are reused, provided the <ulink
2654      url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> option
2655     is also enabled.
2656    </para>
2657    <para>
2658     While it also increases the number of connections problems
2659     when &my-app; tries to reuse a connection that already has
2660     been closed on the server side, or is closed while &my-app;
2661     is trying to reuse it, this should only be a problem if it
2662     happens for the first request sent by the client. If it happens
2663     for requests on reused client connections, &my-app; will simply
2664     close the connection and the client is supposed to retry the
2665     request without bothering the user.
2666    </para>
2667    <para>
2668     Enabling this option is therefore only recommended if the
2669     <ulink
2670      url="#CONNECTION-SHARING">connection-sharing</ulink> option
2671     is disabled.
2672    </para>
2673    <para>
2674     It is an error to specify a value larger than the <ulink
2675      url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> value.
2676    </para>
2677    <para>
2678     This option has no effect if <application>Privoxy</application>
2679     has been compiled without keep-alive support.
2680    </para>
2681   </listitem>
2682  </varlistentry>
2683  <varlistentry>
2684   <term>Examples:</term>
2685   <listitem>
2686    <para>
2687     default-server-timeout 60
2688    </para>
2689   </listitem>
2690  </varlistentry>
2691 </variablelist>
2692 <![%config-file;[<literallayout>@@#default-server-timeout 60</literallayout>]]>
2693 </sect3>
2694
2695
2696 <sect3 renderas="sect4" id="connection-sharing"><title>connection-sharing</title>
2697 <variablelist>
2698  <varlistentry>
2699   <term>Specifies:</term>
2700   <listitem>
2701    <para>
2702     Whether or not outgoing connections that have been kept alive
2703     should be shared between different incoming connections.
2704    </para>
2705   </listitem>
2706  </varlistentry>
2707  <varlistentry>
2708   <term>Type of value:</term>
2709   <listitem>
2710    <para>
2711     <replaceable>0 or 1</replaceable>
2712    </para>
2713   </listitem>
2714  </varlistentry>
2715  <varlistentry>
2716   <term>Default value:</term>
2717   <listitem>
2718    <para>None</para>
2719   </listitem>
2720  </varlistentry>
2721  <varlistentry>
2722   <term>Effect if unset:</term>
2723   <listitem>
2724    <para>
2725     Connections are not shared.
2726    </para>
2727   </listitem>
2728  </varlistentry>
2729  <varlistentry>
2730   <term>Notes:</term>
2731   <listitem>
2732    <para>
2733     This option has no effect if <application>Privoxy</application>
2734     has been compiled without keep-alive support, or if it's disabled.
2735    </para>
2736   </listitem>
2737  </varlistentry>
2738  <varlistentry>
2739   <term>Notes:</term>
2740   <listitem>
2741    <para>
2742     Note that reusing connections doesn't necessary cause speedups.
2743     There are also a few privacy implications you should be aware of.
2744    </para>
2745    <para>
2746     If this option is effective, outgoing connections are shared between
2747     clients (if there are more than one) and closing the browser that initiated
2748     the outgoing connection does no longer affect the connection between &my-app;
2749     and the server unless the client's request hasn't been completed yet.
2750    </para>
2751    <para>
2752     If the outgoing connection  is idle, it will not be closed until either
2753     <application>Privoxy's</application> or the server's timeout is reached.
2754     While it's open, the server knows that the system running &my-app; is still
2755     there.
2756    </para>
2757    <para>
2758     If there are more than one client (maybe even belonging to multiple users),
2759     they will be able to reuse each others connections. This is potentially
2760     dangerous in case of authentication schemes like NTLM where only the
2761     connection is authenticated, instead of requiring authentication for
2762     each request.
2763    </para>
2764    <para>
2765     If there is only a single client, and if said client can keep connections
2766     alive on its own, enabling this option has next to no effect. If the client
2767     doesn't support connection keep-alive, enabling this option may make sense
2768     as it allows &my-app; to keep outgoing connections alive even if the client
2769     itself doesn't support it.
2770    </para>
2771    <para>
2772     You should also be aware that enabling this option increases the likelihood
2773     of getting the "No server or forwarder data" error message, especially if you
2774     are using a slow connection to the Internet.
2775    </para>
2776    <para>
2777     This option should only be used by experienced users who
2778     understand the risks and can weight them against the benefits.
2779    </para>
2780   </listitem>
2781  </varlistentry>
2782  <varlistentry>
2783   <term>Examples:</term>
2784   <listitem>
2785    <para>
2786     connection-sharing 1
2787    </para>
2788   </listitem>
2789  </varlistentry>
2790 </variablelist>
2791 <![%config-file;[<literallayout>@@#connection-sharing 1</literallayout>]]>
2792 </sect3>
2793
2794
2795 <sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
2796 <variablelist>
2797  <varlistentry>
2798   <term>Specifies:</term>
2799   <listitem>
2800    <para>
2801     Number of seconds after which a socket times out if
2802     no data is received.
2803    </para>
2804   </listitem>
2805  </varlistentry>
2806  <varlistentry>
2807   <term>Type of value:</term>
2808   <listitem>
2809    <para>
2810     <replaceable>Time in seconds.</replaceable>
2811    </para>
2812   </listitem>
2813  </varlistentry>
2814  <varlistentry>
2815   <term>Default value:</term>
2816   <listitem>
2817    <para>None</para>
2818   </listitem>
2819  </varlistentry>
2820  <varlistentry>
2821   <term>Effect if unset:</term>
2822   <listitem>
2823    <para>
2824     A default value of 300 seconds is used.
2825    </para>
2826   </listitem>
2827  </varlistentry>
2828  <varlistentry>
2829   <term>Notes:</term>
2830   <listitem>
2831    <para>
2832     The default is quite high and you probably want to reduce it.
2833     If you aren't using an occasionally slow proxy like Tor, reducing
2834     it to a few seconds should be fine.
2835    </para>
2836   </listitem>
2837  </varlistentry>
2838  <varlistentry>
2839   <term>Examples:</term>
2840   <listitem>
2841    <para>
2842     socket-timeout 300
2843    </para>
2844   </listitem>
2845  </varlistentry>
2846 </variablelist>
2847 <![%config-file;[<literallayout>@@socket-timeout 300</literallayout>]]>
2848 </sect3>
2849
2850
2851 <sect3 renderas="sect4" id="max-client-connections"><title>max-client-connections</title>
2852 <variablelist>
2853  <varlistentry>
2854   <term>Specifies:</term>
2855   <listitem>
2856    <para>
2857     Maximum number of client connections that will be served.
2858    </para>
2859   </listitem>
2860  </varlistentry>
2861  <varlistentry>
2862   <term>Type of value:</term>
2863   <listitem>
2864    <para>
2865     <replaceable>Positive number.</replaceable>
2866    </para>
2867   </listitem>
2868  </varlistentry>
2869  <varlistentry>
2870   <term>Default value:</term>
2871   <listitem>
2872    <para>None</para>
2873   </listitem>
2874  </varlistentry>
2875  <varlistentry>
2876   <term>Effect if unset:</term>
2877   <listitem>
2878    <para>
2879     Connections are served until a resource limit is reached.
2880    </para>
2881   </listitem>
2882  </varlistentry>
2883  <varlistentry>
2884   <term>Notes:</term>
2885   <listitem>
2886    <para>
2887     &my-app; creates one thread (or process) for every incoming client
2888     connection that isn't rejected based on the access control settings.
2889    </para>
2890    <para>
2891     If the system is powerful enough, &my-app; can theoretically deal with
2892     several hundred (or thousand) connections at the same time, but some
2893     operating systems enforce resource limits by shutting down offending
2894     processes and their default limits may be below the ones &my-app; would
2895     require under heavy load.
2896    </para>
2897    <para>
2898     Configuring &my-app; to enforce a connection limit below the thread
2899     or process limit used by the operating system makes sure this doesn't
2900     happen. Simply increasing the operating system's limit would work too,
2901     but if &my-app; isn't the only application running on the system,
2902     you may actually want to limit the resources used by &my-app;.
2903    </para>
2904    <para>
2905     If &my-app; is only used by a single trusted user, limiting the
2906     number of client connections is probably unnecessary. If there
2907     are multiple possibly untrusted users you probably still want to
2908     additionally use a packet filter to limit the maximal number of
2909     incoming connections per client. Otherwise a malicious user could
2910     intentionally create a high number of connections to prevent other
2911     users from using &my-app;.
2912    </para>
2913    <para>
2914     Obviously using this option only makes sense if you choose a limit
2915     below the one enforced by the operating system.
2916    </para>
2917   </listitem>
2918  </varlistentry>
2919  <varlistentry>
2920   <term>Examples:</term>
2921   <listitem>
2922    <para>
2923     max-client-connections 256
2924    </para>
2925   </listitem>
2926  </varlistentry>
2927 </variablelist>
2928 <![%config-file;[<literallayout>@@#max-client-connections 256</literallayout>]]>
2929 </sect3>
2930
2931
2932 <sect3 renderas="sect4" id="handle-as-empty-doc-returns-ok"><title>handle-as-empty-doc-returns-ok</title>
2933 <variablelist>
2934  <varlistentry>
2935   <term>Specifies:</term>
2936   <listitem>
2937    <para>
2938     The status code Privoxy returns for pages blocked with
2939     <!--  URL will only end up in the user manual so the relative link should work. -->
2940     <literal><ulink url="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">+handle-as-empty-document</ulink></literal>.
2941    </para>
2942   </listitem>
2943  </varlistentry>
2944  <varlistentry>
2945   <term>Type of value:</term>
2946   <listitem>
2947    <para>
2948     <replaceable>0 or 1</replaceable>
2949    </para>
2950   </listitem>
2951  </varlistentry>
2952  <varlistentry>
2953   <term>Default value:</term>
2954   <listitem>
2955    <para>0</para>
2956   </listitem>
2957  </varlistentry>
2958  <varlistentry>
2959   <term>Effect if unset:</term>
2960   <listitem>
2961    <para>
2962     Privoxy returns a status 403(forbidden) for all blocked pages.
2963    </para>
2964   </listitem>
2965  </varlistentry>
2966  <varlistentry>
2967   <term>Effect if set:</term>
2968   <listitem>
2969    <para>
2970     Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
2971     and a status 403(Forbidden) for all other blocked pages.
2972    </para>
2973   </listitem>
2974  </varlistentry>
2975  <varlistentry>
2976   <term>Notes:</term>
2977   <listitem>
2978    <para>
2979     This is a work-around for Firefox bug 492459:
2980     <quote>
2981     Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.
2982     </quote>
2983     (<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
2984         >https://bugzilla.mozilla.org/show_bug.cgi?id=492459</ulink>)
2985     As the bug has been fixed for quite some time this option should no longer
2986     be needed and will be removed in a future release. Please speak up if you
2987     have a reason why the option should be kept around.
2988    </para>
2989   </listitem>
2990  </varlistentry>
2991 </variablelist>
2992 <![%config-file;[<literallayout>@@#handle-as-empty-doc-returns-ok 1</literallayout>]]>
2993 </sect3>
2994
2995
2996 <sect3 renderas="sect4" id="enable-compression"><title>enable-compression</title>
2997 <variablelist>
2998  <varlistentry>
2999   <term>Specifies:</term>
3000   <listitem>
3001    <para>
3002     Whether or not buffered content is compressed before delivery.
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 does not compress buffered content.
3025    </para>
3026   </listitem>
3027  </varlistentry>
3028  <varlistentry>
3029   <term>Effect if set:</term>
3030   <listitem>
3031    <para>
3032     Privoxy compresses buffered content before delivering it to the client,
3033     provided the client supports it.
3034    </para>
3035   </listitem>
3036  </varlistentry>
3037  <varlistentry>
3038   <term>Notes:</term>
3039   <listitem>
3040    <para>
3041     This directive is only supported if Privoxy has been compiled with
3042     FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB.
3043    </para>
3044    <para>
3045     Compressing buffered content is mainly useful if Privoxy and the
3046     client are running on different systems. If they are running on the
3047     same system, enabling compression is likely to slow things down.
3048     If you didn't measure otherwise, you should assume that it does
3049     and keep this option disabled.
3050    </para>
3051    <para>
3052     Privoxy will not compress buffered content below a certain length.
3053    </para>
3054   </listitem>
3055  </varlistentry>
3056 </variablelist>
3057 <![%config-file;[<literallayout>@@#enable-compression 1</literallayout>]]>
3058 </sect3>
3059
3060
3061 <sect3 renderas="sect4" id="compression-level"><title>compression-level</title>
3062 <variablelist>
3063  <varlistentry>
3064   <term>Specifies:</term>
3065   <listitem>
3066    <para>
3067     The compression level that is passed to the zlib library when compressing buffered content.
3068    </para>
3069   </listitem>
3070  </varlistentry>
3071  <varlistentry>
3072   <term>Type of value:</term>
3073   <listitem>
3074    <para>
3075     <replaceable>Positive number ranging from 0 to 9.</replaceable>
3076    </para>
3077   </listitem>
3078  </varlistentry>
3079  <varlistentry>
3080   <term>Default value:</term>
3081   <listitem>
3082    <para>1</para>
3083   </listitem>
3084  </varlistentry>
3085  <varlistentry>
3086   <term>Notes:</term>
3087   <listitem>
3088    <para>
3089      Compressing the data more takes usually longer than compressing
3090      it less or not compressing it at all. Which level is best depends
3091      on the connection between Privoxy and the client. If you can't
3092      be bothered to benchmark it for yourself, you should stick with
3093      the default and keep compression disabled.
3094    </para>
3095    <para>
3096      If compression is disabled, the compression level is irrelevant.
3097    </para>
3098   </listitem>
3099  </varlistentry>
3100  <varlistentry>
3101   <term>Examples:</term>
3102   <listitem>
3103    <para>
3104     <screen>
3105     # Best speed (compared to the other levels)
3106     compression-level 1
3107     # Best compression
3108     compression-level 9
3109     # No compression. Only useful for testing as the added header
3110     # slightly increases the amount of data that has to be sent.
3111     # If your benchmark shows that using this compression level
3112     # is superior to using no compression at all, the benchmark
3113     # is likely to be flawed.
3114     compression-level 0
3115     </screen>
3116    </para>
3117   </listitem>
3118  </varlistentry>
3119 </variablelist>
3120 <![%config-file;[<literallayout>@@#compression-level 1</literallayout>]]>
3121 </sect3>
3122
3123
3124 <sect3 renderas="sect4" id="client-header-order"><title>client-header-order</title>
3125 <variablelist>
3126  <varlistentry>
3127   <term>Specifies:</term>
3128   <listitem>
3129    <para>
3130     The order in which client headers are sorted before forwarding them.
3131    </para>
3132   </listitem>
3133  </varlistentry>
3134  <varlistentry>
3135   <term>Type of value:</term>
3136   <listitem>
3137    <para>
3138     <replaceable>Client header names delimited by spaces or tabs</replaceable>
3139    </para>
3140   </listitem>
3141  </varlistentry>
3142  <varlistentry>
3143   <term>Default value:</term>
3144   <listitem>
3145    <para>None</para>
3146   </listitem>
3147  </varlistentry>
3148  <varlistentry>
3149   <term>Notes:</term>
3150   <listitem>
3151    <para>
3152      By default &my-app; leaves the client headers in the order they
3153      were sent by the client. Headers are modified in-place, new headers
3154      are added at the end of the already existing headers.
3155    </para>
3156    <para>
3157      The header order can be used to fingerprint client requests
3158      independently of other headers like the User-Agent.
3159    </para>
3160    <para>
3161      This directive allows to sort the headers differently to better
3162      mimic a different User-Agent. Client headers will be emitted
3163      in the order given, headers whose name isn't explicitly specified
3164      are added at the end.
3165    </para>
3166    <para>
3167      Note that sorting headers in an uncommon way will make fingerprinting
3168      actually easier. Encrypted headers are not affected by this directive.
3169    </para>
3170   </listitem>
3171  </varlistentry>
3172 </variablelist>
3173 <![%config-file;[<literallayout>@@#client-header-order Host \
3174 # User-Agent \
3175 # Accept \
3176 # Accept-Language \
3177 # Accept-Encoding \
3178 # Proxy-Connection,\
3179 # Referer,Cookie \
3180 # If-Modified-Since \
3181 # Cache-Control \
3182 # Content-Length \
3183 # Content-Type
3184 </literallayout>]]>
3185 </sect3>
3186
3187
3188 </sect2>
3189
3190 <!--  ~  End section  ~  -->
3191
3192
3193 <!--   ~~~~~       New section      ~~~~~     -->
3194
3195 <sect2 id="windows-gui">
3196 <title>Windows GUI Options</title>
3197 <para>
3198  <application>Privoxy</application> has a number of options specific to the
3199  Windows GUI interface:
3200 </para>
3201
3202 <anchor id="activity-animation">
3203 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3204 <para>
3205  If <quote>activity-animation</quote> is set to 1, the
3206  <application>Privoxy</application> icon will animate when
3207  <quote>Privoxy</quote> is active. To turn off, set to 0.
3208 </para>
3209
3210 <![%config-file;[<literallayout>@@#activity-animation   1</literallayout>]]>
3211 <![%user-man;[
3212 <para>
3213  <literal>
3214   <msgtext>
3215    <literallayout>
3216   <emphasis>activity-animation   1</emphasis>
3217    </literallayout>
3218   </msgtext>
3219  </literal>
3220 </para>
3221 ]]>
3222
3223 <anchor id="log-messages">
3224 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3225 <para>
3226  If <quote>log-messages</quote> is set to 1,
3227  <application>Privoxy</application> will log messages to the console
3228  window:
3229 </para>
3230
3231 <![%config-file;[<literallayout>@@#log-messages   1</literallayout>]]>
3232 <![%user-man;[
3233 <para>
3234  <literal>
3235   <msgtext>
3236    <literallayout>
3237   <emphasis>log-messages       1</emphasis>
3238    </literallayout>
3239   </msgtext>
3240  </literal>
3241 </para>
3242 ]]>
3243
3244 <anchor id="log-buffer-size">
3245 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3246 <para>
3247  If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
3248  i.e. the amount of memory used for the log messages displayed in the
3249  console window, will be limited to <quote>log-max-lines</quote> (see below).
3250 </para>
3251
3252 <para>
3253  Warning: Setting this to 0 will result in the buffer to grow infinitely and
3254  eat up all your memory!
3255 </para>
3256
3257 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
3258 <![%user-man;[
3259 <para>
3260  <literal>
3261   <msgtext>
3262    <literallayout>
3263   <emphasis>log-buffer-size      1</emphasis>
3264    </literallayout>
3265   </msgtext>
3266  </literal>
3267 </para>
3268 ]]>
3269
3270 <anchor id="log-max-lines">
3271 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3272 <para>
3273  <application>log-max-lines</application> is the maximum number of lines held
3274  in the log buffer. See above.
3275 </para>
3276
3277 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
3278 <![%user-man;[
3279 <para>
3280  <literal>
3281   <msgtext>
3282    <literallayout>
3283   <emphasis>log-max-lines      200</emphasis>
3284    </literallayout>
3285   </msgtext>
3286  </literal>
3287 </para>
3288 ]]>
3289
3290 <anchor id="log-highlight-messages">
3291 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3292 <para>
3293  If <quote>log-highlight-messages</quote> is set to 1,
3294  <application>Privoxy</application> will highlight portions of the log
3295  messages with a bold-faced font:
3296 </para>
3297
3298 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
3299 <![%user-man;[
3300 <para>
3301  <literal>
3302   <msgtext>
3303    <literallayout>
3304   <emphasis>log-highlight-messages   1</emphasis>
3305    </literallayout>
3306   </msgtext>
3307  </literal>
3308 </para>
3309 ]]>
3310
3311 <anchor id="log-font-name">
3312 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3313 <para>
3314  The font used in the console window:
3315 </para>
3316
3317 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
3318 <![%user-man;[
3319 <para>
3320  <literal>
3321   <msgtext>
3322    <literallayout>
3323   <emphasis>log-font-name        Comic Sans MS</emphasis>
3324    </literallayout>
3325   </msgtext>
3326  </literal>
3327 </para>
3328 ]]>
3329
3330 <anchor id="log-font-size">
3331 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3332 <para>
3333  Font size used in the console window:
3334 </para>
3335
3336 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
3337 <![%user-man;[
3338 <para>
3339  <literal>
3340   <msgtext>
3341    <literallayout>
3342   <emphasis>log-font-size        8</emphasis>
3343    </literallayout>
3344   </msgtext>
3345  </literal>
3346 </para>
3347 ]]>
3348
3349 <anchor id="show-on-task-bar">
3350 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3351 <para>
3352  <quote>show-on-task-bar</quote> controls whether or not
3353  <application>Privoxy</application> will appear as a button on the Task bar
3354  when minimized:
3355 </para>
3356
3357 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
3358 <![%user-man;[
3359 <para>
3360  <literal>
3361   <msgtext>
3362    <literallayout>
3363   <emphasis>show-on-task-bar     0</emphasis>
3364    </literallayout>
3365   </msgtext>
3366  </literal>
3367 </para>
3368 ]]>
3369
3370 <anchor id="close-button-minimizes">
3371 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3372 <para>
3373  If <quote>close-button-minimizes</quote> is set to 1, the Windows close
3374  button will minimize <application>Privoxy</application> instead of closing
3375  the program (close with the exit option on the File menu).
3376 </para>
3377
3378 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
3379 <![%user-man;[
3380 <para>
3381  <literal>
3382   <msgtext>
3383    <literallayout>
3384   <emphasis>close-button-minimizes  1</emphasis>
3385    </literallayout>
3386   </msgtext>
3387  </literal>
3388 </para>
3389 ]]>
3390
3391 <anchor id="hide-console">
3392 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3393 <para>
3394  The <quote>hide-console</quote> option is specific to the MS-Win console
3395  version of <application>Privoxy</application>. If this option is used,
3396  <application>Privoxy</application> will disconnect from and hide the
3397  command console.
3398 </para>
3399
3400 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
3401 <![%user-man;[
3402 <para>
3403  <literal>
3404   <msgtext>
3405    <literallayout>
3406   #<emphasis>hide-console</emphasis>
3407    </literallayout>
3408   </msgtext>
3409  </literal>
3410 </para>
3411 ]]>
3412
3413 </sect2>
3414 </sect1>
3415
3416 <!-- end config content common to both outputs -->
3417
3418 <![%config-file;[
3419 <!-- These are dummy anchors to keep the processor quiet            -->
3420 <!-- when building config-file only (ie. they are used in u-m only) -->
3421 <sect1 label="">
3422 <title></title>
3423 <anchor id="filter">
3424 <anchor id="filter-file">
3425 <anchor id="regex">
3426 <anchor id="actions-file">
3427 <anchor id="af-patterns">
3428 </sect1>
3429 ]]>
3430
3431 <!-- eof p-config.sgml -->