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