doc/source/p-config.sgml

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