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