1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01
2 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
5 <meta name="generator" content="HTML Tidy, see www.w3.org">
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="Introduction" href="introduction.html">
13 <link rel="NEXT" title="What's New in this Release" href="whatsnew.html">
14 <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
15 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
16 <link rel="STYLESHEET" type="text/css" href="p_doc.css">
17 <style type="text/css">
19 background-color: #EEEEEE;
22 :link { color: #0000FF }
23 :visited { color: #840084 }
24 :active { color: #0000FF }
25 hr.c1 {text-align: left}
29 <div class="NAVHEADER">
30 <table summary="Header navigation table" width="100%" border="0"
31 cellpadding="0" cellspacing="0">
33 <th colspan="3" align="center">
34 Privoxy 3.0.18 User Manual
38 <td width="10%" align="left" valign="bottom">
39 <a href="introduction.html" accesskey="P">Prev</a>
41 <td width="80%" align="center" valign="bottom">
43 <td width="10%" align="right" valign="bottom">
44 <a href="whatsnew.html" accesskey="N">Next</a>
48 <hr width="100%" class="c1">
52 <a name="INSTALLATION">2. Installation</a>
55 <span class="APPLICATION">Privoxy</span> is available both in
56 convenient pre-compiled packages for a wide range of operating
57 systems, and as raw source code. For most users, we recommend using
58 the packages, which can be downloaded from our <a href=
59 "http://sourceforge.net/projects/ijbswa/" target="_top">Privoxy
63 Note: On some platforms, the installer may remove previously
64 installed versions, if found. (See below for your platform). In any
65 case <span class="emphasis"><i class="EMPHASIS">be sure to backup
66 your old configuration if it is valuable to you.</i></span> See the
67 <a href="whatsnew.html#UPGRADERSNOTE">note to upgraders</a> section
72 <a name="INSTALLATION-PACKAGES">2.1. Binary Packages</a>
75 How to install the binary packages depends on your operating
80 <a name="INSTALLATION-PACK-RPM">2.1.1. Red Hat and Fedora
84 RPMs can be installed with <tt class="LITERAL">rpm -Uvh
85 privoxy-3.0.18-1.rpm</tt>, and will use <tt class=
86 "FILENAME">/etc/privoxy</tt> for the location of configuration
90 Note that on Red Hat, <span class="APPLICATION">Privoxy</span>
91 will <span class="emphasis"><i class="EMPHASIS">not</i></span> be
92 automatically started on system boot. You will need to enable
93 that using <b class="COMMAND">chkconfig</b>, <b class=
94 "COMMAND">ntsysv</b>, or similar methods.
97 If you have problems with failed dependencies, try rebuilding the
98 SRC RPM: <tt class="LITERAL">rpm --rebuild
99 privoxy-3.0.18-1.src.rpm</tt>. This will use your locally
100 installed libraries and RPM version.
103 Also note that if you have a <span class=
104 "APPLICATION">Junkbuster</span> RPM installed on your system, you
105 need to remove it first, because the packages conflict.
106 Otherwise, RPM will try to remove <span class=
107 "APPLICATION">Junkbuster</span> automatically if found, before
108 installing <span class="APPLICATION">Privoxy</span>.
113 <a name="INSTALLATION-DEB">2.1.2. Debian and Ubuntu</a>
116 DEBs can be installed with <tt class="LITERAL">apt-get install
117 privoxy</tt>, and will use <tt class="FILENAME">/etc/privoxy</tt>
118 for the location of configuration files.
123 <a name="INSTALLATION-PACK-WIN">2.1.3. Windows</a>
126 Just double-click the installer, which will guide you through the
127 installation process. You will find the configuration files in
128 the same directory as you installed <span class=
129 "APPLICATION">Privoxy</span> in.
132 Version 3.0.5 beta introduced full <span class=
133 "APPLICATION">Windows</span> service functionality. On Windows
134 only, the <span class="APPLICATION">Privoxy</span> program has
135 two new command line arguments to install and uninstall <span
136 class="APPLICATION">Privoxy</span> as a <span class="emphasis"><i
137 class="EMPHASIS">service</i></span>.
139 <div class="VARIABLELIST">
146 <tt class="REPLACEABLE"><i>--install</i></tt>[:<tt class=
147 "REPLACEABLE"><i>service_name</i></tt>]
150 <tt class="REPLACEABLE"><i>--uninstall</i></tt>[:<tt class=
151 "REPLACEABLE"><i>service_name</i></tt>]
157 After invoking <span class="APPLICATION">Privoxy</span> with <b
158 class="COMMAND">--install</b>, you will need to bring up the
159 <span class="APPLICATION">Windows</span> service console to
160 assign the user you want <span class="APPLICATION">Privoxy</span>
161 to run under, and whether or not you want it to run whenever the
162 system starts. You can start the <span class=
163 "APPLICATION">Windows</span> services console with the following
164 command: <b class="COMMAND">services.msc</b>. If you do not take
165 the manual step of modifying <span class=
166 "APPLICATION">Privoxy's</span> service settings, it will not
167 start. Note too that you will need to give Privoxy a user account
168 that actually exists, or it will not be permitted to write to its
169 log and configuration files.
174 <a name="INSTALLATION-PACK-BINTGZ">2.1.4. Solaris</a>
177 Create a new directory, <tt class="LITERAL">cd</tt> to it, then
178 unzip and untar the archive. For the most part, you'll have to
179 figure out where things go.
184 <a name="INSTALLATION-OS2">2.1.5. OS/2</a>
187 First, make sure that no previous installations of <span class=
188 "APPLICATION">Junkbuster</span> and / or <span class=
189 "APPLICATION">Privoxy</span> are left on your system. Check that
190 no <span class="APPLICATION">Junkbuster</span> or <span class=
191 "APPLICATION">Privoxy</span> objects are in your startup
195 Then, just double-click the WarpIN self-installing archive, which
196 will guide you through the installation process. A shadow of the
197 <span class="APPLICATION">Privoxy</span> executable will be
198 placed in your startup folder so it will start automatically
199 whenever OS/2 starts.
202 The directory you choose to install <span class=
203 "APPLICATION">Privoxy</span> into will contain all of the
209 <a name="INSTALLATION-MAC">2.1.6. Mac OS X</a>
212 Unzip the downloaded file (you can either double-click on the zip
213 file icon from the Finder, or from the desktop if you downloaded
214 it there). Then, double-click on the package installer icon and
215 follow the installation process.
218 The privoxy service will automatically start after a successful
219 installation (in addition to every time your computer starts up).
220 To prevent the privoxy service from automatically starting when
221 your computer starts up, remove or rename the folder named <tt
222 class="LITERAL">/Library/StartupItems/Privoxy</tt>.
225 To manually start or stop the privoxy service, use the Privoxy
226 Utility for Mac OS X. This application controls the privoxy
227 service (e.g. starting and stopping the service as well as
228 uninstalling the software).
233 <a name="INSTALLATION-AMIGA">2.1.7. AmigaOS</a>
236 Copy and then unpack the <tt class="FILENAME">lha</tt> archive to
237 a suitable location. All necessary files will be installed into
238 <span class="APPLICATION">Privoxy</span> directory, including all
239 configuration and log files. To uninstall, just remove this
245 <a name="INSTALLATION-TBZ">2.1.8. FreeBSD</a>
248 Privoxy is part of FreeBSD's Ports Collection, you can build and
249 install it with <tt class="LITERAL">cd /usr/ports/www/privoxy;
250 make install clean</tt>.
253 If you don't use the ports, you can fetch and install the package
254 with <tt class="LITERAL">pkg_add -r privoxy</tt>.
257 The port skeleton and the package can also be downloaded from the
259 "https://sourceforge.net/project/showfiles.php?group_id=11118"
260 target="_top">File Release Page</a>, but there's no reason to use
261 them unless you're interested in the beta releases which are only
267 <a name="INSTALLATTION-GENTOO">2.1.9. Gentoo</a>
270 Gentoo source packages (Ebuilds) for <span class=
271 "APPLICATION">Privoxy</span> are contained in the Gentoo Portage
272 Tree (they are not on the download page, but there is a Gentoo
273 section, where you can see when a new <span class=
274 "APPLICATION">Privoxy</span> Version is added to the Portage
278 Before installing <span class="APPLICATION">Privoxy</span> under
279 Gentoo just do first <tt class="LITERAL">emerge --sync</tt> to
280 get the latest changes from the Portage tree. With <tt class=
281 "LITERAL">emerge privoxy</tt> you install the latest version.
284 Configuration files are in <tt class=
285 "FILENAME">/etc/privoxy</tt>, the documentation is in <tt class=
286 "FILENAME">/usr/share/doc/privoxy-3.0.18</tt> and the Log
287 directory is in <tt class="FILENAME">/var/log/privoxy</tt>.
293 <a name="INSTALLATION-SOURCE">2.2. Building from Source</a>
296 The most convenient way to obtain the <span class=
297 "APPLICATION">Privoxy</span> sources is to download the source
298 tarball from our <a href=
299 "http://sourceforge.net/project/showfiles.php?group_id=11118&package_id=10571"
300 target="_top">project download page</a>.
303 If you like to live on the bleeding edge and are not afraid of
304 using possibly unstable development versions, you can check out the
305 up-to-the-minute version directly from <a href=
306 "http://sourceforge.net/cvs/?group_id=11118" target="_top">the CVS
310 To build <span class="APPLICATION">Privoxy</span> from source, <a
311 href="http://www.gnu.org/software/autoconf/autoconf.html" target=
312 "_top">autoconf</a>, <a href=
313 "http://www.gnu.org/software/make/make.html" target="_top">GNU make
314 (gmake)</a>, and, of course, a C compiler like <a href=
315 "http://www.gnu.org/software/gcc/gcc.html" target="_top">gcc</a>
319 When building from a source tarball, first unpack the source:
323 <table border="0" bgcolor="#E0E0E0" width="100%">
327 tar xzvf privoxy-3.0.18-beta-src.tar.gz
328 cd privoxy-3.0.18-beta
335 For retrieving the current CVS sources, you'll need a CVS client
336 installed. Note that sources from CVS are typically development
337 quality, and may not be stable, or well tested. To download CVS
338 source, check the Sourceforge documentation, which might give
343 <table border="0" bgcolor="#E0E0E0" width="100%">
347 cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
348 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current
356 This will create a directory named <tt class=
357 "FILENAME">current/</tt>, which will contain the source tree.
360 You can also check out any <span class="APPLICATION">Privoxy</span>
361 <span class="QUOTE">"branch"</span>, just exchange the <span class=
362 "APPLICATION">current</span> name with the wanted branch name
363 (Example: v_3_0_branch for the 3.0 cvs tree).
366 It is also strongly recommended to not run <span class=
367 "APPLICATION">Privoxy</span> as root. You should
368 configure/install/run <span class="APPLICATION">Privoxy</span> as
369 an unprivileged user, preferably by creating a <span class=
370 "QUOTE">"privoxy"</span> user and group just for this purpose. See
371 your local documentation for the correct command line to do add new
372 users and groups (something like <b class="COMMAND">adduser</b>,
373 but the command syntax may vary from platform to platform).
376 <tt class="FILENAME">/etc/passwd</tt> might then look like:
380 <table border="0" bgcolor="#E0E0E0" width="100%">
384 privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell
391 And then <tt class="FILENAME">/etc/group</tt>, like:
395 <table border="0" bgcolor="#E0E0E0" width="100%">
406 Some binary packages may do this for you.
409 Then, to build from either unpacked tarball or CVS source:
413 <table border="0" bgcolor="#E0E0E0" width="100%">
419 ./configure # (--help to see options)
420 make # (the make from GNU, sometimes called gmake)
421 su # Possibly required
422 make -n install # (to see where all the files will go)
423 make -s install # (to really install, -s to silence output)
430 Using GNU <b class="COMMAND">make</b>, you can have the first four
431 steps automatically done for you by just typing:
435 <table border="0" bgcolor="#E0E0E0" width="100%">
446 in the freshly downloaded or unpacked source directory.
449 To build an executable with security enhanced features so that
450 users cannot easily bypass the proxy (e.g. <span class="QUOTE">"Go
451 There Anyway"</span>), or alter their own configurations, <b class=
452 "COMMAND">configure</b> like this:
456 <table border="0" bgcolor="#E0E0E0" width="100%">
460 ./configure --disable-toggle --disable-editor --disable-force
467 Then build as above. In Privoxy 3.0.7 and later, all of these
468 options can also be disabled through the configuration file.
471 <span class="emphasis"><i class="EMPHASIS">WARNING:</i></span> If
472 installing as root, the install will fail unless a non-root user or
473 group is specified, or a <tt class="LITERAL">privoxy</tt> user and
474 group already exist on the system. If a non-root user is specified,
475 and no group, then the installation will try to also use a group of
476 the same name as <span class="QUOTE">"user"</span>. If a group is
477 specified (and no user), then the support files will be installed
478 as writable by that group, and owned by the user running the
482 <b class="COMMAND">configure</b> accepts <tt class=
483 "LITERAL">--with-user</tt> and <tt class=
484 "LITERAL">--with-group</tt> options for setting user and group
485 ownership of the configuration files (which need to be writable by
486 the daemon). The specified <span class="emphasis"><i class=
487 "EMPHASIS">user must already exist</i></span>. When starting <span
488 class="APPLICATION">Privoxy</span>, it must be run as this same
489 user to insure write access to configuration and log files!
492 Alternately, you can specify <tt class="LITERAL">user</tt> and <tt
493 class="LITERAL">group</tt> on the <b class="COMMAND">make</b>
494 command line, but be sure both already exist:
498 <table border="0" bgcolor="#E0E0E0" width="100%">
502 make -s install USER=privoxy GROUP=privoxy
509 The default installation path for <b class="COMMAND">make
510 install</b> is <tt class="FILENAME">/usr/local</tt>. This may of
511 course be customized with the various <b class=
512 "COMMAND">./configure</b> path options. If you are doing an install
513 to anywhere besides <tt class="FILENAME">/usr/local</tt>, be sure
514 to set the appropriate paths with the correct configure options (<b
515 class="COMMAND">./configure --help</b>). Non-privileged users must
516 of course have write access permissions to wherever the target
517 installation is going.
520 If you do install to <tt class="FILENAME">/usr/local</tt>, the
521 install will use <tt class=
522 "LITERAL">sysconfdir=$prefix/etc/privoxy</tt> by default. All other
523 destinations, and the direct usage of <tt class=
524 "LITERAL">--sysconfdir</tt> flag behave like normal, i.e. will not
525 add the extra <tt class="FILENAME">privoxy</tt> directory. This is
526 for a safer install, as there may already exist another program
527 that uses a file with the <span class="QUOTE">"config"</span> name,
528 and thus makes <tt class="FILENAME">/usr/local/etc</tt> cleaner.
531 If installing to <tt class="FILENAME">/usr/local</tt>, the
532 documentation will go by default to <tt class=
533 "FILENAME">$prefix/share/doc</tt>. But if this directory doesn't
534 exist, it will then try <tt class="FILENAME">$prefix/doc</tt> and
535 install there before creating a new <tt class=
536 "FILENAME">$prefix/share/doc</tt> just for <span class=
537 "APPLICATION">Privoxy</span>.
540 Again, if the installs goes to <tt class=
541 "FILENAME">/usr/local</tt>, the <tt class=
542 "LITERAL">localstatedir</tt> (ie: <tt class="FILENAME">var/</tt>)
543 will default to <tt class="FILENAME">/var</tt> instead of <tt
544 class="LITERAL">$prefix/var</tt> so the logs will go to <tt class=
545 "FILENAME">/var/log/privoxy/</tt>, and the pid file will be created
546 in <tt class="FILENAME">/var/run/privoxy.pid</tt>.
549 <b class="COMMAND">make install</b> will attempt to set the correct
550 values in <tt class="FILENAME">config</tt> (main configuration
551 file). You should check this to make sure all values are correct.
552 If appropriate, an init script will be installed, but it is up to
553 the user to determine how and where to start <span class=
554 "APPLICATION">Privoxy</span>. The init script should be checked for
555 correct paths and values, if anything other than a default install
559 If install finds previous versions of local configuration files,
560 most of these will not be overwritten, and the new ones will be
561 installed with a <span class="QUOTE">"new"</span> extension.
562 default.action and default.filter <span class="emphasis"><i class=
563 "EMPHASIS">will be overwritten</i></span>. You will then need to
564 manually update the other installed configuration files as needed.
565 The default template files <span class="emphasis"><i class=
566 "EMPHASIS">will</i></span> be overwritten. If you have customized,
567 local templates, these should be stored safely in a separate
568 directory and defined in <tt class="FILENAME">config</tt> by the
569 <span class="QUOTE">"templdir"</span> directive. It is of course
570 wise to always back-up any important configuration files <span
571 class="QUOTE">"just in case"</span>. If a previous version of <span
572 class="APPLICATION">Privoxy</span> is already running, you will
573 have to restart it manually.
576 For more detailed instructions on how to build Redhat RPMs, Windows
577 self-extracting installers, building on platforms with special
578 requirements etc, please consult the <a href=
579 "http://www.privoxy.org/developer-manual/newrelease.html" target=
580 "_top">developer manual</a>.
585 <a name="INSTALLATION-KEEPUPDATED">2.3. Keeping your Installation
589 As user feedback comes in and development continues, we will make
590 updated versions of both the main <a href=
591 "actions-file.html">actions file</a> (as a <a href=
592 "http://sourceforge.net/project/showfiles.php?group_id=11118&release_id=103670"
593 target="_top">separate package</a>) and the software itself
594 (including the actions file) available for download.
597 If you wish to receive an email notification whenever we release
598 updates of <span class="APPLICATION">Privoxy</span> or the actions
600 "http://lists.sourceforge.net/lists/listinfo/ijbswa-announce/"
601 target="_top">subscribe to our announce mailing list</a>,
602 ijbswa-announce@lists.sourceforge.net.
605 In order not to lose your personal changes and adjustments when
606 updating to the latest <tt class="LITERAL">default.action</tt> file
607 we <span class="emphasis"><i class="EMPHASIS">strongly
608 recommend</i></span> that you use <tt class=
609 "LITERAL">user.action</tt> and <tt class="LITERAL">user.filter</tt>
610 for your local customizations of <span class=
611 "APPLICATION">Privoxy</span>. See the <a href=
612 "actions-file.html">Chapter on actions files</a> for details.
616 <div class="NAVFOOTER">
617 <hr width="100%" class="c1">
618 <table summary="Footer navigation table" width="100%" border="0"
619 cellpadding="0" cellspacing="0">
621 <td width="33%" align="left" valign="top">
622 <a href="introduction.html" accesskey="P">Prev</a>
624 <td width="34%" align="center" valign="top">
625 <a href="index.html" accesskey="H">Home</a>
627 <td width="33%" align="right" valign="top">
628 <a href="whatsnew.html" accesskey="N">Next</a>
632 <td width="33%" align="left" valign="top">
635 <td width="34%" align="center" valign="top">
638 <td width="33%" align="right" valign="top">
639 What's New in this Release