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