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