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.10 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.10 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="AEN811"
 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="AEN819"
 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.10/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. </P
 279 ><P
 280 > The installed defaults provide a reasonable starting point, though
 281  some settings may be aggressive by some standards. For the time being, the
 282  principle configuration files are:</P
 283 ><P
 284 > <P
 285 ></P
 286 ><UL
 287 ><LI
 288 ><P
 289 >     The <A
 290 HREF="config.html"
 291 >main configuration file</A
 292 > is named <TT
 293 CLASS="FILENAME"
 294 >config</TT
 295 >
 296      on Linux, Unix, BSD, OS/2, and AmigaOS and <TT
 297 CLASS="FILENAME"
 298 >config.txt</TT
 299 >
 300      on Windows. This is a required file.
 301    </P
 302 ></LI
 303 ><LI
 304 ><P
 305 >    <TT
 306 CLASS="FILENAME"
 307 >default.action</TT
 308 > (the main <A
 309 HREF="actions-file.html"
 310 >actions file</A
 311 >)
 312     is used to define which <SPAN
 313 CLASS="QUOTE"
 314 >"actions"</SPAN
 315 > relating to banner-blocking, images, pop-ups,
 316     content modification, cookie handling etc should be applied by default. It also defines many
 317     exceptions (both positive and negative) from this default set of actions that enable
 318     <SPAN
 319 CLASS="APPLICATION"
 320 >Privoxy</SPAN
 321 > to selectively eliminate the junk, and only the junk, on
 322     as many websites as possible.
 323    </P
 324 ><P
 325 >    Multiple actions files may be defined in <TT
 326 CLASS="FILENAME"
 327 >config</TT
 328 >. These
 329     are processed in the order they are defined. Local customizations and locally
 330     preferred exceptions to the default policies  as defined in
 331     <TT
 332 CLASS="FILENAME"
 333 >default.action</TT
 334 > (which you will most probably want
 335     to define sooner or later) are probably best applied in
 336     <TT
 337 CLASS="FILENAME"
 338 >user.action</TT
 339 >, where you can preserve them across
 340     upgrades. <TT
 341 CLASS="FILENAME"
 342 >standard.action</TT
 343 > is only for
 344     <SPAN
 345 CLASS="APPLICATION"
 346 >Privoxy's</SPAN
 347 > internal use.
 348    </P
 349 ><P
 350 >
 351     There is also a web based editor that can be accessed from
 352     <A
 353 HREF="http://config.privoxy.org/show-status"
 354 TARGET="_top"
 355 >http://config.privoxy.org/show-status</A
 356 >
 357     (Shortcut: <A
 358 HREF="http://p.p/show-status"
 359 TARGET="_top"
 360 >http://p.p/show-status</A
 361 >) for the
 362     various actions files.
 363    </P
 364 ></LI
 365 ><LI
 366 ><P
 367 >    <SPAN
 368 CLASS="QUOTE"
 369 >"Filter files"</SPAN
 370 > (the <A
 371 HREF="filter-file.html"
 372 >filter
 373     file</A
 374 >) can be used to re-write the raw page content, including
 375     viewable text as well as embedded HTML and JavaScript, and whatever else
 376     lurks on any given web page. The filtering jobs are only pre-defined here;
 377     whether to apply them or not is up to the actions files.
 378     <TT
 379 CLASS="FILENAME"
 380 >default.filter</TT
 381 > includes various filters made
 382     available for use by the developers. Some are much more intrusive than
 383     others, and all should be used with caution. You may define additional
 384     filter files in <TT
 385 CLASS="FILENAME"
 386 >config</TT
 387 > as you can with
 388     actions files. We suggest <TT
 389 CLASS="FILENAME"
 390 >user.filter</TT
 391 > for any
 392     locally defined filters or customizations.
 393    </P
 394 ></LI
 395 ></UL
 396 ></P
 397 ><P
 398 > The syntax of the configuration and filter files may change between different
 399  Privoxy versions, unfortunately some enhancements cost backwards compatibility.
 400  </P
 401 ><P
 402 > All files use the <SPAN
 403 CLASS="QUOTE"
 404 >"<TT
 405 CLASS="LITERAL"
 406 >#</TT
 407 >"</SPAN
 408 > character to denote a
 409  comment (the rest of the line will be ignored) and understand line continuation
 410  through placing a backslash ("<TT
 411 CLASS="LITERAL"
 412 >\</TT
 413 >") as the very last character
 414  in a line. If the <TT
 415 CLASS="LITERAL"
 416 >#</TT
 417 > is preceded by a backslash, it looses
 418  its special function. Placing a <TT
 419 CLASS="LITERAL"
 420 >#</TT
 421 > in front of an otherwise
 422  valid configuration line to prevent it from being interpreted is called "commenting
 423  out" that line. Blank lines are ignored.</P
 424 ><P
 425 > The actions files and filter files
 426  can use Perl style <A
 427 HREF="appendix.html#REGEX"
 428 >regular expressions</A
 429 > for
 430  maximum flexibility. </P
 431 ><P
 432 > After making any changes, there is no need to restart
 433  <SPAN
 434 CLASS="APPLICATION"
 435 >Privoxy</SPAN
 436 > in order for the changes to take
 437  effect. <SPAN
 438 CLASS="APPLICATION"
 439 >Privoxy</SPAN
 440 > detects such changes
 441  automatically. Note, however, that it may take one or two additional
 442  requests for the change to take effect. When changing the listening address
 443  of <SPAN
 444 CLASS="APPLICATION"
 445 >Privoxy</SPAN
 446 >, these <SPAN
 447 CLASS="QUOTE"
 448 >"wake up"</SPAN
 449 > requests
 450  must obviously be sent to the <SPAN
 451 CLASS="emphasis"
 452 ><I
 453 CLASS="EMPHASIS"
 454 >old</I
 455 ></SPAN
 456 > listening address.</P
 457 ></DIV
 458 ></DIV
 459 ><DIV
 460 CLASS="NAVFOOTER"
 461 ><HR
 462 ALIGN="LEFT"
 463 WIDTH="100%"><TABLE
 464 SUMMARY="Footer navigation table"
 465 WIDTH="100%"
 466 BORDER="0"
 467 CELLPADDING="0"
 468 CELLSPACING="0"
 469 ><TR
 470 ><TD
 471 WIDTH="33%"
 472 ALIGN="left"
 473 VALIGN="top"
 474 ><A
 475 HREF="startup.html"
 476 ACCESSKEY="P"
 477 >Prev</A
 478 ></TD
 479 ><TD
 480 WIDTH="34%"
 481 ALIGN="center"
 482 VALIGN="top"
 483 ><A
 484 HREF="index.html"
 485 ACCESSKEY="H"
 486 >Home</A
 487 ></TD
 488 ><TD
 489 WIDTH="33%"
 490 ALIGN="right"
 491 VALIGN="top"
 492 ><A
 493 HREF="config.html"
 494 ACCESSKEY="N"
 495 >Next</A
 496 ></TD
 497 ></TR
 498 ><TR
 499 ><TD
 500 WIDTH="33%"
 501 ALIGN="left"
 502 VALIGN="top"
 503 >Starting Privoxy</TD
 504 ><TD
 505 WIDTH="34%"
 506 ALIGN="center"
 507 VALIGN="top"
 508 >&nbsp;</TD
 509 ><TD
 510 WIDTH="33%"
 511 ALIGN="right"
 512 VALIGN="top"
 513 >The Main Configuration File</TD
 514 ></TR
 515 ></TABLE
 516 ></DIV
 517 ></BODY
 518 ></HTML
 519 >