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.7 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
21 <LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
33 SUMMARY="Header navigation table"
42 >Privoxy 3.0.7 User Manual</TH
50 HREF="introduction.html"
85 > is available both in convenient pre-compiled
86 packages for a wide range of operating systems, and as raw source code.
87 For most users, we recommend using the packages, which can be downloaded from our
89 HREF="http://sourceforge.net/projects/ijbswa/"
96 On some platforms, the installer may remove previously installed versions, if
97 found. (See below for your platform). In any case <SPAN
102 your old configuration if it is valuable to you.</I
105 HREF="whatsnew.html#UPGRADERSNOTE"
106 >note to upgraders</A
113 NAME="INSTALLATION-PACKAGES"
114 >2.1. Binary Packages</A
117 >How to install the binary packages depends on your operating system:</P
123 NAME="INSTALLATION-PACK-RPM"
124 >2.1.1. Red Hat and Fedora RPMs</A
127 > RPMs can be installed with <TT
129 >rpm -Uvh privoxy-3.0.7-1.rpm</TT
135 of configuration files.</P
137 > Note that on Red Hat, <SPAN
147 > be automatically started on system boot. You will
148 need to enable that using <B
155 >, or similar methods. </P
157 > If you have problems with failed dependencies, try rebuilding the SRC RPM:
160 >rpm --rebuild privoxy-3.0.7-1.src.rpm</TT
162 will use your locally installed libraries and RPM version. </P
164 > Also note that if you have a <SPAN
168 on your system, you need to remove it first, because the packages conflict.
169 Otherwise, RPM will try to remove <SPAN
173 automatically if found, before installing <SPAN
183 NAME="INSTALLATION-DEB"
187 > DEBs can be installed with <TT
189 >apt-get install privoxy</TT
194 > for the location of
195 configuration files.</P
202 NAME="INSTALLATION-PACK-WIN"
206 > Just double-click the installer, which will guide you through
207 the installation process. You will find the configuration files
208 in the same directory as you installed <SPAN
213 > Version 3.0.5 beta introduced full <SPAN
217 functionality. On Windows only, the <SPAN
221 program has two new command line arguments to install and uninstall
270 > After invoking <SPAN
277 >, you will need to bring up the
281 > service console to assign the user you
285 > to run under, and whether or not you
286 want it to run whenever the system starts. You can start the
290 > services console with the following
294 >. If you do not take the manual step
298 > service settings, it will
299 not start. Note too that you will need to give Privoxy a user account that
300 actually exists, or it will not be permitted to
301 write to its log and configuration files.</P
308 NAME="INSTALLATION-PACK-BINTGZ"
312 > Create a new directory, <TT
315 > to it, then unzip and
316 untar the archive. For the most part, you'll have to figure out where
324 NAME="INSTALLATION-OS2"
328 > First, make sure that no previous installations of
337 system. Check that no <SPAN
345 your startup folder. </P
347 > Then, just double-click the WarpIN self-installing archive, which will
348 guide you through the installation process. A shadow of the
352 > executable will be placed in your
353 startup folder so it will start automatically whenever OS/2 starts.</P
355 > The directory you choose to install <SPAN
359 into will contain all of the configuration files.</P
366 NAME="INSTALLATION-MAC"
370 > Unzip the downloaded file (you can either double-click on the file
371 from the finder, or from the desktop if you downloaded it there).
372 Then, double-click on the package installer icon named
377 and follow the installation process.
381 > will be installed in the folder
384 >/Library/Privoxy</TT
386 It will start automatically whenever you start up. To prevent it from
387 starting automatically, remove or rename the folder
390 >/Library/StartupItems/Privoxy</TT
393 > To start Privoxy by hand, double-click on
396 >StartPrivoxy.command</TT
400 >/Library/Privoxy</TT
402 Or, type this command in the Terminal:</P
412 > /Library/Privoxy/StartPrivoxy.command
419 > You will be prompted for the administrator password.</P
426 NAME="INSTALLATION-AMIGA"
430 > Copy and then unpack the <TT
433 > archive to a suitable location.
434 All necessary files will be installed into <SPAN
438 directory, including all configuration and log files. To uninstall, just
439 remove this directory.</P
446 NAME="INSTALLATION-TBZ"
450 > Privoxy is part of FreeBSD's Ports Collection, you can build and install
453 >cd /usr/ports/www/privoxy; make install clean</TT
456 > If you don't use the ports, you can fetch and install
459 >pkg_add -r privoxy</TT
462 > The port skeleton and the package can also be downloaded from the
464 HREF="https://sourceforge.net/project/showfiles.php?group_id=11118"
468 >, but there's no reason to use them unless you're interested in the
469 beta releases which are only available there.</P
476 NAME="INSTALLATTION-GENTOO"
480 > Gentoo source packages (Ebuilds) for <SPAN
484 contained in the Gentoo Portage Tree (they are not on the download page,
485 but there is a Gentoo section, where you can see when a new
489 > Version is added to the Portage Tree).</P
491 > Before installing <SPAN
494 > under Gentoo just do
498 > to get the latest changes from the
499 Portage tree. With <TT
502 > you install the latest
505 > Configuration files are in <TT
509 documentation is in <TT
511 >/usr/share/doc/privoxy-3.0.7</TT
513 and the Log directory is in <TT
515 >/var/log/privoxy</TT
524 NAME="INSTALLATION-SOURCE"
525 >2.2. Building from Source</A
528 > The most convenient way to obtain the <SPAN
532 is to download the source tarball from our
534 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118&package_id=10571"
540 > If you like to live on the bleeding edge and are not afraid of using
541 possibly unstable development versions, you can check out the up-to-the-minute
542 version directly from <A
543 HREF="http://sourceforge.net/cvs/?group_id=11118"
554 HREF="http://www.gnu.org/software/autoconf/autoconf.html"
559 HREF="http://www.gnu.org/software/make/make.html"
563 >, and, of course, a C compiler like <A
564 HREF="http://www.gnu.org/software/gcc/gcc.html"
569 > When building from a source tarball,
570 first unpack the source: </P
580 > tar xzvf privoxy-3.0.7-beta-src* [.tgz or .tar.gz]
581 cd privoxy-3.0.7-beta</PRE
587 > For retrieving the current CVS sources, you'll need a CVS client installed.
588 Note that sources from CVS are typically development quality, and may not be
589 stable, or well tested. To download CVS source, check the Sourceforge
590 documentation, which might give commands like:</P
600 > cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
601 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current
608 > This will create a directory named <TT
612 contain the source tree.</P
614 > You can also check out any <SPAN
621 >, just exchange the <SPAN
625 name with the wanted branch name (Example: v_3_0_branch for the 3.0 cvs
628 > It is also strongly recommended to not run <SPAN
632 as root. You should configure/install/run <SPAN
636 an unprivileged user, preferably by creating a <SPAN
640 and group just for this purpose. See your local documentation for the correct
641 command line to do add new users and groups (something like
645 >, but the command syntax may vary from platform
651 > might then look like:</P
661 > privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell</PRE
680 > privoxy:*:7777:</PRE
686 > Some binary packages may do this for you.</P
688 > Then, to build from either unpacked tarball or CVS source:</P
700 ./configure # (--help to see options)
701 make # (the make from GNU, sometimes called gmake)
702 su # Possibly required
703 make -n install # (to see where all the files will go)
704 make -s install # (to really install, -s to silence output)</PRE
713 >, you can have the first four steps
714 automatically done for you by just typing:</P
730 > in the freshly downloaded or unpacked source directory.</P
732 > To build an executable with security enhanced features so that
733 users cannot easily bypass the proxy (e.g. <SPAN
735 >"Go There Anyway"</SPAN
737 alter their own configurations, <B
750 > ./configure --disable-toggle --disable-editor --disable-force</PRE
756 >Then build as above.</P
764 > If installing as root, the install will fail
765 unless a non-root user or group is specified, or a <TT
769 user and group already exist on the system. If a non-root user is specified,
770 and no group, then the installation will try to also use a group of the same name
774 >. If a group is specified (and no user), then the
775 support files will be installed as writable by that group, and owned by the
776 user running the installation.</P
788 > options for setting user and group ownership
789 of the configuration files (which need to be writable by the daemon). The
794 >user must already exist</I
800 >, it must be run as this same user to
801 insure write access to configuration and log files!</P
803 > Alternately, you can specify <TT
813 > command line, but be sure both already exist:</P
823 > make -s install USER=privoxy GROUP=privoxy</PRE
829 > The default installation path for <B
836 >. This may of course be customized with
840 > path options. If you are doing
841 an install to anywhere besides <TT
845 sure to set the appropriate paths with the correct configure options
848 >./configure --help</B
849 >). Non-privileged users must of course
850 have write access permissions to wherever the target installation is going.</P
852 > If you do install to <TT
855 >, the install will use
858 >sysconfdir=$prefix/etc/privoxy</TT
859 > by default. All other
860 destinations, and the direct usage of <TT
864 behave like normal, i.e. will not add the extra <TT
868 directory. This is for a safer install, as there may already exist another
869 program that uses a file with the <SPAN
872 > name, and thus makes
878 > If installing to <TT
881 >, the documentation will go
884 >$prefix/share/doc</TT
885 >. But if this directory
886 doesn't exist, it will then try <TT
890 there before creating a new <TT
892 >$prefix/share/doc</TT
899 > Again, if the installs goes to <TT
917 the logs will go to <TT
919 >/var/log/privoxy/</TT
921 will be created in <TT
923 >/var/run/privoxy.pid</TT
929 > will attempt to set the correct values
933 > (main configuration file). You should
934 check this to make sure all values are correct. If appropriate,
935 an init script will be installed, but it is up to the user to determine
936 how and where to start <SPAN
940 script should be checked for correct paths and values, if anything other than
941 a default install is done.</P
943 > If install finds previous versions of local configuration files, most of
944 these will not be overwritten, and the new ones will be installed with a
948 > extension. default.action, default.filter, and
949 standard.action <SPAN
953 >will be overwritten</I
955 >. You will then need
956 to manually update the other installed configuration files as needed. All
957 template files will be overwritten. If you have customized, local templates,
958 you should save these first, and in fact it is wise to always save any
959 important configuration files <SPAN
961 >"just in case"</SPAN
966 > is already running, you will
967 have to restart it manually.</P
969 > For more detailed instructions on how to build Redhat RPMs,
970 Windows self-extracting installers, building on platforms with
971 special requirements etc, please consult the <A
972 HREF="../developer-manual/newrelease.html"
982 NAME="INSTALLATION-KEEPUPDATED"
983 >2.3. Keeping your Installation Up-to-Date</A
986 > As user feedback comes in and development continues, we will make updated versions
988 HREF="actions-file.html"
991 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118&release_id=103670"
995 >) and the software itself (including the actions file) available for
998 > If you wish to receive an email notification whenever we release updates of
1002 > or the actions file, <A
1003 HREF="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce/"
1006 to our announce mailing list</A
1007 >, ijbswa-announce@lists.sourceforge.net.</P
1009 > In order not to lose your personal changes and adjustments when updating
1028 customizations of <SPAN
1032 HREF="actions-file.html"
1033 >Chapter on actions files</A
1042 SUMMARY="Footer navigation table"
1053 HREF="introduction.html"
1071 HREF="whatsnew.html"
1091 >What's New in this Release</TD