1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
10 TITLE="Privoxy 3.0.13 User Manual"
11 HREF="index.html"><LINK
14 HREF="introduction.html"><LINK
16 TITLE="What's New in this Release"
17 HREF="whatsnew.html"><LINK
20 HREF="../p_doc.css"><META
21 HTTP-EQUIV="Content-Type"
24 <LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
36 SUMMARY="Header navigation table"
45 >Privoxy 3.0.13 User Manual</TH
53 HREF="introduction.html"
88 > is available both in convenient pre-compiled
89 packages for a wide range of operating systems, and as raw source code.
90 For most users, we recommend using the packages, which can be downloaded from our
92 HREF="http://sourceforge.net/projects/ijbswa/"
99 On some platforms, the installer may remove previously installed versions, if
100 found. (See below for your platform). In any case <SPAN
105 your old configuration if it is valuable to you.</I
108 HREF="whatsnew.html#UPGRADERSNOTE"
109 >note to upgraders</A
116 NAME="INSTALLATION-PACKAGES"
117 >2.1. Binary Packages</A
120 >How to install the binary packages depends on your operating system:</P
126 NAME="INSTALLATION-PACK-RPM"
127 >2.1.1. Red Hat and Fedora RPMs</A
130 > RPMs can be installed with <TT
132 >rpm -Uvh privoxy-3.0.13-1.rpm</TT
138 of configuration files.</P
140 > Note that on Red Hat, <SPAN
150 > be automatically started on system boot. You will
151 need to enable that using <B
158 >, or similar methods. </P
160 > If you have problems with failed dependencies, try rebuilding the SRC RPM:
163 >rpm --rebuild privoxy-3.0.13-1.src.rpm</TT
165 will use your locally installed libraries and RPM version. </P
167 > Also note that if you have a <SPAN
171 on your system, you need to remove it first, because the packages conflict.
172 Otherwise, RPM will try to remove <SPAN
176 automatically if found, before installing <SPAN
186 NAME="INSTALLATION-DEB"
187 >2.1.2. Debian and Ubuntu</A
190 > DEBs can be installed with <TT
192 >apt-get install privoxy</TT
197 > for the location of
198 configuration files.</P
205 NAME="INSTALLATION-PACK-WIN"
209 > Just double-click the installer, which will guide you through
210 the installation process. You will find the configuration files
211 in the same directory as you installed <SPAN
216 > Version 3.0.5 beta introduced full <SPAN
220 functionality. On Windows only, the <SPAN
224 program has two new command line arguments to install and uninstall
273 > After invoking <SPAN
280 >, you will need to bring up the
284 > service console to assign the user you
288 > to run under, and whether or not you
289 want it to run whenever the system starts. You can start the
293 > services console with the following
297 >. If you do not take the manual step
301 > service settings, it will
302 not start. Note too that you will need to give Privoxy a user account that
303 actually exists, or it will not be permitted to
304 write to its log and configuration files.</P
311 NAME="INSTALLATION-PACK-BINTGZ"
315 > Create a new directory, <TT
318 > to it, then unzip and
319 untar the archive. For the most part, you'll have to figure out where
327 NAME="INSTALLATION-OS2"
331 > First, make sure that no previous installations of
340 system. Check that no <SPAN
348 your startup folder. </P
350 > Then, just double-click the WarpIN self-installing archive, which will
351 guide you through the installation process. A shadow of the
355 > executable will be placed in your
356 startup folder so it will start automatically whenever OS/2 starts.</P
358 > The directory you choose to install <SPAN
362 into will contain all of the configuration files.</P
369 NAME="INSTALLATION-MAC"
373 > Unzip the downloaded file (you can either double-click on the zip file
374 icon from the Finder, or from the desktop if you downloaded it there).
375 Then, double-click on the package installer icon and follow the
376 installation process.</P
378 > The privoxy service will automatically start after a successful
379 installation (in addition to every time your computer starts up). To
380 prevent the privoxy service from automatically starting when your
381 computer starts up, remove or rename the folder named
384 >/Library/StartupItems/Privoxy</TT
387 > To manually start or stop the privoxy service, use the Privoxy Utility
388 for Mac OS X. This application controls the privoxy service (e.g.
389 starting and stopping the service as well as uninstalling the software).</P
396 NAME="INSTALLATION-AMIGA"
400 > Copy and then unpack the <TT
403 > archive to a suitable location.
404 All necessary files will be installed into <SPAN
408 directory, including all configuration and log files. To uninstall, just
409 remove this directory.</P
416 NAME="INSTALLATION-TBZ"
420 > Privoxy is part of FreeBSD's Ports Collection, you can build and install
423 >cd /usr/ports/www/privoxy; make install clean</TT
426 > If you don't use the ports, you can fetch and install
429 >pkg_add -r privoxy</TT
432 > The port skeleton and the package can also be downloaded from the
434 HREF="https://sourceforge.net/project/showfiles.php?group_id=11118"
438 >, but there's no reason to use them unless you're interested in the
439 beta releases which are only available there.</P
446 NAME="INSTALLATTION-GENTOO"
450 > Gentoo source packages (Ebuilds) for <SPAN
454 contained in the Gentoo Portage Tree (they are not on the download page,
455 but there is a Gentoo section, where you can see when a new
459 > Version is added to the Portage Tree).</P
461 > Before installing <SPAN
464 > under Gentoo just do
468 > to get the latest changes from the
469 Portage tree. With <TT
472 > you install the latest
475 > Configuration files are in <TT
479 documentation is in <TT
481 >/usr/share/doc/privoxy-3.0.13</TT
483 and the Log directory is in <TT
485 >/var/log/privoxy</TT
494 NAME="INSTALLATION-SOURCE"
495 >2.2. Building from Source</A
498 > The most convenient way to obtain the <SPAN
502 is to download the source tarball from our
504 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118&package_id=10571"
510 > If you like to live on the bleeding edge and are not afraid of using
511 possibly unstable development versions, you can check out the up-to-the-minute
512 version directly from <A
513 HREF="http://sourceforge.net/cvs/?group_id=11118"
524 HREF="http://www.gnu.org/software/autoconf/autoconf.html"
529 HREF="http://www.gnu.org/software/make/make.html"
533 >, and, of course, a C compiler like <A
534 HREF="http://www.gnu.org/software/gcc/gcc.html"
539 > When building from a source tarball,
540 first unpack the source: </P
550 > tar xzvf privoxy-3.0.13-beta-src.tar.gz
551 cd privoxy-3.0.13-beta</PRE
557 > For retrieving the current CVS sources, you'll need a CVS client installed.
558 Note that sources from CVS are typically development quality, and may not be
559 stable, or well tested. To download CVS source, check the Sourceforge
560 documentation, which might give commands like:</P
570 > cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
571 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current
578 > This will create a directory named <TT
582 contain the source tree.</P
584 > You can also check out any <SPAN
591 >, just exchange the <SPAN
595 name with the wanted branch name (Example: v_3_0_branch for the 3.0 cvs
598 > It is also strongly recommended to not run <SPAN
602 as root. You should configure/install/run <SPAN
606 an unprivileged user, preferably by creating a <SPAN
610 and group just for this purpose. See your local documentation for the correct
611 command line to do add new users and groups (something like
615 >, but the command syntax may vary from platform
621 > might then look like:</P
631 > privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell</PRE
650 > privoxy:*:7777:</PRE
656 > Some binary packages may do this for you.</P
658 > Then, to build from either unpacked tarball or CVS source:</P
670 ./configure # (--help to see options)
671 make # (the make from GNU, sometimes called gmake)
672 su # Possibly required
673 make -n install # (to see where all the files will go)
674 make -s install # (to really install, -s to silence output)</PRE
683 >, you can have the first four steps
684 automatically done for you by just typing:</P
700 > in the freshly downloaded or unpacked source directory.</P
702 > To build an executable with security enhanced features so that
703 users cannot easily bypass the proxy (e.g. <SPAN
705 >"Go There Anyway"</SPAN
707 alter their own configurations, <B
720 > ./configure --disable-toggle --disable-editor --disable-force</PRE
726 >Then build as above. In Privoxy 3.0.7 and later, all of these options
727 can also be disabled through the configuration file.</P
735 > If installing as root, the install will fail
736 unless a non-root user or group is specified, or a <TT
740 user and group already exist on the system. If a non-root user is specified,
741 and no group, then the installation will try to also use a group of the same name
745 >. If a group is specified (and no user), then the
746 support files will be installed as writable by that group, and owned by the
747 user running the installation.</P
759 > options for setting user and group ownership
760 of the configuration files (which need to be writable by the daemon). The
765 >user must already exist</I
771 >, it must be run as this same user to
772 insure write access to configuration and log files!</P
774 > Alternately, you can specify <TT
784 > command line, but be sure both already exist:</P
794 > make -s install USER=privoxy GROUP=privoxy</PRE
800 > The default installation path for <B
807 >. This may of course be customized with
811 > path options. If you are doing
812 an install to anywhere besides <TT
816 sure to set the appropriate paths with the correct configure options
819 >./configure --help</B
820 >). Non-privileged users must of course
821 have write access permissions to wherever the target installation is going.</P
823 > If you do install to <TT
826 >, the install will use
829 >sysconfdir=$prefix/etc/privoxy</TT
830 > by default. All other
831 destinations, and the direct usage of <TT
835 behave like normal, i.e. will not add the extra <TT
839 directory. This is for a safer install, as there may already exist another
840 program that uses a file with the <SPAN
843 > name, and thus makes
849 > If installing to <TT
852 >, the documentation will go
855 >$prefix/share/doc</TT
856 >. But if this directory
857 doesn't exist, it will then try <TT
861 there before creating a new <TT
863 >$prefix/share/doc</TT
870 > Again, if the installs goes to <TT
888 the logs will go to <TT
890 >/var/log/privoxy/</TT
892 will be created in <TT
894 >/var/run/privoxy.pid</TT
900 > will attempt to set the correct values
904 > (main configuration file). You should
905 check this to make sure all values are correct. If appropriate,
906 an init script will be installed, but it is up to the user to determine
907 how and where to start <SPAN
911 script should be checked for correct paths and values, if anything other than
912 a default install is done.</P
914 > If install finds previous versions of local configuration files, most of
915 these will not be overwritten, and the new ones will be installed with a
919 > extension. default.action and default.filter
924 >will be overwritten</I
926 >. You will then need
927 to manually update the other installed configuration files as needed. The
928 default template files <SPAN
934 > be overwritten. If you have
935 customized, local templates, these should be stored safely in a separate
936 directory and defined in <TT
943 > directive. It is of course wise to always back-up any
944 important configuration files <SPAN
946 >"just in case"</SPAN
951 > is already running, you will
952 have to restart it manually.</P
954 > For more detailed instructions on how to build Redhat RPMs,
955 Windows self-extracting installers, building on platforms with
956 special requirements etc, please consult the <A
957 HREF="http://www.privoxy.org/developer-manual/newrelease.html"
967 NAME="INSTALLATION-KEEPUPDATED"
968 >2.3. Keeping your Installation Up-to-Date</A
971 > As user feedback comes in and development continues, we will make updated versions
973 HREF="actions-file.html"
976 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118&release_id=103670"
980 >) and the software itself (including the actions file) available for
983 > If you wish to receive an email notification whenever we release updates of
987 > or the actions file, <A
988 HREF="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce/"
991 to our announce mailing list</A
992 >, ijbswa-announce@lists.sourceforge.net.</P
994 > In order not to lose your personal changes and adjustments when updating
1013 customizations of <SPAN
1017 HREF="actions-file.html"
1018 >Chapter on actions files</A
1027 SUMMARY="Footer navigation table"
1038 HREF="introduction.html"
1056 HREF="whatsnew.html"
1076 >What's New in this Release</TD