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