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.6 2006/09/02 12:49:37 hal9 Exp $
   7
   8  Copyright (C) 2001-2006 Privoxy Developers <developers@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.6 2006/09/02 12:49:37 hal9 Exp $
  99 </para>
 100 <para>
 101 Copyright (C) 2001-2006 Privoxy Developers http://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. CONFIGURATION AND LOG FILE LOCATIONS                   #
 114       2. LOCAL SET-UP DOCUMENTATION                             #
 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 the Privoxy configuration.  If you modify this
 129  file, you will need to send a couple of requests (of any kind) to the proxy
 130  before any changes take effect.
 131 </para>
 132 <para>
 133  When starting Privoxy on Unix systems, give the name of this
 134  file as an argument.  On Windows systems, Privoxy will look for
 135  this file with the name 'config.txt' in the same directory where
 136  Privoxy is installed.
 137 </para>
 138
 139 <para>
 140  <literallayout><!-- funky spacing -->
 141
 142 II. FORMAT OF THE CONFIGURATION FILE
 143 ====================================</literallayout>
 144 </para>
 145 <para>
 146  Configuration lines consist of an initial keyword followed by a list
 147  of values, all separated by whitespace (any number of spaces or
 148  tabs).  For example,
 149 </para>
 150 <para>
 151  actionsfile default.action
 152 </para>
 153 <para>
 154  Indicates that the actionsfile is named 'default.action'.
 155 </para>
 156 <para>
 157  The '#' indicates a comment.  Any part of a line following a '#' is
 158  ignored, except if the '#' is preceded by a '\'.
 159 </para>
 160 <para>
 161  Thus, by placing a # at the start of an existing configuration line,
 162  you can make it a comment and it will be treated as if it weren't there.
 163  This is called "commenting out" an option and can be useful.
 164 </para>
 165 <para>
 166  Note that commenting out and option and leaving it at its default
 167  are two completely different things! Most options behave very
 168  differently when unset. See the the "Effect if unset" explanation
 169  in each option's description for details.
 170 </para>
 171 <para>
 172  Long lines can be continued on the next line by using a `\' as
 173  the last character.
 174 </para>
 175
 176 ]]>
 177
 178 <!-- ************************************************ -->
 179 <!-- The following is common to both outputs (mostly) -->
 180 <!-- ************************************************ -->
 181
 182 <!--   ~~~~~       New section      ~~~~~     -->
 183
 184 <sect2 id="conf-log-loc">
 185 <title>Configuration and Log File Locations</title>
 186
 187 <para>
 188  <application>Privoxy</application> can (and normally does) use a number of
 189  other files for additional configuration, help and logging.
 190  This section of the configuration file tells <application>Privoxy</application>
 191  where to find those other files.
 192 </para>
 193
 194 <para>
 195  The user running <application>Privoxy</application>, must have read
 196  permission for all configuration files, and write permission to any files
 197  that would be modified, such as log files and actions files.
 198 </para>
 199
 200
 201 <!--   ~~~~~       New section      ~~~~~     -->
 202 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
 203
 204 <variablelist>
 205  <varlistentry>
 206   <term>Specifies:</term>
 207   <listitem>
 208    <para>The directory where the other configuration files are located</para>
 209   </listitem>
 210  </varlistentry>
 211  <varlistentry>
 212   <term>Type of value:</term>
 213   <listitem>
 214    <para>Path name</para>
 215   </listitem>
 216  </varlistentry>
 217  <varlistentry>
 218   <term>Default value:</term>
 219   <listitem>
 220    <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
 221   </listitem>
 222  </varlistentry>
 223  <varlistentry>
 224   <term>Effect if unset:</term>
 225   <listitem>
 226    <para><emphasis>Mandatory</emphasis></para>
 227   </listitem>
 228  </varlistentry>
 229  <varlistentry>
 230   <term>Notes:</term>
 231   <listitem>
 232    <para>
 233     No trailing <quote><literal>/</literal></quote>, please
 234    </para>
 235    <para>
 236     When development goes modular and multi-user, the blocker, filter, and
 237     per-user config will be stored in subdirectories of <quote>confdir</quote>.
 238     For now, the configuration directory structure is flat, except for
 239     <filename>confdir/templates</filename>, where the HTML templates for CGI
 240     output reside (e.g. <application>Privoxy's</application> 404 error page).
 241    </para>
 242   </listitem>
 243  </varlistentry>
 244 </variablelist>
 245
 246 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
 247 </sect3>
 248
 249
 250 <!--   ~~~~~       New section      ~~~~~     -->
 251 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
 252
 253 <variablelist>
 254  <varlistentry>
 255   <term>Specifies:</term>
 256   <listitem>
 257    <para>
 258     The directory where all logging takes place (i.e. where <filename>logfile</filename> and
 259     <filename>jarfile</filename> are located)
 260    </para>
 261   </listitem>
 262  </varlistentry>
 263  <varlistentry>
 264   <term>Type of value:</term>
 265   <listitem>
 266    <para>Path name</para>
 267   </listitem>
 268  </varlistentry>
 269  <varlistentry>
 270   <term>Default value:</term>
 271   <listitem>
 272    <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
 273   </listitem>
 274  </varlistentry>
 275  <varlistentry>
 276   <term>Effect if unset:</term>
 277   <listitem>
 278    <para><emphasis>Mandatory</emphasis></para>
 279   </listitem>
 280  </varlistentry>
 281  <varlistentry>
 282   <term>Notes:</term>
 283   <listitem>
 284    <para>
 285     No trailing <quote><literal>/</literal></quote>, please
 286    </para>
 287   </listitem>
 288  </varlistentry>
 289 </variablelist>
 290
 291 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
 292 </sect3>
 293
 294
 295 <!--   ~~~~~       New section      ~~~~~     -->
 296 <sect3 renderas="sect4" id="actionsfile"><title>
 297 actionsfile
 298 </title>
 299 <anchor id="default.action">
 300 <anchor id="standard.action">
 301 <anchor id="user.action">
 302 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
 303 <variablelist>
 304  <varlistentry>
 305   <term>Specifies:</term>
 306   <listitem>
 307    <para>
 308     The <link linkend="actions-file">actions file(s)</link> to use
 309    </para>
 310   </listitem>
 311  </varlistentry>
 312  <varlistentry>
 313   <term>Type of value:</term>
 314   <listitem>
 315    <para>File name, relative to <literal>confdir</literal>, without the <literal>.action</literal> suffix</para>
 316   </listitem>
 317  </varlistentry>
 318  <varlistentry>
 319   <term>Default values:</term>
 320   <listitem>
 321    <simplelist>
 322     <member>
 323      <msgtext><literallayout>  standard     # Internal purposes, no editing recommended</literallayout></msgtext>
 324     </member>
 325     <member>
 326      <msgtext><literallayout>  default      # Main actions file</literallayout></msgtext>
 327     </member>
 328     <member>
 329      <msgtext><literallayout>  user         # User customizations</literallayout></msgtext>
 330     </member>
 331    </simplelist>
 332   </listitem>
 333  </varlistentry>
 334  <varlistentry>
 335   <term>Effect if unset:</term>
 336   <listitem>
 337    <para>
 338     No actions are taken at all. Simple neutral proxying.
 339    </para>
 340   </listitem>
 341  </varlistentry>
 342  <varlistentry>
 343   <term>Notes:</term>
 344   <listitem>
 345    <para>
 346     Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
 347    </para>
 348    <para>
 349     The default values include standard.action, which is used for internal
 350     purposes and should be loaded, default.action, which is the
 351     <quote>main</quote> actions file maintained by the developers, and
 352     <filename>user.action</filename>, where you can make your personal additions.
 353    </para>
 354    <para>
 355     Actions files are where all the per site and per URL configuration is done for
 356     ad blocking, cookie management, privacy considerations, etc.
 357     There is no point in using <application>Privoxy</application> without at
 358     least one actions file.
 359    </para>
 360   </listitem>
 361  </varlistentry>
 362 </variablelist>
 363
 364 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
 365 <!-- html -> text conversion, blah -->
 366 <![%config-file;[<literallayout>@@actionsfile standard  # Internal purpose, recommended</literallayout>]]>
 367 <![%config-file;[<literallayout>@@actionsfile default   # Main actions file</literallayout>]]>
 368 <![%config-file;[<literallayout>@@actionsfile user      # User customizations</literallayout>]]>
 369 </sect3>
 370
 371 <!--   ~~~~~       New section      ~~~~~     -->
 372 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
 373 <anchor id="default.filter">
 374 <variablelist>
 375  <varlistentry>
 376   <term>Specifies:</term>
 377   <listitem>
 378    <para>
 379     The <link linkend="filter-file">filter file(s)</link> to use
 380    </para>
 381   </listitem>
 382  </varlistentry>
 383  <varlistentry>
 384   <term>Type of value:</term>
 385   <listitem>
 386    <para>File name, relative to <literal>confdir</literal></para>
 387   </listitem>
 388  </varlistentry>
 389  <varlistentry>
 390   <term>Default value:</term>
 391   <listitem>
 392    <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
 393   </listitem>
 394  </varlistentry>
 395  <varlistentry>
 396   <term>Effect if unset:</term>
 397   <listitem>
 398    <para>
 399     No textual content filtering takes place, i.e. all
 400     <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
 401     actions in the actions files are turned neutral.
 402    </para>
 403   </listitem>
 404  </varlistentry>
 405  <varlistentry>
 406   <term>Notes:</term>
 407   <listitem>
 408    <para>
 409     Multiple <literal>filterfile</literal> lines are permitted.
 410    </para>
 411    <para>
 412     The <link linkend="filter-file">filter files</link> contain content modification
 413     rules that use <link linkend="regex">regular expressions</link>. These rules permit
 414     powerful changes on the content of Web pages, and optionally the headers
 415     as well, e.g., you could disable your favorite JavaScript annoyances,
 416     re-write the actual displayed text, or just have some fun
 417     playing buzzword bingo with web pages.
 418    </para>
 419    <para>
 420     The
 421     <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
 422     actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
 423     to be defined in a filter file!
 424    </para>
 425    <para>
 426     A pre-defined filter file called <filename>default.filter</filename> that contains
 427     a number of useful filters for common problems is included in the distribution.
 428     See the section on the <literal><link linkend="filter">filter</link></literal>
 429     action for a list.
 430    </para>
 431    <para>
 432     It is recommended to place any locally adapted filters into a separate
 433     file, such as <filename>user.filter</filename>.
 434    </para>
 435   </listitem>
 436  </varlistentry>
 437 </variablelist>
 438
 439 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
 440 <![%config-file;[<literallayout>@@filterfile user.filter      # User customizations</literallayout>]]>
 441 </sect3>
 442
 443
 444 <!--   ~~~~~       New section      ~~~~~     -->
 445 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
 446
 447 <variablelist>
 448  <varlistentry>
 449   <term>Specifies:</term>
 450   <listitem>
 451    <para>
 452     The log file to use
 453    </para>
 454   </listitem>
 455  </varlistentry>
 456  <varlistentry>
 457   <term>Type of value:</term>
 458   <listitem>
 459    <para>File name, relative to <literal>logdir</literal></para>
 460   </listitem>
 461  </varlistentry>
 462  <varlistentry>
 463   <term>Default value:</term>
 464   <listitem>
 465    <para>logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows)</para>
 466   </listitem>
 467  </varlistentry>
 468  <varlistentry>
 469   <term>Effect if unset:</term>
 470   <listitem>
 471    <para>
 472     No log file is used, all log messages go to the console (<literal>STDERR</literal>).
 473    </para>
 474   </listitem>
 475  </varlistentry>
 476  <varlistentry>
 477   <term>Notes:</term>
 478   <listitem>
 479  <!--
 480   removed per bug report 688728 02/20/03 HB
 481
 482    <para>
 483     The windows version will additionally log to the console.
 484    </para>
 485   -->
 486    <para>
 487     The logfile is where all logging and error messages are written. The level
 488     of detail and number of messages are set with the <literal>debug</literal>
 489     option (see below). The logfile can be useful for tracking down a problem with
 490     <application>Privoxy</application> (e.g., it's not blocking an ad you
 491     think it should block) but in most cases you probably will never look at it.
 492    </para>
 493    <para>
 494     Your logfile will grow indefinitely, and you will probably want to
 495     periodically remove it.  On Unix systems, you can do this with a cron job
 496     (see <quote>man cron</quote>). For Red Hat, a <command>logrotate</command>
 497     script has been included.
 498    </para>
 499    <para>
 500     On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
 501     +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
 502     the effect that cron.daily will automatically archive, gzip, and empty the
 503     log, when it exceeds 1M size.
 504    </para>
 505    <para>
 506     Any log files must be writable by whatever user <application>Privoxy</application>
 507     is being run as (default on UNIX, user id is <quote>privoxy</quote>).
 508    </para>
 509   </listitem>
 510  </varlistentry>
 511 </variablelist>
 512
 513 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
 514 </sect3>
 515
 516
 517 <!--   ~~~~~       New section      ~~~~~     -->
 518 <sect3 renderas="sect4" id="jarfile"><title>jarfile</title>
 519
 520 <variablelist>
 521  <varlistentry>
 522   <term>Specifies:</term>
 523   <listitem>
 524    <para>
 525     The file to store intercepted cookies in
 526    </para>
 527   </listitem>
 528  </varlistentry>
 529  <varlistentry>
 530   <term>Type of value:</term>
 531   <listitem>
 532    <para>File name, relative to <literal>logdir</literal></para>
 533   </listitem>
 534  </varlistentry>
 535  <varlistentry>
 536   <term>Default value:</term>
 537   <listitem>
 538    <para>Unset (commented out). When activated: jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows)</para>
 539   </listitem>
 540  </varlistentry>
 541  <varlistentry>
 542   <term>Effect if unset:</term>
 543   <listitem>
 544    <para>
 545     Intercepted cookies are not stored in a dedicated log file.
 546    </para>
 547   </listitem>
 548  </varlistentry>
 549  <varlistentry>
 550   <term>Notes:</term>
 551   <listitem>
 552    <para>
 553     The jarfile may grow to ridiculous sizes over time.
 554    </para>
 555    <para>
 556     If debug 8 (show header parsing) is enabled, cookies are
 557     written to the logfile with the rest of the headers.
 558    </para>
 559   </listitem>
 560  </varlistentry>
 561 </variablelist>
 562
 563 <![%config-file;[<literallayout>@@#jarfile jarfile</literallayout>]]>
 564 </sect3>
 565
 566
 567 <!--   ~~~~~       New section      ~~~~~     -->
 568 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
 569 <variablelist>
 570  <varlistentry>
 571   <term>Specifies:</term>
 572   <listitem>
 573    <para>
 574     The trust file to use
 575    </para>
 576   </listitem>
 577  </varlistentry>
 578  <varlistentry>
 579   <term>Type of value:</term>
 580   <listitem>
 581    <para>File name, relative to <literal>confdir</literal></para>
 582   </listitem>
 583  </varlistentry>
 584  <varlistentry>
 585   <term>Default value:</term>
 586   <listitem>
 587    <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
 588   </listitem>
 589  </varlistentry>
 590  <varlistentry>
 591   <term>Effect if unset:</term>
 592   <listitem>
 593    <para>
 594     The entire trust mechanism is turned off.
 595    </para>
 596   </listitem>
 597  </varlistentry>
 598  <varlistentry>
 599   <term>Notes:</term>
 600   <listitem>
 601    <para>
 602     The trust mechanism is an experimental feature for building white-lists and should
 603     be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
 604    </para>
 605    <para>
 606     If you specify a trust file, <application>Privoxy</application> will only allow
 607     access to sites that are specified in the trustfile. Sites can be listed
 608     in one of two ways:
 609    </para>
 610    <para>
 611     Prepending a <literal>~</literal> character limits access to this site
 612     only (and any sub-paths within this site), e.g.
 613     <literal>~www.example.com</literal>.
 614    </para>
 615    <para>
 616     Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
 617     prepending the name with a <literal>+</literal> character. The effect is that
 618     access to untrusted sites will be granted -- but only if a link from this
 619     trusted referrer was used. The link target will then be added to the
 620     <quote>trustfile</quote> so that future, direct accesses will be granted.
 621     Sites added via this mechanism do not become trusted referrers themselves
 622     (i.e. they are added with a <literal>~</literal> designation).
 623    </para>
 624    <para>
 625     If you use the <literal>+</literal> operator in the trust file, it may grow
 626     considerably over time.
 627    </para>
 628    <para>
 629     It is recommended that <application>Privoxy</application> be compiled with
 630     the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
 631     <literal> --disable-editor</literal> options, if this feature is to be
 632     used.
 633    </para>
 634    <para>
 635     Possible applications include limiting Internet access for children.
 636    </para>
 637
 638   </listitem>
 639  </varlistentry>
 640 </variablelist>
 641
 642 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
 643 </sect3>
 644 </sect2>
 645
 646 <!--  ~  End section  ~  -->
 647
 648
 649 <!--   ~~~~~       New section      ~~~~~     -->
 650 <sect2 id="local-set-up">
 651 <title>Local Set-up Documentation</title>
 652
 653   <para>
 654     If you intend to operate <application>Privoxy</application> for more users
 655     than just yourself, it might be a good idea to let them know how to reach
 656     you, what you block and why you do that, your policies, etc.
 657    </para>
 658
 659
 660 <!--   ~~~~~       New section      ~~~~~     -->
 661 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
 662 <variablelist>
 663  <varlistentry>
 664   <term>Specifies:</term>
 665   <listitem>
 666    <para>
 667     Location of the <application>Privoxy</application> User Manual.
 668    </para>
 669   </listitem>
 670  </varlistentry>
 671  <varlistentry>
 672   <term>Type of value:</term>
 673   <listitem>
 674    <para>A fully qualified URI</para>
 675   </listitem>
 676  </varlistentry>
 677  <varlistentry>
 678   <term>Default value:</term>
 679   <listitem>
 680    <para><emphasis>Unset</emphasis></para>
 681   </listitem>
 682  </varlistentry>
 683  <varlistentry>
 684   <term>Effect if unset:</term>
 685   <listitem>
 686    <para>
 687     <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/<replaceable class="parameter">version</replaceable>/user-manual/</ulink>
 688     will be used, where <replaceable class="parameter">version</replaceable> is the <application>Privoxy</application> version.
 689    </para>
 690   </listitem>
 691  </varlistentry>
 692  <varlistentry>
 693   <term>Notes:</term>
 694   <listitem>
 695     <para>
 696     The User Manual URI is used for help links from some of the internal CGI pages.
 697     The manual itself is normally packaged with the binary distributions, so you probably want
 698     to set this to a locally installed copy. For multi-user setups, you could provide a copy on
 699     a local webserver for all your users and use the corresponding URL here.
 700    </para>
 701    <para>
 702     Examples:
 703    </para>
 704   <para>
 705    Unix, in local filesystem:
 706   </para>
 707   <para>
 708    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
 709   </para>
 710   <para>
 711    Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
 712   </para>
 713   <para>
 714    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
 715   </para>
 716   <para>
 717    Windows, UNC notation (with forward slashes):
 718   </para>
 719   <para>
 720    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
 721   </para>
 722   <para>
 723    Any platform, on local webserver (called <quote>local-webserver</quote>):
 724   </para>
 725   <para>
 726    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;http://local-webserver/privoxy-user-manual/</screen>
 727   </para>
 728   <![%user-man;[
 729    <!-- this gets hammered in conversion to config. Text repeated below. -->
 730   <warning>
 731    <para>
 732      If set, this option should be <emphasis>the first option in the config
 733      file</emphasis>, because it is used while the config file is being read.
 734    </para>
 735   </warning>
 736   ]]>
 737
 738   <![%config-file;[
 739    <!-- alternate -->
 740    <para>
 741     WARNING!!!
 742    </para>
 743    <blockquote>
 744     <para>
 745      If set, this option should be the first option in the config
 746      file, because it is used while the config file is being read.
 747     </para>
 748    </blockquote>
 749   ]]>
 750
 751  </listitem>
 752  </varlistentry>
 753 </variablelist>
 754
 755 <![%config-file;[<literallayout>@@#user-manual http://www.privoxy.org/user-manual/</literallayout>]]>
 756 </sect3>
 757
 758
 759 <!--   ~~~~~       New section      ~~~~~     -->
 760 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
 761
 762 <variablelist>
 763  <varlistentry>
 764   <term>Specifies:</term>
 765   <listitem>
 766    <para>
 767     A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
 768    </para>
 769   </listitem>
 770  </varlistentry>
 771  <varlistentry>
 772   <term>Type of value:</term>
 773   <listitem>
 774    <para>URL</para>
 775   </listitem>
 776  </varlistentry>
 777  <varlistentry>
 778   <term>Default value:</term>
 779   <listitem>
 780    <para>Two example URL are provided</para>
 781   </listitem>
 782  </varlistentry>
 783  <varlistentry>
 784   <term>Effect if unset:</term>
 785   <listitem>
 786    <para>
 787     No links are displayed on the "untrusted" error page.
 788    </para>
 789   </listitem>
 790  </varlistentry>
 791  <varlistentry>
 792   <term>Notes:</term>
 793   <listitem>
 794    <para>
 795     The value of this option only matters if the experimental trust mechanism has been
 796     activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> above.)
 797    </para>
 798    <para>
 799     If you use the trust mechanism, it is a good idea to write up some on-line
 800     documentation about your trust policy and to specify the URL(s) here.
 801     Use multiple times for multiple URLs.
 802    </para>
 803    <para>
 804     The URL(s) should be added to the trustfile as well, so users don't end up
 805     locked out from the information on why they were locked out in the first place!
 806    </para>
 807   </listitem>
 808  </varlistentry>
 809 </variablelist>
 810
 811 <![%config-file;[<literallayout>@@trust-info-url  http://www.example.com/why_we_block.html</literallayout>]]>
 812 <![%config-file;[<literallayout>@@trust-info-url  http://www.example.com/what_we_allow.html</literallayout>]]>
 813 </sect3>
 814
 815
 816 <!--   ~~~~~       New section      ~~~~~     -->
 817 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
 818
 819 <variablelist>
 820  <varlistentry>
 821   <term>Specifies:</term>
 822   <listitem>
 823    <para>
 824     An email address to reach the proxy administrator.
 825    </para>
 826   </listitem>
 827  </varlistentry>
 828  <varlistentry>
 829   <term>Type of value:</term>
 830   <listitem>
 831    <para>Email address</para>
 832   </listitem>
 833  </varlistentry>
 834  <varlistentry>
 835   <term>Default value:</term>
 836   <listitem>
 837    <para><emphasis>Unset</emphasis></para>
 838   </listitem>
 839  </varlistentry>
 840  <varlistentry>
 841   <term>Effect if unset:</term>
 842   <listitem>
 843    <para>
 844     No email address is displayed on error pages and the CGI user interface.
 845    </para>
 846   </listitem>
 847  </varlistentry>
 848  <varlistentry>
 849   <term>Notes:</term>
 850   <listitem>
 851     <para>
 852     If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
 853     are unset, the whole "Local Privoxy Support" box on all generated pages will
 854     not be shown.
 855    </para>
 856   </listitem>
 857  </varlistentry>
 858 </variablelist>
 859
 860 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
 861 </sect3>
 862
 863
 864 <!--   ~~~~~       New section      ~~~~~     -->
 865 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
 866
 867 <variablelist>
 868  <varlistentry>
 869   <term>Specifies:</term>
 870   <listitem>
 871    <para>
 872     A URL to documentation about the local <application>Privoxy</application> setup,
 873     configuration or policies.
 874    </para>
 875   </listitem>
 876  </varlistentry>
 877  <varlistentry>
 878   <term>Type of value:</term>
 879   <listitem>
 880    <para>URL</para>
 881   </listitem>
 882  </varlistentry>
 883  <varlistentry>
 884   <term>Default value:</term>
 885   <listitem>
 886    <para><emphasis>Unset</emphasis></para>
 887   </listitem>
 888  </varlistentry>
 889  <varlistentry>
 890   <term>Effect if unset:</term>
 891   <listitem>
 892    <para>
 893     No link to local documentation is displayed on error pages and the CGI user interface.
 894    </para>
 895   </listitem>
 896  </varlistentry>
 897  <varlistentry>
 898   <term>Notes:</term>
 899   <listitem>
 900    <para>
 901     If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
 902     are unset, the whole "Local Privoxy Support" box on all generated pages will
 903     not be shown.
 904    </para>
 905    <para>
 906     This URL shouldn't be blocked ;-)
 907    </para>
 908   </listitem>
 909  </varlistentry>
 910 </variablelist>
 911
 912 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
 913 </sect3>
 914
 915 </sect2>
 916 <!--  ~  End section  ~  -->
 917
 918 <!--   ~~~~~       New section      ~~~~~     -->
 919 <sect2 id="debugging">
 920 <title>Debugging</title>
 921
 922  <para>
 923   These options are mainly useful when tracing a problem.
 924   Note that you might also want to invoke
 925   <application>Privoxy</application> with the <literal>--no-daemon</literal>
 926   command line option when debugging.
 927  </para>
 928
 929 <sect3 renderas="sect4" id="debug"><title>debug</title>
 930
 931 <variablelist>
 932  <varlistentry>
 933   <term>Specifies:</term>
 934   <listitem>
 935    <para>
 936     Key values that determine what information gets logged to the
 937     <link linkend="logfile"><emphasis>logfile</emphasis></link>.
 938    </para>
 939   </listitem>
 940  </varlistentry>
 941  <varlistentry>
 942   <term>Type of value:</term>
 943   <listitem>
 944    <para>Integer values</para>
 945   </listitem>
 946  </varlistentry>
 947  <varlistentry>
 948   <term>Default value:</term>
 949   <listitem>
 950    <para>12289 (i.e.: URLs plus informational and warning messages)</para>
 951   </listitem>
 952  </varlistentry>
 953  <varlistentry>
 954   <term>Effect if unset:</term>
 955   <listitem>
 956    <para>
 957     Nothing gets logged.
 958    </para>
 959   </listitem>
 960  </varlistentry>
 961  <varlistentry>
 962   <term>Notes:</term>
 963   <listitem>
 964    <para>
 965     The available debug levels are:
 966    </para>
 967    <para>
 968     <programlisting>
 969   debug         1 # show each GET/POST/CONNECT request
 970   debug         2 # show each connection status
 971   debug         4 # show I/O status
 972   debug         8 # show header parsing
 973   debug        16 # log all data into the logfile
 974   debug        32 # debug force feature
 975   debug        64 # debug regular expression filter
 976   debug       128 # debug fast redirects
 977   debug       256 # debug GIF de-animation
 978   debug       512 # Common Log Format
 979   debug      1024 # debug kill pop-ups
 980   debug      2048 # CGI user interface
 981   debug      4096 # Startup banner and warnings.
 982   debug      8192 # Non-fatal errors
 983 </programlisting>
 984    </para>
 985    <para>
 986     To select multiple debug levels, you can either add them or use
 987     multiple <literal>debug</literal> lines.
 988    </para>
 989    <para>
 990     A debug level of 1 is informative because it will show you each request
 991     as it happens. <emphasis>1, 4096 and 8192 are highly recommended</emphasis>
 992     so that you will notice when things go wrong. The other levels are probably
 993     only of interest if you are hunting down a specific problem. They can produce
 994     a hell of an output (especially 16).
 995     <!-- LOL -->
 996    </para>
 997    <para>
 998     The reporting of <emphasis>fatal</emphasis> errors (i.e. ones which crash
 999     <application>Privoxy</application>) is always on and cannot be disabled.
1000    </para>
1001    <para>
1002     If you want to use CLF (Common Log Format), you should set <quote>debug
1003     512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1004    </para>
1005   </listitem>
1006  </varlistentry>
1007 </variablelist>
1008
1009 <![%config-file;[<literallayout>@@debug   1    # show each GET/POST/CONNECT request</literallayout>]]>
1010 <![%config-file;[<literallayout>@@debug   4096 # Startup banner and warnings</literallayout>]]>
1011 <![%config-file;[<literallayout>@@debug   8192 # Errors - *we highly recommended enabling this*</literallayout>]]>
1012 </sect3>
1013
1014
1015 <!--   ~~~~~       New section      ~~~~~     -->
1016 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1017
1018 <variablelist>
1019  <varlistentry>
1020   <term>Specifies:</term>
1021   <listitem>
1022    <para>
1023     Whether to run only one server thread
1024    </para>
1025   </listitem>
1026  </varlistentry>
1027  <varlistentry>
1028   <term>Type of value:</term>
1029   <listitem>
1030    <para><emphasis>None</emphasis></para>
1031   </listitem>
1032  </varlistentry>
1033  <varlistentry>
1034   <term>Default value:</term>
1035   <listitem>
1036    <para><emphasis>Unset</emphasis></para>
1037   </listitem>
1038  </varlistentry>
1039  <varlistentry>
1040   <term>Effect if unset:</term>
1041   <listitem>
1042    <para>
1043     Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1044     serve multiple requests simultaneously.
1045    </para>
1046   </listitem>
1047  </varlistentry>
1048  <varlistentry>
1049   <term>Notes:</term>
1050   <listitem>
1051    <para>
1052     This option is only there for debug purposes and you should never
1053     need to use it. <emphasis>It will drastically reduce performance.</emphasis>
1054    </para>
1055   </listitem>
1056  </varlistentry>
1057 </variablelist>
1058
1059 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1060 </sect3>
1061
1062 </sect2>
1063
1064 <!--  ~  End section  ~  -->
1065
1066
1067 <!--   ~~~~~       New section      ~~~~~     -->
1068 <sect2 id="access-control">
1069 <title>Access Control and Security</title>
1070
1071  <para>
1072   This section of the config file controls the security-relevant aspects
1073   of <application>Privoxy</application>'s configuration.
1074  </para>
1075
1076
1077 <!--   ~~~~~       New section      ~~~~~     -->
1078 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1079
1080 <variablelist>
1081  <varlistentry>
1082   <term>Specifies:</term>
1083   <listitem>
1084    <para>
1085     The IP address and TCP port on which <application>Privoxy</application> will
1086     listen for client requests.
1087    </para>
1088   </listitem>
1089  </varlistentry>
1090  <varlistentry>
1091   <term>Type of value:</term>
1092   <listitem>
1093    <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1094   </listitem>
1095  </varlistentry>
1096
1097  <varlistentry>
1098   <term>Default value:</term>
1099   <listitem>
1100    <para>127.0.0.1:8118</para>
1101   </listitem>
1102  </varlistentry>
1103  <varlistentry>
1104   <term>Effect if unset:</term>
1105   <listitem>
1106    <para>
1107     Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1108     home users who run <application>Privoxy</application> on the same machine as
1109     their browser.
1110    </para>
1111   </listitem>
1112  </varlistentry>
1113  <varlistentry>
1114   <term>Notes:</term>
1115   <listitem>
1116    <para>
1117     You will need to configure your browser(s) to this proxy address and port.
1118    </para>
1119    <para>
1120     If you already have another service running on port 8118, or if you want to
1121     serve requests from other machines (e.g. on your local network) as well, you
1122     will need to override the default.
1123    </para>
1124    <para>
1125     If you leave out the IP address, <application>Privoxy</application> will
1126     bind to all interfaces (addresses) on your machine and may become reachable
1127     from the Internet. In that case, consider using <link
1128     linkend="acls">access control lists</link> (ACL's, see below), and/or
1129     a firewall.
1130    </para>
1131    <para>
1132     If you open <application>Privoxy</application> to untrusted users, you will
1133     also want to turn off the <literal><link
1134     linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1135     <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1136     options!
1137    </para>
1138   </listitem>
1139  </varlistentry>
1140  <varlistentry>
1141   <term>Example:</term>
1142   <listitem>
1143    <para>
1144      Suppose you are running <application>Privoxy</application> on
1145      a machine which has the address 192.168.0.1 on your local private network
1146      (192.168.0.0) and has another outside connection with a different address.
1147      You want it to serve requests from inside only:
1148    </para>
1149    <para>
1150     <programlisting>
1151   listen-address  192.168.0.1:8118
1152 </programlisting>
1153    </para>
1154   </listitem>
1155  </varlistentry>
1156 </variablelist>
1157
1158 <![%config-file;[<literallayout>@@listen-address  127.0.0.1:8118</literallayout>]]>
1159 </sect3>
1160
1161
1162 <!--   ~~~~~       New section      ~~~~~     -->
1163 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1164
1165 <variablelist>
1166  <varlistentry>
1167   <term>Specifies:</term>
1168   <listitem>
1169    <para>
1170     Initial state of "toggle" status
1171    </para>
1172   </listitem>
1173  </varlistentry>
1174  <varlistentry>
1175   <term>Type of value:</term>
1176   <listitem>
1177    <para>1 or 0</para>
1178   </listitem>
1179  </varlistentry>
1180  <varlistentry>
1181   <term>Default value:</term>
1182   <listitem>
1183    <para>1</para>
1184   </listitem>
1185  </varlistentry>
1186  <varlistentry>
1187   <term>Effect if unset:</term>
1188   <listitem>
1189    <para>
1190     Act as if toggled on
1191    </para>
1192   </listitem>
1193  </varlistentry>
1194  <varlistentry>
1195   <term>Notes:</term>
1196   <listitem>
1197    <para>
1198     If set to 0, <application>Privoxy</application> will start in
1199     <quote>toggled off</quote> mode, i.e. behave like a normal, content-neutral
1200     proxy where all ad blocking, filtering, etc are disabled. See
1201     <literal>enable-remote-toggle</literal> below. This is not really useful
1202     anymore, since toggling is much easier via <ulink
1203     url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1204     editing the <filename>conf</filename> file.
1205    </para>
1206    <para>
1207     The windows version will only display the toggle icon in the system tray
1208     if this option is present.
1209    </para>
1210   </listitem>
1211  </varlistentry>
1212 </variablelist>
1213
1214 <![%config-file;[<literallayout>@@toggle  1</literallayout>]]>
1215 </sect3>
1216
1217
1218 <!--   ~~~~~       New section      ~~~~~     -->
1219 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1220 <variablelist>
1221  <varlistentry>
1222   <term>Specifies:</term>
1223   <listitem>
1224    <para>
1225     Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1226     feature</ulink> may be used
1227    </para>
1228   </listitem>
1229  </varlistentry>
1230  <varlistentry>
1231   <term>Type of value:</term>
1232   <listitem>
1233    <para>0 or 1</para>
1234   </listitem>
1235  </varlistentry>
1236  <varlistentry>
1237   <term>Default value:</term>
1238   <listitem>
1239    <para>1</para>
1240   </listitem>
1241  </varlistentry>
1242  <varlistentry>
1243   <term>Effect if unset:</term>
1244   <listitem>
1245    <para>
1246     The web-based toggle feature is disabled.
1247    </para>
1248   </listitem>
1249  </varlistentry>
1250  <varlistentry>
1251   <term>Notes:</term>
1252   <listitem>
1253    <para>
1254     When toggled off, <application>Privoxy</application> acts like a normal,
1255     content-neutral proxy, i.e. it acts as if none of the actions applied to
1256     any URL.
1257    </para>
1258    <para>
1259     For the time being, access to the toggle feature can <emphasis>not</emphasis> be
1260     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1261     so that everybody who can access <application>Privoxy</application> (see
1262     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1263     toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1264     for multi-user environments with untrusted users.
1265    </para>
1266    <para>
1267     Note that you must have compiled <application>Privoxy</application> with
1268     support for this feature, otherwise this option has no effect.
1269    </para>
1270   </listitem>
1271  </varlistentry>
1272 </variablelist>
1273
1274 <![%config-file;[<literallayout>@@enable-remote-toggle  1</literallayout>]]>
1275 </sect3>
1276
1277
1278 <!--   ~~~~~       New section      ~~~~~     -->
1279 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1280 <variablelist>
1281  <varlistentry>
1282   <term>Specifies:</term>
1283   <listitem>
1284    <para>
1285     Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1286     file editor</ulink> may be used
1287    </para>
1288   </listitem>
1289  </varlistentry>
1290  <varlistentry>
1291   <term>Type of value:</term>
1292   <listitem>
1293    <para>0 or 1</para>
1294   </listitem>
1295  </varlistentry>
1296  <varlistentry>
1297   <term>Default value:</term>
1298   <listitem>
1299    <para>1</para>
1300   </listitem>
1301  </varlistentry>
1302  <varlistentry>
1303   <term>Effect if unset:</term>
1304   <listitem>
1305    <para>
1306     The web-based actions file editor is disabled.
1307    </para>
1308   </listitem>
1309  </varlistentry>
1310  <varlistentry>
1311   <term>Notes:</term>
1312   <listitem>
1313    <para>
1314     For the time being, access to the editor can <emphasis>not</emphasis> be
1315     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1316     so that everybody who can access <application>Privoxy</application> (see
1317     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1318     modify its configuration for all users. So this option is <emphasis>not
1319     recommended</emphasis> for multi-user environments with untrusted users.
1320    </para>
1321    <para>
1322     Note that you must have compiled <application>Privoxy</application> with
1323     support for this feature, otherwise this option has no effect.
1324    </para>
1325   </listitem>
1326  </varlistentry>
1327 </variablelist>
1328
1329 <![%config-file;[<literallayout>@@enable-edit-actions 1</literallayout>]]>
1330 </sect3>
1331
1332 <!--   ~~~~~       New section      ~~~~~     -->
1333 <sect3 renderas="sect4" id="acls"><title>
1334 ACLs: permit-access and deny-access</title>
1335 <anchor id="permit-access">
1336 <anchor id="deny-access">
1337
1338 <variablelist>
1339  <varlistentry>
1340   <term>Specifies:</term>
1341   <listitem>
1342    <para>
1343     Who can access what.
1344    </para>
1345   </listitem>
1346  </varlistentry>
1347  <varlistentry>
1348   <term>Type of value:</term>
1349   <listitem>
1350    <para>
1351     <replaceable class="parameter">src_addr</replaceable>[/<replaceable class="parameter">src_masklen</replaceable>]
1352     [<replaceable class="parameter">dst_addr</replaceable>[/<replaceable class="parameter">dst_masklen</replaceable>]]
1353    </para>
1354    <para>
1355     Where <replaceable class="parameter">src_addr</replaceable> and
1356    <replaceable class="parameter">dst_addr</replaceable> are IP addresses in dotted decimal notation or valid
1357     DNS names, and <replaceable class="parameter">src_masklen</replaceable> and
1358     <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1359     values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1360     destination part are optional.
1361    </para>
1362   </listitem>
1363  </varlistentry>
1364  <varlistentry>
1365   <term>Default value:</term>
1366   <listitem>
1367    <para><emphasis>Unset</emphasis></para>
1368   </listitem>
1369  </varlistentry>
1370  <varlistentry>
1371   <term>Effect if unset:</term>
1372   <listitem>
1373    <para>
1374     Don't restrict access further than implied by <literal>listen-address</literal>
1375    </para>
1376   </listitem>
1377  </varlistentry>
1378  <varlistentry>
1379   <term>Notes:</term>
1380   <listitem>
1381    <para>
1382     Access controls are included at the request of ISPs and systems
1383     administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1384     For a typical home user, it will normally suffice to ensure that
1385     <application>Privoxy</application> only listens on the localhost
1386     (127.0.0.1) or internal (home) network address by means of the
1387     <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1388     option.
1389    </para>
1390    <para>
1391     Please see the warnings in the FAQ that this proxy is not intended to be a substitute
1392     for a firewall or to encourage anyone to defer addressing basic security
1393     weaknesses.
1394    </para>
1395    <para>
1396     Multiple ACL lines are OK.
1397     If any ACLs are specified, then the <application>Privoxy</application>
1398     talks only to IP addresses that match at least one <literal>permit-access</literal> line
1399     and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1400     last match wins, with the default being <literal>deny-access</literal>.
1401    </para>
1402    <para>
1403     If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1404     for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1405     that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1406     of the ultimate target. This is necessary because it may be impossible for the local
1407     <application>Privoxy</application> to determine the IP address of the
1408     ultimate target (that's often what gateways are used for).
1409    </para>
1410    <para>
1411     You should prefer using IP addresses over DNS names, because the address lookups take
1412     time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1413     like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1414     IP addresses, only the first one is used.
1415    </para>
1416    <para>
1417     Denying access to particular sites by ACL may have undesired side effects
1418     if the site in question is hosted on a machine which also hosts other sites.
1419    </para>
1420   </listitem>
1421  </varlistentry>
1422  <varlistentry>
1423   <term>Examples:</term>
1424   <listitem>
1425    <para>
1426     Explicitly define the default behavior if no ACL and
1427     <literal>listen-address</literal> are set: <quote>localhost</quote>
1428     is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1429     <emphasis>all</emphasis> destination addresses are OK:
1430    </para>
1431    <para>
1432     <screen>
1433   permit-access  localhost
1434 </screen>
1435    </para>
1436    <para>
1437     Allow any host on the same class C subnet as www.privoxy.org access to
1438     nothing but www.example.com:
1439    </para>
1440    <para>
1441     <screen>
1442   permit-access  www.privoxy.org/24 www.example.com/32
1443 </screen>
1444    </para>
1445    <para>
1446     Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1447     with the exception that 192.168.45.73 may not access www.dirty-stuff.example.com:
1448    </para>
1449    <para>
1450     <screen>
1451   permit-access  192.168.45.64/26
1452   deny-access    192.168.45.73    www.dirty-stuff.example.com
1453 </screen>
1454    </para>
1455   </listitem>
1456  </varlistentry>
1457 </variablelist>
1458 </sect3>
1459
1460
1461 <!--   ~~~~~       New section      ~~~~~     -->
1462 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1463
1464 <variablelist>
1465  <varlistentry>
1466   <term>Specifies:</term>
1467   <listitem>
1468    <para>
1469     Maximum size of the buffer for content filtering.
1470    </para>
1471   </listitem>
1472  </varlistentry>
1473  <varlistentry>
1474   <term>Type of value:</term>
1475   <listitem>
1476    <para>Size in Kbytes</para>
1477   </listitem>
1478  </varlistentry>
1479  <varlistentry>
1480   <term>Default value:</term>
1481   <listitem>
1482    <para>4096</para>
1483   </listitem>
1484  </varlistentry>
1485  <varlistentry>
1486   <term>Effect if unset:</term>
1487   <listitem>
1488    <para>
1489     Use a 4MB (4096 KB) limit.
1490    </para>
1491   </listitem>
1492  </varlistentry>
1493  <varlistentry>
1494   <term>Notes:</term>
1495   <listitem>
1496    <para>
1497     For content filtering, i.e. the <literal>+filter</literal> and
1498     <literal>+deanimate-gif</literal> actions, it is necessary that
1499     <application>Privoxy</application> buffers the entire document body.
1500     This can be potentially dangerous, since a server could just keep sending
1501     data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1502     Hence this option.
1503    </para>
1504    <para>
1505     When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1506     flushed to the client unfiltered and no further attempt to
1507     filter the rest of the document is made. Remember that there may be multiple threads
1508     running, which might require up to <literal>buffer-limit</literal> Kbytes
1509     <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1510     above.
1511    </para>
1512   </listitem>
1513  </varlistentry>
1514 </variablelist>
1515
1516 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1517 </sect3>
1518
1519 </sect2>
1520
1521 <!--  ~  End section  ~  -->
1522
1523
1524 <!--   ~~~~~       New section      ~~~~~     -->
1525
1526 <sect2 id="forwarding">
1527 <title>Forwarding</title>
1528
1529 <para>
1530  This feature allows routing of HTTP requests through a chain of
1531  multiple proxies.
1532  It can be used to better protect privacy and confidentiality when
1533  accessing specific domains by routing requests to those domains
1534  through an anonymous public proxy (see e.g. <ulink
1535  url="http://www.multiproxy.org/anon_list.htm">http://www.multiproxy.org/anon_list.htm</ulink>)
1536  Or to use a caching proxy to speed up browsing. Or chaining to a parent
1537  proxy may be necessary because the machine that <application>Privoxy</application>
1538  runs on has no direct Internet access.
1539 </para>
1540
1541 <para>
1542  Also specified here are SOCKS proxies. <application>Privoxy</application>
1543  supports the SOCKS 4 and SOCKS 4A protocols.
1544 </para>
1545
1546 <sect3 renderas="sect4" id="forward"><title>forward</title>
1547 <variablelist>
1548  <varlistentry>
1549   <term>Specifies:</term>
1550   <listitem>
1551    <para>
1552     To which parent HTTP proxy specific requests should be routed.
1553    </para>
1554   </listitem>
1555  </varlistentry>
1556  <varlistentry>
1557   <term>Type of value:</term>
1558   <listitem>
1559    <para>
1560     <replaceable class="parameter">target_pattern</replaceable>
1561     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1562    </para>
1563    <para>
1564     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1565     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1566     denote <quote>all URLs</quote>.
1567     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1568     is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1569     optionally followed by its listening port (default: 8080).
1570     Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1571    </para>
1572   </listitem>
1573  </varlistentry>
1574  <varlistentry>
1575   <term>Default value:</term>
1576   <listitem>
1577    <para><emphasis>Unset</emphasis></para>
1578   </listitem>
1579  </varlistentry>
1580  <varlistentry>
1581   <term>Effect if unset:</term>
1582   <listitem>
1583    <para>
1584     Don't use parent HTTP proxies.
1585    </para>
1586   </listitem>
1587  </varlistentry>
1588  <varlistentry>
1589   <term>Notes:</term>
1590   <listitem>
1591    <para>
1592     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1593     forwarded to another HTTP proxy but are made directly to the web servers.
1594    </para>
1595    <para>
1596     Multiple lines are OK, they are checked in sequence, and the last match wins.
1597    </para>
1598   </listitem>
1599  </varlistentry>
1600  <varlistentry>
1601   <term>Examples:</term>
1602   <listitem>
1603    <para>
1604     Everything goes to an example anonymizing proxy, except SSL on port 443 (which it doesn't handle):
1605    </para>
1606    <para>
1607     <screen>
1608   forward   /      anon-proxy.example.org:8080
1609   forward   :443   .
1610 </screen>
1611    </para>
1612    <para>
1613     Everything goes to our example ISP's caching proxy, except for requests
1614     to that ISP's sites:
1615    </para>
1616    <para>
1617     <screen>
1618   forward   /                  caching-proxy.example-isp.net:8000
1619   forward   .example-isp.net   .
1620 </screen>
1621    </para>
1622   </listitem>
1623  </varlistentry>
1624 </variablelist>
1625 </sect3>
1626
1627
1628 <!--   ~~~~~       New section      ~~~~~     -->
1629 <sect3 renderas="sect4" id="socks"><title>
1630 forward-socks4 and forward-socks4a</title>
1631 <anchor id="forward-socks4">
1632 <anchor id="forward-socks4a">
1633
1634 <variablelist>
1635  <varlistentry>
1636   <term>Specifies:</term>
1637   <listitem>
1638    <para>
1639     Through which SOCKS proxy (and to which parent HTTP proxy) specific requests should be routed.
1640    </para>
1641   </listitem>
1642  </varlistentry>
1643  <varlistentry>
1644   <term>Type of value:</term>
1645   <listitem>
1646    <para>
1647     <replaceable class="parameter">target_pattern</replaceable>
1648     <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
1649     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1650    </para>
1651    <para>
1652     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1653     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1654     denote <quote>all URLs</quote>.
1655     <replaceable class="parameter">http_parent</replaceable> and <replaceable class="parameter">socks_proxy</replaceable>
1656     are IP addresses in dotted decimal notation or valid DNS names (<replaceable class="parameter">http_parent</replaceable>
1657     may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
1658     <replaceable class="parameter">port</replaceable> parameters are TCP ports, i.e. integer values from 1 to 64535
1659    </para>
1660   </listitem>
1661  </varlistentry>
1662  <varlistentry>
1663   <term>Default value:</term>
1664   <listitem>
1665    <para><emphasis>Unset</emphasis></para>
1666   </listitem>
1667  </varlistentry>
1668  <varlistentry>
1669   <term>Effect if unset:</term>
1670   <listitem>
1671    <para>
1672     Don't use SOCKS proxies.
1673    </para>
1674   </listitem>
1675  </varlistentry>
1676  <varlistentry>
1677   <term>Notes:</term>
1678   <listitem>
1679    <para>
1680     Multiple lines are OK, they are checked in sequence, and the last match wins.
1681    </para>
1682    <para>
1683     The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
1684     is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
1685     server, while in SOCKS 4 it happens locally.
1686    </para>
1687    <para>
1688     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1689     forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
1690     a SOCKS proxy.
1691    </para>
1692   </listitem>
1693  </varlistentry>
1694  <varlistentry>
1695   <term>Examples:</term>
1696   <listitem>
1697    <para>
1698      From the company example.com, direct connections are made to all
1699      <quote>internal</quote> domains, but everything outbound goes through
1700      their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
1701      the Internet.
1702    </para>
1703    <para>
1704     <screen>
1705   forward-socks4a   /              socks-gw.example.com:1080  www-cache.example-isp.net:8080
1706   forward           .example.com   .
1707 </screen>
1708    </para>
1709    <para>
1710     A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
1711    </para>
1712    <para>
1713     <screen>
1714   forward-socks4   /               socks-gw.example.com:1080  .
1715 </screen>
1716    </para>
1717
1718     <para>
1719     To chain Privoxy and Tor, both running on the same system, you should use
1720     the rule:
1721    </para>
1722    <para>
1723     <screen>
1724   forward-socks4   /               127.0.0.1:9050 .
1725 </screen>
1726    </para>
1727
1728     <para>
1729     The public <application>Tor</application> network can't be used to reach your local network,
1730     therefore it's a good idea to make some exceptions:
1731    </para>
1732    <para>
1733     <screen>
1734   forward         192.168.*.*/     .
1735   forward            10.*.*.*/     .
1736   forward           127.*.*.*/     .
1737 </screen>
1738    </para>
1739    <para>
1740     Unencrypted connections to systems in these address ranges will
1741     be as (un)secure as the local network is, but the alternative is that you
1742     can't reach the network at all.
1743    </para>
1744    <para>
1745     If you also want to be able to reach servers in your local network by
1746     using their names, you will need additional exceptions that look like
1747     this:
1748    </para>
1749    <para>
1750     <screen>
1751  forward           localhost/     .
1752 </screen>
1753    </para>
1754
1755   </listitem>
1756  </varlistentry>
1757 </variablelist>
1758 </sect3>
1759
1760 <![%user-man;[     <!-- not included in config due to length -->
1761 <!--   ~~~~~       New section      ~~~~~     -->
1762 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
1763
1764 <para>
1765  If you have links to multiple ISPs that provide various special content
1766  only to their subscribers, you can configure multiple <application>Privoxies</application>
1767  which have connections to the respective ISPs to act as forwarders to each other, so that
1768  <emphasis>your</emphasis> users can see the internal content of all ISPs.
1769 </para>
1770
1771 <para>
1772  Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to
1773  isp-b.net. Both run <application>Privoxy</application>. Their forwarding
1774  configuration can look like this:
1775 </para>
1776
1777 <para>
1778  host-a:
1779 </para>
1780
1781 <para>
1782  <screen>
1783   forward    /           .
1784   forward    .isp-b.net  host-b:8118
1785 </screen>
1786 </para>
1787
1788 <para>
1789  host-b:
1790 </para>
1791
1792 <para>
1793  <screen>
1794   forward    /           .
1795   forward    .isp-a.net  host-a:8118
1796 </screen>
1797 </para>
1798
1799 <para>
1800  Now, your users can set their browser's proxy to use either
1801  host-a or host-b and be able to browse the internal content
1802  of both isp-a and isp-b.
1803 </para>
1804
1805 <para>
1806  If you intend to chain <application>Privoxy</application> and
1807  <application>squid</application> locally, then chain as
1808  <literal>browser -> squid -> privoxy</literal> is the recommended way.
1809 </para>
1810
1811 <para>
1812  Assuming that <application>Privoxy</application> and <application>squid</application>
1813  run on the same box, your <application>squid</application> configuration could then look like this:
1814 </para>
1815
1816 <para>
1817  <screen>
1818   # Define Privoxy as parent proxy (without ICP)
1819   cache_peer 127.0.0.1 parent 8118 7 no-query
1820
1821   # Define ACL for protocol FTP
1822   acl ftp proto FTP
1823
1824   # Do not forward FTP requests to Privoxy
1825   always_direct allow ftp
1826
1827   # Forward all the rest to Privoxy
1828   never_direct allow all</screen>
1829 </para>
1830
1831 <para>
1832  You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
1833  Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
1834 </para>
1835
1836 <para>
1837  You could just as well decide to only forward requests for Windows executables through
1838  a virus-scanning parent proxy, say, on <literal>antivir.example.com</literal>, port 8010:
1839 </para>
1840
1841 <para>
1842  <screen>
1843   forward   /                          .
1844   forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010</screen>
1845 </para>
1846
1847 </sect3>
1848 ]]>
1849
1850 </sect2>
1851
1852 <!--  ~  End section  ~  -->
1853
1854
1855 <!--   ~~~~~       New section      ~~~~~     -->
1856
1857 <sect2 id="windows-gui">
1858 <title>Windows GUI Options</title>
1859 <para>
1860  <application>Privoxy</application> has a number of options specific to the
1861  Windows GUI interface:
1862 </para>
1863
1864 <anchor id="activity-animation">
1865 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1866 <para>
1867  If <quote>activity-animation</quote> is set to 1, the
1868  <application>Privoxy</application> icon will animate when
1869  <quote>Privoxy</quote> is active. To turn off, set to 0.
1870 </para>
1871
1872 <![%config-file;[<literallayout>@@#activity-animation   1</literallayout>]]>
1873 <![%user-man;[
1874 <para>
1875  <literal>
1876   <msgtext>
1877    <literallayout>
1878   <emphasis>activity-animation   1</emphasis>
1879    </literallayout>
1880   </msgtext>
1881  </literal>
1882 </para>
1883 ]]>
1884
1885 <anchor id="log-messages">
1886 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1887 <para>
1888  If <quote>log-messages</quote> is set to 1,
1889  <application>Privoxy</application> will log messages to the console
1890  window:
1891 </para>
1892
1893 <![%config-file;[<literallayout>@@#log-messages   1</literallayout>]]>
1894 <![%user-man;[
1895 <para>
1896  <literal>
1897   <msgtext>
1898    <literallayout>
1899   <emphasis>log-messages       1</emphasis>
1900    </literallayout>
1901   </msgtext>
1902  </literal>
1903 </para>
1904 ]]>
1905
1906 <anchor id="log-buffer-size">
1907 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1908 <para>
1909  If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1910  i.e. the amount of memory used for the log messages displayed in the
1911  console window, will be limited to <quote>log-max-lines</quote> (see below).
1912 </para>
1913
1914 <para>
1915  Warning: Setting this to 0 will result in the buffer to grow infinitely and
1916  eat up all your memory!
1917 </para>
1918
1919 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
1920 <![%user-man;[
1921 <para>
1922  <literal>
1923   <msgtext>
1924    <literallayout>
1925   <emphasis>log-buffer-size      1</emphasis>
1926    </literallayout>
1927   </msgtext>
1928  </literal>
1929 </para>
1930 ]]>
1931
1932 <anchor id="log-max-lines">
1933 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1934 <para>
1935  <application>log-max-lines</application> is the maximum number of lines held
1936  in the log buffer. See above.
1937 </para>
1938
1939 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
1940 <![%user-man;[
1941 <para>
1942  <literal>
1943   <msgtext>
1944    <literallayout>
1945   <emphasis>log-max-lines      200</emphasis>
1946    </literallayout>
1947   </msgtext>
1948  </literal>
1949 </para>
1950 ]]>
1951
1952 <anchor id="log-highlight-messages">
1953 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1954 <para>
1955  If <quote>log-highlight-messages</quote> is set to 1,
1956  <application>Privoxy</application> will highlight portions of the log
1957  messages with a bold-faced font:
1958 </para>
1959
1960 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
1961 <![%user-man;[
1962 <para>
1963  <literal>
1964   <msgtext>
1965    <literallayout>
1966   <emphasis>log-highlight-messages   1</emphasis>
1967    </literallayout>
1968   </msgtext>
1969  </literal>
1970 </para>
1971 ]]>
1972
1973 <anchor id="log-font-name">
1974 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1975 <para>
1976  The font used in the console window:
1977 </para>
1978
1979 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
1980 <![%user-man;[
1981 <para>
1982  <literal>
1983   <msgtext>
1984    <literallayout>
1985   <emphasis>log-font-name        Comic Sans MS</emphasis>
1986    </literallayout>
1987   </msgtext>
1988  </literal>
1989 </para>
1990 ]]>
1991
1992 <anchor id="log-font-size">
1993 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1994 <para>
1995  Font size used in the console window:
1996 </para>
1997
1998 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
1999 <![%user-man;[
2000 <para>
2001  <literal>
2002   <msgtext>
2003    <literallayout>
2004   <emphasis>log-font-size        8</emphasis>
2005    </literallayout>
2006   </msgtext>
2007  </literal>
2008 </para>
2009 ]]>
2010
2011 <anchor id="show-on-task-bar">
2012 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2013 <para>
2014  <quote>show-on-task-bar</quote> controls whether or not
2015  <application>Privoxy</application> will appear as a button on the Task bar
2016  when minimized:
2017 </para>
2018
2019 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
2020 <![%user-man;[
2021 <para>
2022  <literal>
2023   <msgtext>
2024    <literallayout>
2025   <emphasis>show-on-task-bar     0</emphasis>
2026    </literallayout>
2027   </msgtext>
2028  </literal>
2029 </para>
2030 ]]>
2031
2032 <anchor id="close-button-minimizes">
2033 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2034 <para>
2035  If <quote>close-button-minimizes</quote> is set to 1, the Windows close
2036  button will minimize <application>Privoxy</application> instead of closing
2037  the program (close with the exit option on the File menu).
2038 </para>
2039
2040 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
2041 <![%user-man;[
2042 <para>
2043  <literal>
2044   <msgtext>
2045    <literallayout>
2046   <emphasis>close-button-minimizes  1</emphasis>
2047    </literallayout>
2048   </msgtext>
2049  </literal>
2050 </para>
2051 ]]>
2052
2053 <anchor id="hide-console">
2054 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2055 <para>
2056  The <quote>hide-console</quote> option is specific to the MS-Win console
2057  version of <application>Privoxy</application>. If this option is used,
2058  <application>Privoxy</application> will disconnect from and hide  the
2059  command console.
2060 </para>
2061
2062 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
2063 <![%user-man;[
2064 <para>
2065  <literal>
2066   <msgtext>
2067    <literallayout>
2068   #<emphasis>hide-console</emphasis>
2069    </literallayout>
2070   </msgtext>
2071  </literal>
2072 </para>
2073 ]]>
2074
2075 </sect2>
2076 </sect1>
2077
2078 <!-- end config content common to both outputs -->
2079
2080 <![%config-file;[
2081 <!-- These are dummy anchors to keep the processor quiet            -->
2082 <!-- when building config-file only (ie. they are used in u-m only) -->
2083 <sect1 label="">
2084 <title></title>
2085 <anchor id="filter">
2086 <anchor id="filter-file">
2087 <anchor id="regex">
2088 <anchor id="actions-file">
2089 <anchor id="af-patterns">
2090 </sect1>
2091 ]]>
2092
2093 <!-- eof p-config.sgml -->