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