doc/webserver/user-manual/startup.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
   2 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
   3 <html>
   4   <head>
   5     <meta name="generator" content="HTML Tidy, see www.w3.org">
   6     <title>
   7       Starting Privoxy
   8     </title>
   9     <meta name="GENERATOR" content=
  10     "Modular DocBook HTML Stylesheet Version 1.79">
  11     <link rel="HOME" title="Privoxy 3.0.18 User Manual" href="index.html">
  12     <link rel="PREVIOUS" title="Quickstart to Using Privoxy" href=
  13     "quickstart.html">
  14     <link rel="NEXT" title="Privoxy Configuration" href="configuration.html">
  15     <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
  16     <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  17     <link rel="STYLESHEET" type="text/css" href="p_doc.css">
  18 <style type="text/css">
  19  body {
  20   background-color: #EEEEEE;
  21   color: #000000;
  22  }
  23  :link { color: #0000FF }
  24  :visited { color: #840084 }
  25  :active { color: #0000FF }
  26  p.c2 {font-weight: bold}
  27  hr.c1 {text-align: left}
  28 </style>
  29   </head>
  30   <body class="SECT1">
  31     <div class="NAVHEADER">
  32       <table summary="Header navigation table" width="100%" border="0"
  33       cellpadding="0" cellspacing="0">
  34         <tr>
  35           <th colspan="3" align="center">
  36             Privoxy 3.0.18 User Manual
  37           </th>
  38         </tr>
  39         <tr>
  40           <td width="10%" align="left" valign="bottom">
  41             <a href="quickstart.html" accesskey="P">Prev</a>
  42           </td>
  43           <td width="80%" align="center" valign="bottom">
  44           </td>
  45           <td width="10%" align="right" valign="bottom">
  46             <a href="configuration.html" accesskey="N">Next</a>
  47           </td>
  48         </tr>
  49       </table>
  50       <hr width="100%" class="c1">
  51     </div>
  52     <div class="SECT1">
  53       <h1 class="SECT1">
  54         <a name="STARTUP">5. Starting Privoxy</a>
  55       </h1>
  56       <p>
  57         Before launching <span class="APPLICATION">Privoxy</span> for the
  58         first time, you will want to configure your browser(s) to use <span
  59         class="APPLICATION">Privoxy</span> as a HTTP and HTTPS (SSL) <a href=
  60         "http://en.wikipedia.org/wiki/Proxy_server" target="_top">proxy</a>.
  61         The default is 127.0.0.1 (or localhost) for the proxy address, and
  62         port 8118 (earlier versions used port 8000). This is the one
  63         configuration step <span class="emphasis"><i class="EMPHASIS">that
  64         must be done</i></span>!
  65       </p>
  66       <p>
  67         Please note that <span class="APPLICATION">Privoxy</span> can only
  68         proxy HTTP and HTTPS traffic. It will not work with FTP or other
  69         protocols.
  70       </p>
  71       <p>
  72       </p>
  73       <div class="FIGURE">
  74         <a name="AEN742"></a>
  75         <p class="c2">
  76           Figure 2. Proxy Configuration Showing Mozilla/Netscape HTTP and
  77           HTTPS (SSL) Settings
  78         </p>
  79         <div class="MEDIAOBJECT">
  80           <p>
  81             <img src="proxy_setup.jpg">
  82           </p>
  83         </div>
  84       </div>
  85
  86       <p>
  87         With <span class="APPLICATION">Firefox</span>, this is typically set
  88         under:
  89       </p>
  90       <p class="LITERALLAYOUT">
  91         &nbsp;<span class="GUIBUTTON">Tools</span>&nbsp;-&gt;&nbsp;<span
  92         class="GUIBUTTON">Options</span>&nbsp;-&gt;&nbsp;&nbsp;<span class=
  93         "GUIBUTTON">Advanced</span>&nbsp;-&gt;&nbsp;<span class=
  94         "GUIBUTTON">Network</span>&nbsp;-&gt;<span class=
  95         "GUIBUTTON">Connection</span>&nbsp;-&gt;&nbsp;<span class=
  96         "GUIBUTTON">Settings</span><br>
  97          &#13;
  98       </p>
  99       <p>
 100         Or optionally on some platforms:
 101       </p>
 102       <p class="LITERALLAYOUT">
 103         &nbsp;<span class="GUIBUTTON">Edit</span>&nbsp;-&gt;&nbsp;<span
 104         class="GUIBUTTON">Preferences</span>&nbsp;-&gt;&nbsp;<span class=
 105         "GUIBUTTON">General</span>&nbsp;-&gt;&nbsp;<span class=
 106         "GUIBUTTON">Connection Settings</span>&nbsp;-&gt;&nbsp;<span class=
 107         "GUIBUTTON">Manual Proxy Configuration</span><br>
 108          &#13;
 109       </p>
 110       <p>
 111         With <span class="APPLICATION">Netscape</span> (and <span class=
 112         "APPLICATION">Mozilla</span>), this can be set under:
 113       </p>
 114       <p class="LITERALLAYOUT">
 115         &nbsp;<span class="GUIBUTTON">Edit</span>&nbsp;-&gt;&nbsp;<span
 116         class="GUIBUTTON">Preferences</span>&nbsp;-&gt;&nbsp;<span class=
 117         "GUIBUTTON">Advanced</span>&nbsp;-&gt;&nbsp;<span class=
 118         "GUIBUTTON">Proxies</span>&nbsp;-&gt;&nbsp;<span class=
 119         "GUIBUTTON">HTTP Proxy</span><br>
 120          &#13;
 121       </p>
 122       <p>
 123         For <span class="APPLICATION">Internet Explorer v.5-7</span>:
 124       </p>
 125       <p class="LITERALLAYOUT">
 126         &nbsp;<span class="GUIBUTTON">Tools</span>&nbsp;-&gt;&nbsp;<span
 127         class="GUIBUTTON">Internet Options</span>&nbsp;-&gt;&nbsp;<span
 128         class="GUIBUTTON">Connections</span>&nbsp;-&gt;&nbsp;<span class=
 129         "GUIBUTTON">LAN Settings</span>
 130       </p>
 131       <p>
 132         Then, check <span class="QUOTE">"Use Proxy"</span> and fill in the
 133         appropriate info (Address: 127.0.0.1, Port: 8118). Include HTTPS
 134         (SSL), if you want HTTPS proxy support too (sometimes labeled <span
 135         class="QUOTE">"Secure"</span>). Make sure any checkboxes like <span
 136         class="QUOTE">"Use the same proxy server for all protocols"</span> is
 137         <span class="emphasis"><i class="EMPHASIS">UNCHECKED</i></span>. You
 138         want only HTTP and HTTPS (SSL)!
 139       </p>
 140       <p>
 141       </p>
 142       <div class="FIGURE">
 143         <a name="AEN787"></a>
 144         <p class="c2">
 145           Figure 3. Proxy Configuration Showing Internet Explorer HTTP and
 146           HTTPS (Secure) Settings
 147         </p>
 148         <div class="MEDIAOBJECT">
 149           <p>
 150             <img src="proxy2.jpg">
 151           </p>
 152         </div>
 153       </div>
 154
 155       <p>
 156         After doing this, flush your browser's disk and memory caches to
 157         force a re-reading of all pages and to get rid of any ads that may be
 158         cached. Remove any <a href=
 159         "http://en.wikipedia.org/wiki/Browser_cookie" target=
 160         "_top">cookies</a>, if you want <span class=
 161         "APPLICATION">Privoxy</span> to manage that. You are now ready to
 162         start enjoying the benefits of using <span class=
 163         "APPLICATION">Privoxy</span>!
 164       </p>
 165       <p>
 166         <span class="APPLICATION">Privoxy</span> itself is typically started
 167         by specifying the main configuration file to be used on the command
 168         line. If no configuration file is specified on the command line,
 169         <span class="APPLICATION">Privoxy</span> will look for a file named
 170         <tt class="FILENAME">config</tt> in the current directory. Except on
 171         Win32 where it will try <tt class="FILENAME">config.txt</tt>.
 172       </p>
 173       <div class="SECT2">
 174         <h2 class="SECT2">
 175           <a name="START-REDHAT">5.1. Red Hat and Fedora</a>
 176         </h2>
 177         <p>
 178           A default Red Hat installation may not start <span class=
 179           "APPLICATION">Privoxy</span> upon boot. It will use the file <tt
 180           class="FILENAME">/etc/privoxy/config</tt> as its main configuration
 181           file.
 182         </p>
 183         <p>
 184         </p>
 185         <table border="0" bgcolor="#E0E0E0" width="100%">
 186           <tr>
 187             <td>
 188 <pre class="SCREEN">
 189  # /etc/rc.d/init.d/privoxy start
 190 </pre>
 191             </td>
 192           </tr>
 193         </table>
 194
 195         <p>
 196           Or ...
 197         </p>
 198         <p>
 199         </p>
 200         <table border="0" bgcolor="#E0E0E0" width="100%">
 201           <tr>
 202             <td>
 203 <pre class="SCREEN">
 204  # service privoxy start
 205 </pre>
 206             </td>
 207           </tr>
 208         </table>
 209       </div>
 210       <div class="SECT2">
 211         <h2 class="SECT2">
 212           <a name="START-DEBIAN">5.2. Debian</a>
 213         </h2>
 214         <p>
 215           We use a script. Note that Debian typically starts <span class=
 216           "APPLICATION">Privoxy</span> upon booting per default. It will use
 217           the file <tt class="FILENAME">/etc/privoxy/config</tt> as its main
 218           configuration file.
 219         </p>
 220         <p>
 221         </p>
 222         <table border="0" bgcolor="#E0E0E0" width="100%">
 223           <tr>
 224             <td>
 225 <pre class="SCREEN">
 226  # /etc/init.d/privoxy start
 227 </pre>
 228             </td>
 229           </tr>
 230         </table>
 231       </div>
 232       <div class="SECT2">
 233         <h2 class="SECT2">
 234           <a name="START-WINDOWS">5.3. Windows</a>
 235         </h2>
 236         <p>
 237           Click on the <span class="APPLICATION">Privoxy</span> Icon to start
 238           <span class="APPLICATION">Privoxy</span>. If no configuration file
 239           is specified on the command line, <span class=
 240           "APPLICATION">Privoxy</span> will look for a file named <tt class=
 241           "FILENAME">config.txt</tt>. Note that Windows will automatically
 242           start <span class="APPLICATION">Privoxy</span> when the system
 243           starts if you chose that option when installing.
 244         </p>
 245         <p>
 246           <span class="APPLICATION">Privoxy</span> can run with full Windows
 247           service functionality. On Windows only, the <span class=
 248           "APPLICATION">Privoxy</span> program has two new command line
 249           arguments to install and uninstall <span class=
 250           "APPLICATION">Privoxy</span> as a service. See the <a href=
 251           "installation.html#INSTALLATION-PACK-WIN">Windows Installation
 252           instructions</a> for details.
 253         </p>
 254       </div>
 255       <div class="SECT2">
 256         <h2 class="SECT2">
 257           <a name="START-UNICES">5.4. Solaris, NetBSD, FreeBSD, HP-UX and
 258           others</a>
 259         </h2>
 260         <p>
 261           Example Unix startup command:
 262         </p>
 263         <p>
 264         </p>
 265         <table border="0" bgcolor="#E0E0E0" width="100%">
 266           <tr>
 267             <td>
 268 <pre class="SCREEN">
 269  # /usr/sbin/privoxy /etc/privoxy/config
 270 </pre>
 271             </td>
 272           </tr>
 273         </table>
 274       </div>
 275       <div class="SECT2">
 276         <h2 class="SECT2">
 277           <a name="START-OS2">5.5. OS/2</a>
 278         </h2>
 279         <p>
 280           During installation, <span class="APPLICATION">Privoxy</span> is
 281           configured to start automatically when the system restarts. You can
 282           start it manually by double-clicking on the <span class=
 283           "APPLICATION">Privoxy</span> icon in the <span class=
 284           "APPLICATION">Privoxy</span> folder.
 285         </p>
 286       </div>
 287       <div class="SECT2">
 288         <h2 class="SECT2">
 289           <a name="START-MACOSX">5.6. Mac OS X</a>
 290         </h2>
 291         <p>
 292           After downloading the privoxy software, unzip the downloaded file
 293           by double-clicking on the zip file icon. Then, double-click on the
 294           installer package icon and follow the installation process.
 295         </p>
 296         <p>
 297           The privoxy service will automatically start after a successful
 298           installation. In addition, the privoxy service will automatically
 299           start every time your computer starts up.
 300         </p>
 301         <p>
 302           To prevent the privoxy service from automatically starting when
 303           your computer starts up, remove or rename the folder named
 304           /Library/StartupItems/Privoxy.
 305         </p>
 306         <p>
 307           A simple application named Privoxy Utility has been created which
 308           enables administrators to easily start and stop the privoxy
 309           service.
 310         </p>
 311         <p>
 312           In addition, the Privoxy Utility presents a simple way for
 313           administrators to edit the various privoxy config files. A method
 314           to uninstall the software is also available.
 315         </p>
 316         <p>
 317           An administrator username and password must be supplied in order
 318           for the Privoxy Utility to perform any of the tasks.
 319         </p>
 320       </div>
 321       <div class="SECT2">
 322         <h2 class="SECT2">
 323           <a name="START-AMIGAOS">5.7. AmigaOS</a>
 324         </h2>
 325         <p>
 326           Start <span class="APPLICATION">Privoxy</span> (with RUN
 327           &lt;&gt;NIL:) in your <tt class="FILENAME">startnet</tt> script
 328           (AmiTCP), in <tt class="FILENAME">s:user-startup</tt> (RoadShow),
 329           as startup program in your startup script (Genesis), or as startup
 330           action (Miami and MiamiDx). <span class=
 331           "APPLICATION">Privoxy</span> will automatically quit when you quit
 332           your TCP/IP stack (just ignore the harmless warning your TCP/IP
 333           stack may display that <span class="APPLICATION">Privoxy</span> is
 334           still running).
 335         </p>
 336       </div>
 337       <div class="SECT2">
 338         <h2 class="SECT2">
 339           <a name="START-GENTOO">5.8. Gentoo</a>
 340         </h2>
 341         <p>
 342           A script is again used. It will use the file <tt class=
 343           "FILENAME">/etc/privoxy/config</tt> as its main configuration file.
 344         </p>
 345         <p>
 346         </p>
 347         <table border="0" bgcolor="#E0E0E0" width="100%">
 348           <tr>
 349             <td>
 350 <pre class="SCREEN">
 351  /etc/init.d/privoxy start
 352 </pre>
 353             </td>
 354           </tr>
 355         </table>
 356
 357         <p>
 358           Note that <span class="APPLICATION">Privoxy</span> is not
 359           automatically started at boot time by default. You can change this
 360           with the <tt class="LITERAL">rc-update</tt> command.
 361         </p>
 362         <p>
 363         </p>
 364         <table border="0" bgcolor="#E0E0E0" width="100%">
 365           <tr>
 366             <td>
 367 <pre class="SCREEN">
 368  rc-update add privoxy default
 369 </pre>
 370             </td>
 371           </tr>
 372         </table>
 373       </div>
 374       <div class="SECT2">
 375         <h2 class="SECT2">
 376           <a name="CMDOPTIONS">5.9. Command Line Options</a>
 377         </h2>
 378         <p>
 379           <span class="APPLICATION">Privoxy</span> may be invoked with the
 380           following command-line options:
 381         </p>
 382         <p>
 383         </p>
 384         <ul>
 385           <li>
 386             <p>
 387               <span class="emphasis"><i class="EMPHASIS">--version</i></span>
 388             </p>
 389             <p>
 390               Print version info and exit. Unix only.
 391             </p>
 392           </li>
 393           <li>
 394             <p>
 395               <span class="emphasis"><i class="EMPHASIS">--help</i></span>
 396             </p>
 397             <p>
 398               Print short usage info and exit. Unix only.
 399             </p>
 400           </li>
 401           <li>
 402             <p>
 403               <span class="emphasis"><i class=
 404               "EMPHASIS">--no-daemon</i></span>
 405             </p>
 406             <p>
 407               Don't become a daemon, i.e. don't fork and become process group
 408               leader, and don't detach from controlling tty. Unix only.
 409             </p>
 410           </li>
 411           <li>
 412             <p>
 413               <span class="emphasis"><i class="EMPHASIS">--pidfile
 414               FILE</i></span>
 415             </p>
 416             <p>
 417               On startup, write the process ID to <span class="emphasis"><i
 418               class="EMPHASIS">FILE</i></span>. Delete the <span class=
 419               "emphasis"><i class="EMPHASIS">FILE</i></span> on exit. Failure
 420               to create or delete the <span class="emphasis"><i class=
 421               "EMPHASIS">FILE</i></span> is non-fatal. If no <span class=
 422               "emphasis"><i class="EMPHASIS">FILE</i></span> option is given,
 423               no PID file will be used. Unix only.
 424             </p>
 425           </li>
 426           <li>
 427             <p>
 428               <span class="emphasis"><i class="EMPHASIS">--user
 429               USER[.GROUP]</i></span>
 430             </p>
 431             <p>
 432               After (optionally) writing the PID file, assume the user ID of
 433               <span class="emphasis"><i class="EMPHASIS">USER</i></span>, and
 434               if included the GID of GROUP. Exit if the privileges are not
 435               sufficient to do so. Unix only.
 436             </p>
 437           </li>
 438           <li>
 439             <p>
 440               <span class="emphasis"><i class="EMPHASIS">--chroot</i></span>
 441             </p>
 442             <p>
 443               Before changing to the user ID given in the <span class=
 444               "emphasis"><i class="EMPHASIS">--user</i></span> option, chroot
 445               to that user's home directory, i.e. make the kernel pretend to
 446               the <span class="APPLICATION">Privoxy</span> process that the
 447               directory tree starts there. If set up carefully, this can
 448               limit the impact of possible vulnerabilities in <span class=
 449               "APPLICATION">Privoxy</span> to the files contained in that
 450               hierarchy. Unix only.
 451             </p>
 452           </li>
 453           <li>
 454             <p>
 455               <span class="emphasis"><i class=
 456               "EMPHASIS">--pre-chroot-nslookup hostname</i></span>
 457             </p>
 458             <p>
 459               Specifies a hostname to look up before doing a chroot. On some
 460               systems, initializing the resolver library involves reading
 461               config files from /etc and/or loading additional shared
 462               libraries from /lib. On these systems, doing a hostname lookup
 463               before the chroot reduces the number of files that must be
 464               copied into the chroot tree.
 465             </p>
 466             <p>
 467               For fastest startup speed, a good value is a hostname that is
 468               not in /etc/hosts but that your local name server (listed in
 469               /etc/resolv.conf) can resolve without recursion (that is,
 470               without having to ask any other name servers). The hostname
 471               need not exist, but if it doesn't, an error message (which can
 472               be ignored) will be output.
 473             </p>
 474           </li>
 475           <li>
 476             <p>
 477               <span class="emphasis"><i class=
 478               "EMPHASIS">configfile</i></span>
 479             </p>
 480             <p>
 481               If no <span class="emphasis"><i class=
 482               "EMPHASIS">configfile</i></span> is included on the command
 483               line, <span class="APPLICATION">Privoxy</span> will look for a
 484               file named <span class="QUOTE">"config"</span> in the current
 485               directory (except on Win32 where it will look for <span class=
 486               "QUOTE">"config.txt"</span> instead). Specify full path to
 487               avoid confusion. If no config file is found, <span class=
 488               "APPLICATION">Privoxy</span> will fail to start.
 489             </p>
 490           </li>
 491         </ul>
 492
 493         <p>
 494           On <span class="APPLICATION">MS Windows</span> only there are two
 495           additional command-line options to allow <span class=
 496           "APPLICATION">Privoxy</span> to install and run as a <span class=
 497           "emphasis"><i class="EMPHASIS">service</i></span>. See the <a href=
 498           "installation.html#INSTALLATION-PACK-WIN">Window Installation
 499           section</a> for details.
 500         </p>
 501       </div>
 502     </div>
 503     <div class="NAVFOOTER">
 504       <hr width="100%" class="c1">
 505       <table summary="Footer navigation table" width="100%" border="0"
 506       cellpadding="0" cellspacing="0">
 507         <tr>
 508           <td width="33%" align="left" valign="top">
 509             <a href="quickstart.html" accesskey="P">Prev</a>
 510           </td>
 511           <td width="34%" align="center" valign="top">
 512             <a href="index.html" accesskey="H">Home</a>
 513           </td>
 514           <td width="33%" align="right" valign="top">
 515             <a href="configuration.html" accesskey="N">Next</a>
 516           </td>
 517         </tr>
 518         <tr>
 519           <td width="33%" align="left" valign="top">
 520             Quickstart to Using Privoxy
 521           </td>
 522           <td width="34%" align="center" valign="top">
 523             &nbsp;
 524           </td>
 525           <td width="33%" align="right" valign="top">
 526             Privoxy Configuration
 527           </td>
 528         </tr>
 529       </table>
 530     </div>
 531   </body>
 532 </html>
 533