1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
6 <title>Starting Privoxy</title>
7 <meta name="GENERATOR" content=
8 "Modular DocBook HTML Stylesheet Version 1.79">
9 <link rel="HOME" title="Privoxy 3.0.24 User Manual" href="index.html">
10 <link rel="PREVIOUS" title="Quickstart to Using Privoxy" href=
12 <link rel="NEXT" title="Privoxy Configuration" href="configuration.html">
13 <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
14 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
15 <link rel="STYLESHEET" type="text/css" href="p_doc.css">
18 <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
19 "#840084" alink="#0000FF">
20 <div class="NAVHEADER">
21 <table summary="Header navigation table" width="100%" border="0"
22 cellpadding="0" cellspacing="0">
24 <th colspan="3" align="center">Privoxy 3.0.24 User Manual</th>
28 <td width="10%" align="left" valign="bottom"><a href=
29 "quickstart.html" accesskey="P">Prev</a></td>
31 <td width="80%" align="center" valign="bottom"></td>
33 <td width="10%" align="right" valign="bottom"><a href=
34 "configuration.html" accesskey="N">Next</a></td>
37 <hr align="left" width="100%">
41 <h1 class="SECT1"><a name="STARTUP" id="STARTUP">5. Starting
44 <p>Before launching <span class="APPLICATION">Privoxy</span> for the
45 first time, you will want to configure your browser(s) to use
46 <span class="APPLICATION">Privoxy</span> as a HTTP and HTTPS (SSL)
47 <a href="http://en.wikipedia.org/wiki/Proxy_server" target=
48 "_top">proxy</a>. The default is 127.0.0.1 (or localhost) for the proxy
49 address, and port 8118 (earlier versions used port 8000). This is the one
50 configuration step <span class="emphasis"><i class="EMPHASIS">that must
51 be done</i></span>!</p>
53 <p>Please note that <span class="APPLICATION">Privoxy</span> can only
54 proxy HTTP and HTTPS traffic. It will not work with FTP or other
58 <a name="AEN627" id="AEN627"></a>
60 <p><b>Figure 2. Proxy Configuration Showing Mozilla/Netscape HTTP and
61 HTTPS (SSL) Settings</b></p>
63 <div class="MEDIAOBJECT">
64 <p><img src="proxy_setup.jpg"></p>
68 <p>With <span class="APPLICATION">Firefox</span>, this is typically set
71 <p class="LITERALLAYOUT"> <span class=
72 "GUIBUTTON">Tools</span> -> <span class=
73 "GUIBUTTON">Options</span> -> <span class=
74 "GUIBUTTON">Advanced</span> -> <span class=
75 "GUIBUTTON">Network</span> -><span class=
76 "GUIBUTTON">Connection</span> -> <span class=
77 "GUIBUTTON">Settings</span><br></p>
79 <p>Or optionally on some platforms:</p>
81 <p class="LITERALLAYOUT"> <span class=
82 "GUIBUTTON">Edit</span> -> <span class=
83 "GUIBUTTON">Preferences</span> -> <span class=
84 "GUIBUTTON">General</span> -> <span class=
85 "GUIBUTTON">Connection Settings</span> -> <span class=
86 "GUIBUTTON">Manual Proxy Configuration</span><br></p>
88 <p>With <span class="APPLICATION">Netscape</span> (and <span class=
89 "APPLICATION">Mozilla</span>), this can be set under:</p>
91 <p class="LITERALLAYOUT"> <span class=
92 "GUIBUTTON">Edit</span> -> <span class=
93 "GUIBUTTON">Preferences</span> -> <span class=
94 "GUIBUTTON">Advanced</span> -> <span class=
95 "GUIBUTTON">Proxies</span> -> <span class="GUIBUTTON">HTTP
98 <p>For <span class="APPLICATION">Internet Explorer v.5-7</span>:</p>
100 <p class="LITERALLAYOUT"> <span class=
101 "GUIBUTTON">Tools</span> -> <span class="GUIBUTTON">Internet
102 Options</span> -> <span class=
103 "GUIBUTTON">Connections</span> -> <span class=
104 "GUIBUTTON">LAN Settings</span></p>
106 <p>Then, check <span class="QUOTE">"Use Proxy"</span> and fill in the
107 appropriate info (Address: 127.0.0.1, Port: 8118). Include HTTPS (SSL),
108 if you want HTTPS proxy support too (sometimes labeled <span class=
109 "QUOTE">"Secure"</span>). Make sure any checkboxes like <span class=
110 "QUOTE">"Use the same proxy server for all protocols"</span> is
111 <span class="emphasis"><i class="EMPHASIS">UNCHECKED</i></span>. You want
112 only HTTP and HTTPS (SSL)!</p>
115 <a name="AEN672" id="AEN672"></a>
117 <p><b>Figure 3. Proxy Configuration Showing Internet Explorer HTTP and
118 HTTPS (Secure) Settings</b></p>
120 <div class="MEDIAOBJECT">
121 <p><img src="proxy2.jpg"></p>
125 <p>After doing this, flush your browser's disk and memory caches to force
126 a re-reading of all pages and to get rid of any ads that may be cached.
127 Remove any <a href="http://en.wikipedia.org/wiki/Browser_cookie" target=
128 "_top">cookies</a>, if you want <span class="APPLICATION">Privoxy</span>
129 to manage that. You are now ready to start enjoying the benefits of using
130 <span class="APPLICATION">Privoxy</span>!</p>
132 <p><span class="APPLICATION">Privoxy</span> itself is typically started
133 by specifying the main configuration file to be used on the command line.
134 If no configuration file is specified on the command line, <span class=
135 "APPLICATION">Privoxy</span> will look for a file named <tt class=
136 "FILENAME">config</tt> in the current directory. Except on Win32 where it
137 will try <tt class="FILENAME">config.txt</tt>.</p>
140 <h2 class="SECT2"><a name="START-DEBIAN" id="START-DEBIAN">5.1.
143 <p>We use a script. Note that Debian typically starts <span class=
144 "APPLICATION">Privoxy</span> upon booting per default. It will use the
145 file <tt class="FILENAME">/etc/privoxy/config</tt> as its main
146 configuration file.</p>
148 <table border="0" bgcolor="#E0E0E0" width="100%">
152 # /etc/init.d/privoxy start
160 <h2 class="SECT2"><a name="START-FREEBSD" id="START-FREEBSD">5.2.
161 FreeBSD and ElectroBSD</a></h2>
163 <p>To start <span class="APPLICATION">Privoxy</span> upon booting, add
164 "privoxy_enable='YES'" to <tt class="FILENAME">/etc/rc.conf</tt>.
165 <span class="APPLICATION">Privoxy</span> will use <tt class=
166 "FILENAME">/usr/local/etc/privoxy/config</tt> as its main configuration
169 <p>If you installed <span class="APPLICATION">Privoxy</span> into a
170 jail, the paths above are relative to the jail root.</p>
172 <p>To start <span class="APPLICATION">Privoxy</span> manually, run:</p>
174 <table border="0" bgcolor="#E0E0E0" width="100%">
178 # service privoxy onestart
186 <h2 class="SECT2"><a name="START-WINDOWS" id="START-WINDOWS">5.3.
189 <p>Click on the <span class="APPLICATION">Privoxy</span> Icon to start
190 <span class="APPLICATION">Privoxy</span>. If no configuration file is
191 specified on the command line, <span class="APPLICATION">Privoxy</span>
192 will look for a file named <tt class="FILENAME">config.txt</tt>. Note
193 that Windows will automatically start <span class=
194 "APPLICATION">Privoxy</span> when the system starts if you chose that
195 option when installing.</p>
197 <p><span class="APPLICATION">Privoxy</span> can run with full Windows
198 service functionality. On Windows only, the <span class=
199 "APPLICATION">Privoxy</span> program has two new command line arguments
200 to install and uninstall <span class="APPLICATION">Privoxy</span> as a
201 service. See the <a href=
202 "installation.html#INSTALLATION-PACK-WIN">Windows Installation
203 instructions</a> for details.</p>
207 <h2 class="SECT2"><a name="START-UNICES" id="START-UNICES">5.4. Generic
208 instructions for Unix derivates (Solaris, NetBSD, HP-UX etc.)</a></h2>
210 <p>Example Unix startup command:</p>
212 <table border="0" bgcolor="#E0E0E0" width="100%">
216 # /usr/sbin/privoxy --user privoxy /etc/privoxy/config
222 <p>Note that if you installed <span class="APPLICATION">Privoxy</span>
223 through a package manager, the package will probably contain a
224 platform-specific script or configuration file to start <span class=
225 "APPLICATION">Privoxy</span> upon boot.</p>
229 <h2 class="SECT2"><a name="START-OS2" id="START-OS2">5.5. OS/2</a></h2>
231 <p>During installation, <span class="APPLICATION">Privoxy</span> is
232 configured to start automatically when the system restarts. You can
233 start it manually by double-clicking on the <span class=
234 "APPLICATION">Privoxy</span> icon in the <span class=
235 "APPLICATION">Privoxy</span> folder.</p>
239 <h2 class="SECT2"><a name="START-MACOSX" id="START-MACOSX">5.6. Mac OS
242 <p>After downloading the privoxy software, unzip the downloaded file by
243 double-clicking on the zip file icon. Then, double-click on the
244 installer package icon and follow the installation process.</p>
246 <p>The privoxy service will automatically start after a successful
247 installation. In addition, the privoxy service will automatically start
248 every time your computer starts up.</p>
250 <p>To prevent the privoxy service from automatically starting when your
251 computer starts up, remove or rename the folder named
252 /Library/StartupItems/Privoxy.</p>
254 <p>A simple application named Privoxy Utility has been created which
255 enables administrators to easily start and stop the privoxy
258 <p>In addition, the Privoxy Utility presents a simple way for
259 administrators to edit the various privoxy config files. A method to
260 uninstall the software is also available.</p>
262 <p>An administrator username and password must be supplied in order for
263 the Privoxy Utility to perform any of the tasks.</p>
267 <h2 class="SECT2"><a name="CMDOPTIONS" id="CMDOPTIONS">5.7. Command
268 Line Options</a></h2>
270 <p><span class="APPLICATION">Privoxy</span> may be invoked with the
271 following command-line options:</p>
275 <p><span class="emphasis"><i class=
276 "EMPHASIS">--config-test</i></span></p>
278 <p>Exit after loading the configuration files before binding to the
279 listen address. The exit code signals whether or not the
280 configuration files have been successfully loaded.</p>
282 <p>If the exit code is 1, at least one of the configuration files
283 is invalid, if it is 0, all the configuration files have been
284 successfully loaded (but may still contain errors that can
285 currently only be detected at run time).</p>
287 <p>This option doesn't affect the log setting, combination with
288 <span class="emphasis"><i class="EMPHASIS">--no-daemon</i></span>
289 is recommended if a configured log file shouldn't be used.</p>
293 <p><span class="emphasis"><i class=
294 "EMPHASIS">--version</i></span></p>
296 <p>Print version info and exit. Unix only.</p>
300 <p><span class="emphasis"><i class="EMPHASIS">--help</i></span></p>
302 <p>Print short usage info and exit. Unix only.</p>
306 <p><span class="emphasis"><i class=
307 "EMPHASIS">--no-daemon</i></span></p>
309 <p>Don't become a daemon, i.e. don't fork and become process group
310 leader, and don't detach from controlling tty. Unix only.</p>
314 <p><span class="emphasis"><i class="EMPHASIS">--pidfile
317 <p>On startup, write the process ID to <span class=
318 "emphasis"><i class="EMPHASIS">FILE</i></span>. Delete the
319 <span class="emphasis"><i class="EMPHASIS">FILE</i></span> on exit.
320 Failure to create or delete the <span class="emphasis"><i class=
321 "EMPHASIS">FILE</i></span> is non-fatal. If no <span class=
322 "emphasis"><i class="EMPHASIS">FILE</i></span> option is given, no
323 PID file will be used. Unix only.</p>
327 <p><span class="emphasis"><i class="EMPHASIS">--user
328 USER[.GROUP]</i></span></p>
330 <p>After (optionally) writing the PID file, assume the user ID of
331 <span class="emphasis"><i class="EMPHASIS">USER</i></span>, and if
332 included the GID of GROUP. Exit if the privileges are not
333 sufficient to do so. Unix only.</p>
337 <p><span class="emphasis"><i class=
338 "EMPHASIS">--chroot</i></span></p>
340 <p>Before changing to the user ID given in the <span class=
341 "emphasis"><i class="EMPHASIS">--user</i></span> option, chroot to
342 that user's home directory, i.e. make the kernel pretend to the
343 <span class="APPLICATION">Privoxy</span> process that the directory
344 tree starts there. If set up carefully, this can limit the impact
345 of possible vulnerabilities in <span class=
346 "APPLICATION">Privoxy</span> to the files contained in that
347 hierarchy. Unix only.</p>
351 <p><span class="emphasis"><i class="EMPHASIS">--pre-chroot-nslookup
352 hostname</i></span></p>
354 <p>Specifies a hostname (for example www.privoxy.org) to look up
355 before doing a chroot. On some systems, initializing the resolver
356 library involves reading config files from /etc and/or loading
357 additional shared libraries from /lib. On these systems, doing a
358 hostname lookup before the chroot reduces the number of files that
359 must be copied into the chroot tree.</p>
361 <p>For fastest startup speed, a good value is a hostname that is
362 not in /etc/hosts but that your local name server (listed in
363 /etc/resolv.conf) can resolve without recursion (that is, without
364 having to ask any other name servers). The hostname need not exist,
365 but if it doesn't, an error message (which can be ignored) will be
370 <p><span class="emphasis"><i class=
371 "EMPHASIS">configfile</i></span></p>
373 <p>If no <span class="emphasis"><i class=
374 "EMPHASIS">configfile</i></span> is included on the command line,
375 <span class="APPLICATION">Privoxy</span> will look for a file named
376 <span class="QUOTE">"config"</span> in the current directory
377 (except on Win32 where it will look for <span class=
378 "QUOTE">"config.txt"</span> instead). Specify full path to avoid
379 confusion. If no config file is found, <span class=
380 "APPLICATION">Privoxy</span> will fail to start.</p>
384 <p>On <span class="APPLICATION">MS Windows</span> only there are two
385 additional command-line options to allow <span class=
386 "APPLICATION">Privoxy</span> to install and run as a <span class=
387 "emphasis"><i class="EMPHASIS">service</i></span>. See the <a href=
388 "installation.html#INSTALLATION-PACK-WIN">Window Installation
389 section</a> for details.</p>
393 <div class="NAVFOOTER">
394 <hr align="left" width="100%">
396 <table summary="Footer navigation table" width="100%" border="0"
397 cellpadding="0" cellspacing="0">
399 <td width="33%" align="left" valign="top"><a href="quickstart.html"
400 accesskey="P">Prev</a></td>
402 <td width="34%" align="center" valign="top"><a href="index.html"
403 accesskey="H">Home</a></td>
405 <td width="33%" align="right" valign="top"><a href=
406 "configuration.html" accesskey="N">Next</a></td>
410 <td width="33%" align="left" valign="top">Quickstart to Using
413 <td width="34%" align="center" valign="top"> </td>
415 <td width="33%" align="right" valign="top">Privoxy Configuration</td>