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