doc/webserver/user-manual/configuration.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2 "http://www.w3.org/TR/html4/loose.dtd">
   3
   4 <html>
   5 <head>
   6   <title>Privoxy Configuration</title>
   7   <meta name="GENERATOR" content=
   8   "Modular DocBook HTML Stylesheet Version 1.79">
   9   <link rel="HOME" title="Privoxy 3.0.25 User Manual" href="index.html">
  10   <link rel="PREVIOUS" title="Starting Privoxy" href="startup.html">
  11   <link rel="NEXT" title="The Main Configuration File" href="config.html">
  12   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
  13   <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  14   <link rel="STYLESHEET" type="text/css" href="p_doc.css">
  15 </head>
  16
  17 <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
  18 "#840084" alink="#0000FF">
  19   <div class="NAVHEADER">
  20     <table summary="Header navigation table" width="100%" border="0"
  21     cellpadding="0" cellspacing="0">
  22       <tr>
  23         <th colspan="3" align="center">Privoxy 3.0.25 User Manual</th>
  24       </tr>
  25
  26       <tr>
  27         <td width="10%" align="left" valign="bottom"><a href="startup.html"
  28         accesskey="P">Prev</a></td>
  29
  30         <td width="80%" align="center" valign="bottom"></td>
  31
  32         <td width="10%" align="right" valign="bottom"><a href="config.html"
  33         accesskey="N">Next</a></td>
  34       </tr>
  35     </table>
  36     <hr align="left" width="100%">
  37   </div>
  38
  39   <div class="SECT1">
  40     <h1 class="SECT1"><a name="CONFIGURATION" id="CONFIGURATION">6. Privoxy
  41     Configuration</a></h1>
  42
  43     <p>All <span class="APPLICATION">Privoxy</span> configuration is stored
  44     in text files. These files can be edited with a text editor. Many
  45     important aspects of <span class="APPLICATION">Privoxy</span> can also be
  46     controlled easily with a web browser.</p>
  47
  48     <div class="SECT2">
  49       <h2 class="SECT2"><a name="CONTROL-WITH-WEBBROWSER" id=
  50       "CONTROL-WITH-WEBBROWSER">6.1. Controlling Privoxy with Your Web
  51       Browser</a></h2>
  52
  53       <p><span class="APPLICATION">Privoxy</span>'s user interface can be
  54       reached through the special URL <a href="http://config.privoxy.org/"
  55       target="_top">http://config.privoxy.org/</a> (shortcut: <a href=
  56       "http://p.p/" target="_top">http://p.p/</a>), which is a built-in page
  57       and works without Internet access. You will see the following
  58       section:</p>
  59
  60       <table border="0" bgcolor="#E0E0E0" width="100%">
  61         <tr>
  62           <td>
  63             <pre class="SCREEN">
  64
  65 </pre>
  66
  67             <h2 class="BRIDGEHEAD"><a name="AEN821" id=
  68             "AEN821"></a>&nbsp;&nbsp;&nbsp;&nbsp;Privoxy Menu</h2>
  69             <pre>
  70 </pre>
  71
  72             <table border="0">
  73               <tbody>
  74                 <tr>
  75                   <td>
  76                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9642;&nbsp;&nbsp;<a href="http://config.privoxy.org/show-status"
  77                   target="_top">View &amp; change the current
  78                   configuration</a></td>
  79                 </tr>
  80
  81                 <tr>
  82                   <td>
  83                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9642;&nbsp;&nbsp;<a href="http://config.privoxy.org/show-version"
  84                   target="_top">View the source code version numbers</a></td>
  85                 </tr>
  86
  87                 <tr>
  88                   <td>
  89                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9642;&nbsp;&nbsp;<a href="http://config.privoxy.org/show-request"
  90                   target="_top">View the request headers.</a></td>
  91                 </tr>
  92
  93                 <tr>
  94                   <td>
  95                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9642;&nbsp;&nbsp;<a href="http://config.privoxy.org/show-url-info"
  96                   target="_top">Look up which actions apply to a URL and
  97                   why</a></td>
  98                 </tr>
  99
 100                 <tr>
 101                   <td>
 102                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9642;&nbsp;&nbsp;<a href="http://config.privoxy.org/toggle"
 103                   target="_top">Toggle Privoxy on or off</a></td>
 104                 </tr>
 105
 106                 <tr>
 107                   <td>
 108                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9642;&nbsp;&nbsp;<a href="https://www.privoxy.org/3.0.25/user-manual/"
 109                   target="_top">Documentation</a></td>
 110                 </tr>
 111               </tbody>
 112             </table>
 113           </td>
 114         </tr>
 115       </table>
 116
 117       <p>This should be self-explanatory. Note the first item leads to an
 118       editor for the <a href="actions-file.html">actions files</a>, which is
 119       where the ad, banner, cookie, and URL blocking magic is configured as
 120       well as other advanced features of <span class=
 121       "APPLICATION">Privoxy</span>. This is an easy way to adjust various
 122       aspects of <span class="APPLICATION">Privoxy</span> configuration. The
 123       actions file, and other configuration files, are explained in detail
 124       below.</p>
 125
 126       <p><span class="QUOTE">"Toggle Privoxy On or Off"</span> is handy for
 127       sites that might have problems with your current actions and filters.
 128       You can in fact use it as a test to see whether it is <span class=
 129       "APPLICATION">Privoxy</span> causing the problem or not. <span class=
 130       "APPLICATION">Privoxy</span> continues to run as a proxy in this case,
 131       but all manipulation is disabled, i.e. <span class=
 132       "APPLICATION">Privoxy</span> acts like a normal forwarding proxy.</p>
 133
 134       <p>Note that several of the features described above are disabled by
 135       default in <span class="APPLICATION">Privoxy</span> 3.0.7 beta and
 136       later. Check the <a href="config.html" target="_top">configuration
 137       file</a> to learn why and in which cases it's safe to enable them
 138       again.</p>
 139     </div>
 140
 141     <div class="SECT2">
 142       <h2 class="SECT2"><a name="CONFOVERVIEW" id="CONFOVERVIEW">6.2.
 143       Configuration Files Overview</a></h2>
 144
 145       <p>For Unix, *BSD and Linux, all configuration files are located in
 146       <tt class="FILENAME">/etc/privoxy/</tt> by default. For MS Windows,
 147       OS/2, and AmigaOS these are all in the same directory as the
 148       <span class="APPLICATION">Privoxy</span> executable. The name and
 149       number of configuration files has changed from previous versions, and
 150       is subject to change as development progresses.</p>
 151
 152       <p>The installed defaults provide a reasonable starting point, though
 153       some settings may be aggressive by some standards. For the time being,
 154       the principle configuration files are:</p>
 155
 156       <ul>
 157         <li>
 158           <p>The <a href="config.html">main configuration file</a> is named
 159           <tt class="FILENAME">config</tt> on Linux, Unix, BSD, OS/2, and
 160           AmigaOS and <tt class="FILENAME">config.txt</tt> on Windows. This
 161           is a required file.</p>
 162         </li>
 163
 164         <li>
 165           <p><tt class="FILENAME">match-all.action</tt> is used to define
 166           which <span class="QUOTE">"actions"</span> relating to
 167           banner-blocking, images, pop-ups, content modification, cookie
 168           handling etc should be applied by default. It should be the first
 169           actions file loaded.</p>
 170
 171           <p><tt class="FILENAME">default.action</tt> defines many exceptions
 172           (both positive and negative) from the default set of actions that's
 173           configured in <tt class="FILENAME">match-all.action</tt>. It should
 174           be the second actions file loaded and shouldn't be edited by the
 175           user.</p>
 176
 177           <p>Multiple actions files may be defined in <tt class=
 178           "FILENAME">config</tt>. These are processed in the order they are
 179           defined. Local customizations and locally preferred exceptions to
 180           the default policies as defined in <tt class=
 181           "FILENAME">match-all.action</tt> (which you will most probably want
 182           to define sooner or later) are best applied in <tt class=
 183           "FILENAME">user.action</tt>, where you can preserve them across
 184           upgrades. The file isn't installed by all installers, but you can
 185           easily create it yourself with a text editor.</p>
 186
 187           <p>There is also a web based editor that can be accessed from
 188           <a href="http://config.privoxy.org/show-status" target=
 189           "_top">http://config.privoxy.org/show-status</a> (Shortcut:
 190           <a href="http://p.p/show-status" target=
 191           "_top">http://p.p/show-status</a>) for the various actions
 192           files.</p>
 193         </li>
 194
 195         <li>
 196           <p><span class="QUOTE">"Filter files"</span> (the <a href=
 197           "filter-file.html">filter file</a>) can be used to re-write the raw
 198           page content, including viewable text as well as embedded HTML and
 199           JavaScript, and whatever else lurks on any given web page. The
 200           filtering jobs are only pre-defined here; whether to apply them or
 201           not is up to the actions files. <tt class=
 202           "FILENAME">default.filter</tt> includes various filters made
 203           available for use by the developers. Some are much more intrusive
 204           than others, and all should be used with caution. You may define
 205           additional filter files in <tt class="FILENAME">config</tt> as you
 206           can with actions files. We suggest <tt class=
 207           "FILENAME">user.filter</tt> for any locally defined filters or
 208           customizations.</p>
 209         </li>
 210       </ul>
 211
 212       <p>The syntax of the configuration and filter files may change between
 213       different Privoxy versions, unfortunately some enhancements cost
 214       backwards compatibility.</p>
 215
 216       <p>All files use the <span class="QUOTE">"<tt class=
 217       "LITERAL">#</tt>"</span> character to denote a comment (the rest of the
 218       line will be ignored) and understand line continuation through placing
 219       a backslash ("<tt class="LITERAL">\</tt>") as the very last character
 220       in a line. If the <tt class="LITERAL">#</tt> is preceded by a
 221       backslash, it looses its special function. Placing a <tt class=
 222       "LITERAL">#</tt> in front of an otherwise valid configuration line to
 223       prevent it from being interpreted is called "commenting out" that line.
 224       Blank lines are ignored.</p>
 225
 226       <p>The actions files and filter files can use Perl style <a href=
 227       "appendix.html#REGEX">regular expressions</a> for maximum
 228       flexibility.</p>
 229
 230       <p>After making any changes, there is no need to restart <span class=
 231       "APPLICATION">Privoxy</span> in order for the changes to take effect.
 232       <span class="APPLICATION">Privoxy</span> detects such changes
 233       automatically. Note, however, that it may take one or two additional
 234       requests for the change to take effect. When changing the listening
 235       address of <span class="APPLICATION">Privoxy</span>, these <span class=
 236       "QUOTE">"wake up"</span> requests must obviously be sent to the
 237       <span class="emphasis"><i class="EMPHASIS">old</i></span> listening
 238       address.</p>
 239
 240       <p>While under development, the configuration content is subject to
 241       change. The below documentation may not be accurate by the time you
 242       read this. Also, what constitutes a <span class=
 243       "QUOTE">"default"</span> setting, may change, so please check all your
 244       configuration files on important issues.</p>
 245     </div>
 246   </div>
 247
 248   <div class="NAVFOOTER">
 249     <hr align="left" width="100%">
 250
 251     <table summary="Footer navigation table" width="100%" border="0"
 252     cellpadding="0" cellspacing="0">
 253       <tr>
 254         <td width="33%" align="left" valign="top"><a href="startup.html"
 255         accesskey="P">Prev</a></td>
 256
 257         <td width="34%" align="center" valign="top"><a href="index.html"
 258         accesskey="H">Home</a></td>
 259
 260         <td width="33%" align="right" valign="top"><a href="config.html"
 261         accesskey="N">Next</a></td>
 262       </tr>
 263
 264       <tr>
 265         <td width="33%" align="left" valign="top">Starting Privoxy</td>
 266
 267         <td width="34%" align="center" valign="top">&nbsp;</td>
 268
 269         <td width="33%" align="right" valign="top">The Main Configuration
 270         File</td>
 271       </tr>
 272     </table>
 273   </div>
 274 </body>
 275 </html>