doc/webserver/user-manual/quickstart.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >Quickstart to Using Privoxy</TITLE
   5 ><META
   6 NAME="GENERATOR"
   7 CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
   8 REL="HOME"
   9 TITLE="Privoxy User Manual"
  10 HREF="index.html"><LINK
  11 REL="PREVIOUS"
  12 TITLE="Installation"
  13 HREF="installation.html"><LINK
  14 REL="NEXT"
  15 TITLE="Privoxy Configuration"
  16 HREF="configuration.html"><LINK
  17 REL="STYLESHEET"
  18 TYPE="text/css"
  19 HREF="../p_doc.css"></HEAD
  20 ><BODY
  21 CLASS="SECT1"
  22 BGCOLOR="#EEEEEE"
  23 TEXT="#000000"
  24 LINK="#0000FF"
  25 VLINK="#840084"
  26 ALINK="#0000FF"
  27 ><DIV
  28 CLASS="NAVHEADER"
  29 ><TABLE
  30 WIDTH="100%"
  31 BORDER="0"
  32 CELLPADDING="0"
  33 CELLSPACING="0"
  34 ><TR
  35 ><TH
  36 COLSPAN="3"
  37 ALIGN="center"
  38 >Privoxy User Manual</TH
  39 ></TR
  40 ><TR
  41 ><TD
  42 WIDTH="10%"
  43 ALIGN="left"
  44 VALIGN="bottom"
  45 ><A
  46 HREF="installation.html"
  47 >Prev</A
  48 ></TD
  49 ><TD
  50 WIDTH="80%"
  51 ALIGN="center"
  52 VALIGN="bottom"
  53 ></TD
  54 ><TD
  55 WIDTH="10%"
  56 ALIGN="right"
  57 VALIGN="bottom"
  58 ><A
  59 HREF="configuration.html"
  60 >Next</A
  61 ></TD
  62 ></TR
  63 ></TABLE
  64 ><HR
  65 ALIGN="LEFT"
  66 WIDTH="100%"></DIV
  67 ><DIV
  68 CLASS="SECT1"
  69 ><H1
  70 CLASS="SECT1"
  71 ><A
  72 NAME="QUICKSTART"
  73 >4. Quickstart to Using <SPAN
  74 CLASS="APPLICATION"
  75 >Privoxy</SPAN
  76 ></A
  77 ></H1
  78 ><P
  79 > Before launching <SPAN
  80 CLASS="APPLICATION"
  81 >Privoxy</SPAN
  82 > for the first time, you
  83  will want to configure your browser(s) to use <SPAN
  84 CLASS="APPLICATION"
  85 >Privoxy</SPAN
  86 >
  87  as a HTTP and HTTPS proxy. The default is localhost for the proxy address,
  88  and port 8118 (earlier versions used port 800). This is the one required
  89  configuration that must be done! </P
  90 ><P
  91 >
  92  With <SPAN
  93 CLASS="APPLICATION"
  94 >Netscape</SPAN
  95 > (and
  96  <SPAN
  97 CLASS="APPLICATION"
  98 >Mozilla</SPAN
  99 >), this can be set under <TT
 100 CLASS="LITERAL"
 101 >Edit
 102  -&#62; Preferences -&#62; Advanced -&#62; Proxies -&#62; HTTP Proxy</TT
 103 >.
 104  For <SPAN
 105 CLASS="APPLICATION"
 106 >Internet Explorer</SPAN
 107 >: <TT
 108 CLASS="LITERAL"
 109 >Tools -&#62;
 110  Internet Properties -&#62; Connections -&#62; LAN Setting</TT
 111 >. Then,
 112  check <SPAN
 113 CLASS="QUOTE"
 114 >"Use Proxy"</SPAN
 115 > and fill in the appropriate info (Address:
 116  localhost, Port: 8118). Include if HTTPS proxy support too.</P
 117 ><P
 118 > After doing this, flush your browser's disk and memory caches to force a
 119  re-reading of all pages and get rid of any ads that may be cached. You
 120  are now ready to start enjoying the benefits of using
 121  <SPAN
 122 CLASS="APPLICATION"
 123 >Privoxy</SPAN
 124 >.</P
 125 ><P
 126 > <SPAN
 127 CLASS="APPLICATION"
 128 >Privoxy</SPAN
 129 > is typically started by specifying the
 130  main configuration file to be used on the command line. Example Unix startup
 131  command:</P
 132 ><P
 133 > <TABLE
 134 BORDER="0"
 135 BGCOLOR="#E0E0E0"
 136 WIDTH="100%"
 137 ><TR
 138 ><TD
 139 ><PRE
 140 CLASS="SCREEN"
 141 >
 142  # /usr/sbin/privoxy /etc/privoxy/config
 143
 144  </PRE
 145 ></TD
 146 ></TR
 147 ></TABLE
 148 ></P
 149 ><P
 150 > An init script is provided for SuSE and Redhat.</P
 151 ><P
 152 > For for SuSE: <B
 153 CLASS="COMMAND"
 154 >/etc/rc.d/privoxy start</B
 155 ></P
 156 ><P
 157 > For RedHat: <B
 158 CLASS="COMMAND"
 159 >/etc/rc.d/init.d/privoxy start</B
 160 ></P
 161 ><P
 162 > If no configuration file is specified on the command line,
 163  <SPAN
 164 CLASS="APPLICATION"
 165 >Privoxy</SPAN
 166 > will look for a file named
 167  <TT
 168 CLASS="FILENAME"
 169 >config</TT
 170 > in the current directory. Except on Win32 where
 171  it will try <TT
 172 CLASS="FILENAME"
 173 >config.txt</TT
 174 >. If no file is specified on the
 175  command line and no default configuration file can be found,
 176  <SPAN
 177 CLASS="APPLICATION"
 178 >Privoxy</SPAN
 179 > will fail to start.</P
 180 ><P
 181 > The included default configuration files should give a reasonable starting
 182  point, though may be somewhat aggressive in blocking junk. Most of the
 183  per site configuration is done in the <SPAN
 184 CLASS="QUOTE"
 185 >"actions"</SPAN
 186 > files. These
 187  are where various cookie actions are defined, ad and banner blocking,
 188  and other aspects of <SPAN
 189 CLASS="APPLICATION"
 190 >Privoxy</SPAN
 191 > configuration. There
 192  are several such files included, with varying levels of aggressiveness. </P
 193 ><P
 194 > You will probably want to keep an eye out for sites that require persistent
 195  cookies, and add these to <TT
 196 CLASS="FILENAME"
 197 >default.action</TT
 198 > as needed. By
 199  default, most of these will be accepted only during the current browser
 200  session, until you add them to the configuration. If you want the browser to
 201  handle this instead, you will need to edit
 202  <TT
 203 CLASS="FILENAME"
 204 >default.action</TT
 205 > and disable this feature. If you use more
 206  than one browser, it would make more sense to let
 207  <SPAN
 208 CLASS="APPLICATION"
 209 >Privoxy</SPAN
 210 > handle this. In which case, the browser(s)
 211  should be set to accept all cookies.</P
 212 ><P
 213 > <SPAN
 214 CLASS="APPLICATION"
 215 >Privoxy</SPAN
 216 > is HTTP/1.1 compliant,  but not all 1.1
 217  features are as yet implemented. If browsers that support HTTP/1.1 (like
 218  <SPAN
 219 CLASS="APPLICATION"
 220 >Mozilla</SPAN
 221 > or recent versions of I.E.) experience
 222  problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look
 223  under <TT
 224 CLASS="LITERAL"
 225 >Edit -&#62; Preferences -&#62; Debug -&#62; Networking</TT
 226 >.
 227  Or set the <SPAN
 228 CLASS="QUOTE"
 229 >"+downgrade"</SPAN
 230 > config option in
 231  <TT
 232 CLASS="FILENAME"
 233 >default.action</TT
 234 >.</P
 235 ><P
 236 > After running <SPAN
 237 CLASS="APPLICATION"
 238 >Privoxy</SPAN
 239 > for a while, you can
 240  start to fine tune the configuration to suit your personal, or site,
 241  preferences and requirements. There are many, many aspects that can
 242  be customized. <SPAN
 243 CLASS="QUOTE"
 244 >"Actions"</SPAN
 245 > (as specified in <TT
 246 CLASS="FILENAME"
 247 >default.action</TT
 248 >)
 249  can be adjusted by pointing your browser to
 250  <A
 251 HREF="http://p.p/"
 252 TARGET="_top"
 253 >http://p.p/</A
 254 >,
 255  and then follow the link to <SPAN
 256 CLASS="QUOTE"
 257 >"edit the actions list"</SPAN
 258 >.
 259  (This is an internal page and does not require Internet access.)</P
 260 ><P
 261 > In fact, various aspects of <SPAN
 262 CLASS="APPLICATION"
 263 >Privoxy</SPAN
 264 >
 265  configuration can be viewed from this page, including
 266  current configuration parameters, source code version numbers,
 267  the browser's request headers, and <SPAN
 268 CLASS="QUOTE"
 269 >"actions"</SPAN
 270 > that apply
 271  to a given URL. In addition to the <TT
 272 CLASS="FILENAME"
 273 >default.action</TT
 274 > file
 275  editor mentioned above, <SPAN
 276 CLASS="APPLICATION"
 277 >Privoxy</SPAN
 278 > can also
 279  be turned <SPAN
 280 CLASS="QUOTE"
 281 >"on"</SPAN
 282 > and <SPAN
 283 CLASS="QUOTE"
 284 >"off"</SPAN
 285 > from this page.</P
 286 ><P
 287 > If you encounter problems, please verify it is a
 288  <SPAN
 289 CLASS="APPLICATION"
 290 >Privoxy</SPAN
 291 > bug, by disabling
 292  <SPAN
 293 CLASS="APPLICATION"
 294 >Privoxy</SPAN
 295 >, and then trying the same page.
 296  Also, try another browser if possible to eliminate browser or site
 297  problems. Before reporting it as a bug, see if there is not a configuration
 298  option that is enabled that is causing the page not to load. You can then add
 299  an exception for that page or site. For instance, try adding it to the
 300  <TT
 301 CLASS="LITERAL"
 302 >{fragile}</TT
 303 > section of <TT
 304 CLASS="FILENAME"
 305 >default.action</TT
 306 >.
 307  This will turn off most actions for this site. For more on troubleshooting
 308  problem sites, see the <A
 309 HREF="appendix.html#ACTIONSANAT"
 310 TARGET="_top"
 311 >Appendix</A
 312 >. If a bug, please report it
 313  to the developers (see below). </P
 314 ><DIV
 315 CLASS="SECT2"
 316 ><H2
 317 CLASS="SECT2"
 318 ><A
 319 NAME="AEN230"
 320 >4.1. Command Line Options</A
 321 ></H2
 322 ><P
 323 > <SPAN
 324 CLASS="APPLICATION"
 325 >Privoxy</SPAN
 326 > may be invoked with the following
 327  command-line options:</P
 328 ><P
 329 > <P
 330 ></P
 331 ><UL
 332 ><LI
 333 ><P
 334 >    <I
 335 CLASS="EMPHASIS"
 336 >--version</I
 337 >
 338   </P
 339 ><P
 340 >     Print version info and exit, Unix only.
 341   </P
 342 ></LI
 343 ><LI
 344 ><P
 345 >    <I
 346 CLASS="EMPHASIS"
 347 >--help</I
 348 >
 349   </P
 350 ><P
 351 >   Print a short usage info and exit, Unix only.
 352   </P
 353 ></LI
 354 ><LI
 355 ><P
 356 >   <I
 357 CLASS="EMPHASIS"
 358 >--no-daemon</I
 359 >
 360   </P
 361 ><P
 362 >   Don't become a daemon, i.e. don't fork and become process group
 363    leader, don't detach from controlling tty. Unix only.
 364   </P
 365 ></LI
 366 ><LI
 367 ><P
 368 >   <I
 369 CLASS="EMPHASIS"
 370 >--pidfile FILE</I
 371 >
 372
 373   </P
 374 ><P
 375 >   On startup, write the process ID to <I
 376 CLASS="EMPHASIS"
 377 >FILE</I
 378 >. Delete the
 379    <I
 380 CLASS="EMPHASIS"
 381 >FILE</I
 382 > on exit. Failiure to create or delete the
 383    <I
 384 CLASS="EMPHASIS"
 385 >FILE</I
 386 > is non-fatal. If no <I
 387 CLASS="EMPHASIS"
 388 >FILE</I
 389 >
 390    option is given, no PID file will be used. Unix only.
 391   </P
 392 ></LI
 393 ><LI
 394 ><P
 395 >   <I
 396 CLASS="EMPHASIS"
 397 >--user USER[.GROUP]</I
 398 >
 399
 400   </P
 401 ><P
 402 >   After (optionally) writing the PID file, assume the user  ID  of
 403    <I
 404 CLASS="EMPHASIS"
 405 >USER</I
 406 >, and if included the GID of GROUP.  Exit if the
 407    privileges are not sufficient to do so. Unix only.
 408   </P
 409 ></LI
 410 ><LI
 411 ><P
 412 >    <I
 413 CLASS="EMPHASIS"
 414 >configfile</I
 415 >
 416   </P
 417 ><P
 418 >    If no <I
 419 CLASS="EMPHASIS"
 420 >configfile</I
 421 > is included on the command line,
 422     <SPAN
 423 CLASS="APPLICATION"
 424 >Privoxy</SPAN
 425 > will look for a file named
 426     <SPAN
 427 CLASS="QUOTE"
 428 >"config"</SPAN
 429 > in the current directory (except on Win32
 430     where it will look for <SPAN
 431 CLASS="QUOTE"
 432 >"config.txt"</SPAN
 433 > instead). Specify
 434     full path to avoid confusion.
 435   </P
 436 ></LI
 437 ></UL
 438 ></P
 439 ></DIV
 440 ></DIV
 441 ><DIV
 442 CLASS="NAVFOOTER"
 443 ><HR
 444 ALIGN="LEFT"
 445 WIDTH="100%"><TABLE
 446 WIDTH="100%"
 447 BORDER="0"
 448 CELLPADDING="0"
 449 CELLSPACING="0"
 450 ><TR
 451 ><TD
 452 WIDTH="33%"
 453 ALIGN="left"
 454 VALIGN="top"
 455 ><A
 456 HREF="installation.html"
 457 >Prev</A
 458 ></TD
 459 ><TD
 460 WIDTH="34%"
 461 ALIGN="center"
 462 VALIGN="top"
 463 ><A
 464 HREF="index.html"
 465 >Home</A
 466 ></TD
 467 ><TD
 468 WIDTH="33%"
 469 ALIGN="right"
 470 VALIGN="top"
 471 ><A
 472 HREF="configuration.html"
 473 >Next</A
 474 ></TD
 475 ></TR
 476 ><TR
 477 ><TD
 478 WIDTH="33%"
 479 ALIGN="left"
 480 VALIGN="top"
 481 >Installation</TD
 482 ><TD
 483 WIDTH="34%"
 484 ALIGN="center"
 485 VALIGN="top"
 486 >&nbsp;</TD
 487 ><TD
 488 WIDTH="33%"
 489 ALIGN="right"
 490 VALIGN="top"
 491 ><SPAN
 492 CLASS="APPLICATION"
 493 >Privoxy</SPAN
 494 > Configuration</TD
 495 ></TR
 496 ></TABLE
 497 ></DIV
 498 ></BODY
 499 ></HTML
 500 >