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.21 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.21 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="AEN1074" id="AEN1074">6.1. Controlling
  50       Privoxy with Your Web Browser</a></h2>
  51
  52       <p><span class="APPLICATION">Privoxy</span>'s user interface can be
  53       reached through the special URL <a href="http://config.privoxy.org/"
  54       target="_top">http://config.privoxy.org/</a> (shortcut: <a href=
  55       "http://p.p/" target="_top">http://p.p/</a>), which is a built-in page
  56       and works without Internet access. You will see the following
  57       section:</p>
  58
  59       <table border="0" bgcolor="#E0E0E0" width="100%">
  60         <tr>
  61           <td>
  62             <pre class="SCREEN">
  63
  64 </pre>
  65
  66             <h2 class="BRIDGEHEAD"><a name="AEN1082" id=
  67             "AEN1082"></a>&nbsp;&nbsp;&nbsp;&nbsp;Privoxy Menu</h2>
  68
  69             <table border="0">
  70               <tbody>
  71                 <tr>
  72                   <td>
  73                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9642;&nbsp;&nbsp;<a href="http://config.privoxy.org/show-status"
  74                   target="_top">View &amp; change the current
  75                   configuration</a></td>
  76                 </tr>
  77
  78                 <tr>
  79                   <td>
  80                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9642;&nbsp;&nbsp;<a href="http://config.privoxy.org/show-version"
  81                   target="_top">View the source code version numbers</a></td>
  82                 </tr>
  83
  84                 <tr>
  85                   <td>
  86                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9642;&nbsp;&nbsp;<a href="http://config.privoxy.org/show-request"
  87                   target="_top">View the request headers.</a></td>
  88                 </tr>
  89
  90                 <tr>
  91                   <td>
  92                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9642;&nbsp;&nbsp;<a href="http://config.privoxy.org/show-url-info"
  93                   target="_top">Look up which actions apply to a URL and
  94                   why</a></td>
  95                 </tr>
  96
  97                 <tr>
  98                   <td>
  99                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9642;&nbsp;&nbsp;<a href="http://config.privoxy.org/toggle"
 100                   target="_top">Toggle Privoxy on or off</a></td>
 101                 </tr>
 102
 103                 <tr>
 104                   <td>
 105                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#9642;&nbsp;&nbsp;<a href="http://www.privoxy.org/3.0.21/user-manual/"
 106                   target="_top">Documentation</a></td>
 107                 </tr>
 108               </tbody>
 109             </table>
 110           </td>
 111         </tr>
 112       </table>
 113
 114       <p>This should be self-explanatory. Note the first item leads to an
 115       editor for the <a href="actions-file.html">actions files</a>, which is
 116       where the ad, banner, cookie, and URL blocking magic is configured as
 117       well as other advanced features of <span class=
 118       "APPLICATION">Privoxy</span>. This is an easy way to adjust various
 119       aspects of <span class="APPLICATION">Privoxy</span> configuration. The
 120       actions file, and other configuration files, are explained in detail
 121       below.</p>
 122
 123       <p><span class="QUOTE">"Toggle Privoxy On or Off"</span> is handy for
 124       sites that might have problems with your current actions and filters.
 125       You can in fact use it as a test to see whether it is <span class=
 126       "APPLICATION">Privoxy</span> causing the problem or not. <span class=
 127       "APPLICATION">Privoxy</span> continues to run as a proxy in this case,
 128       but all manipulation is disabled, i.e. <span class=
 129       "APPLICATION">Privoxy</span> acts like a normal forwarding proxy. There
 130       is even a toggle <a href="appendix.html#BOOKMARKLETS">Bookmarklet</a>
 131       offered, so that you can toggle <span class=
 132       "APPLICATION">Privoxy</span> with one click from your browser.</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.</p>
 149
 150       <p>The installed defaults provide a reasonable starting point, though
 151       some settings may be aggressive by some standards. For the time being,
 152       the principle configuration files are:</p>
 153
 154       <ul>
 155         <li>
 156           <p>The <a href="config.html">main configuration file</a> is named
 157           <tt class="FILENAME">config</tt> on Linux, Unix, BSD, OS/2, and
 158           AmigaOS and <tt class="FILENAME">config.txt</tt> on Windows. This
 159           is a required file.</p>
 160         </li>
 161
 162         <li>
 163           <p><tt class="FILENAME">match-all.action</tt> is used to define
 164           which <span class="QUOTE">"actions"</span> relating to
 165           banner-blocking, images, pop-ups, content modification, cookie
 166           handling etc should be applied by default. It should be the first
 167           actions file loaded.</p>
 168
 169           <p><tt class="FILENAME">default.action</tt> defines many exceptions
 170           (both positive and negative) from the default set of actions that's
 171           configured in <tt class="FILENAME">match-all.action</tt>. It should
 172           be the second actions file loaded and shouldn't be edited by the
 173           user.</p>
 174
 175           <p>Multiple actions files may be defined in <tt class=
 176           "FILENAME">config</tt>. These are processed in the order they are
 177           defined. Local customizations and locally preferred exceptions to
 178           the default policies as defined in <tt class=
 179           "FILENAME">match-all.action</tt> (which you will most probably want
 180           to define sooner or later) are best applied in <tt class=
 181           "FILENAME">user.action</tt>, where you can preserve them across
 182           upgrades. The file isn't installed by all installers, but you can
 183           easily create it yourself with a text editor.</p>
 184
 185           <p>There is also a web based editor that can be accessed from
 186           <a href="http://config.privoxy.org/show-status" target=
 187           "_top">http://config.privoxy.org/show-status</a> (Shortcut:
 188           <a href="http://p.p/show-status" target=
 189           "_top">http://p.p/show-status</a>) for the various actions
 190           files.</p>
 191         </li>
 192
 193         <li>
 194           <p><span class="QUOTE">"Filter files"</span> (the <a href=
 195           "filter-file.html">filter file</a>) can be used to re-write the raw
 196           page content, including viewable text as well as embedded HTML and
 197           JavaScript, and whatever else lurks on any given web page. The
 198           filtering jobs are only pre-defined here; whether to apply them or
 199           not is up to the actions files. <tt class=
 200           "FILENAME">default.filter</tt> includes various filters made
 201           available for use by the developers. Some are much more intrusive
 202           than others, and all should be used with caution. You may define
 203           additional filter files in <tt class="FILENAME">config</tt> as you
 204           can with actions files. We suggest <tt class=
 205           "FILENAME">user.filter</tt> for any locally defined filters or
 206           customizations.</p>
 207         </li>
 208       </ul>
 209
 210       <p>The syntax of the configuration and filter files may change between
 211       different Privoxy versions, unfortunately some enhancements cost
 212       backwards compatibility.</p>
 213
 214       <p>All files use the <span class="QUOTE">"<tt class=
 215       "LITERAL">#</tt>"</span> character to denote a comment (the rest of the
 216       line will be ignored) and understand line continuation through placing
 217       a backslash ("<tt class="LITERAL">\</tt>") as the very last character
 218       in a line. If the <tt class="LITERAL">#</tt> is preceded by a
 219       backslash, it looses its special function. Placing a <tt class=
 220       "LITERAL">#</tt> in front of an otherwise valid configuration line to
 221       prevent it from being interpreted is called "commenting out" that line.
 222       Blank lines are ignored.</p>
 223
 224       <p>The actions files and filter files can use Perl style <a href=
 225       "appendix.html#REGEX">regular expressions</a> for maximum
 226       flexibility.</p>
 227
 228       <p>After making any changes, there is no need to restart <span class=
 229       "APPLICATION">Privoxy</span> in order for the changes to take effect.
 230       <span class="APPLICATION">Privoxy</span> detects such changes
 231       automatically. Note, however, that it may take one or two additional
 232       requests for the change to take effect. When changing the listening
 233       address of <span class="APPLICATION">Privoxy</span>, these <span class=
 234       "QUOTE">"wake up"</span> requests must obviously be sent to the
 235       <span class="emphasis"><i class="EMPHASIS">old</i></span> listening
 236       address.</p>
 237     </div>
 238   </div>
 239
 240   <div class="NAVFOOTER">
 241     <hr align="left" width="100%">
 242
 243     <table summary="Footer navigation table" width="100%" border="0"
 244     cellpadding="0" cellspacing="0">
 245       <tr>
 246         <td width="33%" align="left" valign="top"><a href="startup.html"
 247         accesskey="P">Prev</a></td>
 248
 249         <td width="34%" align="center" valign="top"><a href="index.html"
 250         accesskey="H">Home</a></td>
 251
 252         <td width="33%" align="right" valign="top"><a href="config.html"
 253         accesskey="N">Next</a></td>
 254       </tr>
 255
 256       <tr>
 257         <td width="33%" align="left" valign="top">Starting Privoxy</td>
 258
 259         <td width="34%" align="center" valign="top">&nbsp;</td>
 260
 261         <td width="33%" align="right" valign="top">The Main Configuration
 262         File</td>
 263       </tr>
 264     </table>
 265   </div>
 266 </body>
 267 </html>