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.8 2002/08/22 23:15:21 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  $Id: p-config.sgml,v 1.1.2.8 2002/08/22 23:15:21 hal9 Exp $
  99 </para>
 100 <para>
 101 Copyright (C) 2001, 2002 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 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      2048 # CGI user interface
 932   debug      4096 # Startup banner and warnings.
 933   debug      8192 # Non-fatal errors
 934 </programlisting>
 935    </para>
 936    <para>
 937     To select multiple debug levels, you can either add them or use
 938     multiple <literal>debug</literal> lines.
 939    </para>
 940    <para>
 941     A debug level of 1 is informative because it will show you each request
 942     as it happens. <emphasis>1, 4096 and 8192 are highly recommended</emphasis>
 943     so that you will notice when things go wrong. The other levels are probably
 944     only of interest if you are hunting down a specific problem. They can produce
 945     a hell of an output (especially 16).
 946     <!-- LOL -->
 947    </para>
 948    <para>
 949     The reporting of <emphasis>fatal</emphasis> errors (i.e. ones which crash
 950     <application>Privoxy</application>) is always on and cannot be disabled.
 951    </para>
 952    <para>
 953     If you want to use CLF (Common Log Format), you should set <quote>debug
 954     512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
 955    </para>
 956   </listitem>
 957  </varlistentry>
 958 </variablelist>
 959
 960 <![%config-file;[<literallayout>@@debug   1    # show each GET/POST/CONNECT request</literallayout>]]>
 961 <![%config-file;[<literallayout>@@debug   4096 # Startup banner and warnings</literallayout>]]>
 962 <![%config-file;[<literallayout>@@debug   8192 # Errors - *we highly recommended enabling this*</literallayout>]]>
 963 </sect3>
 964
 965
 966 <!--   ~~~~~       New section      ~~~~~     -->
 967 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
 968
 969 <variablelist>
 970  <varlistentry>
 971   <term>Specifies:</term>
 972   <listitem>
 973    <para>
 974     Whether to run only one server thread
 975    </para>
 976   </listitem>
 977  </varlistentry>
 978  <varlistentry>
 979   <term>Type of value:</term>
 980   <listitem>
 981    <para><emphasis>None</emphasis></para>
 982   </listitem>
 983  </varlistentry>
 984  <varlistentry>
 985   <term>Default value:</term>
 986   <listitem>
 987    <para><emphasis>Unset</emphasis></para>
 988   </listitem>
 989  </varlistentry>
 990  <varlistentry>
 991   <term>Effect if unset:</term>
 992   <listitem>
 993    <para>
 994     Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
 995     serve multiple requests simultaneously.
 996    </para>
 997   </listitem>
 998  </varlistentry>
 999  <varlistentry>
1000   <term>Notes:</term>
1001   <listitem>
1002    <para>
1003     This option is only there for debug purposes and you should never
1004     need to use it. <emphasis>It will drastically reduce performance.</emphasis>
1005    </para>
1006   </listitem>
1007  </varlistentry>
1008 </variablelist>
1009
1010 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1011 </sect3>
1012
1013 </sect2>
1014
1015 <!--  ~  End section  ~  -->
1016
1017
1018 <!--   ~~~~~       New section      ~~~~~     -->
1019 <sect2 id="access-control">
1020 <title>Access Control and Security</title>
1021
1022  <para>
1023   This section of the config file controls the security-relevant aspects
1024   of <application>Privoxy</application>'s configuration.
1025  </para>
1026
1027
1028 <!--   ~~~~~       New section      ~~~~~     -->
1029 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1030
1031 <variablelist>
1032  <varlistentry>
1033   <term>Specifies:</term>
1034   <listitem>
1035    <para>
1036     The IP address and TCP port on which <application>Privoxy</application> will
1037     listen for client requests.
1038    </para>
1039   </listitem>
1040  </varlistentry>
1041  <varlistentry>
1042   <term>Type of value:</term>
1043   <listitem>
1044    <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1045   </listitem>
1046  </varlistentry>
1047
1048  <varlistentry>
1049   <term>Default value:</term>
1050   <listitem>
1051    <para>127.0.0.1:8118</para>
1052   </listitem>
1053  </varlistentry>
1054  <varlistentry>
1055   <term>Effect if unset:</term>
1056   <listitem>
1057    <para>
1058     Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1059     home users who run <application>Privoxy</application> on the same machine as
1060     their browser.
1061    </para>
1062   </listitem>
1063  </varlistentry>
1064  <varlistentry>
1065   <term>Notes:</term>
1066   <listitem>
1067    <para>
1068     You will need to configure your browser(s) to this proxy address and port.
1069    </para>
1070    <para>
1071     If you already have another service running on port 8118, or if you want to
1072     serve requests from other machines (e.g. on your local network) as well, you
1073     will need to override the default.
1074    </para>
1075    <para>
1076     If you leave out the IP address, <application>Privoxy</application> will
1077     bind to all interfaces (addresses) on your machine and may become reachable
1078     from the Internet. In that case, consider using <link
1079     linkend="acls">access control lists</link> (ACL's, see below), and/or
1080     a firewall.
1081    </para>
1082    <para>
1083     If you open <application>Privoxy</application> to untrusted users, you will
1084     also want to turn off the <literal><link
1085     linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1086     <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1087     options!
1088    </para>
1089   </listitem>
1090  </varlistentry>
1091  <varlistentry>
1092   <term>Example:</term>
1093   <listitem>
1094    <para>
1095      Suppose you are running <application>Privoxy</application> on
1096      a machine which has the address 192.168.0.1 on your local private network
1097      (192.168.0.0) and has another outside connection with a different address.
1098      You want it to serve requests from inside only:
1099    </para>
1100    <para>
1101     <programlisting>
1102   listen-address  192.168.0.1:8118
1103 </programlisting>
1104    </para>
1105   </listitem>
1106  </varlistentry>
1107 </variablelist>
1108
1109 <![%config-file;[<literallayout>@@listen-address  127.0.0.1:8118</literallayout>]]>
1110 </sect3>
1111
1112
1113 <!--   ~~~~~       New section      ~~~~~     -->
1114 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1115
1116 <variablelist>
1117  <varlistentry>
1118   <term>Specifies:</term>
1119   <listitem>
1120    <para>
1121     Initial state of "toggle" status
1122    </para>
1123   </listitem>
1124  </varlistentry>
1125  <varlistentry>
1126   <term>Type of value:</term>
1127   <listitem>
1128    <para>1 or 0</para>
1129   </listitem>
1130  </varlistentry>
1131  <varlistentry>
1132   <term>Default value:</term>
1133   <listitem>
1134    <para>1</para>
1135   </listitem>
1136  </varlistentry>
1137  <varlistentry>
1138   <term>Effect if unset:</term>
1139   <listitem>
1140    <para>
1141     Act as if toggled on
1142    </para>
1143   </listitem>
1144  </varlistentry>
1145  <varlistentry>
1146   <term>Notes:</term>
1147   <listitem>
1148    <para>
1149     If set to 0, <application>Privoxy</application> will start in
1150     <quote>toggled off</quote> mode, i.e. behave like a normal, content-neutral
1151     proxy where all ad blocking, filtering, etc are disabled. See
1152     <literal>enable-remote-toggle</literal> below. This is not really useful
1153     anymore, since toggling is much easier via <ulink
1154     url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1155     editing the <filename>conf</filename> file.
1156    </para>
1157    <para>
1158     The windows version will only display the toggle icon in the system tray
1159     if this option is present.
1160    </para>
1161   </listitem>
1162  </varlistentry>
1163 </variablelist>
1164
1165 <![%config-file;[<literallayout>@@toggle  1</literallayout>]]>
1166 </sect3>
1167
1168
1169 <!--   ~~~~~       New section      ~~~~~     -->
1170 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1171 <variablelist>
1172  <varlistentry>
1173   <term>Specifies:</term>
1174   <listitem>
1175    <para>
1176     Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1177     feature</ulink> may be used
1178    </para>
1179   </listitem>
1180  </varlistentry>
1181  <varlistentry>
1182   <term>Type of value:</term>
1183   <listitem>
1184    <para>0 or 1</para>
1185   </listitem>
1186  </varlistentry>
1187  <varlistentry>
1188   <term>Default value:</term>
1189   <listitem>
1190    <para>1</para>
1191   </listitem>
1192  </varlistentry>
1193  <varlistentry>
1194   <term>Effect if unset:</term>
1195   <listitem>
1196    <para>
1197     The web-based toggle feature is disabled.
1198    </para>
1199   </listitem>
1200  </varlistentry>
1201  <varlistentry>
1202   <term>Notes:</term>
1203   <listitem>
1204    <para>
1205     When toggled off, <application>Privoxy</application> acts like a normal,
1206     content-neutral proxy, i.e. it acts as if none of the actions applied to
1207     any URL.
1208    </para>
1209    <para>
1210     For the time being, access to the toggle feature can <emphasis>not</emphasis> be
1211     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1212     so that everybody who can access <application>Privoxy</application> (see
1213     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1214     toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1215     for multi-user environments with untrusted users.
1216    </para>
1217    <para>
1218     Note that you must have compiled <application>Privoxy</application> with
1219     support for this feature, otherwise this option has no effect.
1220    </para>
1221   </listitem>
1222  </varlistentry>
1223 </variablelist>
1224
1225 <![%config-file;[<literallayout>@@enable-remote-toggle  1</literallayout>]]>
1226 </sect3>
1227
1228
1229 <!--   ~~~~~       New section      ~~~~~     -->
1230 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1231 <variablelist>
1232  <varlistentry>
1233   <term>Specifies:</term>
1234   <listitem>
1235    <para>
1236     Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1237     file editor</ulink> may be used
1238    </para>
1239   </listitem>
1240  </varlistentry>
1241  <varlistentry>
1242   <term>Type of value:</term>
1243   <listitem>
1244    <para>0 or 1</para>
1245   </listitem>
1246  </varlistentry>
1247  <varlistentry>
1248   <term>Default value:</term>
1249   <listitem>
1250    <para>1</para>
1251   </listitem>
1252  </varlistentry>
1253  <varlistentry>
1254   <term>Effect if unset:</term>
1255   <listitem>
1256    <para>
1257     The web-based actions file editor is disabled.
1258    </para>
1259   </listitem>
1260  </varlistentry>
1261  <varlistentry>
1262   <term>Notes:</term>
1263   <listitem>
1264    <para>
1265     For the time being, access to the editor can <emphasis>not</emphasis> be
1266     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1267     so that everybody who can access <application>Privoxy</application> (see
1268     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1269     modify its configuration for all users. So this option is <emphasis>not
1270     recommended</emphasis> for multi-user environments with untrusted users.
1271    </para>
1272    <para>
1273     Note that you must have compiled <application>Privoxy</application> with
1274     support for this feature, otherwise this option has no effect.
1275    </para>
1276   </listitem>
1277  </varlistentry>
1278 </variablelist>
1279
1280 <![%config-file;[<literallayout>@@enable-edit-actions 1</literallayout>]]>
1281 </sect3>
1282
1283 <!--   ~~~~~       New section      ~~~~~     -->
1284 <sect3 renderas="sect4" id="acls"><title>
1285 ACLs: permit-access and deny-access</title>
1286 <anchor id="permit-access">
1287 <anchor id="deny-access">
1288
1289 <variablelist>
1290  <varlistentry>
1291   <term>Specifies:</term>
1292   <listitem>
1293    <para>
1294     Who can access what.
1295    </para>
1296   </listitem>
1297  </varlistentry>
1298  <varlistentry>
1299   <term>Type of value:</term>
1300   <listitem>
1301    <para>
1302     <replaceable class="parameter">src_addr</replaceable>[/<replaceable class="parameter">src_masklen</replaceable>]
1303     [<replaceable class="parameter">dst_addr</replaceable>[/<replaceable class="parameter">dst_masklen</replaceable>]]
1304    </para>
1305    <para>
1306     Where <replaceable class="parameter">src_addr</replaceable> and
1307    <replaceable class="parameter">dst_addr</replaceable> are IP addresses in dotted decimal notation or valid
1308     DNS names, and <replaceable class="parameter">src_masklen</replaceable> and
1309     <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1310     values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1311     destination part are optional.
1312    </para>
1313   </listitem>
1314  </varlistentry>
1315  <varlistentry>
1316   <term>Default value:</term>
1317   <listitem>
1318    <para><emphasis>Unset</emphasis></para>
1319   </listitem>
1320  </varlistentry>
1321  <varlistentry>
1322   <term>Effect if unset:</term>
1323   <listitem>
1324    <para>
1325     Don't restrict access further than implied by <literal>listen-address</literal>
1326    </para>
1327   </listitem>
1328  </varlistentry>
1329  <varlistentry>
1330   <term>Notes:</term>
1331   <listitem>
1332    <para>
1333     Access controls are included at the request of ISPs and systems
1334     administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1335     For a typical home user, it will normally suffice to ensure that
1336     <application>Privoxy</application> only listens on the localhost
1337     (127.0.0.1) or internal (home) network address by means of the
1338     <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1339     option.
1340    </para>
1341    <para>
1342     Please see the warnings in the FAQ that this proxy is not intended to be a substitute
1343     for a firewall or to encourage anyone to defer addressing basic security
1344     weaknesses.
1345    </para>
1346    <para>
1347     Multiple ACL lines are OK.
1348     If any ACLs are specified, then the <application>Privoxy</application>
1349     talks only to IP addresses that match at least one <literal>permit-access</literal> line
1350     and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1351     last match wins, with the default being <literal>deny-access</literal>.
1352    </para>
1353    <para>
1354     If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1355     for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1356     that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1357     of the ultimate target. This is necessary because it may be impossible for the local
1358     <application>Privoxy</application> to determine the IP address of the
1359     ultimate target (that's often what gateways are used for).
1360    </para>
1361    <para>
1362     You should prefer using IP addresses over DNS names, because the address lookups take
1363     time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1364     like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1365     IP addresses, only the first one is used.
1366    </para>
1367    <para>
1368     Denying access to particular sites by ACL may have undesired side effects
1369     if the site in question is hosted on a machine which also hosts other sites.
1370    </para>
1371   </listitem>
1372  </varlistentry>
1373  <varlistentry>
1374   <term>Examples:</term>
1375   <listitem>
1376    <para>
1377     Explicitly define the default behavior if no ACL and
1378     <literal>listen-address</literal> are set: <quote>localhost</quote>
1379     is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1380     <emphasis>all</emphasis> destination addresses are OK:
1381    </para>
1382    <para>
1383     <screen>
1384   permit-access  localhost
1385 </screen>
1386    </para>
1387    <para>
1388     Allow any host on the same class C subnet as www.privoxy.org access to
1389     nothing but www.example.com:
1390    </para>
1391    <para>
1392     <screen>
1393   permit-access  www.privoxy.org/24 www.example.com/32
1394 </screen>
1395    </para>
1396    <para>
1397     Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1398     with the exception that 192.168.45.73 may not access www.dirty-stuff.example.com:
1399    </para>
1400    <para>
1401     <screen>
1402   permit-access  192.168.45.64/26
1403   deny-access    192.168.45.73    www.dirty-stuff.example.com
1404 </screen>
1405    </para>
1406   </listitem>
1407  </varlistentry>
1408 </variablelist>
1409 </sect3>
1410
1411
1412 <!--   ~~~~~       New section      ~~~~~     -->
1413 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1414
1415 <variablelist>
1416  <varlistentry>
1417   <term>Specifies:</term>
1418   <listitem>
1419    <para>
1420     Maximum size of the buffer for content filtering.
1421    </para>
1422   </listitem>
1423  </varlistentry>
1424  <varlistentry>
1425   <term>Type of value:</term>
1426   <listitem>
1427    <para>Size in Kbytes</para>
1428   </listitem>
1429  </varlistentry>
1430  <varlistentry>
1431   <term>Default value:</term>
1432   <listitem>
1433    <para>4096</para>
1434   </listitem>
1435  </varlistentry>
1436  <varlistentry>
1437   <term>Effect if unset:</term>
1438   <listitem>
1439    <para>
1440     Use a 4MB (4096 KB) limit.
1441    </para>
1442   </listitem>
1443  </varlistentry>
1444  <varlistentry>
1445   <term>Notes:</term>
1446   <listitem>
1447    <para>
1448     For content filtering, i.e. the <literal>+filter</literal> and
1449     <literal>+deanimate-gif</literal> actions, it is necessary that
1450     <application>Privoxy</application> buffers the entire document body.
1451     This can be potentially dangerous, since a server could just keep sending
1452     data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1453     Hence this option.
1454    </para>
1455    <para>
1456     When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1457     flushed to the client unfiltered and no further attempt to
1458     filter the rest of the document is made. Remember that there may be multiple threads
1459     running, which might require up to <literal>buffer-limit</literal> Kbytes
1460     <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1461     above.
1462    </para>
1463   </listitem>
1464  </varlistentry>
1465 </variablelist>
1466
1467 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1468 </sect3>
1469
1470 </sect2>
1471
1472 <!--  ~  End section  ~  -->
1473
1474
1475 <!--   ~~~~~       New section      ~~~~~     -->
1476
1477 <sect2 id="forwarding">
1478 <title>Forwarding</title>
1479
1480 <para>
1481  This feature allows routing of HTTP requests through a chain of
1482  multiple proxies.
1483  It can be used to better protect privacy and confidentiality when
1484  accessing specific domains by routing requests to those domains
1485  through an anonymous public proxy (see e.g. <ulink
1486  url="http://www.multiproxy.org/anon_list.htm">http://www.multiproxy.org/anon_list.htm</ulink>)
1487  Or to use a caching proxy to speed up browsing. Or chaining to a parent
1488  proxy may be necessary because the machine that <application>Privoxy</application>
1489  runs on has no direct Internet access.
1490 </para>
1491
1492 <para>
1493  Also specified here are SOCKS proxies. <application>Privoxy</application>
1494  supports the SOCKS 4 and SOCKS 4A protocols.
1495 </para>
1496
1497 <sect3 renderas="sect4" id="forward"><title>forward</title>
1498 <variablelist>
1499  <varlistentry>
1500   <term>Specifies:</term>
1501   <listitem>
1502    <para>
1503     To which parent HTTP proxy specific requests should be routed.
1504    </para>
1505   </listitem>
1506  </varlistentry>
1507  <varlistentry>
1508   <term>Type of value:</term>
1509   <listitem>
1510    <para>
1511     <replaceable class="parameter">target_pattern</replaceable>
1512     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1513    </para>
1514    <para>
1515     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1516     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1517     denote <quote>all URLs</quote>.
1518     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1519     is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1520     optionally followed by its listening port (default: 8080).
1521     Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1522    </para>
1523   </listitem>
1524  </varlistentry>
1525  <varlistentry>
1526   <term>Default value:</term>
1527   <listitem>
1528    <para><emphasis>Unset</emphasis></para>
1529   </listitem>
1530  </varlistentry>
1531  <varlistentry>
1532   <term>Effect if unset:</term>
1533   <listitem>
1534    <para>
1535     Don't use parent HTTP proxies.
1536    </para>
1537   </listitem>
1538  </varlistentry>
1539  <varlistentry>
1540   <term>Notes:</term>
1541   <listitem>
1542    <para>
1543     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1544     forwarded to another HTTP proxy but are made directly to the web servers.
1545    </para>
1546    <para>
1547     Multiple lines are OK, they are checked in sequence, and the last match wins.
1548    </para>
1549   </listitem>
1550  </varlistentry>
1551  <varlistentry>
1552   <term>Examples:</term>
1553   <listitem>
1554    <para>
1555     Everything goes to an example anonymizing proxy, except SSL on port 443 (which it doesn't handle):
1556    </para>
1557    <para>
1558     <screen>
1559   forward   /      anon-proxy.example.org:8080
1560   forward   :443   .
1561 </screen>
1562    </para>
1563    <para>
1564     Everything goes to our example ISP's caching proxy, except for requests
1565     to that ISP's sites:
1566    </para>
1567    <para>
1568     <screen>
1569   forward   /                  caching-proxy.example-isp.net:8000
1570   forward   .example-isp.net   .
1571 </screen>
1572    </para>
1573   </listitem>
1574  </varlistentry>
1575 </variablelist>
1576 </sect3>
1577
1578
1579 <!--   ~~~~~       New section      ~~~~~     -->
1580 <sect3 renderas="sect4" id="socks"><title>
1581 forward-socks4 and forward-socks4a</title>
1582 <anchor id="forward-socks4">
1583 <anchor id="forward-socks4a">
1584
1585 <variablelist>
1586  <varlistentry>
1587   <term>Specifies:</term>
1588   <listitem>
1589    <para>
1590     Through which SOCKS proxy (and to which parent HTTP proxy) specific requests should be routed.
1591    </para>
1592   </listitem>
1593  </varlistentry>
1594  <varlistentry>
1595   <term>Type of value:</term>
1596   <listitem>
1597    <para>
1598     <replaceable class="parameter">target_pattern</replaceable>
1599     <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
1600     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1601    </para>
1602    <para>
1603     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1604     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1605     denote <quote>all URLs</quote>.
1606     <replaceable class="parameter">http_parent</replaceable> and <replaceable class="parameter">socks_proxy</replaceable>
1607     are IP addresses in dotted decimal notation or valid DNS names (<replaceable class="parameter">http_parent</replaceable>
1608     may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
1609     <replaceable class="parameter">port</replaceable> parameters are TCP ports, i.e. integer values from 1 to 64535
1610    </para>
1611   </listitem>
1612  </varlistentry>
1613  <varlistentry>
1614   <term>Default value:</term>
1615   <listitem>
1616    <para><emphasis>Unset</emphasis></para>
1617   </listitem>
1618  </varlistentry>
1619  <varlistentry>
1620   <term>Effect if unset:</term>
1621   <listitem>
1622    <para>
1623     Don't use SOCKS proxies.
1624    </para>
1625   </listitem>
1626  </varlistentry>
1627  <varlistentry>
1628   <term>Notes:</term>
1629   <listitem>
1630    <para>
1631     Multiple lines are OK, they are checked in sequence, and the last match wins.
1632    </para>
1633    <para>
1634     The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
1635     is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
1636     server, while in SOCKS 4 it happens locally.
1637    </para>
1638    <para>
1639     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1640     forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
1641     a SOCKS proxy.
1642    </para>
1643   </listitem>
1644  </varlistentry>
1645  <varlistentry>
1646   <term>Examples:</term>
1647   <listitem>
1648    <para>
1649      From the company example.com, direct connections are made to all
1650      <quote>internal</quote> domains, but everything outbound goes through
1651      their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
1652      the Internet.
1653    </para>
1654    <para>
1655     <screen>
1656   forward-socks4a   /              socks-gw.example.com:1080  www-cache.example-isp.net:8080
1657   forward           .example.com   .
1658 </screen>
1659    </para>
1660    <para>
1661     A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
1662    </para>
1663    <para>
1664     <screen>
1665   forward-socks4   /               socks-gw.example.com:1080  .
1666 </screen>
1667    </para>
1668   </listitem>
1669  </varlistentry>
1670 </variablelist>
1671 </sect3>
1672
1673 <![%user-man;[     <!-- not included in config due to length -->
1674 <!--   ~~~~~       New section      ~~~~~     -->
1675 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
1676
1677 <para>
1678  If you have links to multiple ISPs that provide various special content
1679  only to their subscribers, you can configure multiple <application>Privoxies</application>
1680  which have connections to the respective ISPs to act as forwarders to each other, so that
1681  <emphasis>your</emphasis> users can see the internal content of all ISPs.
1682 </para>
1683
1684 <para>
1685  Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to
1686  isp-b.net. Both run <application>Privoxy</application>. Their forwarding
1687  configuration can look like this:
1688 </para>
1689
1690 <para>
1691  host-a:
1692 </para>
1693
1694 <para>
1695  <screen>
1696   forward    /           .
1697   forward    .isp-b.net  host-b:8118
1698 </screen>
1699 </para>
1700
1701 <para>
1702  host-b:
1703 </para>
1704
1705 <para>
1706  <screen>
1707   forward    /           .
1708   forward    .isp-a.net  host-a:8118
1709 </screen>
1710 </para>
1711
1712 <para>
1713  Now, your users can set their browser's proxy to use either
1714  host-a or host-b and be able to browse the internal content
1715  of both isp-a and isp-b.
1716 </para>
1717
1718 <para>
1719  If you intend to chain <application>Privoxy</application> and
1720  <application>squid</application> locally, then chain as
1721  <literal>browser -> squid -> privoxy</literal> is the recommended way.
1722 </para>
1723
1724 <para>
1725  Assuming that <application>Privoxy</application> and <application>squid</application>
1726  run on the same box, your <application>squid</application> configuration could then look like this:
1727 </para>
1728
1729 <para>
1730  <screen>
1731   # Define Privoxy as parent proxy (without ICP)
1732   cache_peer 127.0.0.1 parent 8118 7 no-query
1733
1734   # Define ACL for protocol FTP
1735   acl ftp proto FTP
1736
1737   # Do not forward FTP requests to Privoxy
1738   always_direct allow ftp
1739
1740   # Forward all the rest to Privoxy
1741   never_direct allow all</screen>
1742 </para>
1743
1744 <para>
1745  You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
1746  Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
1747 </para>
1748
1749 <para>
1750  You could just as well decide to only forward requests for Windows executables through
1751  a virus-scanning parent proxy, say, on <literal>antivir.example.com</literal>, port 8010:
1752 </para>
1753
1754 <para>
1755  <screen>
1756   forward   /                          .
1757   forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010</screen>
1758 </para>
1759
1760 </sect3>
1761 ]]>
1762
1763 </sect2>
1764
1765 <!--  ~  End section  ~  -->
1766
1767
1768 <!--   ~~~~~       New section      ~~~~~     -->
1769
1770 <sect2 id="windows-gui">
1771 <title>Windows GUI Options</title>
1772 <para>
1773  <application>Privoxy</application> has a number of options specific to the
1774  Windows GUI interface:
1775 </para>
1776
1777 <anchor id="activity-animation">
1778 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1779 <para>
1780  If <quote>activity-animation</quote> is set to 1, the
1781  <application>Privoxy</application> icon will animate when
1782  <quote>Privoxy</quote> is active. To turn off, set to 0.
1783 </para>
1784
1785 <![%config-file;[<literallayout>@@#activity-animation   1</literallayout>]]>
1786 <![%user-man;[
1787 <para>
1788  <literal>
1789   <msgtext>
1790    <literallayout>
1791   <emphasis>activity-animation   1</emphasis>
1792    </literallayout>
1793   </msgtext>
1794  </literal>
1795 </para>
1796 ]]>
1797
1798 <anchor id="log-messages">
1799 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1800 <para>
1801  If <quote>log-messages</quote> is set to 1,
1802  <application>Privoxy</application> will log messages to the console
1803  window:
1804 </para>
1805
1806 <![%config-file;[<literallayout>@@#log-messages   1</literallayout>]]>
1807 <![%user-man;[
1808 <para>
1809  <literal>
1810   <msgtext>
1811    <literallayout>
1812   <emphasis>log-messages       1</emphasis>
1813    </literallayout>
1814   </msgtext>
1815  </literal>
1816 </para>
1817 ]]>
1818
1819 <anchor id="log-buffer-size">
1820 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1821 <para>
1822  If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1823  i.e. the amount of memory used for the log messages displayed in the
1824  console window, will be limited to <quote>log-max-lines</quote> (see below).
1825 </para>
1826
1827 <para>
1828  Warning: Setting this to 0 will result in the buffer to grow infinitely and
1829  eat up all your memory!
1830 </para>
1831
1832 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
1833 <![%user-man;[
1834 <para>
1835  <literal>
1836   <msgtext>
1837    <literallayout>
1838   <emphasis>log-buffer-size      1</emphasis>
1839    </literallayout>
1840   </msgtext>
1841  </literal>
1842 </para>
1843 ]]>
1844
1845 <anchor id="log-max-lines">
1846 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1847 <para>
1848  <application>log-max-lines</application> is the maximum number of lines held
1849  in the log buffer. See above.
1850 </para>
1851
1852 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
1853 <![%user-man;[
1854 <para>
1855  <literal>
1856   <msgtext>
1857    <literallayout>
1858   <emphasis>log-max-lines      200</emphasis>
1859    </literallayout>
1860   </msgtext>
1861  </literal>
1862 </para>
1863 ]]>
1864
1865 <anchor id="log-highlight-messages">
1866 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1867 <para>
1868  If <quote>log-highlight-messages</quote> is set to 1,
1869  <application>Privoxy</application> will highlight portions of the log
1870  messages with a bold-faced font:
1871 </para>
1872
1873 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
1874 <![%user-man;[
1875 <para>
1876  <literal>
1877   <msgtext>
1878    <literallayout>
1879   <emphasis>log-highlight-messages   1</emphasis>
1880    </literallayout>
1881   </msgtext>
1882  </literal>
1883 </para>
1884 ]]>
1885
1886 <anchor id="log-font-name">
1887 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1888 <para>
1889  The font used in the console window:
1890 </para>
1891
1892 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
1893 <![%user-man;[
1894 <para>
1895  <literal>
1896   <msgtext>
1897    <literallayout>
1898   <emphasis>log-font-name        Comic Sans MS</emphasis>
1899    </literallayout>
1900   </msgtext>
1901  </literal>
1902 </para>
1903 ]]>
1904
1905 <anchor id="log-font-size">
1906 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1907 <para>
1908  Font size used in the console window:
1909 </para>
1910
1911 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
1912 <![%user-man;[
1913 <para>
1914  <literal>
1915   <msgtext>
1916    <literallayout>
1917   <emphasis>log-font-size        8</emphasis>
1918    </literallayout>
1919   </msgtext>
1920  </literal>
1921 </para>
1922 ]]>
1923
1924 <anchor id="show-on-task-bar">
1925 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1926 <para>
1927  <quote>show-on-task-bar</quote> controls whether or not
1928  <application>Privoxy</application> will appear as a button on the Task bar
1929  when minimized:
1930 </para>
1931
1932 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
1933 <![%user-man;[
1934 <para>
1935  <literal>
1936   <msgtext>
1937    <literallayout>
1938   <emphasis>show-on-task-bar     0</emphasis>
1939    </literallayout>
1940   </msgtext>
1941  </literal>
1942 </para>
1943 ]]>
1944
1945 <anchor id="close-button-minimizes">
1946 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1947 <para>
1948  If <quote>close-button-minimizes</quote> is set to 1, the Windows close
1949  button will minimize <application>Privoxy</application> instead of closing
1950  the program (close with the exit option on the File menu).
1951 </para>
1952
1953 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
1954 <![%user-man;[
1955 <para>
1956  <literal>
1957   <msgtext>
1958    <literallayout>
1959   <emphasis>close-button-minimizes  1</emphasis>
1960    </literallayout>
1961   </msgtext>
1962  </literal>
1963 </para>
1964 ]]>
1965
1966 <anchor id="hide-console">
1967 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
1968 <para>
1969  The <quote>hide-console</quote> option is specific to the MS-Win console
1970  version of <application>Privoxy</application>. If this option is used,
1971  <application>Privoxy</application> will disconnect from and hide  the
1972  command console.
1973 </para>
1974
1975 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
1976 <![%user-man;[
1977 <para>
1978  <literal>
1979   <msgtext>
1980    <literallayout>
1981   #<emphasis>hide-console</emphasis>
1982    </literallayout>
1983   </msgtext>
1984  </literal>
1985 </para>
1986 ]]>
1987
1988 </sect2>
1989 </sect1>
1990
1991 <!-- end config content common to both outputs -->
1992
1993 <![%config-file;[
1994 <!-- These are dummy anchors to keep the processor quiet            -->
1995 <!-- when building config-file only (ie. they are used in u-m only) -->
1996 <sect1 label="">
1997 <title></title>
1998 <anchor id="filter">
1999 <anchor id="filter-file">
2000 <anchor id="regex">
2001 <anchor id="actions-file">
2002 <anchor id="af-patterns">
2003 </sect1>
2004 ]]>
2005
2006 <!-- eof p-config.sgml -->