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.27 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.27 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="https://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-DEB"
127 >2.1.1. Debian and Ubuntu</A
130 > DEBs can be installed with <TT
132 >apt-get install privoxy</TT
137 > for the location of
138 configuration files.</P
145 NAME="INSTALLATION-PACK-WIN"
149 > Just double-click the installer, which will guide you through
150 the installation process. You will find the configuration files
151 in the same directory as you installed <SPAN
156 > Version 3.0.5 beta introduced full <SPAN
160 functionality. On Windows only, the <SPAN
164 program has two new command line arguments to install and uninstall
213 > After invoking <SPAN
220 >, you will need to bring up the
224 > service console to assign the user you
228 > to run under, and whether or not you
229 want it to run whenever the system starts. You can start the
233 > services console with the following
237 >. If you do not take the manual step
241 > service settings, it will
242 not start. Note too that you will need to give Privoxy a user account that
243 actually exists, or it will not be permitted to
244 write to its log and configuration files.</P
251 NAME="INSTALLATION-OS2"
255 > First, make sure that no previous installations of
264 system. Check that no <SPAN
272 your startup folder.</P
274 > Then, just double-click the WarpIN self-installing archive, which will
275 guide you through the installation process. A shadow of the
279 > executable will be placed in your
280 startup folder so it will start automatically whenever OS/2 starts.</P
282 > The directory you choose to install <SPAN
286 into will contain all of the configuration files.</P
293 NAME="INSTALLATION-MAC"
297 > Installation instructions for the OS X platform depend upon whether
298 you downloaded a ready-built installation package (.pkg or .mpkg) or have
299 downloaded the source code.</P
306 NAME="OS-X-INSTALL-FROM-PACKAGE"
307 >2.1.5. Installation from ready-built package</A
310 > The downloaded file will either be a .pkg (for OS X 10.5 upwards) or a bzipped
311 .mpkg file (for OS X 10.4). The former can be double-clicked as is and the
312 installation will start; double-clicking the latter will unzip the .mpkg file
313 which can then be double-clicked to commence the installation.</P
315 > The privoxy service will automatically start after a successful installation
316 (and thereafter every time your computer starts up) however you will need to
317 configure your web browser(s) to use it. To do so, configure them to use a
318 proxy for HTTP and HTTPS at the address 127.0.0.1:8118.</P
320 > To prevent the privoxy service from automatically starting when your computer
321 starts up, remove or rename the file <TT
323 >/Library/LaunchDaemons/org.ijbswa.privoxy.plist</TT
325 (on OS X 10.5 and higher) or the folder named
328 >/Library/StartupItems/Privoxy</TT
329 > (on OS X 10.4 'Tiger').</P
331 > To manually start or stop the privoxy service, use the scripts startPrivoxy.sh
332 and stopPrivoxy.sh supplied in /Applications/Privoxy. They must be run from an
333 administrator account, using sudo.</P
335 > To uninstall, run /Applications/Privoxy/uninstall.command as sudo from an
336 administrator account.</P
343 NAME="OS-X-INSTALL-FROM-SOURCE"
344 >2.1.6. Installation from source</A
347 > To build and install the Privoxy source code on OS X you will need to obtain
348 the macsetup module from the Privoxy Sourceforge CVS repository (refer to
349 Sourceforge help for details of how to set up a CVS client to have read-only
350 access to the repository). This module contains scripts that leverage the usual
351 open-source tools (available as part of Apple's free of charge Xcode
352 distribution or via the usual open-source software package managers for OS X
353 (MacPorts, Homebrew, Fink etc.) to build and then install the privoxy binary
354 and associated files. The macsetup module's README file contains complete
355 instructions for its use.</P
357 > The privoxy service will automatically start after a successful installation
358 (and thereafter every time your computer starts up) however you will need to
359 configure your web browser(s) to use it. To do so, configure them to use a
360 proxy for HTTP and HTTPS at the address 127.0.0.1:8118.</P
362 > To prevent the privoxy service from automatically starting when your computer
363 starts up, remove or rename the file <TT
365 >/Library/LaunchDaemons/org.ijbswa.privoxy.plist</TT
367 (on OS X 10.5 and higher) or the folder named
370 >/Library/StartupItems/Privoxy</TT
371 > (on OS X 10.4 'Tiger').</P
373 > To manually start or stop the privoxy service, use the Privoxy Utility
374 for Mac OS X (also part of the macsetup module). This application can start
375 and stop the privoxy service and display its log and configuration files.</P
377 > To uninstall, run the macsetup module's uninstall.sh as sudo from an
378 administrator account.</P
385 NAME="INSTALLATION-FREEBSD"
389 > Privoxy is part of FreeBSD's Ports Collection, you can build and install
392 >cd /usr/ports/www/privoxy; make install clean</TT
401 NAME="INSTALLATION-SOURCE"
402 >2.2. Building from Source</A
405 > The most convenient way to obtain the <SPAN
409 is to download the source tarball from our
411 HREF="https://sourceforge.net/projects/ijbswa/files/Sources/"
417 > If you like to live on the bleeding edge and are not afraid of using
418 possibly unstable development versions, you can check out the up-to-the-minute
419 version directly from <A
420 HREF="https://sourceforge.net/p/ijbswa/code/?source=navbar"
431 HREF="http://www.gnu.org/software/autoconf/autoconf.html"
436 HREF="http://www.gnu.org/software/make/make.html"
440 >, and, of course, a C compiler like <A
441 HREF="http://www.gnu.org/software/gcc/gcc.html"
446 > When building from a source tarball,
447 first unpack the source:</P
456 > tar xzvf privoxy-3.0.27-beta-src.tar.gz
457 cd privoxy-3.0.27-beta</PRE
462 > For retrieving the current CVS sources, you'll need a CVS client installed.
463 Note that sources from CVS are typically development quality, and may not be
464 stable, or well tested. To download CVS source, check the Sourceforge
465 documentation, which might give commands like:</P
474 > cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
475 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current
481 > This will create a directory named <TT
485 contain the source tree.</P
487 > You can also check out any <SPAN
494 >, just exchange the <SPAN
498 name with the wanted branch name (Example: v_3_0_branch for the 3.0 cvs
501 > It is also strongly recommended to not run <SPAN
505 as root. You should configure/install/run <SPAN
509 an unprivileged user, preferably by creating a <SPAN
513 and group just for this purpose. See your local documentation for the correct
514 command line to do add new users and groups (something like
518 >, but the command syntax may vary from platform
524 > might then look like:</P
533 > privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell</PRE
550 > privoxy:*:7777:</PRE
555 > Some binary packages may do this for you.</P
557 > Then, to build from either unpacked tarball or CVS source:</P
568 ./configure # (--help to see options)
569 make # (the make from GNU, sometimes called gmake)
570 su # Possibly required
571 make -n install # (to see where all the files will go)
572 make -s install # (to really install, -s to silence output)</PRE
580 >, you can have the first four steps
581 automatically done for you by just typing:</P
595 > in the freshly downloaded or unpacked source directory.</P
597 > To build an executable with security enhanced features so that
598 users cannot easily bypass the proxy (e.g. <SPAN
600 >"Go There Anyway"</SPAN
602 alter their own configurations, <B
614 > ./configure --disable-toggle --disable-editor --disable-force</PRE
619 > Note that all of these options can also be disabled through the configuration file.</P
627 > If installing as root, the install will fail
628 unless a non-root user or group is specified, or a <TT
632 user and group already exist on the system. If a non-root user is specified,
633 and no group, then the installation will try to also use a group of the same name
637 >. If a group is specified (and no user), then the
638 support files will be installed as writable by that group, and owned by the
639 user running the installation.</P
651 > options for setting user and group ownership
652 of the configuration files (which need to be writable by the daemon). The
657 >user must already exist</I
663 >, it must be run as this same user to
664 insure write access to configuration and log files!</P
666 > Alternately, you can specify <TT
676 > command line, but be sure both already exist:</P
685 > make -s install USER=privoxy GROUP=privoxy</PRE
690 > The default installation path for <B
697 >. This may of course be customized with
701 > path options. If you are doing
702 an install to anywhere besides <TT
706 sure to set the appropriate paths with the correct configure options
709 >./configure --help</B
710 >). Non-privileged users must of course
711 have write access permissions to wherever the target installation is going.</P
713 > If you do install to <TT
716 >, the install will use
719 >sysconfdir=$prefix/etc/privoxy</TT
720 > by default. All other
721 destinations, and the direct usage of <TT
725 behave like normal, i.e. will not add the extra <TT
729 directory. This is for a safer install, as there may already exist another
730 program that uses a file with the <SPAN
733 > name, and thus makes
739 > If installing to <TT
742 >, the documentation will go
745 >$prefix/share/doc</TT
746 >. But if this directory
747 doesn't exist, it will then try <TT
751 there before creating a new <TT
753 >$prefix/share/doc</TT
760 > Again, if the installs goes to <TT
778 the logs will go to <TT
780 >/var/log/privoxy/</TT
782 will be created in <TT
784 >/var/run/privoxy.pid</TT
790 > will attempt to set the correct values
794 > (main configuration file). You should
795 check this to make sure all values are correct. If appropriate,
796 an init script will be installed, but it is up to the user to determine
797 how and where to start <SPAN
801 script should be checked for correct paths and values, if anything other than
802 a default install is done.</P
804 > If install finds previous versions of local configuration files, most of
805 these will not be overwritten, and the new ones will be installed with a
809 > extension. default.action and default.filter
814 >will be overwritten</I
816 >. You will then need
817 to manually update the other installed configuration files as needed. The
818 default template files <SPAN
824 > be overwritten. If you have
825 customized, local templates, these should be stored safely in a separate
826 directory and defined in <TT
833 > directive. It is of course wise to always back-up any
834 important configuration files <SPAN
836 >"just in case"</SPAN
841 > is already running, you will
842 have to restart it manually.</P
844 > For more detailed instructions on how to build Redhat RPMs,
845 Windows self-extracting installers, building on platforms with
846 special requirements etc, please consult the <A
847 HREF="https://www.privoxy.org/developer-manual/newrelease.html"
857 NAME="INSTALLATION-KEEPUPDATED"
858 >2.3. Keeping your Installation Up-to-Date</A
861 > If you wish to receive an email notification whenever we release updates of
865 > or the actions file, <A
866 HREF="https://lists.privoxy.org/mailman/listinfo/privoxy-announce"
869 to our announce mailing list</A
870 >, privoxy-announce@lists.privoxy.org.</P
872 > In order not to lose your personal changes and adjustments when updating
891 customizations of <SPAN
895 HREF="actions-file.html"
896 >Chapter on actions files</A
905 SUMMARY="Footer navigation table"
916 HREF="introduction.html"
954 >What's New in this Release</TD