doc/source/p-config.sgml

   1 <!--
   2  File        :  $Source: /cvsroot/ijbswa/current/doc/source/p-config.sgml,v $
   3
   4  Purpose     :  Used with other docs and files only.
   5
   6  $Id: p-config.sgml,v 2.28 2008/02/03 19:15:54 fabiankeil Exp $
   7
   8  Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/
   9  See LICENSE.
  10
  11  ========================================================================
  12  NOTE: Please read developer-manual/documentation.html before touching
  13  anything in this, or other Privoxy documentation.
  14  ========================================================================
  15
  16
  17  This file contains all the config file comments and options. It used to
  18  build both the user-manual config sections, and all of config (yes, the main
  19  config file) itself.
  20
  21  Rationale: This is broken up into two files since a file with a prolog
  22  (DTD, etc) cannot be sourced as a secondary file. config.sgml is basically
  23  a wrapper for this file.
  24
  25  IMPORTANT:
  26
  27  OPTIONS: The actual options are included in this file and prefixed with
  28  '@@', and processed by the Makefile to strip the '@@'. Default options
  29  that should appear commented out should be listed as: '@@#OPTION'.
  30  Otherwise, as '@@OPTION'. Example:
  31
  32   @@listen-address  127.0.0.1:8118
  33
  34  The Makefile does significant other processing too. The final results
  35  should be checked to make sure that the perl processing does not
  36  fubar something!!! Makefile processing requires w3m, fmt (shell line
  37  formatter), and perl.
  38
  39
  40  This file is included into:
  41
  42    user-manual.sgml
  43    config   (the actual Privoxy config file)
  44
  45 -->
  46
  47 <![%user-man;[
  48 <!-- This part only goes into user-manual -->
  49 <sect1 id="config">
  50 <title>The Main Configuration File</title>
  51
  52 <para>
  53  Again, the main configuration file is named <filename>config</filename> on
  54  Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
  55  Configuration lines consist of an initial keyword followed by a list of
  56  values, all separated by whitespace (any number of spaces or tabs). For
  57  example:
  58 </para>
  59
  60 <para>
  61  <literal>
  62   <msgtext>
  63    <literallayout>
  64   <emphasis>confdir /etc/privoxy</emphasis></literallayout>
  65   </msgtext>
  66  </literal>
  67 </para>
  68
  69 <para>
  70  Assigns the value <literal>/etc/privoxy</literal> to the option
  71  <literal>confdir</literal> and thus indicates that the configuration
  72  directory is named <quote>/etc/privoxy/</quote>.
  73 </para>
  74
  75 <para>
  76  All options in the config file except for <literal>confdir</literal> and
  77  <literal>logdir</literal> are optional. Watch out in the below description
  78  for what happens if you leave them unset.
  79 </para>
  80
  81 <para>
  82  The main config file controls all aspects of <application>Privoxy</application>'s
  83  operation that are not location dependent (i.e. they apply universally, no matter
  84  where you may be surfing).
  85 </para>
  86
  87 ]]>
  88
  89
  90 <![%config-file;[
  91 <!-- This part only goes into the config file -->
  92 <sect1 id="config">
  93 <title>
  94  @@TITLE<!-- between the @@ is stripped by Makefile -->@@
  95  Sample Configuration File for Privoxy v&p-version;
  96 </title>
  97 <para>
  98  $Id: p-config.sgml,v 2.28 2008/02/03 19:15:54 fabiankeil Exp $
  99 </para>
 100 <para>
 101 Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/
 102 </para>
 103
 104 <para>
 105  <literallayout>
 106 #################################################################
 107                                                                 #
 108                     Table of Contents                           #
 109                                                                 #
 110       I. INTRODUCTION                                           #
 111      II. FORMAT OF THE CONFIGURATION FILE                       #
 112                                                                 #
 113       1. LOCAL SET-UP DOCUMENTATION                             #
 114       2. CONFIGURATION AND LOG FILE LOCATIONS                   #
 115       3. DEBUGGING                                              #
 116       4. ACCESS CONTROL AND SECURITY                            #
 117       5. FORWARDING                                             #
 118       6. WINDOWS GUI OPTIONS                                    #
 119                                                                 #
 120 #################################################################
 121  </literallayout>
 122 </para>
 123
 124 <literallayout>I. INTRODUCTION
 125  ===============  <!-- fuck this madness --></literallayout>
 126
 127 <para>
 128  This file holds Privoxy's main configuration.  Privoxy detects
 129  configuration changes automatically, so you don't have to restart it
 130  unless you want to load a different configuration file.
 131 </para>
 132 <para>
 133  The configuration will be reloaded with the first request after the
 134  change was done, this request itself will still use the old configuration,
 135  though. In other words: it takes two requests before you see the result of
 136  your changes. Requests that are dropped due to ACL don't trigger reloads.
 137 </para>
 138 <para>
 139  When starting Privoxy on Unix systems, give the location of this
 140  file as last argument.  On Windows systems, Privoxy will look for
 141  this file with the name 'config.txt' in the current working directory
 142  of the Privoxy process.
 143 </para>
 144
 145 <para>
 146  <literallayout><!-- funky spacing -->
 147
 148 II. FORMAT OF THE CONFIGURATION FILE
 149 ====================================</literallayout>
 150 </para>
 151 <para>
 152  Configuration lines consist of an initial keyword followed by a list
 153  of values, all separated by whitespace (any number of spaces or
 154  tabs).  For example,
 155 </para>
 156 <para>
 157  actionsfile default.action
 158 </para>
 159 <para>
 160  Indicates that the actionsfile is named 'default.action'.
 161 </para>
 162 <para>
 163  The '#' indicates a comment.  Any part of a line following a '#' is
 164  ignored, except if the '#' is preceded by a '\'.
 165 </para>
 166 <para>
 167  Thus, by placing a # at the start of an existing configuration line,
 168  you can make it a comment and it will be treated as if it weren't there.
 169  This is called "commenting out" an option and can be useful. Removing
 170  the # again is called "uncommenting".
 171 </para>
 172 <para>
 173  Note that commenting out an option and leaving it at its default
 174  are two completely different things! Most options behave very
 175  differently when unset. See the "Effect if unset" explanation
 176  in each option's description for details.
 177 </para>
 178 <para>
 179  Long lines can be continued on the next line by using a `\' as
 180  the last character.
 181 </para>
 182
 183 ]]>
 184
 185 <!-- ************************************************ -->
 186 <!-- The following is common to both outputs (mostly) -->
 187 <!-- ************************************************ -->
 188
 189
 190
 191 <!--   ~~~~~       New section      ~~~~~     -->
 192 <sect2 id="local-set-up">
 193 <title>Local Set-up Documentation</title>
 194
 195   <para>
 196     If you intend to operate <application>Privoxy</application> for more users
 197     than just yourself, it might be a good idea to let them know how to reach
 198     you, what you block and why you do that, your policies, etc.
 199    </para>
 200
 201
 202 <!--   ~~~~~       New section      ~~~~~     -->
 203 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
 204 <variablelist>
 205  <varlistentry>
 206   <term>Specifies:</term>
 207   <listitem>
 208    <para>
 209     Location of the <application>Privoxy</application> User Manual.
 210    </para>
 211   </listitem>
 212  </varlistentry>
 213  <varlistentry>
 214   <term>Type of value:</term>
 215   <listitem>
 216    <para>A fully qualified URI</para>
 217   </listitem>
 218  </varlistentry>
 219  <varlistentry>
 220   <term>Default value:</term>
 221   <listitem>
 222    <para><emphasis>Unset</emphasis></para>
 223   </listitem>
 224  </varlistentry>
 225  <varlistentry>
 226   <term>Effect if unset:</term>
 227   <listitem>
 228    <para>
 229     <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/<replaceable class="parameter">version</replaceable>/user-manual/</ulink>
 230     will be used, where <replaceable class="parameter">version</replaceable> is the <application>Privoxy</application> version.
 231    </para>
 232   </listitem>
 233  </varlistentry>
 234  <varlistentry>
 235   <term>Notes:</term>
 236   <listitem>
 237     <para>
 238     The User Manual URI is the single best source of information on
 239     <application>Privoxy</application>, and is used for help links from some
 240     of the internal CGI pages. The manual itself is normally packaged with the
 241     binary distributions, so you probably want to set this to a locally
 242     installed copy.
 243    </para>
 244    <para>
 245     Examples:
 246    </para>
 247   <!--
 248   <para>
 249    Unix, in local filesystem (may not work with all browsers):
 250   </para>
 251   <para>
 252    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
 253   </para>
 254   <para>
 255    Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
 256   </para>
 257   <para>
 258    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
 259   </para>
 260   <para>
 261    Windows, UNC notation (with forward slashes):
 262   </para>
 263   <para>
 264    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
 265   </para>
 266  -->
 267   <para>
 268    The best all purpose solution is simply to put the full local
 269    <literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
 270    located:
 271   </para>
 272   <para>
 273    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;/usr/share/doc/privoxy/user-manual</screen>
 274   </para>
 275   <para>
 276    The User Manual is then available to anyone with access to
 277    <application>Privoxy</application>, by following the built-in URL:
 278    <literal>http://config.privoxy.org/user-manual/</literal>
 279    (or the shortcut: <literal>http://p.p/user-manual/</literal>).
 280   </para>
 281   <para>
 282    If the documentation is not on the local system, it can be accessed
 283    from a remote server, as:
 284   </para>
 285   <para>
 286    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;http://example.com/privoxy/user-manual/</screen>
 287   </para>
 288   <![%user-man;[
 289    <!-- this gets hammered in conversion to config. Text repeated below. -->
 290   <warning>
 291    <para>
 292      If set, this option should be <emphasis>the first option in the config
 293      file</emphasis>, because it is used while the config file is being read
 294      on start-up.
 295    </para>
 296   </warning>
 297   ]]>
 298
 299   <![%config-file;[
 300    <!-- alternate -->
 301    <para>
 302     WARNING!!!
 303    </para>
 304    <blockquote>
 305     <para>
 306      If set, this option should be the first option in the config
 307      file, because it is used while the config file is being read.
 308     </para>
 309    </blockquote>
 310   ]]>
 311
 312  </listitem>
 313  </varlistentry>
 314 </variablelist>
 315
 316 <![%config-file;[<literallayout>@@#user-manual http://www.privoxy.org/user-manual/</literallayout>]]>
 317 </sect3>
 318
 319
 320 <!--   ~~~~~       New section      ~~~~~     -->
 321 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
 322
 323 <variablelist>
 324  <varlistentry>
 325   <term>Specifies:</term>
 326   <listitem>
 327    <para>
 328     A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
 329    </para>
 330   </listitem>
 331  </varlistentry>
 332  <varlistentry>
 333   <term>Type of value:</term>
 334   <listitem>
 335    <para>URL</para>
 336   </listitem>
 337  </varlistentry>
 338  <varlistentry>
 339   <term>Default value:</term>
 340   <listitem>
 341    <para>Two example URLs are provided</para>
 342   </listitem>
 343  </varlistentry>
 344  <varlistentry>
 345   <term>Effect if unset:</term>
 346   <listitem>
 347    <para>
 348     No links are displayed on the "untrusted" error page.
 349    </para>
 350   </listitem>
 351  </varlistentry>
 352  <varlistentry>
 353   <term>Notes:</term>
 354   <listitem>
 355    <para>
 356     The value of this option only matters if the experimental trust mechanism has been
 357     activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> below.)
 358    </para>
 359    <para>
 360     If you use the trust mechanism, it is a good idea to write up some on-line
 361     documentation about your trust policy and to specify the URL(s) here.
 362     Use multiple times for multiple URLs.
 363    </para>
 364    <para>
 365     The URL(s) should be added to the trustfile as well, so users don't end up
 366     locked out from the information on why they were locked out in the first place!
 367    </para>
 368   </listitem>
 369  </varlistentry>
 370 </variablelist>
 371
 372 <![%config-file;[<literallayout>@@trust-info-url  http://www.example.com/why_we_block.html</literallayout>]]>
 373 <![%config-file;[<literallayout>@@trust-info-url  http://www.example.com/what_we_allow.html</literallayout>]]>
 374 </sect3>
 375
 376
 377 <!--   ~~~~~       New section      ~~~~~     -->
 378 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
 379
 380 <variablelist>
 381  <varlistentry>
 382   <term>Specifies:</term>
 383   <listitem>
 384    <para>
 385     An email address to reach the <application>Privoxy</application> administrator.
 386    </para>
 387   </listitem>
 388  </varlistentry>
 389  <varlistentry>
 390   <term>Type of value:</term>
 391   <listitem>
 392    <para>Email address</para>
 393   </listitem>
 394  </varlistentry>
 395  <varlistentry>
 396   <term>Default value:</term>
 397   <listitem>
 398    <para><emphasis>Unset</emphasis></para>
 399   </listitem>
 400  </varlistentry>
 401  <varlistentry>
 402   <term>Effect if unset:</term>
 403   <listitem>
 404    <para>
 405     No email address is displayed on error pages and the CGI user interface.
 406    </para>
 407   </listitem>
 408  </varlistentry>
 409  <varlistentry>
 410   <term>Notes:</term>
 411   <listitem>
 412    <para>
 413     If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
 414     are unset, the whole "Local Privoxy Support" box on all generated pages will
 415     not be shown.
 416    </para>
 417   </listitem>
 418  </varlistentry>
 419 </variablelist>
 420
 421 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
 422 </sect3>
 423
 424
 425 <!--   ~~~~~       New section      ~~~~~     -->
 426 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
 427
 428 <variablelist>
 429  <varlistentry>
 430   <term>Specifies:</term>
 431   <listitem>
 432    <para>
 433     A URL to documentation about the local <application>Privoxy</application> setup,
 434     configuration or policies.
 435    </para>
 436   </listitem>
 437  </varlistentry>
 438  <varlistentry>
 439   <term>Type of value:</term>
 440   <listitem>
 441    <para>URL</para>
 442   </listitem>
 443  </varlistentry>
 444  <varlistentry>
 445   <term>Default value:</term>
 446   <listitem>
 447    <para><emphasis>Unset</emphasis></para>
 448   </listitem>
 449  </varlistentry>
 450  <varlistentry>
 451   <term>Effect if unset:</term>
 452   <listitem>
 453    <para>
 454     No link to local documentation is displayed on error pages and the CGI user interface.
 455    </para>
 456   </listitem>
 457  </varlistentry>
 458  <varlistentry>
 459   <term>Notes:</term>
 460   <listitem>
 461    <para>
 462     If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
 463     are unset, the whole "Local Privoxy Support" box on all generated pages will
 464     not be shown.
 465    </para>
 466    <para>
 467     This URL shouldn't be blocked ;-)
 468    </para>
 469   </listitem>
 470  </varlistentry>
 471 </variablelist>
 472
 473 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
 474 </sect3>
 475
 476 </sect2>
 477 <!--  ~  End section  ~  -->
 478
 479
 480
 481 <!--   ~~~~~       New section      ~~~~~     -->
 482
 483 <sect2 id="conf-log-loc">
 484 <title>Configuration and Log File Locations</title>
 485
 486 <para>
 487  <application>Privoxy</application> can (and normally does) use a number of
 488  other files for additional configuration, help and logging.
 489  This section of the configuration file tells <application>Privoxy</application>
 490  where to find those other files.
 491 </para>
 492
 493 <para>
 494  The user running <application>Privoxy</application>, must have read
 495  permission for all configuration files, and write permission to any files
 496  that would be modified, such as log files and actions files.
 497 </para>
 498
 499
 500 <!--   ~~~~~       New section      ~~~~~     -->
 501 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
 502
 503 <variablelist>
 504  <varlistentry>
 505   <term>Specifies:</term>
 506   <listitem>
 507    <para>The directory where the other configuration files are located.</para>
 508   </listitem>
 509  </varlistentry>
 510  <varlistentry>
 511   <term>Type of value:</term>
 512   <listitem>
 513    <para>Path name</para>
 514   </listitem>
 515  </varlistentry>
 516  <varlistentry>
 517   <term>Default value:</term>
 518   <listitem>
 519    <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
 520   </listitem>
 521  </varlistentry>
 522  <varlistentry>
 523   <term>Effect if unset:</term>
 524   <listitem>
 525    <para><emphasis>Mandatory</emphasis></para>
 526   </listitem>
 527  </varlistentry>
 528  <varlistentry>
 529   <term>Notes:</term>
 530   <listitem>
 531    <para>
 532     No trailing <quote><literal>/</literal></quote>, please.
 533    </para>
 534   <!--
 535    This is really outdated and not likely to happen. HB 09/20/06
 536    <para>
 537     When development goes modular and multi-user, the blocker, filter, and
 538     per-user config will be stored in subdirectories of <quote>confdir</quote>.
 539     For now, the configuration directory structure is flat, except for
 540     <filename>confdir/templates</filename>, where the HTML templates for CGI
 541     output reside (e.g. <application>Privoxy's</application> 404 error page).
 542    </para>
 543   -->
 544   </listitem>
 545  </varlistentry>
 546 </variablelist>
 547
 548 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
 549 </sect3>
 550
 551 <!--   ~~~~~       New section      ~~~~~     -->
 552 <sect3 renderas="sect4" id="templdir"><title>templdir</title>
 553
 554 <variablelist>
 555  <varlistentry>
 556   <term>Specifies:</term>
 557   <listitem>
 558    <para>An alternative directory where the templates are loaded from.</para>
 559   </listitem>
 560  </varlistentry>
 561  <varlistentry>
 562   <term>Type of value:</term>
 563   <listitem>
 564    <para>Path name</para>
 565   </listitem>
 566  </varlistentry>
 567  <varlistentry>
 568   <term>Default value:</term>
 569   <listitem>
 570    <para>unset</para>
 571   </listitem>
 572  </varlistentry>
 573  <varlistentry>
 574   <term>Effect if unset:</term>
 575   <listitem>
 576    <para>The templates are assumed to be located in confdir/template.</para>
 577   </listitem>
 578  </varlistentry>
 579  <varlistentry>
 580   <term>Notes:</term>
 581   <listitem>
 582    <para>
 583     <application>Privoxy's</application> original templates are usually
 584     overwritten with each update. Use this option to relocate customized
 585     templates that should be kept. As template variables might change
 586     between updates, you shouldn't expect templates to work with
 587     <application>Privoxy</application> releases other than the one
 588     they were part of, though.
 589    </para>
 590   </listitem>
 591  </varlistentry>
 592 </variablelist>
 593
 594 <![%config-file;[<literallayout>@@#templdir .</literallayout>]]>
 595 </sect3>
 596
 597
 598 <!--   ~~~~~       New section      ~~~~~     -->
 599 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
 600
 601 <variablelist>
 602  <varlistentry>
 603   <term>Specifies:</term>
 604   <listitem>
 605    <para>
 606     The directory where all logging takes place
 607     (i.e. where <filename>logfile</filename> and
 608     <filename>jarfile</filename> are located).
 609    </para>
 610   </listitem>
 611  </varlistentry>
 612  <varlistentry>
 613   <term>Type of value:</term>
 614   <listitem>
 615    <para>Path name</para>
 616   </listitem>
 617  </varlistentry>
 618  <varlistentry>
 619   <term>Default value:</term>
 620   <listitem>
 621    <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
 622   </listitem>
 623  </varlistentry>
 624  <varlistentry>
 625   <term>Effect if unset:</term>
 626   <listitem>
 627    <para><emphasis>Mandatory</emphasis></para>
 628   </listitem>
 629  </varlistentry>
 630  <varlistentry>
 631   <term>Notes:</term>
 632   <listitem>
 633    <para>
 634     No trailing <quote><literal>/</literal></quote>, please.
 635    </para>
 636   </listitem>
 637  </varlistentry>
 638 </variablelist>
 639
 640 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
 641 </sect3>
 642
 643
 644 <!--   ~~~~~       New section      ~~~~~     -->
 645 <sect3 renderas="sect4" id="actionsfile"><title>
 646 actionsfile
 647 </title>
 648 <anchor id="default.action">
 649 <anchor id="standard.action">
 650 <anchor id="user.action">
 651 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
 652 <variablelist>
 653  <varlistentry>
 654   <term>Specifies:</term>
 655   <listitem>
 656    <para>
 657     The <link linkend="actions-file">actions file(s)</link> to use
 658    </para>
 659   </listitem>
 660  </varlistentry>
 661  <varlistentry>
 662   <term>Type of value:</term>
 663   <listitem>
 664    <para>Complete file name, relative to <literal>confdir</literal></para>
 665   </listitem>
 666  </varlistentry>
 667  <varlistentry>
 668   <term>Default values:</term>
 669   <listitem>
 670    <simplelist>
 671     <member>
 672      <msgtext><literallayout>  standard.action     # Internal purposes, no editing recommended</literallayout></msgtext>
 673     </member>
 674     <member>
 675      <msgtext><literallayout>  default.action      # Main actions file</literallayout></msgtext>
 676     </member>
 677     <member>
 678      <msgtext><literallayout>  user.action         # User customizations</literallayout></msgtext>
 679     </member>
 680    </simplelist>
 681   </listitem>
 682  </varlistentry>
 683  <varlistentry>
 684   <term>Effect if unset:</term>
 685   <listitem>
 686    <para>
 687     No actions are taken at all. More or less neutral proxying.
 688    </para>
 689   </listitem>
 690  </varlistentry>
 691  <varlistentry>
 692   <term>Notes:</term>
 693   <listitem>
 694    <para>
 695     Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
 696    </para>
 697    <para>
 698     The default values include <filename>standard.action</filename>, which is used
 699     for internal purposes and should be loaded, <filename>default.action</filename>,
 700     which is the <quote>main</quote> actions file maintained by the developers, and
 701     <filename>user.action</filename>, where you can make your personal additions.
 702    </para>
 703    <para>
 704     Actions files contain all the per site and per URL configuration for
 705     ad blocking, cookie management, privacy considerations, etc.
 706     There is no point in using <application>Privoxy</application> without at
 707     least one actions file.
 708    </para>
 709    <para>
 710     Note that since Privoxy 3.0.7, the complete filename, including the <quote>.action</quote>
 711     extension has to be specified.  The syntax change was necessary to be consistent
 712     with the other file options and to allow previously forbidden characters.
 713    </para>
 714   </listitem>
 715  </varlistentry>
 716 </variablelist>
 717
 718 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
 719 <!-- html -> text conversion, blah -->
 720 <![%config-file;[<literallayout>@@actionsfile standard.action  # Internal purpose, recommended</literallayout>]]>
 721 <![%config-file;[<literallayout>@@actionsfile default.action   # Main actions file</literallayout>]]>
 722 <!--
 723  XXX: Like user.filter, user.action should probably be commented out
 724  by default as not all packages install it into the default directory.
 725  fk 2007-11-07
 726 -->
 727 <![%config-file;[<literallayout>@@actionsfile user.action      # User customizations</literallayout>]]>
 728 </sect3>
 729
 730 <!--   ~~~~~       New section      ~~~~~     -->
 731 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
 732 <anchor id="default.filter">
 733 <variablelist>
 734  <varlistentry>
 735   <term>Specifies:</term>
 736   <listitem>
 737    <para>
 738     The <link linkend="filter-file">filter file(s)</link> to use
 739    </para>
 740   </listitem>
 741  </varlistentry>
 742  <varlistentry>
 743   <term>Type of value:</term>
 744   <listitem>
 745    <para>File name, relative to <literal>confdir</literal></para>
 746   </listitem>
 747  </varlistentry>
 748  <varlistentry>
 749   <term>Default value:</term>
 750   <listitem>
 751    <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
 752   </listitem>
 753  </varlistentry>
 754  <varlistentry>
 755   <term>Effect if unset:</term>
 756   <listitem>
 757    <para>
 758     No textual content filtering takes place, i.e. all
 759     <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
 760     actions in the actions files are turned neutral.
 761    </para>
 762   </listitem>
 763  </varlistentry>
 764  <varlistentry>
 765   <term>Notes:</term>
 766   <listitem>
 767    <para>
 768     Multiple <literal>filterfile</literal> lines are permitted.
 769    </para>
 770    <para>
 771     The <link linkend="filter-file">filter files</link> contain content modification
 772     rules that use <link linkend="regex">regular expressions</link>. These rules permit
 773     powerful changes on the content of Web pages, and optionally the headers
 774     as well, e.g., you could try to disable your favorite JavaScript annoyances,
 775     re-write the actual displayed text, or just have some fun
 776     playing buzzword bingo with web pages.
 777    </para>
 778    <para>
 779     The
 780     <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
 781     actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
 782     to be defined in a filter file!
 783    </para>
 784    <para>
 785     A pre-defined filter file called <filename>default.filter</filename> that contains
 786     a number of useful filters for common problems is included in the distribution.
 787     See the section on the <literal><link linkend="filter">filter</link></literal>
 788     action for a list.
 789    </para>
 790    <para>
 791     It is recommended to place any locally adapted filters into a separate
 792     file, such as <filename>user.filter</filename>.
 793    </para>
 794   </listitem>
 795  </varlistentry>
 796 </variablelist>
 797
 798 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
 799 <![%config-file;[<literallayout>@@#filterfile user.filter      # User customizations</literallayout>]]>
 800 </sect3>
 801
 802
 803 <!--   ~~~~~       New section      ~~~~~     -->
 804 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
 805
 806 <variablelist>
 807  <varlistentry>
 808   <term>Specifies:</term>
 809   <listitem>
 810    <para>
 811     The log file to use
 812    </para>
 813   </listitem>
 814  </varlistentry>
 815  <varlistentry>
 816   <term>Type of value:</term>
 817   <listitem>
 818    <para>File name, relative to <literal>logdir</literal></para>
 819   </listitem>
 820  </varlistentry>
 821  <varlistentry>
 822   <term>Default value:</term>
 823   <listitem>
 824    <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
 825   </listitem>
 826  </varlistentry>
 827  <varlistentry>
 828   <term>Effect if unset:</term>
 829   <listitem>
 830    <para>
 831     No logfile is written.
 832    </para>
 833   </listitem>
 834  </varlistentry>
 835  <varlistentry>
 836   <term>Notes:</term>
 837   <listitem>
 838    <para>
 839     The logfile is where all logging and error messages are written. The level
 840     of detail and number of messages are set with the <literal>debug</literal>
 841     option (see below). The logfile can be useful for tracking down a problem with
 842     <application>Privoxy</application> (e.g., it's not blocking an ad you
 843     think it should block) and it can help you to monitor what your browser
 844     is doing.
 845    </para>
 846    <para>
 847     Depending on the debug options below, the logfile may be a privacy risk
 848     if third parties can get access to it. As most users will never look
 849     at it, <application>Privoxy</application> 3.0.7 and later only log fatal
 850     errors by default.
 851    </para>
 852    <para>
 853     For most troubleshooting purposes, you will have to change that,
 854     please refer to the debugging section for details.
 855    </para>
 856    <para>
 857     Your logfile will grow indefinitely, and you will probably want to
 858     periodically remove it.  On Unix systems, you can do this with a cron job
 859     (see <quote>man cron</quote>). For Red Hat based Linux distributions, a
 860     <command>logrotate</command> script has been included.
 861    </para>
 862    <para>
 863     Any log files must be writable by whatever user <application>Privoxy</application>
 864     is being run as (on Unix, default user id is <quote>privoxy</quote>).
 865    </para>
 866   </listitem>
 867  </varlistentry>
 868 </variablelist>
 869
 870 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
 871 </sect3>
 872
 873
 874 <!--   ~~~~~       New section      ~~~~~     -->
 875 <sect3 renderas="sect4" id="jarfile"><title>jarfile</title>
 876
 877 <variablelist>
 878  <varlistentry>
 879   <term>Specifies:</term>
 880   <listitem>
 881    <para>
 882     The file to store intercepted cookies in
 883    </para>
 884   </listitem>
 885  </varlistentry>
 886  <varlistentry>
 887   <term>Type of value:</term>
 888   <listitem>
 889    <para>File name, relative to <literal>logdir</literal></para>
 890   </listitem>
 891  </varlistentry>
 892  <varlistentry>
 893   <term>Default value:</term>
 894   <listitem>
 895    <para><emphasis>Unset (commented out)</emphasis>. When activated: jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows).</para>
 896   </listitem>
 897  </varlistentry>
 898  <varlistentry>
 899   <term>Effect if unset:</term>
 900   <listitem>
 901    <para>
 902     Intercepted cookies are not stored in a dedicated log file.
 903    </para>
 904   </listitem>
 905  </varlistentry>
 906  <varlistentry>
 907   <term>Notes:</term>
 908   <listitem>
 909    <para>
 910     The jarfile may grow to ridiculous sizes over time.
 911    </para>
 912    <para>
 913     If debug 8 (show header parsing) is enabled, cookies are
 914     also written to the logfile with the rest of the headers.
 915     Therefore this option isn't very useful and may be removed
 916     in future releases. Please report to the developers if you
 917     are still using it.
 918    </para>
 919   </listitem>
 920  </varlistentry>
 921 </variablelist>
 922
 923 <![%config-file;[<literallayout>@@#jarfile jarfile</literallayout>]]>
 924 </sect3>
 925
 926
 927 <!--   ~~~~~       New section      ~~~~~     -->
 928 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
 929 <variablelist>
 930  <varlistentry>
 931   <term>Specifies:</term>
 932   <listitem>
 933    <para>
 934     The name of the trust file to use
 935    </para>
 936   </listitem>
 937  </varlistentry>
 938  <varlistentry>
 939   <term>Type of value:</term>
 940   <listitem>
 941    <para>File name, relative to <literal>confdir</literal></para>
 942   </listitem>
 943  </varlistentry>
 944  <varlistentry>
 945   <term>Default value:</term>
 946   <listitem>
 947    <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
 948   </listitem>
 949  </varlistentry>
 950  <varlistentry>
 951   <term>Effect if unset:</term>
 952   <listitem>
 953    <para>
 954     The entire trust mechanism is disabled.
 955    </para>
 956   </listitem>
 957  </varlistentry>
 958  <varlistentry>
 959   <term>Notes:</term>
 960   <listitem>
 961    <para>
 962     The trust mechanism is an experimental feature for building white-lists and should
 963     be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
 964    </para>
 965    <para>
 966     If you specify a trust file, <application>Privoxy</application> will only allow
 967     access to sites that are specified in the trustfile. Sites can be listed
 968     in one of two ways:
 969    </para>
 970    <para>
 971     Prepending a <literal>~</literal> character limits access to this site
 972     only (and any sub-paths within this site), e.g.
 973     <literal>~www.example.com</literal> allows access to
 974     <literal>~www.example.com/features/news.html</literal>, etc.
 975    </para>
 976    <para>
 977     Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
 978     prepending the name with a <literal>+</literal> character. The effect is that
 979     access to untrusted sites will be granted -- but only if a link from this
 980     trusted referrer was used to get there. The link target will then be added
 981     to the <quote>trustfile</quote> so that future, direct accesses will be
 982     granted. Sites added via this mechanism do not become trusted referrers
 983     themselves (i.e. they are added with a <literal>~</literal> designation).
 984     There is a limit of 512 such entries, after which new entries will not be
 985     made.
 986    </para>
 987    <para>
 988     If you use the <literal>+</literal> operator in the trust file, it may grow
 989     considerably over time.
 990    </para>
 991    <para>
 992     It is recommended that <application>Privoxy</application> be compiled with
 993     the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
 994     <literal> --disable-editor</literal> options, if this feature is to be
 995     used.
 996    </para>
 997    <para>
 998     Possible applications include limiting Internet access for children.
 999    </para>
1000
1001   </listitem>
1002  </varlistentry>
1003 </variablelist>
1004
1005 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
1006 </sect3>
1007 </sect2>
1008
1009 <!--  ~  End section  ~  -->
1010
1011 <!--   ~~~~~       New section      ~~~~~     -->
1012 <sect2 id="debugging">
1013 <title>Debugging</title>
1014
1015  <para>
1016   These options are mainly useful when tracing a problem.
1017   Note that you might also want to invoke
1018   <application>Privoxy</application> with the <literal>--no-daemon</literal>
1019   command line option when debugging.
1020  </para>
1021
1022 <sect3 renderas="sect4" id="debug"><title>debug</title>
1023
1024 <variablelist>
1025  <varlistentry>
1026   <term>Specifies:</term>
1027   <listitem>
1028    <para>
1029     Key values that determine what information gets logged.
1030    </para>
1031   </listitem>
1032  </varlistentry>
1033  <varlistentry>
1034   <term>Type of value:</term>
1035   <listitem>
1036    <para>Integer values</para>
1037   </listitem>
1038  </varlistentry>
1039  <varlistentry>
1040   <term>Default value:</term>
1041   <listitem>
1042    <para>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</para>
1043   </listitem>
1044  </varlistentry>
1045  <varlistentry>
1046   <term>Effect if unset:</term>
1047   <listitem>
1048    <para>
1049     Default value is used (see above).
1050    </para>
1051   </listitem>
1052  </varlistentry>
1053  <varlistentry>
1054   <term>Notes:</term>
1055   <listitem>
1056    <para>
1057     The available debug levels are:
1058    </para>
1059    <para>
1060     <programlisting>
1061   debug         1 # log each request destination (and the crunch reason if &my-app; intercepted the request)
1062   debug         2 # show each connection status
1063   debug         4 # show I/O status
1064   debug         8 # show header parsing
1065   debug        16 # log all data written to the network into the logfile
1066   debug        32 # debug force feature
1067   debug        64 # debug regular expression filters
1068   debug       128 # debug redirects
1069   debug       256 # debug GIF de-animation
1070   debug       512 # Common Log Format
1071   debug      1024 # debug kill pop-ups
1072   debug      2048 # CGI user interface
1073   debug      4096 # Startup banner and warnings.
1074   debug      8192 # Non-fatal errors
1075 </programlisting>
1076    </para>
1077    <para>
1078     To select multiple debug levels, you can either add them or use
1079     multiple <literal>debug</literal> lines.
1080    </para>
1081    <para>
1082     A debug level of 1 is informative because it will show you each request
1083     as it happens. <emphasis>1, 4096 and 8192 are recommended</emphasis>
1084     so that you will notice when things go wrong. The other levels are
1085     probably only of interest if you are hunting down a specific problem.
1086     They can produce a hell of an output (especially 16).
1087     <!-- LOL -->
1088    </para>
1089    <para>
1090     &my-app; used to ship with the debug levels recommended above enabled by
1091     default, but due to privacy concerns 3.0.7 and later are configured to
1092     only log fatal errors.
1093    </para>
1094    <para>
1095     If you are used to the more verbose settings, simply enable the debug lines
1096     below again.
1097    </para>
1098    <para>
1099     If you want to use pure CLF (Common Log Format), you should set <quote>debug
1100     512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1101    </para>
1102    <para>
1103     <application>Privoxy</application> has a hard-coded limit for the
1104     length of log messages. If it's reached, messages are logged truncated
1105     and marked with <quote>... [too long, truncated]</quote>.
1106    </para>
1107    <para>
1108     Please don't file any support requests without trying to reproduce
1109     the problem with increased debug level first. Once you read the log
1110     messages, you may even be able to solve the problem on your own.
1111    </para>
1112   </listitem>
1113  </varlistentry>
1114 </variablelist>
1115
1116 <![%config-file;[<literallayout>@@#debug      1 # log each request destination (and the crunch reason if &my-app; intercepted the request)</literallayout>]]>
1117 <![%config-file;[<literallayout>@@#debug   4096 # Startup banner and warnings</literallayout>]]>
1118 <![%config-file;[<literallayout>@@#debug   8192 # Non-fatal errors</literallayout>]]>
1119 </sect3>
1120
1121
1122 <!--   ~~~~~       New section      ~~~~~     -->
1123 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1124
1125 <variablelist>
1126  <varlistentry>
1127   <term>Specifies:</term>
1128   <listitem>
1129    <para>
1130     Whether to run only one server thread.
1131    </para>
1132   </listitem>
1133  </varlistentry>
1134  <varlistentry>
1135   <term>Type of value:</term>
1136   <listitem>
1137    <para><emphasis>None</emphasis></para>
1138   </listitem>
1139  </varlistentry>
1140  <varlistentry>
1141   <term>Default value:</term>
1142   <listitem>
1143    <para><emphasis>Unset</emphasis></para>
1144   </listitem>
1145  </varlistentry>
1146  <varlistentry>
1147   <term>Effect if unset:</term>
1148   <listitem>
1149    <para>
1150     Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1151     serve multiple requests simultaneously.
1152    </para>
1153   </listitem>
1154  </varlistentry>
1155  <varlistentry>
1156   <term>Notes:</term>
1157   <listitem>
1158    <para>
1159     This option is only there for debugging purposes.
1160     <emphasis>It will drastically reduce performance.</emphasis>
1161    </para>
1162   </listitem>
1163  </varlistentry>
1164 </variablelist>
1165
1166 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1167 </sect3>
1168
1169 <!--   ~~~~~       New section      ~~~~~     -->
1170 <sect3 renderas="sect4" id="hostname"><title>hostname</title>
1171
1172 <variablelist>
1173  <varlistentry>
1174   <term>Specifies:</term>
1175   <listitem>
1176    <para>
1177     The hostname shown on the CGI pages.
1178    </para>
1179   </listitem>
1180  </varlistentry>
1181  <varlistentry>
1182   <term>Type of value:</term>
1183   <listitem>
1184    <para>Text</para>
1185   </listitem>
1186  </varlistentry>
1187  <varlistentry>
1188   <term>Default value:</term>
1189   <listitem>
1190    <para><emphasis>Unset</emphasis></para>
1191   </listitem>
1192  </varlistentry>
1193  <varlistentry>
1194   <term>Effect if unset:</term>
1195   <listitem>
1196    <para>
1197     The hostname provided by the operating system is used.
1198    </para>
1199   </listitem>
1200  </varlistentry>
1201  <varlistentry>
1202   <term>Notes:</term>
1203   <listitem>
1204    <para>
1205     On some misconfigured systems resolving the hostname fails or
1206     takes too much time and slows Privoxy down. Setting a fixed hostname
1207     works around the problem.
1208    </para>
1209    <para>
1210     In other circumstances it might be desirable to show a hostname
1211     other than the one returned by the operating system. For example
1212     if the system has several different hostnames and you don't want
1213     to use the first one.
1214    </para>
1215    <para>
1216     Note that Privoxy does not validate the specified hostname value.
1217    </para>
1218   </listitem>
1219  </varlistentry>
1220 </variablelist>
1221
1222 <![%config-file;[<literallayout>@@#hostname hostname.example.org</literallayout>]]>
1223 </sect3>
1224
1225 </sect2>
1226
1227 <!--  ~  End section  ~  -->
1228
1229
1230 <!--   ~~~~~       New section      ~~~~~     -->
1231 <sect2 id="access-control">
1232 <title>Access Control and Security</title>
1233
1234  <para>
1235   This section of the config file controls the security-relevant aspects
1236   of <application>Privoxy</application>'s configuration.
1237  </para>
1238
1239
1240 <!--   ~~~~~       New section      ~~~~~     -->
1241 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1242
1243 <variablelist>
1244  <varlistentry>
1245   <term>Specifies:</term>
1246   <listitem>
1247    <para>
1248     The IP address and TCP port on which <application>Privoxy</application> will
1249     listen for client requests.
1250    </para>
1251   </listitem>
1252  </varlistentry>
1253  <varlistentry>
1254   <term>Type of value:</term>
1255   <listitem>
1256    <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1257   </listitem>
1258  </varlistentry>
1259
1260  <varlistentry>
1261   <term>Default value:</term>
1262   <listitem>
1263    <para>127.0.0.1:8118</para>
1264   </listitem>
1265  </varlistentry>
1266  <varlistentry>
1267   <term>Effect if unset:</term>
1268   <listitem>
1269    <para>
1270     Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1271     home users who run <application>Privoxy</application> on the same machine as
1272     their browser.
1273    </para>
1274   </listitem>
1275  </varlistentry>
1276  <varlistentry>
1277   <term>Notes:</term>
1278   <listitem>
1279    <para>
1280     You will need to configure your browser(s) to this proxy address and port.
1281    </para>
1282    <para>
1283     If you already have another service running on port 8118, or if you want to
1284     serve requests from other machines (e.g. on your local network) as well, you
1285     will need to override the default.
1286    </para>
1287    <para>
1288     If you leave out the IP address, <application>Privoxy</application> will
1289     bind to all interfaces (addresses) on your machine and may become reachable
1290     from the Internet. In that case, consider using <link
1291     linkend="acls">access control lists</link> (ACL's, see below), and/or
1292     a firewall.
1293    </para>
1294    <para>
1295     If you open <application>Privoxy</application> to untrusted users, you will
1296     also want to make sure that the following actions are disabled:  <literal><link
1297     linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1298     <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1299    </para>
1300   </listitem>
1301  </varlistentry>
1302  <varlistentry>
1303   <term>Example:</term>
1304   <listitem>
1305    <para>
1306      Suppose you are running <application>Privoxy</application> on
1307      a machine which has the address 192.168.0.1 on your local private network
1308      (192.168.0.0) and has another outside connection with a different address.
1309      You want it to serve requests from inside only:
1310    </para>
1311    <para>
1312     <programlisting>
1313   listen-address  192.168.0.1:8118
1314 </programlisting>
1315    </para>
1316   </listitem>
1317  </varlistentry>
1318 </variablelist>
1319
1320 <![%config-file;[<literallayout>@@listen-address  127.0.0.1:8118</literallayout>]]>
1321 </sect3>
1322
1323
1324 <!--   ~~~~~       New section      ~~~~~     -->
1325 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1326
1327 <variablelist>
1328  <varlistentry>
1329   <term>Specifies:</term>
1330   <listitem>
1331    <para>
1332     Initial state of "toggle" status
1333    </para>
1334   </listitem>
1335  </varlistentry>
1336  <varlistentry>
1337   <term>Type of value:</term>
1338   <listitem>
1339    <para>1 or 0</para>
1340   </listitem>
1341  </varlistentry>
1342  <varlistentry>
1343   <term>Default value:</term>
1344   <listitem>
1345    <para>1</para>
1346   </listitem>
1347  </varlistentry>
1348  <varlistentry>
1349   <term>Effect if unset:</term>
1350   <listitem>
1351    <para>
1352     Act as if toggled on
1353    </para>
1354   </listitem>
1355  </varlistentry>
1356  <varlistentry>
1357   <term>Notes:</term>
1358   <listitem>
1359    <para>
1360     If set to 0, <application>Privoxy</application> will start in
1361     <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1362     content-neutral proxy with both ad blocking and content filtering
1363     disabled. See <literal>enable-remote-toggle</literal> below.
1364 <!--
1365     This is not really useful
1366     anymore, since toggling is much easier via <ulink
1367     url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1368     editing the <filename>conf</filename> file.
1369
1370     Remote toggling is now disabled by default. fk 2007-11-07)
1371 -->
1372    </para>
1373    <para>
1374     The windows version will only display the toggle icon in the system tray
1375     if this option is present.
1376    </para>
1377   </listitem>
1378  </varlistentry>
1379 </variablelist>
1380
1381 <![%config-file;[<literallayout>@@toggle  1</literallayout>]]>
1382 </sect3>
1383
1384
1385 <!--   ~~~~~       New section      ~~~~~     -->
1386 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1387 <variablelist>
1388  <varlistentry>
1389   <term>Specifies:</term>
1390   <listitem>
1391    <para>
1392     Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1393     feature</ulink> may be used
1394    </para>
1395   </listitem>
1396  </varlistentry>
1397  <varlistentry>
1398   <term>Type of value:</term>
1399   <listitem>
1400    <para>0 or 1</para>
1401   </listitem>
1402  </varlistentry>
1403  <varlistentry>
1404   <term>Default value:</term>
1405   <listitem>
1406    <para>0</para>
1407   </listitem>
1408  </varlistentry>
1409  <varlistentry>
1410   <term>Effect if unset:</term>
1411   <listitem>
1412    <para>
1413     The web-based toggle feature is disabled.
1414    </para>
1415   </listitem>
1416  </varlistentry>
1417  <varlistentry>
1418   <term>Notes:</term>
1419   <listitem>
1420    <para>
1421     When toggled off, <application>Privoxy</application> mostly acts like a normal,
1422     content-neutral proxy, i.e. doesn't block ads or filter content.
1423    </para>
1424    <para>
1425     Access to the toggle feature can <emphasis>not</emphasis> be
1426     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1427     so that everybody who can access <application>Privoxy</application> (see
1428     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1429     toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1430     for multi-user environments with untrusted users.
1431    </para>
1432    <para>
1433     Note that malicious client side code (e.g Java) is also
1434     capable of using this option.
1435    </para>
1436    <para>
1437     As a lot of <application>Privoxy</application> users don't read
1438     documentation, this feature is disabled by default.
1439    </para>
1440    <para>
1441     Note that you must have compiled <application>Privoxy</application> with
1442     support for this feature, otherwise this option has no effect.
1443    </para>
1444   </listitem>
1445  </varlistentry>
1446 </variablelist>
1447
1448 <![%config-file;[<literallayout>@@enable-remote-toggle  0</literallayout>]]>
1449 </sect3>
1450
1451
1452 <!--   ~~~~~       New section      ~~~~~     -->
1453 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1454 <variablelist>
1455  <varlistentry>
1456   <term>Specifies:</term>
1457   <listitem>
1458    <para>
1459     Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1460    </para>
1461   </listitem>
1462  </varlistentry>
1463  <varlistentry>
1464   <term>Type of value:</term>
1465   <listitem>
1466    <para>0 or 1</para>
1467   </listitem>
1468  </varlistentry>
1469  <varlistentry>
1470   <term>Default value:</term>
1471   <listitem>
1472    <para>0</para>
1473   </listitem>
1474  </varlistentry>
1475  <varlistentry>
1476   <term>Effect if unset:</term>
1477   <listitem>
1478    <para>
1479     Privoxy ignores special HTTP headers.
1480    </para>
1481   </listitem>
1482  </varlistentry>
1483  <varlistentry>
1484   <term>Notes:</term>
1485   <listitem>
1486    <para>
1487     When toggled on, the client can change <application>Privoxy's</application>
1488     behaviour by setting special HTTP headers. Currently the only supported
1489     special header is <quote>X-Filter: No</quote>, to disable filtering for
1490     the ongoing request, even if it is enabled in one of the action files.
1491    </para>
1492    <para>
1493     This feature is disabled by default. If you are using
1494     <application>Privoxy</application> in a environment with trusted clients,
1495     you may enable this feature at your discretion. Note that malicious client
1496     side code (e.g Java) is also capable of using this feature.
1497    </para>
1498    <para>
1499     This option will be removed in future releases as it has been obsoleted
1500     by the more general header taggers.
1501    </para>
1502   </listitem>
1503  </varlistentry>
1504 </variablelist>
1505
1506 <![%config-file;[<literallayout>@@enable-remote-http-toggle  0</literallayout>]]>
1507 </sect3>
1508
1509
1510 <!--   ~~~~~       New section      ~~~~~     -->
1511 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1512 <variablelist>
1513  <varlistentry>
1514   <term>Specifies:</term>
1515   <listitem>
1516    <para>
1517     Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1518     file editor</ulink> may be used
1519    </para>
1520   </listitem>
1521  </varlistentry>
1522  <varlistentry>
1523   <term>Type of value:</term>
1524   <listitem>
1525    <para>0 or 1</para>
1526   </listitem>
1527  </varlistentry>
1528  <varlistentry>
1529   <term>Default value:</term>
1530   <listitem>
1531    <para>0</para>
1532   </listitem>
1533  </varlistentry>
1534  <varlistentry>
1535   <term>Effect if unset:</term>
1536   <listitem>
1537    <para>
1538     The web-based actions file editor is disabled.
1539    </para>
1540   </listitem>
1541  </varlistentry>
1542  <varlistentry>
1543   <term>Notes:</term>
1544   <listitem>
1545    <para>
1546     Access to the editor can <emphasis>not</emphasis> be
1547     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1548     so that everybody who can access <application>Privoxy</application> (see
1549     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1550     modify its configuration for all users.
1551    </para>
1552    <para>
1553     This option is <emphasis>not recommended</emphasis> for environments
1554     with untrusted users and as a lot of <application>Privoxy</application>
1555     users don't read documentation, this feature is disabled by default.
1556    </para>
1557    <para>
1558     Note that malicious client side code (e.g Java) is also
1559     capable of using the actions editor and you shouldn't enable
1560     this options unless you understand the consequences and are
1561     sure your browser is configured correctly.
1562    </para>
1563    <para>
1564     Note that you must have compiled <application>Privoxy</application> with
1565     support for this feature, otherwise this option has no effect.
1566    </para>
1567   </listitem>
1568  </varlistentry>
1569 </variablelist>
1570
1571 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1572 </sect3>
1573
1574
1575 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1576 <variablelist>
1577  <varlistentry>
1578   <term>Specifies:</term>
1579   <listitem>
1580    <para>
1581     Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1582    </para>
1583   </listitem>
1584  </varlistentry>
1585  <varlistentry>
1586   <term>Type of value:</term>
1587   <listitem>
1588    <para>
1589     <replaceable>0 or 1</replaceable>
1590    </para>
1591   </listitem>
1592  </varlistentry>
1593  <varlistentry>
1594   <term>Default value:</term>
1595   <listitem>
1596    <para><emphasis>0</emphasis></para>
1597   </listitem>
1598  </varlistentry>
1599  <varlistentry>
1600   <term>Effect if unset:</term>
1601   <listitem>
1602    <para>
1603     Blocks are not enforced.
1604    </para>
1605   </listitem>
1606  </varlistentry>
1607  <varlistentry>
1608   <term>Notes:</term>
1609   <listitem>
1610    <para>
1611     <application>Privoxy</application> is mainly used to block and filter
1612     requests as a service to the user, for example to block ads and other
1613     junk that clogs the pipes. <application>Privoxy's</application> configuration
1614     isn't perfect and sometimes innocent pages are blocked. In this situation it
1615     makes sense to allow the user to enforce the request and have
1616     <application>Privoxy</application> ignore the block.
1617    </para>
1618    <para>
1619     In the default configuration <application>Privoxy's</application>
1620     <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1621     link to adds a special string (the force prefix) to the request URL.
1622     If that link is used, <application>Privoxy</application> will
1623     detect the force prefix, remove it again and let the request pass.
1624    </para>
1625    <para>
1626     Of course <application>Privoxy</application> can also be used to enforce
1627     a network policy. In that case the user obviously should not be able to
1628     bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1629     option is for. If it's enabled, <application>Privoxy</application> hides
1630     the <quote>go there anyway</quote> link. If the user adds the force
1631     prefix by hand, it will not be accepted and the circumvention attempt
1632     is logged.
1633    </para>
1634   </listitem>
1635  </varlistentry>
1636  <varlistentry>
1637   <term>Examples:</term>
1638   <listitem>
1639    <para>
1640     enforce-blocks 1
1641    </para>
1642   </listitem>
1643  </varlistentry>
1644 </variablelist>
1645 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1646 </sect3>
1647
1648
1649 <!--   ~~~~~       New section      ~~~~~     -->
1650 <sect3 renderas="sect4" id="acls"><title>
1651 ACLs: permit-access and deny-access</title>
1652 <anchor id="permit-access">
1653 <anchor id="deny-access">
1654
1655 <variablelist>
1656  <varlistentry>
1657   <term>Specifies:</term>
1658   <listitem>
1659    <para>
1660     Who can access what.
1661    </para>
1662   </listitem>
1663  </varlistentry>
1664  <varlistentry>
1665   <term>Type of value:</term>
1666   <listitem>
1667    <para>
1668     <replaceable class="parameter">src_addr</replaceable>[/<replaceable class="parameter">src_masklen</replaceable>]
1669     [<replaceable class="parameter">dst_addr</replaceable>[/<replaceable class="parameter">dst_masklen</replaceable>]]
1670    </para>
1671    <para>
1672     Where <replaceable class="parameter">src_addr</replaceable> and
1673    <replaceable class="parameter">dst_addr</replaceable> are IP addresses in dotted decimal notation or valid
1674     DNS names, and <replaceable class="parameter">src_masklen</replaceable> and
1675     <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1676     values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1677     destination part are optional.
1678    </para>
1679   </listitem>
1680  </varlistentry>
1681  <varlistentry>
1682   <term>Default value:</term>
1683   <listitem>
1684    <para><emphasis>Unset</emphasis></para>
1685   </listitem>
1686  </varlistentry>
1687  <varlistentry>
1688   <term>Effect if unset:</term>
1689   <listitem>
1690    <para>
1691     Don't restrict access further than implied by <literal>listen-address</literal>
1692    </para>
1693   </listitem>
1694  </varlistentry>
1695  <varlistentry>
1696   <term>Notes:</term>
1697   <listitem>
1698    <para>
1699     Access controls are included at the request of ISPs and systems
1700     administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1701     For a typical home user, it will normally suffice to ensure that
1702     <application>Privoxy</application> only listens on the localhost
1703     (127.0.0.1) or internal (home) network address by means of the
1704     <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1705     option.
1706    </para>
1707    <para>
1708     Please see the warnings in the FAQ that <application>Privoxy</application>
1709     is not intended to be a substitute for a firewall or to encourage anyone
1710     to defer addressing basic security weaknesses.
1711    </para>
1712    <para>
1713     Multiple ACL lines are OK.
1714     If any ACLs are specified, <application>Privoxy</application> only talks
1715     to IP addresses that match at least one <literal>permit-access</literal> line
1716     and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1717     last match wins, with the default being <literal>deny-access</literal>.
1718    </para>
1719    <para>
1720     If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1721     for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1722     that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1723     of the ultimate target. This is necessary because it may be impossible for the local
1724     <application>Privoxy</application> to determine the IP address of the
1725     ultimate target (that's often what gateways are used for).
1726    </para>
1727    <para>
1728     You should prefer using IP addresses over DNS names, because the address lookups take
1729     time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1730     like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1731     IP addresses, only the first one is used.
1732    </para>
1733    <para>
1734     Denying access to particular sites by ACL may have undesired side effects
1735     if the site in question is hosted on a machine which also hosts other sites
1736     (most sites are).
1737    </para>
1738   </listitem>
1739  </varlistentry>
1740  <varlistentry>
1741   <term>Examples:</term>
1742   <listitem>
1743    <para>
1744     Explicitly define the default behavior if no ACL and
1745     <literal>listen-address</literal> are set: <quote>localhost</quote>
1746     is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1747     <emphasis>all</emphasis> destination addresses are OK:
1748    </para>
1749    <para>
1750     <screen>
1751   permit-access  localhost
1752 </screen>
1753    </para>
1754    <para>
1755     Allow any host on the same class C subnet as www.privoxy.org access to
1756     nothing but www.example.com (or other domains hosted on the same system):
1757    </para>
1758    <para>
1759     <screen>
1760   permit-access  www.privoxy.org/24 www.example.com/32
1761 </screen>
1762    </para>
1763    <para>
1764     Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1765     with the exception that 192.168.45.73 may not access the IP address behind
1766     www.dirty-stuff.example.com:
1767    </para>
1768    <para>
1769     <screen>
1770   permit-access  192.168.45.64/26
1771   deny-access    192.168.45.73    www.dirty-stuff.example.com
1772 </screen>
1773    </para>
1774   </listitem>
1775  </varlistentry>
1776 </variablelist>
1777 </sect3>
1778
1779
1780 <!--   ~~~~~       New section      ~~~~~     -->
1781 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1782
1783 <variablelist>
1784  <varlistentry>
1785   <term>Specifies:</term>
1786   <listitem>
1787    <para>
1788     Maximum size of the buffer for content filtering.
1789    </para>
1790   </listitem>
1791  </varlistentry>
1792  <varlistentry>
1793   <term>Type of value:</term>
1794   <listitem>
1795    <para>Size in Kbytes</para>
1796   </listitem>
1797  </varlistentry>
1798  <varlistentry>
1799   <term>Default value:</term>
1800   <listitem>
1801    <para>4096</para>
1802   </listitem>
1803  </varlistentry>
1804  <varlistentry>
1805   <term>Effect if unset:</term>
1806   <listitem>
1807    <para>
1808     Use a 4MB (4096 KB) limit.
1809    </para>
1810   </listitem>
1811  </varlistentry>
1812  <varlistentry>
1813   <term>Notes:</term>
1814   <listitem>
1815    <para>
1816     For content filtering, i.e. the <literal>+filter</literal> and
1817     <literal>+deanimate-gif</literal> actions, it is necessary that
1818     <application>Privoxy</application> buffers the entire document body.
1819     This can be potentially dangerous, since a server could just keep sending
1820     data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1821     Hence this option.
1822    </para>
1823    <para>
1824     When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1825     flushed to the client unfiltered and no further attempt to
1826     filter the rest of the document is made. Remember that there may be multiple threads
1827     running, which might require up to <literal>buffer-limit</literal> Kbytes
1828     <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1829     above.
1830    </para>
1831   </listitem>
1832  </varlistentry>
1833 </variablelist>
1834
1835 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1836 </sect3>
1837
1838 </sect2>
1839
1840 <!--  ~  End section  ~  -->
1841
1842
1843 <!--   ~~~~~       New section      ~~~~~     -->
1844
1845 <sect2 id="forwarding">
1846 <title>Forwarding</title>
1847
1848 <para>
1849  This feature allows routing of HTTP requests through a chain of
1850  multiple proxies.
1851 </para>
1852 <para>
1853  Forwarding can be used to chain Privoxy with a caching proxy to speed
1854  up browsing. Using a parent proxy may also be necessary if the machine
1855  that <application>Privoxy</application> runs on has no direct Internet access.
1856 </para>
1857 <para>
1858  Note that parent proxies can severely decrease your privacy level.
1859  For example a parent proxy could add your IP address to the request
1860  headers and if it's a caching proxy it may add the <quote>Etag</quote>
1861  header to revalidation requests again, even though you configured Privoxy
1862  to remove it. It may also ignore Privoxy's header time randomization and use the
1863  original values which could be used by the server as cookie replacement
1864  to track your steps between visits.
1865 </para>
1866
1867 <para>
1868  Also specified here are SOCKS proxies. <application>Privoxy</application>
1869  supports the SOCKS 4 and SOCKS 4A protocols.
1870 </para>
1871
1872 <sect3 renderas="sect4" id="forward"><title>forward</title>
1873 <variablelist>
1874  <varlistentry>
1875   <term>Specifies:</term>
1876   <listitem>
1877    <para>
1878     To which parent HTTP proxy specific requests should be routed.
1879    </para>
1880   </listitem>
1881  </varlistentry>
1882  <varlistentry>
1883   <term>Type of value:</term>
1884   <listitem>
1885    <para>
1886     <replaceable class="parameter">target_pattern</replaceable>
1887     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1888    </para>
1889    <para>
1890     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1891     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1892     denote <quote>all URLs</quote>.
1893     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1894     is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1895     optionally followed by its listening port (default: 8080).
1896     Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1897    </para>
1898   </listitem>
1899  </varlistentry>
1900  <varlistentry>
1901   <term>Default value:</term>
1902   <listitem>
1903    <para><emphasis>Unset</emphasis></para>
1904   </listitem>
1905  </varlistentry>
1906  <varlistentry>
1907   <term>Effect if unset:</term>
1908   <listitem>
1909    <para>
1910     Don't use parent HTTP proxies.
1911    </para>
1912   </listitem>
1913  </varlistentry>
1914  <varlistentry>
1915   <term>Notes:</term>
1916   <listitem>
1917    <para>
1918     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1919     forwarded to another HTTP proxy but are made directly to the web servers.
1920    </para>
1921    <para>
1922     Multiple lines are OK, they are checked in sequence, and the last match wins.
1923    </para>
1924   </listitem>
1925  </varlistentry>
1926  <varlistentry>
1927   <term>Examples:</term>
1928   <listitem>
1929    <para>
1930     Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
1931    </para>
1932    <para>
1933     <screen>
1934   forward   /      parent-proxy.example.org:8080
1935   forward   :443   .
1936 </screen>
1937    </para>
1938    <para>
1939     Everything goes to our example ISP's caching proxy, except for requests
1940     to that ISP's sites:
1941    </para>
1942    <para>
1943     <screen>
1944   forward   /                  caching-proxy.isp.example.net:8000
1945   forward   .isp.example.net   .
1946 </screen>
1947    </para>
1948   </listitem>
1949  </varlistentry>
1950 </variablelist>
1951 </sect3>
1952
1953
1954 <!--   ~~~~~       New section      ~~~~~     -->
1955 <sect3 renderas="sect4" id="socks"><title>
1956 forward-socks4, forward-socks4a and forward-socks5</title>
1957 <anchor id="forward-socks4">
1958 <anchor id="forward-socks4a">
1959
1960 <variablelist>
1961  <varlistentry>
1962   <term>Specifies:</term>
1963   <listitem>
1964    <para>
1965     Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
1966    </para>
1967   </listitem>
1968  </varlistentry>
1969  <varlistentry>
1970   <term>Type of value:</term>
1971   <listitem>
1972    <para>
1973     <replaceable class="parameter">target_pattern</replaceable>
1974     <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
1975     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1976    </para>
1977    <para>
1978     where <replaceable class="parameter">target_pattern</replaceable> is a
1979     <link linkend="af-patterns">URL pattern</link> that specifies to which
1980     requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1981     denote <quote>all URLs</quote>. <replaceable class="parameter">http_parent</replaceable>
1982     and <replaceable class="parameter">socks_proxy</replaceable>
1983     are IP addresses in dotted decimal notation or valid DNS names
1984     (<replaceable class="parameter">http_parent</replaceable>
1985     may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
1986     <replaceable class="parameter">port</replaceable> parameters are TCP ports,
1987     i.e. integer values from 1 to 65535
1988    </para>
1989   </listitem>
1990  </varlistentry>
1991  <varlistentry>
1992   <term>Default value:</term>
1993   <listitem>
1994    <para><emphasis>Unset</emphasis></para>
1995   </listitem>
1996  </varlistentry>
1997  <varlistentry>
1998   <term>Effect if unset:</term>
1999   <listitem>
2000    <para>
2001     Don't use SOCKS proxies.
2002    </para>
2003   </listitem>
2004  </varlistentry>
2005  <varlistentry>
2006   <term>Notes:</term>
2007   <listitem>
2008    <para>
2009     Multiple lines are OK, they are checked in sequence, and the last match wins.
2010    </para>
2011    <para>
2012     The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
2013     is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2014     server, while in SOCKS 4 it happens locally.
2015    </para>
2016    <para>
2017     With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
2018    </para>
2019    <para>
2020     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2021     forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2022     a SOCKS proxy.
2023    </para>
2024   </listitem>
2025  </varlistentry>
2026  <varlistentry>
2027   <term>Examples:</term>
2028   <listitem>
2029    <para>
2030      From the company example.com, direct connections are made to all
2031      <quote>internal</quote> domains, but everything outbound goes through
2032      their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2033      the Internet.
2034    </para>
2035    <para>
2036     <screen>
2037   forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
2038   forward           .example.com   .
2039 </screen>
2040    </para>
2041    <para>
2042     A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2043    </para>
2044    <para>
2045     <screen>
2046   forward-socks4   /               socks-gw.example.com:1080  .
2047 </screen>
2048    </para>
2049
2050     <para>
2051     To chain Privoxy and Tor, both running on the same system, you would use
2052     something like:
2053    </para>
2054    <para>
2055     <screen>
2056   forward-socks4a   /               127.0.0.1:9050 .
2057 </screen>
2058    </para>
2059
2060     <para>
2061     The public <application>Tor</application> network can't be used to
2062     reach your local network, if you need to access local servers you
2063     therefore might want to make some exceptions:
2064    </para>
2065    <para>
2066     <screen>
2067   forward         192.168.*.*/     .
2068   forward            10.*.*.*/     .
2069   forward           127.*.*.*/     .
2070 </screen>
2071    </para>
2072    <para>
2073     Unencrypted connections to systems in these address ranges will
2074     be as (un)secure as the local network is, but the alternative is that you
2075     can't reach the local network through <application>Privoxy</application>
2076     at all. Of course this may actually be desired and there is no reason
2077     to make these exceptions if you aren't sure you need them.
2078    </para>
2079    <para>
2080     If you also want to be able to reach servers in your local network by
2081     using their names, you will need additional exceptions that look like
2082     this:
2083    </para>
2084    <para>
2085     <screen>
2086  forward           localhost/     .
2087 </screen>
2088    </para>
2089
2090   </listitem>
2091  </varlistentry>
2092 </variablelist>
2093 </sect3>
2094
2095 <![%user-man;[     <!-- not included in config due to length -->
2096 <!--   ~~~~~       New section      ~~~~~     -->
2097 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2098
2099 <para>
2100  If you have links to multiple ISPs that provide various special content
2101  only to their subscribers, you can configure multiple <application>Privoxies</application>
2102  which have connections to the respective ISPs to act as forwarders to each other, so that
2103  <emphasis>your</emphasis> users can see the internal content of all ISPs.
2104 </para>
2105
2106 <para>
2107  Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2108  isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2109  configuration can look like this:
2110 </para>
2111
2112 <para>
2113  host-a:
2114 </para>
2115
2116 <para>
2117  <screen>
2118   forward    /           .
2119   forward    .isp-b.example.net  host-b:8118
2120 </screen>
2121 </para>
2122
2123 <para>
2124  host-b:
2125 </para>
2126
2127 <para>
2128  <screen>
2129   forward    /           .
2130   forward    .isp-a.example.org  host-a:8118
2131 </screen>
2132 </para>
2133
2134 <para>
2135  Now, your users can set their browser's proxy to use either
2136  host-a or host-b and be able to browse the internal content
2137  of both isp-a and isp-b.
2138 </para>
2139
2140 <para>
2141  If you intend to chain <application>Privoxy</application> and
2142  <application>squid</application> locally, then chaining as
2143  <literal>browser -> squid -> privoxy</literal> is the recommended way.
2144 </para>
2145
2146 <para>
2147  Assuming that <application>Privoxy</application> and <application>squid</application>
2148  run on the same box, your <application>squid</application> configuration could then look like this:
2149 </para>
2150
2151 <para>
2152  <screen>
2153   # Define Privoxy as parent proxy (without ICP)
2154   cache_peer 127.0.0.1 parent 8118 7 no-query
2155
2156   # Define ACL for protocol FTP
2157   acl ftp proto FTP
2158
2159   # Do not forward FTP requests to Privoxy
2160   always_direct allow ftp
2161
2162   # Forward all the rest to Privoxy
2163   never_direct allow all</screen>
2164 </para>
2165
2166 <para>
2167  You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2168  Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2169 </para>
2170
2171 <para>
2172  You could just as well decide to only forward requests you suspect
2173  of leading to Windows executables through a virus-scanning parent proxy,
2174  say, on <literal>antivir.example.com</literal>, port 8010:
2175 </para>
2176
2177 <para>
2178  <screen>
2179   forward   /                          .
2180   forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010</screen>
2181 </para>
2182
2183 </sect3>
2184 ]]>
2185
2186 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2187 <variablelist>
2188  <varlistentry>
2189   <term>Specifies:</term>
2190   <listitem>
2191    <para>
2192     How often Privoxy retries if a forwarded connection request fails.
2193    </para>
2194   </listitem>
2195  </varlistentry>
2196  <varlistentry>
2197   <term>Type of value:</term>
2198   <listitem>
2199    <para>
2200     <replaceable class="parameter">Number of retries.</replaceable>
2201    </para>
2202   </listitem>
2203  </varlistentry>
2204  <varlistentry>
2205   <term>Default value:</term>
2206   <listitem>
2207    <para><emphasis>0</emphasis></para>
2208   </listitem>
2209  </varlistentry>
2210  <varlistentry>
2211   <term>Effect if unset:</term>
2212   <listitem>
2213    <para>
2214     Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2215    </para>
2216   </listitem>
2217  </varlistentry>
2218  <varlistentry>
2219   <term>Notes:</term>
2220   <listitem>
2221    <para>
2222     <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2223     for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2224     The connection might have failed because of a DNS timeout in which case a retry makes sense,
2225     but it might also have failed because the server doesn't exist or isn't reachable. In this
2226     case the retry will just delay the appearance of Privoxy's error message.
2227    </para>
2228    <para>
2229     Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2230     that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2231    </para>
2232    <para>
2233     Only use this option, if you are getting lots of forwarding-related error messages
2234     that go away when you try again manually. Start with a small value and check Privoxy's
2235     logfile from time to time, to see how many retries are usually needed.
2236    </para>
2237   </listitem>
2238  </varlistentry>
2239  <varlistentry>
2240   <term>Examples:</term>
2241   <listitem>
2242    <para>
2243     forwarded-connect-retries 1
2244    </para>
2245   </listitem>
2246  </varlistentry>
2247 </variablelist>
2248 <![%config-file;[<literallayout>@@forwarded-connect-retries  0</literallayout>]]>
2249 </sect3>
2250
2251 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2252 <variablelist>
2253  <varlistentry>
2254   <term>Specifies:</term>
2255   <listitem>
2256    <para>
2257     Whether intercepted requests should be treated as valid.
2258    </para>
2259   </listitem>
2260  </varlistentry>
2261  <varlistentry>
2262   <term>Type of value:</term>
2263   <listitem>
2264    <para>
2265     <replaceable>0 or 1</replaceable>
2266    </para>
2267   </listitem>
2268  </varlistentry>
2269  <varlistentry>
2270   <term>Default value:</term>
2271   <listitem>
2272    <para><emphasis>0</emphasis></para>
2273   </listitem>
2274  </varlistentry>
2275  <varlistentry>
2276   <term>Effect if unset:</term>
2277   <listitem>
2278    <para>
2279     Only proxy requests are accepted, intercepted requests are treated as invalid.
2280    </para>
2281   </listitem>
2282  </varlistentry>
2283  <varlistentry>
2284   <term>Notes:</term>
2285   <listitem>
2286    <para>
2287     If you don't trust your clients and want to force them
2288     to use <application>Privoxy</application>, enable this
2289     option and configure your packet filter to redirect outgoing
2290     HTTP connections into <application>Privoxy</application>.
2291    </para>
2292    <para>
2293     Make sure that <application>Privoxy's</application> own requests
2294     aren't redirected as well. Additionally take care that
2295     <application>Privoxy</application> can't intentionally connect
2296     to itself, otherwise you could run into redirection loops if
2297     <application>Privoxy's</application> listening port is reachable
2298     by the outside or an attacker has access to the pages you visit.
2299    </para>
2300   </listitem>
2301  </varlistentry>
2302  <varlistentry>
2303   <term>Examples:</term>
2304   <listitem>
2305    <para>
2306     accept-intercepted-requests 1
2307    </para>
2308   </listitem>
2309  </varlistentry>
2310 </variablelist>
2311 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2312 </sect3>
2313
2314 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2315 <variablelist>
2316  <varlistentry>
2317   <term>Specifies:</term>
2318   <listitem>
2319    <para>
2320     Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2321    </para>
2322   </listitem>
2323  </varlistentry>
2324  <varlistentry>
2325   <term>Type of value:</term>
2326   <listitem>
2327    <para>
2328     <replaceable>0 or 1</replaceable>
2329    </para>
2330   </listitem>
2331  </varlistentry>
2332  <varlistentry>
2333   <term>Default value:</term>
2334   <listitem>
2335    <para><emphasis>0</emphasis></para>
2336   </listitem>
2337  </varlistentry>
2338  <varlistentry>
2339   <term>Effect if unset:</term>
2340   <listitem>
2341    <para>
2342     <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2343    </para>
2344   </listitem>
2345  </varlistentry>
2346  <varlistentry>
2347   <term>Notes:</term>
2348   <listitem>
2349    <para>
2350     By default <application>Privoxy</application> ignores block or redirect actions
2351     for its CGI pages. Intercepting these requests can be useful in multi-user
2352     setups to implement fine-grained access control, but it can also render the complete
2353     web interface useless and make debugging problems painful if done without care.
2354    </para>
2355    <para>
2356     Don't enable this option unless you're sure that you really need it.
2357    </para>
2358   </listitem>
2359  </varlistentry>
2360  <varlistentry>
2361   <term>Examples:</term>
2362   <listitem>
2363    <para>
2364     allow-cgi-request-crunching 1
2365    </para>
2366   </listitem>
2367  </varlistentry>
2368 </variablelist>
2369 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2370 </sect3>
2371
2372 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2373 <variablelist>
2374  <varlistentry>
2375   <term>Specifies:</term>
2376   <listitem>
2377    <para>
2378     Whether the CGI interface should stay compatible with broken HTTP clients.
2379    </para>
2380   </listitem>
2381  </varlistentry>
2382  <varlistentry>
2383   <term>Type of value:</term>
2384   <listitem>
2385    <para>
2386     <replaceable>0 or 1</replaceable>
2387    </para>
2388   </listitem>
2389  </varlistentry>
2390  <varlistentry>
2391   <term>Default value:</term>
2392   <listitem>
2393    <para><emphasis>0</emphasis></para>
2394   </listitem>
2395  </varlistentry>
2396  <varlistentry>
2397   <term>Effect if unset:</term>
2398   <listitem>
2399    <para>
2400     The CGI form generate long GET URLs.
2401    </para>
2402   </listitem>
2403  </varlistentry>
2404  <varlistentry>
2405   <term>Notes:</term>
2406   <listitem>
2407    <para>
2408     <application>Privoxy's</application> CGI forms can lead to
2409     rather long URLs. This isn't a problem as far as the HTTP
2410     standard is concerned, but it can confuse clients with arbitrary
2411     URL length limitations.
2412    </para>
2413    <para>
2414     Enabling split-large-forms causes <application>Privoxy</application>
2415     to divide big forms into smaller ones to keep the URL length down.
2416     It makes editing a lot less convenient and you can no longer
2417     submit all changes at once, but at least it works around this
2418     browser bug.
2419    </para>
2420    <para>
2421     If you don't notice any editing problems, there is no reason
2422     to enable this option, but if one of the submit buttons appears
2423     to be broken, you should give it a try.
2424    </para>
2425   </listitem>
2426  </varlistentry>
2427  <varlistentry>
2428   <term>Examples:</term>
2429   <listitem>
2430    <para>
2431     split-large-forms 1
2432    </para>
2433   </listitem>
2434  </varlistentry>
2435 </variablelist>
2436 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2437 </sect3>
2438
2439 </sect2>
2440
2441 <!--  ~  End section  ~  -->
2442
2443
2444 <!--   ~~~~~       New section      ~~~~~     -->
2445
2446 <sect2 id="windows-gui">
2447 <title>Windows GUI Options</title>
2448 <para>
2449  <application>Privoxy</application> has a number of options specific to the
2450  Windows GUI interface:
2451 </para>
2452
2453 <anchor id="activity-animation">
2454 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2455 <para>
2456  If <quote>activity-animation</quote> is set to 1, the
2457  <application>Privoxy</application> icon will animate when
2458  <quote>Privoxy</quote> is active. To turn off, set to 0.
2459 </para>
2460
2461 <![%config-file;[<literallayout>@@#activity-animation   1</literallayout>]]>
2462 <![%user-man;[
2463 <para>
2464  <literal>
2465   <msgtext>
2466    <literallayout>
2467   <emphasis>activity-animation   1</emphasis>
2468    </literallayout>
2469   </msgtext>
2470  </literal>
2471 </para>
2472 ]]>
2473
2474 <anchor id="log-messages">
2475 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2476 <para>
2477  If <quote>log-messages</quote> is set to 1,
2478  <application>Privoxy</application> will log messages to the console
2479  window:
2480 </para>
2481
2482 <![%config-file;[<literallayout>@@#log-messages   1</literallayout>]]>
2483 <![%user-man;[
2484 <para>
2485  <literal>
2486   <msgtext>
2487    <literallayout>
2488   <emphasis>log-messages       1</emphasis>
2489    </literallayout>
2490   </msgtext>
2491  </literal>
2492 </para>
2493 ]]>
2494
2495 <anchor id="log-buffer-size">
2496 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2497 <para>
2498  If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
2499  i.e. the amount of memory used for the log messages displayed in the
2500  console window, will be limited to <quote>log-max-lines</quote> (see below).
2501 </para>
2502
2503 <para>
2504  Warning: Setting this to 0 will result in the buffer to grow infinitely and
2505  eat up all your memory!
2506 </para>
2507
2508 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
2509 <![%user-man;[
2510 <para>
2511  <literal>
2512   <msgtext>
2513    <literallayout>
2514   <emphasis>log-buffer-size      1</emphasis>
2515    </literallayout>
2516   </msgtext>
2517  </literal>
2518 </para>
2519 ]]>
2520
2521 <anchor id="log-max-lines">
2522 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2523 <para>
2524  <application>log-max-lines</application> is the maximum number of lines held
2525  in the log buffer. See above.
2526 </para>
2527
2528 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
2529 <![%user-man;[
2530 <para>
2531  <literal>
2532   <msgtext>
2533    <literallayout>
2534   <emphasis>log-max-lines      200</emphasis>
2535    </literallayout>
2536   </msgtext>
2537  </literal>
2538 </para>
2539 ]]>
2540
2541 <anchor id="log-highlight-messages">
2542 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2543 <para>
2544  If <quote>log-highlight-messages</quote> is set to 1,
2545  <application>Privoxy</application> will highlight portions of the log
2546  messages with a bold-faced font:
2547 </para>
2548
2549 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
2550 <![%user-man;[
2551 <para>
2552  <literal>
2553   <msgtext>
2554    <literallayout>
2555   <emphasis>log-highlight-messages   1</emphasis>
2556    </literallayout>
2557   </msgtext>
2558  </literal>
2559 </para>
2560 ]]>
2561
2562 <anchor id="log-font-name">
2563 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2564 <para>
2565  The font used in the console window:
2566 </para>
2567
2568 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
2569 <![%user-man;[
2570 <para>
2571  <literal>
2572   <msgtext>
2573    <literallayout>
2574   <emphasis>log-font-name        Comic Sans MS</emphasis>
2575    </literallayout>
2576   </msgtext>
2577  </literal>
2578 </para>
2579 ]]>
2580
2581 <anchor id="log-font-size">
2582 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2583 <para>
2584  Font size used in the console window:
2585 </para>
2586
2587 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
2588 <![%user-man;[
2589 <para>
2590  <literal>
2591   <msgtext>
2592    <literallayout>
2593   <emphasis>log-font-size        8</emphasis>
2594    </literallayout>
2595   </msgtext>
2596  </literal>
2597 </para>
2598 ]]>
2599
2600 <anchor id="show-on-task-bar">
2601 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2602 <para>
2603  <quote>show-on-task-bar</quote> controls whether or not
2604  <application>Privoxy</application> will appear as a button on the Task bar
2605  when minimized:
2606 </para>
2607
2608 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
2609 <![%user-man;[
2610 <para>
2611  <literal>
2612   <msgtext>
2613    <literallayout>
2614   <emphasis>show-on-task-bar     0</emphasis>
2615    </literallayout>
2616   </msgtext>
2617  </literal>
2618 </para>
2619 ]]>
2620
2621 <anchor id="close-button-minimizes">
2622 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2623 <para>
2624  If <quote>close-button-minimizes</quote> is set to 1, the Windows close
2625  button will minimize <application>Privoxy</application> instead of closing
2626  the program (close with the exit option on the File menu).
2627 </para>
2628
2629 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
2630 <![%user-man;[
2631 <para>
2632  <literal>
2633   <msgtext>
2634    <literallayout>
2635   <emphasis>close-button-minimizes  1</emphasis>
2636    </literallayout>
2637   </msgtext>
2638  </literal>
2639 </para>
2640 ]]>
2641
2642 <anchor id="hide-console">
2643 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2644 <para>
2645  The <quote>hide-console</quote> option is specific to the MS-Win console
2646  version of <application>Privoxy</application>. If this option is used,
2647  <application>Privoxy</application> will disconnect from and hide the
2648  command console.
2649 </para>
2650
2651 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
2652 <![%user-man;[
2653 <para>
2654  <literal>
2655   <msgtext>
2656    <literallayout>
2657   #<emphasis>hide-console</emphasis>
2658    </literallayout>
2659   </msgtext>
2660  </literal>
2661 </para>
2662 ]]>
2663
2664 </sect2>
2665 </sect1>
2666
2667 <!-- end config content common to both outputs -->
2668
2669 <![%config-file;[
2670 <!-- These are dummy anchors to keep the processor quiet            -->
2671 <!-- when building config-file only (ie. they are used in u-m only) -->
2672 <sect1 label="">
2673 <title></title>
2674 <anchor id="filter">
2675 <anchor id="filter-file">
2676 <anchor id="regex">
2677 <anchor id="actions-file">
2678 <anchor id="af-patterns">
2679 </sect1>
2680 ]]>
2681
2682 <!-- eof p-config.sgml -->