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.8 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.8 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.8-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.8-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 file
374 from the finder, or from the desktop if you downloaded it there).
375 Then, double-click on the package installer icon named
380 and follow the installation process.
384 > will be installed in the folder
387 >/Library/Privoxy</TT
389 It will start automatically whenever you start up. To prevent it from
390 starting automatically, remove or rename the folder
393 >/Library/StartupItems/Privoxy</TT
396 > To start Privoxy by hand, double-click on
399 >StartPrivoxy.command</TT
403 >/Library/Privoxy</TT
405 Or, type this command in the Terminal:</P
415 > /Library/Privoxy/StartPrivoxy.command
422 > You will be prompted for the administrator password.</P
429 NAME="INSTALLATION-AMIGA"
433 > Copy and then unpack the <TT
436 > archive to a suitable location.
437 All necessary files will be installed into <SPAN
441 directory, including all configuration and log files. To uninstall, just
442 remove this directory.</P
449 NAME="INSTALLATION-TBZ"
453 > Privoxy is part of FreeBSD's Ports Collection, you can build and install
456 >cd /usr/ports/www/privoxy; make install clean</TT
459 > If you don't use the ports, you can fetch and install
462 >pkg_add -r privoxy</TT
465 > The port skeleton and the package can also be downloaded from the
467 HREF="https://sourceforge.net/project/showfiles.php?group_id=11118"
471 >, but there's no reason to use them unless you're interested in the
472 beta releases which are only available there.</P
479 NAME="INSTALLATTION-GENTOO"
483 > Gentoo source packages (Ebuilds) for <SPAN
487 contained in the Gentoo Portage Tree (they are not on the download page,
488 but there is a Gentoo section, where you can see when a new
492 > Version is added to the Portage Tree).</P
494 > Before installing <SPAN
497 > under Gentoo just do
501 > to get the latest changes from the
502 Portage tree. With <TT
505 > you install the latest
508 > Configuration files are in <TT
512 documentation is in <TT
514 >/usr/share/doc/privoxy-3.0.8</TT
516 and the Log directory is in <TT
518 >/var/log/privoxy</TT
527 NAME="INSTALLATION-SOURCE"
528 >2.2. Building from Source</A
531 > The most convenient way to obtain the <SPAN
535 is to download the source tarball from our
537 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118&package_id=10571"
543 > If you like to live on the bleeding edge and are not afraid of using
544 possibly unstable development versions, you can check out the up-to-the-minute
545 version directly from <A
546 HREF="http://sourceforge.net/cvs/?group_id=11118"
557 HREF="http://www.gnu.org/software/autoconf/autoconf.html"
562 HREF="http://www.gnu.org/software/make/make.html"
566 >, and, of course, a C compiler like <A
567 HREF="http://www.gnu.org/software/gcc/gcc.html"
572 > When building from a source tarball,
573 first unpack the source: </P
583 > tar xzvf privoxy-3.0.8-src* [.tgz or .tar.gz]
584 cd privoxy-3.0.8</PRE
590 > For retrieving the current CVS sources, you'll need a CVS client installed.
591 Note that sources from CVS are typically development quality, and may not be
592 stable, or well tested. To download CVS source, check the Sourceforge
593 documentation, which might give commands like:</P
603 > cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
604 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current
611 > This will create a directory named <TT
615 contain the source tree.</P
617 > You can also check out any <SPAN
624 >, just exchange the <SPAN
628 name with the wanted branch name (Example: v_3_0_branch for the 3.0 cvs
631 > It is also strongly recommended to not run <SPAN
635 as root. You should configure/install/run <SPAN
639 an unprivileged user, preferably by creating a <SPAN
643 and group just for this purpose. See your local documentation for the correct
644 command line to do add new users and groups (something like
648 >, but the command syntax may vary from platform
654 > might then look like:</P
664 > privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell</PRE
683 > privoxy:*:7777:</PRE
689 > Some binary packages may do this for you.</P
691 > Then, to build from either unpacked tarball or CVS source:</P
703 ./configure # (--help to see options)
704 make # (the make from GNU, sometimes called gmake)
705 su # Possibly required
706 make -n install # (to see where all the files will go)
707 make -s install # (to really install, -s to silence output)</PRE
716 >, you can have the first four steps
717 automatically done for you by just typing:</P
733 > in the freshly downloaded or unpacked source directory.</P
735 > To build an executable with security enhanced features so that
736 users cannot easily bypass the proxy (e.g. <SPAN
738 >"Go There Anyway"</SPAN
740 alter their own configurations, <B
753 > ./configure --disable-toggle --disable-editor --disable-force</PRE
759 >Then build as above. In Privoxy 3.0.7 and later, all of these options
760 can also be disabled through the configuration file.</P
768 > If installing as root, the install will fail
769 unless a non-root user or group is specified, or a <TT
773 user and group already exist on the system. If a non-root user is specified,
774 and no group, then the installation will try to also use a group of the same name
778 >. If a group is specified (and no user), then the
779 support files will be installed as writable by that group, and owned by the
780 user running the installation.</P
792 > options for setting user and group ownership
793 of the configuration files (which need to be writable by the daemon). The
798 >user must already exist</I
804 >, it must be run as this same user to
805 insure write access to configuration and log files!</P
807 > Alternately, you can specify <TT
817 > command line, but be sure both already exist:</P
827 > make -s install USER=privoxy GROUP=privoxy</PRE
833 > The default installation path for <B
840 >. This may of course be customized with
844 > path options. If you are doing
845 an install to anywhere besides <TT
849 sure to set the appropriate paths with the correct configure options
852 >./configure --help</B
853 >). Non-privileged users must of course
854 have write access permissions to wherever the target installation is going.</P
856 > If you do install to <TT
859 >, the install will use
862 >sysconfdir=$prefix/etc/privoxy</TT
863 > by default. All other
864 destinations, and the direct usage of <TT
868 behave like normal, i.e. will not add the extra <TT
872 directory. This is for a safer install, as there may already exist another
873 program that uses a file with the <SPAN
876 > name, and thus makes
882 > If installing to <TT
885 >, the documentation will go
888 >$prefix/share/doc</TT
889 >. But if this directory
890 doesn't exist, it will then try <TT
894 there before creating a new <TT
896 >$prefix/share/doc</TT
903 > Again, if the installs goes to <TT
921 the logs will go to <TT
923 >/var/log/privoxy/</TT
925 will be created in <TT
927 >/var/run/privoxy.pid</TT
933 > will attempt to set the correct values
937 > (main configuration file). You should
938 check this to make sure all values are correct. If appropriate,
939 an init script will be installed, but it is up to the user to determine
940 how and where to start <SPAN
944 script should be checked for correct paths and values, if anything other than
945 a default install is done.</P
947 > If install finds previous versions of local configuration files, most of
948 these will not be overwritten, and the new ones will be installed with a
952 > extension. default.action, default.filter, and
953 standard.action <SPAN
957 >will be overwritten</I
959 >. You will then need
960 to manually update the other installed configuration files as needed. The
961 default template files <SPAN
967 > be overwritten. If you have
968 customized, local templates, these should be stored safely in a separate
969 directory and defined in <TT
976 > directive. It is of course wise to always back-up any
977 important configuration files <SPAN
979 >"just in case"</SPAN
984 > is already running, you will
985 have to restart it manually.</P
987 > For more detailed instructions on how to build Redhat RPMs,
988 Windows self-extracting installers, building on platforms with
989 special requirements etc, please consult the <A
990 HREF="../developer-manual/newrelease.html"
1000 NAME="INSTALLATION-KEEPUPDATED"
1001 >2.3. Keeping your Installation Up-to-Date</A
1004 > As user feedback comes in and development continues, we will make updated versions
1006 HREF="actions-file.html"
1009 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118&release_id=103670"
1013 >) and the software itself (including the actions file) available for
1016 > If you wish to receive an email notification whenever we release updates of
1020 > or the actions file, <A
1021 HREF="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce/"
1024 to our announce mailing list</A
1025 >, ijbswa-announce@lists.sourceforge.net.</P
1027 > In order not to lose your personal changes and adjustments when updating
1046 customizations of <SPAN
1050 HREF="actions-file.html"
1051 >Chapter on actions files</A
1060 SUMMARY="Footer navigation table"
1071 HREF="introduction.html"
1089 HREF="whatsnew.html"
1109 >What's New in this Release</TD