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