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.21 2007/11/07 18:50:39 fabiankeil Exp $
   7
   8  Copyright (C) 2001-2007 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.21 2007/11/07 18:50:39 fabiankeil Exp $
  99 </para>
 100 <para>
 101 Copyright (C) 2001-2007 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     Logging is disabled unless <literal>--no-daemon</literal> mode is used.
 832    </para>
 833   </listitem>
 834  </varlistentry>
 835  <varlistentry>
 836   <term>Notes:</term>
 837   <listitem>
 838  <!--
 839   removed per bug report 688728 02/20/03 HB
 840
 841    <para>
 842     The windows version will additionally log to the console.
 843    </para>
 844   -->
 845    <para>
 846     The logfile is where all logging and error messages are written. The level
 847     of detail and number of messages are set with the <literal>debug</literal>
 848     option (see below). The logfile can be useful for tracking down a problem with
 849     <application>Privoxy</application> (e.g., it's not blocking an ad you
 850     think it should block) and it can help you to monitor what your browser
 851     is doing.
 852    </para>
 853    <para>
 854     Many users will never look at it, however, and it's a privacy risk
 855     if third parties can get access to it. It is therefore disabled by
 856     default in <application>Privoxy</application> 3.0.7 and later.
 857   </para>
 858   <para>
 859     For troubleshooting purposes, you will have to explicitly enable it.
 860     Please don't file any support requests without trying to reproduce
 861     the problem with logging enabled first. Once you read the log messages,
 862     you may even be able to solve the problem on your own.
 863    </para>
 864    <para>
 865     Your logfile will grow indefinitely, and you will probably want to
 866     periodically remove it.  On Unix systems, you can do this with a cron job
 867     (see <quote>man cron</quote>). For Red Hat based Linux distributions, a
 868     <command>logrotate</command> script has been included.
 869    </para>
 870 <!--
 871 No one cares enough about SuSE to build privoxy packages,
 872 so most Privoxy users seem to use different platforms and
 873 are thus unlikely to care about these instructions.
 874 It's also questionable if they still work.
 875 fk 2007-11-07
 876    <para>
 877     On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
 878     +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
 879     the effect that cron.daily will automatically archive, gzip, and empty the
 880     log, when it exceeds 1M size.
 881    </para>
 882 -->
 883    <para>
 884     Any log files must be writable by whatever user <application>Privoxy</application>
 885     is being run as (on Unix, default user id is <quote>privoxy</quote>).
 886    </para>
 887   </listitem>
 888  </varlistentry>
 889 </variablelist>
 890
 891 <![%config-file;[<literallayout>@@#logfile logfile</literallayout>]]>
 892 </sect3>
 893
 894
 895 <!--   ~~~~~       New section      ~~~~~     -->
 896 <sect3 renderas="sect4" id="jarfile"><title>jarfile</title>
 897
 898 <variablelist>
 899  <varlistentry>
 900   <term>Specifies:</term>
 901   <listitem>
 902    <para>
 903     The file to store intercepted cookies in
 904    </para>
 905   </listitem>
 906  </varlistentry>
 907  <varlistentry>
 908   <term>Type of value:</term>
 909   <listitem>
 910    <para>File name, relative to <literal>logdir</literal></para>
 911   </listitem>
 912  </varlistentry>
 913  <varlistentry>
 914   <term>Default value:</term>
 915   <listitem>
 916    <para><emphasis>Unset (commented out)</emphasis>. When activated: jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows).</para>
 917   </listitem>
 918  </varlistentry>
 919  <varlistentry>
 920   <term>Effect if unset:</term>
 921   <listitem>
 922    <para>
 923     Intercepted cookies are not stored in a dedicated log file.
 924    </para>
 925   </listitem>
 926  </varlistentry>
 927  <varlistentry>
 928   <term>Notes:</term>
 929   <listitem>
 930    <para>
 931     The jarfile may grow to ridiculous sizes over time.
 932    </para>
 933    <para>
 934     If debug 8 (show header parsing) is enabled, cookies are
 935     also written to the logfile with the rest of the headers.
 936     Therefore this option isn't very useful and may be removed
 937     in future releases. Please report to the developers if you
 938     are still using it.
 939    </para>
 940   </listitem>
 941  </varlistentry>
 942 </variablelist>
 943
 944 <![%config-file;[<literallayout>@@#jarfile jarfile</literallayout>]]>
 945 </sect3>
 946
 947
 948 <!--   ~~~~~       New section      ~~~~~     -->
 949 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
 950 <variablelist>
 951  <varlistentry>
 952   <term>Specifies:</term>
 953   <listitem>
 954    <para>
 955     The name of the trust file to use
 956    </para>
 957   </listitem>
 958  </varlistentry>
 959  <varlistentry>
 960   <term>Type of value:</term>
 961   <listitem>
 962    <para>File name, relative to <literal>confdir</literal></para>
 963   </listitem>
 964  </varlistentry>
 965  <varlistentry>
 966   <term>Default value:</term>
 967   <listitem>
 968    <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
 969   </listitem>
 970  </varlistentry>
 971  <varlistentry>
 972   <term>Effect if unset:</term>
 973   <listitem>
 974    <para>
 975     The entire trust mechanism is disabled.
 976    </para>
 977   </listitem>
 978  </varlistentry>
 979  <varlistentry>
 980   <term>Notes:</term>
 981   <listitem>
 982    <para>
 983     The trust mechanism is an experimental feature for building white-lists and should
 984     be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
 985    </para>
 986    <para>
 987     If you specify a trust file, <application>Privoxy</application> will only allow
 988     access to sites that are specified in the trustfile. Sites can be listed
 989     in one of two ways:
 990    </para>
 991    <para>
 992     Prepending a <literal>~</literal> character limits access to this site
 993     only (and any sub-paths within this site), e.g.
 994     <literal>~www.example.com</literal> allows access to
 995     <literal>~www.example.com/features/news.html</literal>, etc.
 996    </para>
 997    <para>
 998     Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
 999     prepending the name with a <literal>+</literal> character. The effect is that
1000     access to untrusted sites will be granted -- but only if a link from this
1001     trusted referrer was used to get there. The link target will then be added
1002     to the <quote>trustfile</quote> so that future, direct accesses will be
1003     granted. Sites added via this mechanism do not become trusted referrers
1004     themselves (i.e. they are added with a <literal>~</literal> designation).
1005     There is a limit of 512 such entries, after which new entries will not be
1006     made.
1007    </para>
1008    <para>
1009     If you use the <literal>+</literal> operator in the trust file, it may grow
1010     considerably over time.
1011    </para>
1012    <para>
1013     It is recommended that <application>Privoxy</application> be compiled with
1014     the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
1015     <literal> --disable-editor</literal> options, if this feature is to be
1016     used.
1017    </para>
1018    <para>
1019     Possible applications include limiting Internet access for children.
1020    </para>
1021
1022   </listitem>
1023  </varlistentry>
1024 </variablelist>
1025
1026 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
1027 </sect3>
1028 </sect2>
1029
1030 <!--  ~  End section  ~  -->
1031
1032 <!--   ~~~~~       New section      ~~~~~     -->
1033 <sect2 id="debugging">
1034 <title>Debugging</title>
1035
1036  <para>
1037   These options are mainly useful when tracing a problem.
1038   Note that you might also want to invoke
1039   <application>Privoxy</application> with the <literal>--no-daemon</literal>
1040   command line option when debugging.
1041  </para>
1042
1043 <sect3 renderas="sect4" id="debug"><title>debug</title>
1044
1045 <variablelist>
1046  <varlistentry>
1047   <term>Specifies:</term>
1048   <listitem>
1049    <para>
1050     Key values that determine what information gets logged to the
1051     <link linkend="logfile"><emphasis>logfile</emphasis></link>.
1052    </para>
1053   </listitem>
1054  </varlistentry>
1055  <varlistentry>
1056   <term>Type of value:</term>
1057   <listitem>
1058    <para>Integer values</para>
1059   </listitem>
1060  </varlistentry>
1061  <varlistentry>
1062   <term>Default value:</term>
1063   <listitem>
1064    <para>12289 (i.e.: URLs plus informational and warning messages)</para>
1065   </listitem>
1066  </varlistentry>
1067  <varlistentry>
1068   <term>Effect if unset:</term>
1069   <listitem>
1070    <para>
1071     Nothing gets logged.
1072    </para>
1073   </listitem>
1074  </varlistentry>
1075  <varlistentry>
1076   <term>Notes:</term>
1077   <listitem>
1078    <para>
1079     The available debug levels are:
1080    </para>
1081    <para>
1082     <programlisting>
1083   debug         1 # show each GET/POST/CONNECT request
1084   debug         2 # show each connection status
1085   debug         4 # show I/O status
1086   debug         8 # show header parsing
1087   debug        16 # log all data written to the network into the logfile
1088   debug        32 # debug force feature
1089   debug        64 # debug regular expression filters
1090   debug       128 # debug redirects
1091   debug       256 # debug GIF de-animation
1092   debug       512 # Common Log Format
1093   debug      1024 # debug kill pop-ups
1094   debug      2048 # CGI user interface
1095   debug      4096 # Startup banner and warnings.
1096   debug      8192 # Non-fatal errors
1097 </programlisting>
1098    </para>
1099    <para>
1100     To select multiple debug levels, you can either add them or use
1101     multiple <literal>debug</literal> lines.
1102    </para>
1103    <para>
1104     A debug level of 1 is informative because it will show you each request
1105     as it happens. <emphasis>1, 4096 and 8192 are highly recommended</emphasis>
1106     so that you will notice when things go wrong. The other levels are probably
1107     only of interest if you are hunting down a specific problem. They can produce
1108     a hell of an output (especially 16).
1109     <!-- LOL -->
1110    </para>
1111 <!--
1112    <para>
1113     The reporting of <emphasis>fatal</emphasis> errors (i.e. ones which causes
1114     <application>Privoxy</application> to exit) is always on and cannot be disabled.
1115    </para>
1116    It can be disabled by not logging at all (now the default)
1117    and I doubt that any user would care about not being able
1118    to disable it anyway.
1119    fk 2007-11-09
1120 -->
1121    <para>
1122     If you want to use CLF (Common Log Format), you should set <quote>debug
1123     512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1124    </para>
1125    <para>
1126     <application>Privoxy</application> has a hard-coded limit for the
1127     length of log messages. If it's reached, messages are logged truncated
1128     and marked with <quote>... [too long, truncated]</quote>.
1129    </para>
1130   </listitem>
1131  </varlistentry>
1132 </variablelist>
1133
1134 <![%config-file;[<literallayout>@@debug   1    # show each GET/POST/CONNECT request</literallayout>]]>
1135 <![%config-file;[<literallayout>@@debug   4096 # Startup banner and warnings</literallayout>]]>
1136 <![%config-file;[<literallayout>@@debug   8192 # Errors - *we highly recommended enabling this*</literallayout>]]>
1137 </sect3>
1138
1139
1140 <!--   ~~~~~       New section      ~~~~~     -->
1141 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1142
1143 <variablelist>
1144  <varlistentry>
1145   <term>Specifies:</term>
1146   <listitem>
1147    <para>
1148     Whether to run only one server thread.
1149    </para>
1150   </listitem>
1151  </varlistentry>
1152  <varlistentry>
1153   <term>Type of value:</term>
1154   <listitem>
1155    <para><emphasis>None</emphasis></para>
1156   </listitem>
1157  </varlistentry>
1158  <varlistentry>
1159   <term>Default value:</term>
1160   <listitem>
1161    <para><emphasis>Unset</emphasis></para>
1162   </listitem>
1163  </varlistentry>
1164  <varlistentry>
1165   <term>Effect if unset:</term>
1166   <listitem>
1167    <para>
1168     Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1169     serve multiple requests simultaneously.
1170    </para>
1171   </listitem>
1172  </varlistentry>
1173  <varlistentry>
1174   <term>Notes:</term>
1175   <listitem>
1176    <para>
1177     This option is only there for debugging purposes.
1178     <emphasis>It will drastically reduce performance.</emphasis>
1179    </para>
1180   </listitem>
1181  </varlistentry>
1182 </variablelist>
1183
1184 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1185 </sect3>
1186
1187 </sect2>
1188
1189 <!--  ~  End section  ~  -->
1190
1191
1192 <!--   ~~~~~       New section      ~~~~~     -->
1193 <sect2 id="access-control">
1194 <title>Access Control and Security</title>
1195
1196  <para>
1197   This section of the config file controls the security-relevant aspects
1198   of <application>Privoxy</application>'s configuration.
1199  </para>
1200
1201
1202 <!--   ~~~~~       New section      ~~~~~     -->
1203 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1204
1205 <variablelist>
1206  <varlistentry>
1207   <term>Specifies:</term>
1208   <listitem>
1209    <para>
1210     The IP address and TCP port on which <application>Privoxy</application> will
1211     listen for client requests.
1212    </para>
1213   </listitem>
1214  </varlistentry>
1215  <varlistentry>
1216   <term>Type of value:</term>
1217   <listitem>
1218    <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1219   </listitem>
1220  </varlistentry>
1221
1222  <varlistentry>
1223   <term>Default value:</term>
1224   <listitem>
1225    <para>127.0.0.1:8118</para>
1226   </listitem>
1227  </varlistentry>
1228  <varlistentry>
1229   <term>Effect if unset:</term>
1230   <listitem>
1231    <para>
1232     Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1233     home users who run <application>Privoxy</application> on the same machine as
1234     their browser.
1235    </para>
1236   </listitem>
1237  </varlistentry>
1238  <varlistentry>
1239   <term>Notes:</term>
1240   <listitem>
1241    <para>
1242     You will need to configure your browser(s) to this proxy address and port.
1243    </para>
1244    <para>
1245     If you already have another service running on port 8118, or if you want to
1246     serve requests from other machines (e.g. on your local network) as well, you
1247     will need to override the default.
1248    </para>
1249    <para>
1250     If you leave out the IP address, <application>Privoxy</application> will
1251     bind to all interfaces (addresses) on your machine and may become reachable
1252     from the Internet. In that case, consider using <link
1253     linkend="acls">access control lists</link> (ACL's, see below), and/or
1254     a firewall.
1255    </para>
1256    <para>
1257     If you open <application>Privoxy</application> to untrusted users, you will
1258     also want to make sure that the following actions are disabled:  <literal><link
1259     linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1260     <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1261    </para>
1262   </listitem>
1263  </varlistentry>
1264  <varlistentry>
1265   <term>Example:</term>
1266   <listitem>
1267    <para>
1268      Suppose you are running <application>Privoxy</application> on
1269      a machine which has the address 192.168.0.1 on your local private network
1270      (192.168.0.0) and has another outside connection with a different address.
1271      You want it to serve requests from inside only:
1272    </para>
1273    <para>
1274     <programlisting>
1275   listen-address  192.168.0.1:8118
1276 </programlisting>
1277    </para>
1278   </listitem>
1279  </varlistentry>
1280 </variablelist>
1281
1282 <![%config-file;[<literallayout>@@listen-address  127.0.0.1:8118</literallayout>]]>
1283 </sect3>
1284
1285
1286 <!--   ~~~~~       New section      ~~~~~     -->
1287 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1288
1289 <variablelist>
1290  <varlistentry>
1291   <term>Specifies:</term>
1292   <listitem>
1293    <para>
1294     Initial state of "toggle" status
1295    </para>
1296   </listitem>
1297  </varlistentry>
1298  <varlistentry>
1299   <term>Type of value:</term>
1300   <listitem>
1301    <para>1 or 0</para>
1302   </listitem>
1303  </varlistentry>
1304  <varlistentry>
1305   <term>Default value:</term>
1306   <listitem>
1307    <para>1</para>
1308   </listitem>
1309  </varlistentry>
1310  <varlistentry>
1311   <term>Effect if unset:</term>
1312   <listitem>
1313    <para>
1314     Act as if toggled on
1315    </para>
1316   </listitem>
1317  </varlistentry>
1318  <varlistentry>
1319   <term>Notes:</term>
1320   <listitem>
1321    <para>
1322     If set to 0, <application>Privoxy</application> will start in
1323     <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1324     content-neutral proxy with both ad blocking and content filtering
1325     disabled. See <literal>enable-remote-toggle</literal> below.
1326 <!--
1327     This is not really useful
1328     anymore, since toggling is much easier via <ulink
1329     url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1330     editing the <filename>conf</filename> file.
1331
1332     Remote toggling is now disabled by default. fk 2007-11-07)
1333 -->
1334    </para>
1335    <para>
1336     The windows version will only display the toggle icon in the system tray
1337     if this option is present.
1338    </para>
1339   </listitem>
1340  </varlistentry>
1341 </variablelist>
1342
1343 <![%config-file;[<literallayout>@@toggle  1</literallayout>]]>
1344 </sect3>
1345
1346
1347 <!--   ~~~~~       New section      ~~~~~     -->
1348 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1349 <variablelist>
1350  <varlistentry>
1351   <term>Specifies:</term>
1352   <listitem>
1353    <para>
1354     Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1355     feature</ulink> may be used
1356    </para>
1357   </listitem>
1358  </varlistentry>
1359  <varlistentry>
1360   <term>Type of value:</term>
1361   <listitem>
1362    <para>0 or 1</para>
1363   </listitem>
1364  </varlistentry>
1365  <varlistentry>
1366   <term>Default value:</term>
1367   <listitem>
1368    <para>0</para>
1369   </listitem>
1370  </varlistentry>
1371  <varlistentry>
1372   <term>Effect if unset:</term>
1373   <listitem>
1374    <para>
1375     The web-based toggle feature is disabled.
1376    </para>
1377   </listitem>
1378  </varlistentry>
1379  <varlistentry>
1380   <term>Notes:</term>
1381   <listitem>
1382    <para>
1383     When toggled off, <application>Privoxy</application> mostly acts like a normal,
1384     content-neutral proxy, i.e. doesn't block ads or filter content.
1385    </para>
1386    <para>
1387     Access to the toggle feature can <emphasis>not</emphasis> be
1388     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1389     so that everybody who can access <application>Privoxy</application> (see
1390     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1391     toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1392     for multi-user environments with untrusted users.
1393    </para>
1394    <para>
1395     Note that malicious client side code (e.g Java) is also
1396     capable of using this option.
1397    </para>
1398    <para>
1399     As a lot of <application>Privoxy</application> users don't read
1400     documentation, this feature is disabled by default.
1401    </para>
1402    <para>
1403     Note that you must have compiled <application>Privoxy</application> with
1404     support for this feature, otherwise this option has no effect.
1405    </para>
1406   </listitem>
1407  </varlistentry>
1408 </variablelist>
1409
1410 <![%config-file;[<literallayout>@@enable-remote-toggle  0</literallayout>]]>
1411 </sect3>
1412
1413
1414 <!--   ~~~~~       New section      ~~~~~     -->
1415 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1416 <variablelist>
1417  <varlistentry>
1418   <term>Specifies:</term>
1419   <listitem>
1420    <para>
1421     Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1422    </para>
1423   </listitem>
1424  </varlistentry>
1425  <varlistentry>
1426   <term>Type of value:</term>
1427   <listitem>
1428    <para>0 or 1</para>
1429   </listitem>
1430  </varlistentry>
1431  <varlistentry>
1432   <term>Default value:</term>
1433   <listitem>
1434    <para>0</para>
1435   </listitem>
1436  </varlistentry>
1437  <varlistentry>
1438   <term>Effect if unset:</term>
1439   <listitem>
1440    <para>
1441     Privoxy ignores special HTTP headers.
1442    </para>
1443   </listitem>
1444  </varlistentry>
1445  <varlistentry>
1446   <term>Notes:</term>
1447   <listitem>
1448    <para>
1449     When toggled on, the client can change <application>Privoxy's</application>
1450     behaviour by setting special HTTP headers. Currently the only supported
1451     special header is <quote>X-Filter: No</quote>, to disable filtering for
1452     the ongoing request, even if it is enabled in one of the action files.
1453    </para>
1454    <para>
1455     This feature is disabled by default. If you are using
1456     <application>Privoxy</application> in a environment with trusted clients,
1457     you may enable this feature at your discretion. Note that malicious client
1458     side code (e.g Java) is also capable of using this feature.
1459    </para>
1460    <para>
1461     This option will be removed in future releases as it has been obsoleted
1462     by the more general header taggers.
1463    </para>
1464   </listitem>
1465  </varlistentry>
1466 </variablelist>
1467
1468 <![%config-file;[<literallayout>@@enable-remote-http-toggle  0</literallayout>]]>
1469 </sect3>
1470
1471
1472 <!--   ~~~~~       New section      ~~~~~     -->
1473 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1474 <variablelist>
1475  <varlistentry>
1476   <term>Specifies:</term>
1477   <listitem>
1478    <para>
1479     Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1480     file editor</ulink> may be used
1481    </para>
1482   </listitem>
1483  </varlistentry>
1484  <varlistentry>
1485   <term>Type of value:</term>
1486   <listitem>
1487    <para>0 or 1</para>
1488   </listitem>
1489  </varlistentry>
1490  <varlistentry>
1491   <term>Default value:</term>
1492   <listitem>
1493    <para>0</para>
1494   </listitem>
1495  </varlistentry>
1496  <varlistentry>
1497   <term>Effect if unset:</term>
1498   <listitem>
1499    <para>
1500     The web-based actions file editor is disabled.
1501    </para>
1502   </listitem>
1503  </varlistentry>
1504  <varlistentry>
1505   <term>Notes:</term>
1506   <listitem>
1507    <para>
1508     Access to the editor can <emphasis>not</emphasis> be
1509     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1510     so that everybody who can access <application>Privoxy</application> (see
1511     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1512     modify its configuration for all users.
1513    </para>
1514    <para>
1515     This option is <emphasis>not recommended</emphasis> for environments
1516     with untrusted users and as a lot of <application>Privoxy</application>
1517     users don't read documentation, this feature is disabled by default.
1518    </para>
1519    </para>
1520    <para>
1521     Note that malicious client side code (e.g Java) is also
1522     capable of using the actions editor and you shouldn't enable
1523     this options unless you understand the consequences and are
1524     sure your browser is configured correctly.
1525    </para>
1526    <para>
1527     Note that you must have compiled <application>Privoxy</application> with
1528     support for this feature, otherwise this option has no effect.
1529    </para>
1530   </listitem>
1531  </varlistentry>
1532 </variablelist>
1533
1534 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1535 </sect3>
1536
1537
1538 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1539 <variablelist>
1540  <varlistentry>
1541   <term>Specifies:</term>
1542   <listitem>
1543    <para>
1544     Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1545    </para>
1546   </listitem>
1547  </varlistentry>
1548  <varlistentry>
1549   <term>Type of value:</term>
1550   <listitem>
1551    <para>
1552     <replaceable>0 or 1</replaceable>
1553    </para>
1554   </listitem>
1555  </varlistentry>
1556  <varlistentry>
1557   <term>Default value:</term>
1558   <listitem>
1559    <para><emphasis>0</emphasis></para>
1560   </listitem>
1561  </varlistentry>
1562  <varlistentry>
1563   <term>Effect if unset:</term>
1564   <listitem>
1565    <para>
1566     Blocks are not enforced.
1567    </para>
1568   </listitem>
1569  </varlistentry>
1570  <varlistentry>
1571   <term>Notes:</term>
1572   <listitem>
1573    <para>
1574     <application>Privoxy</application> is mainly used to block and filter
1575     requests as a service to the user, for example to block ads and other
1576     junk that clogs the pipes. <application>Privoxy's</application> configuration
1577     isn't perfect and sometimes innocent pages are blocked. In this situation it
1578     makes sense to allow the user to enforce the request and have
1579     <application>Privoxy</application> ignore the block.
1580    </para>
1581    <para>
1582     In the default configuration <application>Privoxy's</application>
1583     <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1584     link to adds a special string (the force prefix) to the request URL.
1585     If that link is used, <application>Privoxy</application> will
1586     detect the force prefix, remove it again and let the request pass.
1587    </para>
1588    <para>
1589     Of course <application>Privoxy</application> can also be used to enforce
1590     a network policy. In that case the user obviously should not be able to
1591     bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1592     option is for. If it's enabled, <application>Privoxy</application> hides
1593     the <quote>go there anyway</quote> link. If the user adds the force
1594     prefix by hand, it will not be accepted and the circumvention attempt
1595     is logged.
1596    </para>
1597   </listitem>
1598  </varlistentry>
1599  <varlistentry>
1600   <term>Examples:</term>
1601   <listitem>
1602    <para>
1603     enforce-blocks 1
1604    </para>
1605   </listitem>
1606  </varlistentry>
1607 </variablelist>
1608 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1609 </sect3>
1610
1611
1612 <!--   ~~~~~       New section      ~~~~~     -->
1613 <sect3 renderas="sect4" id="acls"><title>
1614 ACLs: permit-access and deny-access</title>
1615 <anchor id="permit-access">
1616 <anchor id="deny-access">
1617
1618 <variablelist>
1619  <varlistentry>
1620   <term>Specifies:</term>
1621   <listitem>
1622    <para>
1623     Who can access what.
1624    </para>
1625   </listitem>
1626  </varlistentry>
1627  <varlistentry>
1628   <term>Type of value:</term>
1629   <listitem>
1630    <para>
1631     <replaceable class="parameter">src_addr</replaceable>[/<replaceable class="parameter">src_masklen</replaceable>]
1632     [<replaceable class="parameter">dst_addr</replaceable>[/<replaceable class="parameter">dst_masklen</replaceable>]]
1633    </para>
1634    <para>
1635     Where <replaceable class="parameter">src_addr</replaceable> and
1636    <replaceable class="parameter">dst_addr</replaceable> are IP addresses in dotted decimal notation or valid
1637     DNS names, and <replaceable class="parameter">src_masklen</replaceable> and
1638     <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1639     values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1640     destination part are optional.
1641    </para>
1642   </listitem>
1643  </varlistentry>
1644  <varlistentry>
1645   <term>Default value:</term>
1646   <listitem>
1647    <para><emphasis>Unset</emphasis></para>
1648   </listitem>
1649  </varlistentry>
1650  <varlistentry>
1651   <term>Effect if unset:</term>
1652   <listitem>
1653    <para>
1654     Don't restrict access further than implied by <literal>listen-address</literal>
1655    </para>
1656   </listitem>
1657  </varlistentry>
1658  <varlistentry>
1659   <term>Notes:</term>
1660   <listitem>
1661    <para>
1662     Access controls are included at the request of ISPs and systems
1663     administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1664     For a typical home user, it will normally suffice to ensure that
1665     <application>Privoxy</application> only listens on the localhost
1666     (127.0.0.1) or internal (home) network address by means of the
1667     <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1668     option.
1669    </para>
1670    <para>
1671     Please see the warnings in the FAQ that <application>Privoxy</application>
1672     is not intended to be a substitute for a firewall or to encourage anyone
1673     to defer addressing basic security weaknesses.
1674    </para>
1675    <para>
1676     Multiple ACL lines are OK.
1677     If any ACLs are specified, <application>Privoxy</application> only talks
1678     to IP addresses that match at least one <literal>permit-access</literal> line
1679     and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1680     last match wins, with the default being <literal>deny-access</literal>.
1681    </para>
1682    <para>
1683     If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1684     for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1685     that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1686     of the ultimate target. This is necessary because it may be impossible for the local
1687     <application>Privoxy</application> to determine the IP address of the
1688     ultimate target (that's often what gateways are used for).
1689    </para>
1690    <para>
1691     You should prefer using IP addresses over DNS names, because the address lookups take
1692     time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1693     like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1694     IP addresses, only the first one is used.
1695    </para>
1696    <para>
1697     Denying access to particular sites by ACL may have undesired side effects
1698     if the site in question is hosted on a machine which also hosts other sites
1699     (most sites are).
1700    </para>
1701   </listitem>
1702  </varlistentry>
1703  <varlistentry>
1704   <term>Examples:</term>
1705   <listitem>
1706    <para>
1707     Explicitly define the default behavior if no ACL and
1708     <literal>listen-address</literal> are set: <quote>localhost</quote>
1709     is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1710     <emphasis>all</emphasis> destination addresses are OK:
1711    </para>
1712    <para>
1713     <screen>
1714   permit-access  localhost
1715 </screen>
1716    </para>
1717    <para>
1718     Allow any host on the same class C subnet as www.privoxy.org access to
1719     nothing but www.example.com (or other domains hosted on the same system):
1720    </para>
1721    <para>
1722     <screen>
1723   permit-access  www.privoxy.org/24 www.example.com/32
1724 </screen>
1725    </para>
1726    <para>
1727     Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1728     with the exception that 192.168.45.73 may not access the IP address behind
1729     www.dirty-stuff.example.com:
1730    </para>
1731    <para>
1732     <screen>
1733   permit-access  192.168.45.64/26
1734   deny-access    192.168.45.73    www.dirty-stuff.example.com
1735 </screen>
1736    </para>
1737   </listitem>
1738  </varlistentry>
1739 </variablelist>
1740 </sect3>
1741
1742
1743 <!--   ~~~~~       New section      ~~~~~     -->
1744 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1745
1746 <variablelist>
1747  <varlistentry>
1748   <term>Specifies:</term>
1749   <listitem>
1750    <para>
1751     Maximum size of the buffer for content filtering.
1752    </para>
1753   </listitem>
1754  </varlistentry>
1755  <varlistentry>
1756   <term>Type of value:</term>
1757   <listitem>
1758    <para>Size in Kbytes</para>
1759   </listitem>
1760  </varlistentry>
1761  <varlistentry>
1762   <term>Default value:</term>
1763   <listitem>
1764    <para>4096</para>
1765   </listitem>
1766  </varlistentry>
1767  <varlistentry>
1768   <term>Effect if unset:</term>
1769   <listitem>
1770    <para>
1771     Use a 4MB (4096 KB) limit.
1772    </para>
1773   </listitem>
1774  </varlistentry>
1775  <varlistentry>
1776   <term>Notes:</term>
1777   <listitem>
1778    <para>
1779     For content filtering, i.e. the <literal>+filter</literal> and
1780     <literal>+deanimate-gif</literal> actions, it is necessary that
1781     <application>Privoxy</application> buffers the entire document body.
1782     This can be potentially dangerous, since a server could just keep sending
1783     data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1784     Hence this option.
1785    </para>
1786    <para>
1787     When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1788     flushed to the client unfiltered and no further attempt to
1789     filter the rest of the document is made. Remember that there may be multiple threads
1790     running, which might require up to <literal>buffer-limit</literal> Kbytes
1791     <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1792     above.
1793    </para>
1794   </listitem>
1795  </varlistentry>
1796 </variablelist>
1797
1798 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1799 </sect3>
1800
1801 </sect2>
1802
1803 <!--  ~  End section  ~  -->
1804
1805
1806 <!--   ~~~~~       New section      ~~~~~     -->
1807
1808 <sect2 id="forwarding">
1809 <title>Forwarding</title>
1810
1811 <para>
1812  This feature allows routing of HTTP requests through a chain of
1813  multiple proxies.
1814 </para>
1815 <para>
1816  Forwarding can be used to chain Privoxy with a caching proxy to speed
1817  up browsing. Using a parent proxy may also be necessary if the machine
1818  that <application>Privoxy</application> runs on has no direct Internet access.
1819 </para>
1820 <para>
1821  Note that parent proxies can severely decrease your privacy level.
1822  For example a parent proxy could add your IP address to the request
1823  headers and if it's a caching proxy it may add the <quote>Etag</quote>
1824  header to revalidation requests again, even though you configured Privoxy
1825  to remove it. It may also ignore Privoxy's header time randomization and use the
1826  original values which could be used by the server as cookie replacement
1827  to track your steps between visits.
1828 </para>
1829
1830 <para>
1831  Also specified here are SOCKS proxies. <application>Privoxy</application>
1832  supports the SOCKS 4 and SOCKS 4A protocols.
1833 </para>
1834
1835 <sect3 renderas="sect4" id="forward"><title>forward</title>
1836 <variablelist>
1837  <varlistentry>
1838   <term>Specifies:</term>
1839   <listitem>
1840    <para>
1841     To which parent HTTP proxy specific requests should be routed.
1842    </para>
1843   </listitem>
1844  </varlistentry>
1845  <varlistentry>
1846   <term>Type of value:</term>
1847   <listitem>
1848    <para>
1849     <replaceable class="parameter">target_pattern</replaceable>
1850     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1851    </para>
1852    <para>
1853     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1854     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1855     denote <quote>all URLs</quote>.
1856     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1857     is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1858     optionally followed by its listening port (default: 8080).
1859     Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1860    </para>
1861   </listitem>
1862  </varlistentry>
1863  <varlistentry>
1864   <term>Default value:</term>
1865   <listitem>
1866    <para><emphasis>Unset</emphasis></para>
1867   </listitem>
1868  </varlistentry>
1869  <varlistentry>
1870   <term>Effect if unset:</term>
1871   <listitem>
1872    <para>
1873     Don't use parent HTTP proxies.
1874    </para>
1875   </listitem>
1876  </varlistentry>
1877  <varlistentry>
1878   <term>Notes:</term>
1879   <listitem>
1880    <para>
1881     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1882     forwarded to another HTTP proxy but are made directly to the web servers.
1883    </para>
1884    <para>
1885     Multiple lines are OK, they are checked in sequence, and the last match wins.
1886    </para>
1887   </listitem>
1888  </varlistentry>
1889  <varlistentry>
1890   <term>Examples:</term>
1891   <listitem>
1892    <para>
1893     Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
1894    </para>
1895    <para>
1896     <screen>
1897   forward   /      parent-proxy.example.org:8080
1898   forward   :443   .
1899 </screen>
1900    </para>
1901    <para>
1902     Everything goes to our example ISP's caching proxy, except for requests
1903     to that ISP's sites:
1904    </para>
1905    <para>
1906     <screen>
1907   forward   /                  caching-proxy.isp.example.net:8000
1908   forward   .isp.example.net   .
1909 </screen>
1910    </para>
1911   </listitem>
1912  </varlistentry>
1913 </variablelist>
1914 </sect3>
1915
1916
1917 <!--   ~~~~~       New section      ~~~~~     -->
1918 <sect3 renderas="sect4" id="socks"><title>
1919 forward-socks4 and forward-socks4a</title>
1920 <anchor id="forward-socks4">
1921 <anchor id="forward-socks4a">
1922
1923 <variablelist>
1924  <varlistentry>
1925   <term>Specifies:</term>
1926   <listitem>
1927    <para>
1928     Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
1929    </para>
1930   </listitem>
1931  </varlistentry>
1932  <varlistentry>
1933   <term>Type of value:</term>
1934   <listitem>
1935    <para>
1936     <replaceable class="parameter">target_pattern</replaceable>
1937     <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
1938     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1939    </para>
1940    <para>
1941     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1942     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1943     denote <quote>all URLs</quote>.
1944     <replaceable class="parameter">http_parent</replaceable> and <replaceable class="parameter">socks_proxy</replaceable>
1945     are IP addresses in dotted decimal notation or valid DNS names (<replaceable class="parameter">http_parent</replaceable>
1946     may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
1947     <replaceable class="parameter">port</replaceable> parameters are TCP ports, i.e. integer values from 1 to 64535
1948    </para>
1949   </listitem>
1950  </varlistentry>
1951  <varlistentry>
1952   <term>Default value:</term>
1953   <listitem>
1954    <para><emphasis>Unset</emphasis></para>
1955   </listitem>
1956  </varlistentry>
1957  <varlistentry>
1958   <term>Effect if unset:</term>
1959   <listitem>
1960    <para>
1961     Don't use SOCKS proxies.
1962    </para>
1963   </listitem>
1964  </varlistentry>
1965  <varlistentry>
1966   <term>Notes:</term>
1967   <listitem>
1968    <para>
1969     Multiple lines are OK, they are checked in sequence, and the last match wins.
1970    </para>
1971    <para>
1972     The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
1973     is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
1974     server, while in SOCKS 4 it happens locally.
1975    </para>
1976    <para>
1977     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1978     forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
1979     a SOCKS proxy.
1980    </para>
1981   </listitem>
1982  </varlistentry>
1983  <varlistentry>
1984   <term>Examples:</term>
1985   <listitem>
1986    <para>
1987      From the company example.com, direct connections are made to all
1988      <quote>internal</quote> domains, but everything outbound goes through
1989      their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
1990      the Internet.
1991    </para>
1992    <para>
1993     <screen>
1994   forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
1995   forward           .example.com   .
1996 </screen>
1997    </para>
1998    <para>
1999     A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2000    </para>
2001    <para>
2002     <screen>
2003   forward-socks4   /               socks-gw.example.com:1080  .
2004 </screen>
2005    </para>
2006
2007     <para>
2008     To chain Privoxy and Tor, both running on the same system, you would use
2009     something like:
2010    </para>
2011    <para>
2012     <screen>
2013   forward-socks4a   /               127.0.0.1:9050 .
2014 </screen>
2015    </para>
2016
2017     <para>
2018     The public <application>Tor</application> network can't be used to
2019     reach your local network, if you need to access local servers you
2020     therefore might want to make some exceptions:
2021    </para>
2022    <para>
2023     <screen>
2024   forward         192.168.*.*/     .
2025   forward            10.*.*.*/     .
2026   forward           127.*.*.*/     .
2027 </screen>
2028    </para>
2029    <para>
2030     Unencrypted connections to systems in these address ranges will
2031     be as (un)secure as the local network is, but the alternative is that you
2032     can't reach the local network through <application>Privoxy</application>
2033     at all. Of course this may actually be desired and there is no reason
2034     to make these exceptions if you aren't sure you need them.
2035    </para>
2036    <para>
2037     If you also want to be able to reach servers in your local network by
2038     using their names, you will need additional exceptions that look like
2039     this:
2040    </para>
2041    <para>
2042     <screen>
2043  forward           localhost/     .
2044 </screen>
2045    </para>
2046
2047   </listitem>
2048  </varlistentry>
2049 </variablelist>
2050 </sect3>
2051
2052 <![%user-man;[     <!-- not included in config due to length -->
2053 <!--   ~~~~~       New section      ~~~~~     -->
2054 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2055
2056 <para>
2057  If you have links to multiple ISPs that provide various special content
2058  only to their subscribers, you can configure multiple <application>Privoxies</application>
2059  which have connections to the respective ISPs to act as forwarders to each other, so that
2060  <emphasis>your</emphasis> users can see the internal content of all ISPs.
2061 </para>
2062
2063 <para>
2064  Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2065  isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2066  configuration can look like this:
2067 </para>
2068
2069 <para>
2070  host-a:
2071 </para>
2072
2073 <para>
2074  <screen>
2075   forward    /           .
2076   forward    .isp-b.example.net  host-b:8118
2077 </screen>
2078 </para>
2079
2080 <para>
2081  host-b:
2082 </para>
2083
2084 <para>
2085  <screen>
2086   forward    /           .
2087   forward    .isp-a.example.org  host-a:8118
2088 </screen>
2089 </para>
2090
2091 <para>
2092  Now, your users can set their browser's proxy to use either
2093  host-a or host-b and be able to browse the internal content
2094  of both isp-a and isp-b.
2095 </para>
2096
2097 <para>
2098  If you intend to chain <application>Privoxy</application> and
2099  <application>squid</application> locally, then chaining as
2100  <literal>browser -> squid -> privoxy</literal> is the recommended way.
2101 </para>
2102
2103 <para>
2104  Assuming that <application>Privoxy</application> and <application>squid</application>
2105  run on the same box, your <application>squid</application> configuration could then look like this:
2106 </para>
2107
2108 <para>
2109  <screen>
2110   # Define Privoxy as parent proxy (without ICP)
2111   cache_peer 127.0.0.1 parent 8118 7 no-query
2112
2113   # Define ACL for protocol FTP
2114   acl ftp proto FTP
2115
2116   # Do not forward FTP requests to Privoxy
2117   always_direct allow ftp
2118
2119   # Forward all the rest to Privoxy
2120   never_direct allow all</screen>
2121 </para>
2122
2123 <para>
2124  You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2125  Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2126 </para>
2127
2128 <para>
2129  You could just as well decide to only forward requests you suspect
2130  of leading to Windows executables through a virus-scanning parent proxy,
2131  say, on <literal>antivir.example.com</literal>, port 8010:
2132 </para>
2133
2134 <para>
2135  <screen>
2136   forward   /                          .
2137   forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010</screen>
2138 </para>
2139
2140 </sect3>
2141 ]]>
2142
2143 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2144 <variablelist>
2145  <varlistentry>
2146   <term>Specifies:</term>
2147   <listitem>
2148    <para>
2149     How often Privoxy retries if a forwarded connection request fails.
2150    </para>
2151   </listitem>
2152  </varlistentry>
2153  <varlistentry>
2154   <term>Type of value:</term>
2155   <listitem>
2156    <para>
2157     <replaceable class="parameter">Number of retries.</replaceable>
2158    </para>
2159   </listitem>
2160  </varlistentry>
2161  <varlistentry>
2162   <term>Default value:</term>
2163   <listitem>
2164    <para><emphasis>0</emphasis></para>
2165   </listitem>
2166  </varlistentry>
2167  <varlistentry>
2168   <term>Effect if unset:</term>
2169   <listitem>
2170    <para>
2171     Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2172    </para>
2173   </listitem>
2174  </varlistentry>
2175  <varlistentry>
2176   <term>Notes:</term>
2177   <listitem>
2178    <para>
2179     <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2180     for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2181     The connection might have failed because of a DNS timeout in which case a retry makes sense,
2182     but it might also have failed because the server doesn't exist or isn't reachable. In this
2183     case the retry will just delay the appearance of Privoxy's error message.
2184    </para>
2185    <para>
2186     Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2187     that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2188    </para>
2189    <para>
2190     Only use this option, if you are getting lots of forwarding-related error messages
2191     that go away when you try again manually. Start with a small value and check Privoxy's
2192     logfile from time to time, to see how many retries are usually needed.
2193    </para>
2194   </listitem>
2195  </varlistentry>
2196  <varlistentry>
2197   <term>Examples:</term>
2198   <listitem>
2199    <para>
2200     forwarded-connect-retries 1
2201    </para>
2202   </listitem>
2203  </varlistentry>
2204 </variablelist>
2205 <![%config-file;[<literallayout>@@forwarded-connect-retries  0</literallayout>]]>
2206 </sect3>
2207
2208 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2209 <variablelist>
2210  <varlistentry>
2211   <term>Specifies:</term>
2212   <listitem>
2213    <para>
2214     Whether intercepted requests should be treated as valid.
2215    </para>
2216   </listitem>
2217  </varlistentry>
2218  <varlistentry>
2219   <term>Type of value:</term>
2220   <listitem>
2221    <para>
2222     <replaceable>0 or 1</replaceable>
2223    </para>
2224   </listitem>
2225  </varlistentry>
2226  <varlistentry>
2227   <term>Default value:</term>
2228   <listitem>
2229    <para><emphasis>0</emphasis></para>
2230   </listitem>
2231  </varlistentry>
2232  <varlistentry>
2233   <term>Effect if unset:</term>
2234   <listitem>
2235    <para>
2236     Only proxy requests are accepted, intercepted requests are treated as invalid.
2237    </para>
2238   </listitem>
2239  </varlistentry>
2240  <varlistentry>
2241   <term>Notes:</term>
2242   <listitem>
2243    <para>
2244     If you don't trust your clients and want to force them
2245     to use <application>Privoxy</application>, enable this
2246     option and configure your packet filter to redirect outgoing
2247     HTTP connections into <application>Privoxy</application>.
2248    </para>
2249    <para>
2250     Make sure that <application>Privoxy's</application> own requests
2251     aren't redirected as well. Additionally take care that
2252     <application>Privoxy</application> can't intentionally connect
2253     to itself, otherwise you could run into redirection loops if
2254     <application>Privoxy's</application> listening port is reachable
2255     by the outside or an attacker has access to the pages you visit.
2256    </para>
2257   </listitem>
2258  </varlistentry>
2259  <varlistentry>
2260   <term>Examples:</term>
2261   <listitem>
2262    <para>
2263     accept-intercepted-requests 1
2264    </para>
2265   </listitem>
2266  </varlistentry>
2267 </variablelist>
2268 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2269 </sect3>
2270
2271 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2272 <variablelist>
2273  <varlistentry>
2274   <term>Specifies:</term>
2275   <listitem>
2276    <para>
2277     Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2278    </para>
2279   </listitem>
2280  </varlistentry>
2281  <varlistentry>
2282   <term>Type of value:</term>
2283   <listitem>
2284    <para>
2285     <replaceable>0 or 1</replaceable>
2286    </para>
2287   </listitem>
2288  </varlistentry>
2289  <varlistentry>
2290   <term>Default value:</term>
2291   <listitem>
2292    <para><emphasis>0</emphasis></para>
2293   </listitem>
2294  </varlistentry>
2295  <varlistentry>
2296   <term>Effect if unset:</term>
2297   <listitem>
2298    <para>
2299     <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2300    </para>
2301   </listitem>
2302  </varlistentry>
2303  <varlistentry>
2304   <term>Notes:</term>
2305   <listitem>
2306    <para>
2307     By default <application>Privoxy</application> ignores block or redirect actions
2308     for its CGI pages. Intercepting these requests can be useful in multi-user
2309     setups to implement fine-grained access control, but it can also render the complete
2310     web interface useless and make debugging problems painful if done without care.
2311    </para>
2312    <para>
2313     Don't enable this option unless you're sure that you really need it.
2314    </para>
2315   </listitem>
2316  </varlistentry>
2317  <varlistentry>
2318   <term>Examples:</term>
2319   <listitem>
2320    <para>
2321     allow-cgi-request-crunching 1
2322    </para>
2323   </listitem>
2324  </varlistentry>
2325 </variablelist>
2326 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2327 </sect3>
2328
2329 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2330 <variablelist>
2331  <varlistentry>
2332   <term>Specifies:</term>
2333   <listitem>
2334    <para>
2335     Whether the CGI interface should stay compatible with broken HTTP clients.
2336    </para>
2337   </listitem>
2338  </varlistentry>
2339  <varlistentry>
2340   <term>Type of value:</term>
2341   <listitem>
2342    <para>
2343     <replaceable>0 or 1</replaceable>
2344    </para>
2345   </listitem>
2346  </varlistentry>
2347  <varlistentry>
2348   <term>Default value:</term>
2349   <listitem>
2350    <para><emphasis>0</emphasis></para>
2351   </listitem>
2352  </varlistentry>
2353  <varlistentry>
2354   <term>Effect if unset:</term>
2355   <listitem>
2356    <para>
2357     The CGI form generate long GET URLs.
2358    </para>
2359   </listitem>
2360  </varlistentry>
2361  <varlistentry>
2362   <term>Notes:</term>
2363   <listitem>
2364    <para>
2365     <application>Privoxy's</application> CGI forms can lead to
2366     rather long URLs. This isn't a problem as far as the HTTP
2367     standard is concerned, but it can confuse clients with arbitrary
2368     URL lenght limitations.
2369    </para>
2370    <para>
2371     Enabling split-large-forms causes <application>Privoxy</application>
2372     to devide big forms into smaller ones to keep the URL length down.
2373     It makes editing a lot less convenient and you can no longer
2374     submit all changes at once, but at least it works around this
2375     browser bug.
2376    </para>
2377    <para>
2378     If you don't notice any editing problems, there is no reason
2379     to enable this option, but if one of the submit buttons appears
2380     to be broken, you should give it a try.
2381    </para>
2382   </listitem>
2383  </varlistentry>
2384  <varlistentry>
2385   <term>Examples:</term>
2386   <listitem>
2387    <para>
2388     split-large-forms 1
2389    </para>
2390   </listitem>
2391  </varlistentry>
2392 </variablelist>
2393 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2394 </sect3>
2395
2396 </sect2>
2397
2398 <!--  ~  End section  ~  -->
2399
2400
2401 <!--   ~~~~~       New section      ~~~~~     -->
2402
2403 <sect2 id="windows-gui">
2404 <title>Windows GUI Options</title>
2405 <para>
2406  <application>Privoxy</application> has a number of options specific to the
2407  Windows GUI interface:
2408 </para>
2409
2410 <anchor id="activity-animation">
2411 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2412 <para>
2413  If <quote>activity-animation</quote> is set to 1, the
2414  <application>Privoxy</application> icon will animate when
2415  <quote>Privoxy</quote> is active. To turn off, set to 0.
2416 </para>
2417
2418 <![%config-file;[<literallayout>@@#activity-animation   1</literallayout>]]>
2419 <![%user-man;[
2420 <para>
2421  <literal>
2422   <msgtext>
2423    <literallayout>
2424   <emphasis>activity-animation   1</emphasis>
2425    </literallayout>
2426   </msgtext>
2427  </literal>
2428 </para>
2429 ]]>
2430
2431 <anchor id="log-messages">
2432 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2433 <para>
2434  If <quote>log-messages</quote> is set to 1,
2435  <application>Privoxy</application> will log messages to the console
2436  window:
2437 </para>
2438
2439 <![%config-file;[<literallayout>@@#log-messages   1</literallayout>]]>
2440 <![%user-man;[
2441 <para>
2442  <literal>
2443   <msgtext>
2444    <literallayout>
2445   <emphasis>log-messages       1</emphasis>
2446    </literallayout>
2447   </msgtext>
2448  </literal>
2449 </para>
2450 ]]>
2451
2452 <anchor id="log-buffer-size">
2453 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2454 <para>
2455  If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
2456  i.e. the amount of memory used for the log messages displayed in the
2457  console window, will be limited to <quote>log-max-lines</quote> (see below).
2458 </para>
2459
2460 <para>
2461  Warning: Setting this to 0 will result in the buffer to grow infinitely and
2462  eat up all your memory!
2463 </para>
2464
2465 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
2466 <![%user-man;[
2467 <para>
2468  <literal>
2469   <msgtext>
2470    <literallayout>
2471   <emphasis>log-buffer-size      1</emphasis>
2472    </literallayout>
2473   </msgtext>
2474  </literal>
2475 </para>
2476 ]]>
2477
2478 <anchor id="log-max-lines">
2479 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2480 <para>
2481  <application>log-max-lines</application> is the maximum number of lines held
2482  in the log buffer. See above.
2483 </para>
2484
2485 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
2486 <![%user-man;[
2487 <para>
2488  <literal>
2489   <msgtext>
2490    <literallayout>
2491   <emphasis>log-max-lines      200</emphasis>
2492    </literallayout>
2493   </msgtext>
2494  </literal>
2495 </para>
2496 ]]>
2497
2498 <anchor id="log-highlight-messages">
2499 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2500 <para>
2501  If <quote>log-highlight-messages</quote> is set to 1,
2502  <application>Privoxy</application> will highlight portions of the log
2503  messages with a bold-faced font:
2504 </para>
2505
2506 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
2507 <![%user-man;[
2508 <para>
2509  <literal>
2510   <msgtext>
2511    <literallayout>
2512   <emphasis>log-highlight-messages   1</emphasis>
2513    </literallayout>
2514   </msgtext>
2515  </literal>
2516 </para>
2517 ]]>
2518
2519 <anchor id="log-font-name">
2520 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2521 <para>
2522  The font used in the console window:
2523 </para>
2524
2525 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
2526 <![%user-man;[
2527 <para>
2528  <literal>
2529   <msgtext>
2530    <literallayout>
2531   <emphasis>log-font-name        Comic Sans MS</emphasis>
2532    </literallayout>
2533   </msgtext>
2534  </literal>
2535 </para>
2536 ]]>
2537
2538 <anchor id="log-font-size">
2539 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2540 <para>
2541  Font size used in the console window:
2542 </para>
2543
2544 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
2545 <![%user-man;[
2546 <para>
2547  <literal>
2548   <msgtext>
2549    <literallayout>
2550   <emphasis>log-font-size        8</emphasis>
2551    </literallayout>
2552   </msgtext>
2553  </literal>
2554 </para>
2555 ]]>
2556
2557 <anchor id="show-on-task-bar">
2558 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2559 <para>
2560  <quote>show-on-task-bar</quote> controls whether or not
2561  <application>Privoxy</application> will appear as a button on the Task bar
2562  when minimized:
2563 </para>
2564
2565 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
2566 <![%user-man;[
2567 <para>
2568  <literal>
2569   <msgtext>
2570    <literallayout>
2571   <emphasis>show-on-task-bar     0</emphasis>
2572    </literallayout>
2573   </msgtext>
2574  </literal>
2575 </para>
2576 ]]>
2577
2578 <anchor id="close-button-minimizes">
2579 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2580 <para>
2581  If <quote>close-button-minimizes</quote> is set to 1, the Windows close
2582  button will minimize <application>Privoxy</application> instead of closing
2583  the program (close with the exit option on the File menu).
2584 </para>
2585
2586 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
2587 <![%user-man;[
2588 <para>
2589  <literal>
2590   <msgtext>
2591    <literallayout>
2592   <emphasis>close-button-minimizes  1</emphasis>
2593    </literallayout>
2594   </msgtext>
2595  </literal>
2596 </para>
2597 ]]>
2598
2599 <anchor id="hide-console">
2600 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2601 <para>
2602  The <quote>hide-console</quote> option is specific to the MS-Win console
2603  version of <application>Privoxy</application>. If this option is used,
2604  <application>Privoxy</application> will disconnect from and hide the
2605  command console.
2606 </para>
2607
2608 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
2609 <![%user-man;[
2610 <para>
2611  <literal>
2612   <msgtext>
2613    <literallayout>
2614   #<emphasis>hide-console</emphasis>
2615    </literallayout>
2616   </msgtext>
2617  </literal>
2618 </para>
2619 ]]>
2620
2621 </sect2>
2622 </sect1>
2623
2624 <!-- end config content common to both outputs -->
2625
2626 <![%config-file;[
2627 <!-- These are dummy anchors to keep the processor quiet            -->
2628 <!-- when building config-file only (ie. they are used in u-m only) -->
2629 <sect1 label="">
2630 <title></title>
2631 <anchor id="filter">
2632 <anchor id="filter-file">
2633 <anchor id="regex">
2634 <anchor id="actions-file">
2635 <anchor id="af-patterns">
2636 </sect1>
2637 ]]>
2638
2639 <!-- eof p-config.sgml -->