doc/webserver/user-manual/configuration.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
   2 <HTML
   3 ><HEAD
   4 ><TITLE
   5 >Privoxy Configuration</TITLE
   6 ><META
   7 NAME="GENERATOR"
   8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
   9 REL="HOME"
  10 TITLE="Privoxy 3.0.14 User Manual"
  11 HREF="index.html"><LINK
  12 REL="PREVIOUS"
  13 TITLE="Starting Privoxy"
  14 HREF="startup.html"><LINK
  15 REL="NEXT"
  16 TITLE="The Main Configuration File"
  17 HREF="config.html"><LINK
  18 REL="STYLESHEET"
  19 TYPE="text/css"
  20 HREF="../p_doc.css"><META
  21 HTTP-EQUIV="Content-Type"
  22 CONTENT="text/html;
  23 charset=ISO-8859-1">
  24 <LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
  25 </head
  26 ><BODY
  27 CLASS="SECT1"
  28 BGCOLOR="#EEEEEE"
  29 TEXT="#000000"
  30 LINK="#0000FF"
  31 VLINK="#840084"
  32 ALINK="#0000FF"
  33 ><DIV
  34 CLASS="NAVHEADER"
  35 ><TABLE
  36 SUMMARY="Header navigation table"
  37 WIDTH="100%"
  38 BORDER="0"
  39 CELLPADDING="0"
  40 CELLSPACING="0"
  41 ><TR
  42 ><TH
  43 COLSPAN="3"
  44 ALIGN="center"
  45 >Privoxy 3.0.14 User Manual</TH
  46 ></TR
  47 ><TR
  48 ><TD
  49 WIDTH="10%"
  50 ALIGN="left"
  51 VALIGN="bottom"
  52 ><A
  53 HREF="startup.html"
  54 ACCESSKEY="P"
  55 >Prev</A
  56 ></TD
  57 ><TD
  58 WIDTH="80%"
  59 ALIGN="center"
  60 VALIGN="bottom"
  61 ></TD
  62 ><TD
  63 WIDTH="10%"
  64 ALIGN="right"
  65 VALIGN="bottom"
  66 ><A
  67 HREF="config.html"
  68 ACCESSKEY="N"
  69 >Next</A
  70 ></TD
  71 ></TR
  72 ></TABLE
  73 ><HR
  74 ALIGN="LEFT"
  75 WIDTH="100%"></DIV
  76 ><DIV
  77 CLASS="SECT1"
  78 ><H1
  79 CLASS="SECT1"
  80 ><A
  81 NAME="CONFIGURATION"
  82 >6. Privoxy Configuration</A
  83 ></H1
  84 ><P
  85 >  All <SPAN
  86 CLASS="APPLICATION"
  87 >Privoxy</SPAN
  88 > configuration is stored
  89   in text files. These files can be edited with a text editor.
  90   Many important aspects of <SPAN
  91 CLASS="APPLICATION"
  92 >Privoxy</SPAN
  93 > can
  94   also be controlled easily with a web browser.
  95  </P
  96 ><DIV
  97 CLASS="SECT2"
  98 ><H2
  99 CLASS="SECT2"
 100 ><A
 101 NAME="AEN780"
 102 >6.1. Controlling Privoxy with Your Web Browser</A
 103 ></H2
 104 ><P
 105 > <SPAN
 106 CLASS="APPLICATION"
 107 >Privoxy</SPAN
 108 >'s user interface can be reached through the special
 109  URL <A
 110 HREF="http://config.privoxy.org/"
 111 TARGET="_top"
 112 >http://config.privoxy.org/</A
 113 >
 114  (shortcut: <A
 115 HREF="http://p.p/"
 116 TARGET="_top"
 117 >http://p.p/</A
 118 >),
 119  which is a built-in page and works without Internet access.
 120  You will see the following section:&#13;</P
 121 ><TABLE
 122 BORDER="0"
 123 BGCOLOR="#E0E0E0"
 124 WIDTH="100%"
 125 ><TR
 126 ><TD
 127 ><PRE
 128 CLASS="SCREEN"
 129 > <H2
 130 CLASS="BRIDGEHEAD"
 131 ><A
 132 NAME="AEN788"
 133 ></A
 134 >    Privoxy Menu</H2
 135 ><P
 136 ></P
 137 ><TABLE
 138 BORDER="0"
 139 ><TBODY
 140 ><TR
 141 ><TD
 142 >          &#9642;  <A
 143 HREF="http://config.privoxy.org/show-status"
 144 TARGET="_top"
 145 >View &#38; change the current configuration</A
 146 >
 147  </TD
 148 ></TR
 149 ><TR
 150 ><TD
 151 >          &#9642;  <A
 152 HREF="http://config.privoxy.org/show-version"
 153 TARGET="_top"
 154 >View the source code version numbers</A
 155 >
 156  </TD
 157 ></TR
 158 ><TR
 159 ><TD
 160 >          &#9642;  <A
 161 HREF="http://config.privoxy.org/show-request"
 162 TARGET="_top"
 163 >View the request headers.</A
 164 >
 165  </TD
 166 ></TR
 167 ><TR
 168 ><TD
 169 >          &#9642;  <A
 170 HREF="http://config.privoxy.org/show-url-info"
 171 TARGET="_top"
 172 >Look up which actions apply to a URL and why</A
 173 >
 174  </TD
 175 ></TR
 176 ><TR
 177 ><TD
 178 >          &#9642;  <A
 179 HREF="http://config.privoxy.org/toggle"
 180 TARGET="_top"
 181 >Toggle Privoxy on or off</A
 182 >
 183  </TD
 184 ></TR
 185 ><TR
 186 ><TD
 187 >          &#9642;  <A
 188 HREF="http://www.privoxy.org/3.0.14/user-manual/"
 189 TARGET="_top"
 190 >Documentation</A
 191 >
 192  </TD
 193 ></TR
 194 ></TBODY
 195 ></TABLE
 196 ><P
 197 ></P
 198 ></PRE
 199 ></TD
 200 ></TR
 201 ></TABLE
 202 ><P
 203 > This should be self-explanatory. Note the first item leads to an editor for the
 204  <A
 205 HREF="actions-file.html"
 206 >actions files</A
 207 >, which is where the ad, banner,
 208  cookie, and URL blocking magic is configured as well as other advanced features of
 209  <SPAN
 210 CLASS="APPLICATION"
 211 >Privoxy</SPAN
 212 >. This is an easy way to adjust various
 213  aspects of <SPAN
 214 CLASS="APPLICATION"
 215 >Privoxy</SPAN
 216 > configuration. The actions
 217  file, and other configuration files, are explained in detail below. </P
 218 ><P
 219 > <SPAN
 220 CLASS="QUOTE"
 221 >"Toggle Privoxy On or Off"</SPAN
 222 > is handy for sites that might
 223  have problems with your current actions and filters. You can in fact use
 224  it as a test to see whether it is <SPAN
 225 CLASS="APPLICATION"
 226 >Privoxy</SPAN
 227 >
 228  causing the problem or not. <SPAN
 229 CLASS="APPLICATION"
 230 >Privoxy</SPAN
 231 > continues
 232  to run as a proxy in this case, but all manipulation is disabled, i.e.
 233  <SPAN
 234 CLASS="APPLICATION"
 235 >Privoxy</SPAN
 236 > acts like a normal forwarding proxy. There
 237  is even a toggle <A
 238 HREF="appendix.html#BOOKMARKLETS"
 239 >Bookmarklet</A
 240 > offered, so
 241  that you can toggle <SPAN
 242 CLASS="APPLICATION"
 243 >Privoxy</SPAN
 244 > with one click from
 245  your browser.</P
 246 ><P
 247 > Note that several of the features described above are disabled by default
 248  in <SPAN
 249 CLASS="APPLICATION"
 250 >Privoxy</SPAN
 251 > 3.0.7 beta and later.
 252  Check the
 253  <A
 254 HREF="config.html"
 255 TARGET="_top"
 256 >configuration file</A
 257 > to learn why
 258  and in which cases it's safe to enable them again.</P
 259 ></DIV
 260 ><DIV
 261 CLASS="SECT2"
 262 ><H2
 263 CLASS="SECT2"
 264 ><A
 265 NAME="CONFOVERVIEW"
 266 >6.2. Configuration Files Overview</A
 267 ></H2
 268 ><P
 269 > For Unix, *BSD and Linux, all configuration files are located in
 270  <TT
 271 CLASS="FILENAME"
 272 >/etc/privoxy/</TT
 273 > by default. For MS Windows, OS/2, and
 274  AmigaOS these are all in the same directory as the
 275  <SPAN
 276 CLASS="APPLICATION"
 277 >Privoxy</SPAN
 278 > executable.  The name
 279  and number of configuration files has changed from previous versions, and is
 280  subject to change as development progresses.</P
 281 ><P
 282 > The installed defaults provide a reasonable starting point, though
 283  some settings may be aggressive by some standards. For the time being, the
 284  principle configuration files are:</P
 285 ><P
 286 > <P
 287 ></P
 288 ><UL
 289 ><LI
 290 ><P
 291 >     The <A
 292 HREF="config.html"
 293 >main configuration file</A
 294 > is named <TT
 295 CLASS="FILENAME"
 296 >config</TT
 297 >
 298      on Linux, Unix, BSD, OS/2, and AmigaOS and <TT
 299 CLASS="FILENAME"
 300 >config.txt</TT
 301 >
 302      on Windows. This is a required file.
 303    </P
 304 ></LI
 305 ><LI
 306 ><P
 307 >    <TT
 308 CLASS="FILENAME"
 309 >match-all.action</TT
 310 > is used to define which <SPAN
 311 CLASS="QUOTE"
 312 >"actions"</SPAN
 313 >
 314     relating to banner-blocking, images, pop-ups, content modification, cookie handling
 315     etc should be applied by default. It should be the first actions file loaded.
 316    </P
 317 ><P
 318 >    <TT
 319 CLASS="FILENAME"
 320 >default.action</TT
 321 > defines many exceptions (both positive and negative)
 322     from the default set of actions that's configured in <TT
 323 CLASS="FILENAME"
 324 >match-all.action</TT
 325 >.
 326     It should be the second actions file loaded and shouldn't be edited by the user.
 327    </P
 328 ><P
 329 >    Multiple actions files may be defined in <TT
 330 CLASS="FILENAME"
 331 >config</TT
 332 >. These
 333     are processed in the order they are defined. Local customizations and locally
 334     preferred exceptions to the default policies as defined in
 335     <TT
 336 CLASS="FILENAME"
 337 >match-all.action</TT
 338 > (which you will most probably want
 339     to define sooner or later) are best applied in <TT
 340 CLASS="FILENAME"
 341 >user.action</TT
 342 >,
 343     where you can preserve them across upgrades. The file isn't installed by all
 344     installers, but you can easily create it yourself with a text editor.
 345    </P
 346 ><P
 347 >
 348     There is also a web based editor that can be accessed from
 349     <A
 350 HREF="http://config.privoxy.org/show-status"
 351 TARGET="_top"
 352 >http://config.privoxy.org/show-status</A
 353 >
 354     (Shortcut: <A
 355 HREF="http://p.p/show-status"
 356 TARGET="_top"
 357 >http://p.p/show-status</A
 358 >) for the
 359     various actions files.
 360    </P
 361 ></LI
 362 ><LI
 363 ><P
 364 >    <SPAN
 365 CLASS="QUOTE"
 366 >"Filter files"</SPAN
 367 > (the <A
 368 HREF="filter-file.html"
 369 >filter
 370     file</A
 371 >) can be used to re-write the raw page content, including
 372     viewable text as well as embedded HTML and JavaScript, and whatever else
 373     lurks on any given web page. The filtering jobs are only pre-defined here;
 374     whether to apply them or not is up to the actions files.
 375     <TT
 376 CLASS="FILENAME"
 377 >default.filter</TT
 378 > includes various filters made
 379     available for use by the developers. Some are much more intrusive than
 380     others, and all should be used with caution. You may define additional
 381     filter files in <TT
 382 CLASS="FILENAME"
 383 >config</TT
 384 > as you can with
 385     actions files. We suggest <TT
 386 CLASS="FILENAME"
 387 >user.filter</TT
 388 > for any
 389     locally defined filters or customizations.
 390    </P
 391 ></LI
 392 ></UL
 393 ></P
 394 ><P
 395 > The syntax of the configuration and filter files may change between different
 396  Privoxy versions, unfortunately some enhancements cost backwards compatibility.
 397  </P
 398 ><P
 399 > All files use the <SPAN
 400 CLASS="QUOTE"
 401 >"<TT
 402 CLASS="LITERAL"
 403 >#</TT
 404 >"</SPAN
 405 > character to denote a
 406  comment (the rest of the line will be ignored) and understand line continuation
 407  through placing a backslash ("<TT
 408 CLASS="LITERAL"
 409 >\</TT
 410 >") as the very last character
 411  in a line. If the <TT
 412 CLASS="LITERAL"
 413 >#</TT
 414 > is preceded by a backslash, it looses
 415  its special function. Placing a <TT
 416 CLASS="LITERAL"
 417 >#</TT
 418 > in front of an otherwise
 419  valid configuration line to prevent it from being interpreted is called "commenting
 420  out" that line. Blank lines are ignored.</P
 421 ><P
 422 > The actions files and filter files
 423  can use Perl style <A
 424 HREF="appendix.html#REGEX"
 425 >regular expressions</A
 426 > for
 427  maximum flexibility. </P
 428 ><P
 429 > After making any changes, there is no need to restart
 430  <SPAN
 431 CLASS="APPLICATION"
 432 >Privoxy</SPAN
 433 > in order for the changes to take
 434  effect. <SPAN
 435 CLASS="APPLICATION"
 436 >Privoxy</SPAN
 437 > detects such changes
 438  automatically. Note, however, that it may take one or two additional
 439  requests for the change to take effect. When changing the listening address
 440  of <SPAN
 441 CLASS="APPLICATION"
 442 >Privoxy</SPAN
 443 >, these <SPAN
 444 CLASS="QUOTE"
 445 >"wake up"</SPAN
 446 > requests
 447  must obviously be sent to the <SPAN
 448 CLASS="emphasis"
 449 ><I
 450 CLASS="EMPHASIS"
 451 >old</I
 452 ></SPAN
 453 > listening address.</P
 454 ><P
 455 > While under development, the configuration content is subject to change.
 456  The below documentation may not be accurate by the time you read this.
 457  Also, what constitutes a <SPAN
 458 CLASS="QUOTE"
 459 >"default"</SPAN
 460 > setting, may change, so
 461  please check all your configuration files on important issues.</P
 462 ></DIV
 463 ></DIV
 464 ><DIV
 465 CLASS="NAVFOOTER"
 466 ><HR
 467 ALIGN="LEFT"
 468 WIDTH="100%"><TABLE
 469 SUMMARY="Footer navigation table"
 470 WIDTH="100%"
 471 BORDER="0"
 472 CELLPADDING="0"
 473 CELLSPACING="0"
 474 ><TR
 475 ><TD
 476 WIDTH="33%"
 477 ALIGN="left"
 478 VALIGN="top"
 479 ><A
 480 HREF="startup.html"
 481 ACCESSKEY="P"
 482 >Prev</A
 483 ></TD
 484 ><TD
 485 WIDTH="34%"
 486 ALIGN="center"
 487 VALIGN="top"
 488 ><A
 489 HREF="index.html"
 490 ACCESSKEY="H"
 491 >Home</A
 492 ></TD
 493 ><TD
 494 WIDTH="33%"
 495 ALIGN="right"
 496 VALIGN="top"
 497 ><A
 498 HREF="config.html"
 499 ACCESSKEY="N"
 500 >Next</A
 501 ></TD
 502 ></TR
 503 ><TR
 504 ><TD
 505 WIDTH="33%"
 506 ALIGN="left"
 507 VALIGN="top"
 508 >Starting Privoxy</TD
 509 ><TD
 510 WIDTH="34%"
 511 ALIGN="center"
 512 VALIGN="top"
 513 >&nbsp;</TD
 514 ><TD
 515 WIDTH="33%"
 516 ALIGN="right"
 517 VALIGN="top"
 518 >The Main Configuration File</TD
 519 ></TR
 520 ></TABLE
 521 ></DIV
 522 ></BODY
 523 ></HTML
 524 >