+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Installation</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.64
-"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
-TITLE="Privoxy User Manual"
+TITLE="Privoxy 3.0.27 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Introduction"
HREF="introduction.html"><LINK
REL="NEXT"
-TITLE="Quickstart to Using Privoxy"
-HREF="quickstart.html"><LINK
+TITLE="What's New in this Release"
+HREF="whatsnew.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css"><META
+HTTP-EQUIV="Content-Type"
+CONTENT="text/html;
+charset=ISO-8859-1">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
><DIV
CLASS="NAVHEADER"
><TABLE
+SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy User Manual</TH
+>Privoxy 3.0.27 User Manual</TH
></TR
><TR
><TD
VALIGN="bottom"
><A
HREF="introduction.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
ALIGN="right"
VALIGN="bottom"
><A
-HREF="quickstart.html"
+HREF="whatsnew.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
CLASS="SECT1"
><A
NAME="INSTALLATION"
->3. Installation</A
+>2. Installation</A
></H1
><P
> <SPAN
packages for a wide range of operating systems, and as raw source code.
For most users, we recommend using the packages, which can be downloaded from our
<A
-HREF="http://sourceforge.net/projects/ijbswa/"
+HREF="https://sourceforge.net/projects/ijbswa/"
TARGET="_top"
->Privoxy Project Page</A
+>Privoxy Project
+ Page</A
>.</P
><P
-> If you like to live on the bleeding edge and are not afraid of using
- possibly unstable development versions, you can check out the up-to-the-minute
- version directly from <A
-HREF="http://sourceforge.net/cvs/?group_id=11118"
-TARGET="_top"
->the
- CVS repository</A
-> or simply download <A
-HREF="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.gz"
-TARGET="_top"
->the nightly CVS
- tarball.</A
-></P
-><P
-> At present, <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> is known to run on Win32, Mac
- OSX, OS/2, AmigaOS, Linux (RedHat, Suse, Debian), FreeBSD, NetBSD, BeOS, and
- many flavors of Unix.</P
+> Note:
+ On some platforms, the installer may remove previously installed versions, if
+ found. (See below for your platform). In any case <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>be sure to backup
+ your old configuration if it is valuable to you.</I
+></SPAN
+> See the <A
+HREF="whatsnew.html#UPGRADERSNOTE"
+>note to upgraders</A
+> section below.</P
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="INSTALLATION-PACKAGES"
->3.1. Binary Packages</A
+>2.1. Binary Packages</A
></H2
><P
-> Note: If you have a previous <SPAN
-CLASS="APPLICATION"
->Junkbuster</SPAN
-> or
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> installation on your system, you
- will need to remove it. Some platforms do this for you as part
- of their installation procedure. (See below for your platform).</P
-><P
-> In any case <I
-CLASS="EMPHASIS"
->be sure to backup your old configuration
- if it is valuable to you.</I
-> See the
- <A
-HREF="quickstart.html#UPGRADERSNOTE"
->note to upgraders</A
->.</P
-><P
-> How to install the binary packages depends on your operating system:</P
+>How to install the binary packages depends on your operating system:</P
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
-NAME="INSTALLATION-PACK-RPM"
->3.1.1. Red Hat and SuSE RPMs</A
+NAME="INSTALLATION-DEB"
+>2.1.1. Debian and Ubuntu</A
></H3
><P
-> RPMs can be installed with <TT
+> DEBs can be installed with <TT
CLASS="LITERAL"
->rpm -Uvh privoxy-2.9.14-1.rpm</TT
+>apt-get install privoxy</TT
>,
and will use <TT
CLASS="FILENAME"
>/etc/privoxy</TT
-> for the location
- of configuration files.</P
+> for the location of
+ configuration files.</P
+></DIV
+><DIV
+CLASS="SECT3"
+><H3
+CLASS="SECT3"
+><A
+NAME="INSTALLATION-PACK-WIN"
+>2.1.2. Windows</A
+></H3
><P
-> Note that on Red Hat, <SPAN
+> Just double-click the installer, which will guide you through
+ the installation process. You will find the configuration files
+ in the same directory as you installed <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> will not be
- automatically started on system boot. You will need to enable that using
- <B
-CLASS="COMMAND"
->chkconfig</B
->, <B
-CLASS="COMMAND"
->ntsysv</B
->, or similar method.</P
-><P
-> If you have problems with failed dependencies, try rebuilding the SRC RPM:
- <TT
-CLASS="LITERAL"
->rpm --rebuild privoxy-2.9.14-1.src.rpm;</TT
->. This
- will use your locally installed libraries and RPM version. </P
+> in.</P
><P
-> Also note that if you have a <SPAN
+> Version 3.0.5 beta introduced full <SPAN
CLASS="APPLICATION"
->Junkbuster</SPAN
-> RPM installed
- on your system, you need to remove it first, because the packages conflict.
- Otherwise, RPM will try to remove <SPAN
+>Windows</SPAN
+> service
+ functionality. On Windows only, the <SPAN
CLASS="APPLICATION"
->Junkbuster</SPAN
+>Privoxy</SPAN
>
- automatically, before installing <SPAN
+ program has two new command line arguments to install and uninstall
+ <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
+> as a <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>service</I
+></SPAN
>.</P
-></DIV
-><DIV
-CLASS="SECT3"
-><H3
-CLASS="SECT3"
-><A
-NAME="INSTALLATION-DEB"
->3.1.2. Debian</A
-></H3
><P
-> FIXME.</P
-></DIV
+></P
><DIV
-CLASS="SECT3"
-><H3
-CLASS="SECT3"
-><A
-NAME="INSTALLATION-PACK-WIN"
->3.1.3. Windows</A
-></H3
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Arguments:</DT
+><DD
><P
-> Just double-click the installer, which will guide you through
- the installation process.</P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>--install</I
+></TT
+>[:<TT
+CLASS="REPLACEABLE"
+><I
+>service_name</I
+></TT
+>]
+ </P
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>--uninstall</I
+></TT
+>[:<TT
+CLASS="REPLACEABLE"
+><I
+>service_name</I
+></TT
+>]
+ </P
+></DD
+></DL
></DIV
-><DIV
-CLASS="SECT3"
-><H3
-CLASS="SECT3"
-><A
-NAME="INSTALLATION-PACK-BINTGZ"
->3.1.4. Solaris, NetBSD, FreeBSD, HP-UX</A
-></H3
><P
-> Create a new directory, <TT
-CLASS="LITERAL"
->cd</TT
-> to it, then unzip and
- untar the archive. For the most part, you'll have to figure out where
- things go. FIXME.</P
+> After invoking <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> with
+ <B
+CLASS="COMMAND"
+>--install</B
+>, you will need to bring up the
+ <SPAN
+CLASS="APPLICATION"
+>Windows</SPAN
+> service console to assign the user you
+ want <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> to run under, and whether or not you
+ want it to run whenever the system starts. You can start the
+ <SPAN
+CLASS="APPLICATION"
+>Windows</SPAN
+> services console with the following
+ command: <B
+CLASS="COMMAND"
+>services.msc</B
+>. If you do not take the manual step
+ of modifying <SPAN
+CLASS="APPLICATION"
+>Privoxy's</SPAN
+> service settings, it will
+ not start. Note too that you will need to give Privoxy a user account that
+ actually exists, or it will not be permitted to
+ write to its log and configuration files.</P
></DIV
><DIV
CLASS="SECT3"
CLASS="SECT3"
><A
NAME="INSTALLATION-OS2"
->3.1.5. OS/2</A
+>2.1.3. OS/2</A
></H3
><P
> First, make sure that no previous installations of
<SPAN
CLASS="APPLICATION"
>Junkbuster</SPAN
-> and / or
+> and / or
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> are left on your
- system. You can do this by </P
+ system. Check that no <SPAN
+CLASS="APPLICATION"
+>Junkbuster</SPAN
+>
+ or <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> objects are in
+ your startup folder.</P
><P
> Then, just double-click the WarpIN self-installing archive, which will
guide you through the installation process. A shadow of the
CLASS="SECT3"
><A
NAME="INSTALLATION-MAC"
->3.1.6. Max OSX</A
+>2.1.4. Mac OS X</A
></H3
><P
-> Unzip the downloaded package (you can either double-click on the file
- in the finder, or on the desktop if you downloaded it there). Then,
- double-click on the package installer icon and follow the installation
- process.
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> will be installed in the subdirectory
+> Installation instructions for the OS X platform depend upon whether
+ you downloaded a ready-built installation package (.pkg or .mpkg) or have
+ downloaded the source code.</P
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="OS-X-INSTALL-FROM-PACKAGE"
+>2.1.5. Installation from ready-built package</A
+></H4
+><P
+> The downloaded file will either be a .pkg (for OS X 10.5 upwards) or a bzipped
+ .mpkg file (for OS X 10.4). The former can be double-clicked as is and the
+ installation will start; double-clicking the latter will unzip the .mpkg file
+ which can then be double-clicked to commence the installation.</P
+><P
+> The privoxy service will automatically start after a successful installation
+ (and thereafter every time your computer starts up) however you will need to
+ configure your web browser(s) to use it. To do so, configure them to use a
+ proxy for HTTP and HTTPS at the address 127.0.0.1:8118.</P
+><P
+> To prevent the privoxy service from automatically starting when your computer
+ starts up, remove or rename the file <TT
+CLASS="LITERAL"
+>/Library/LaunchDaemons/org.ijbswa.privoxy.plist</TT
+>
+ (on OS X 10.5 and higher) or the folder named
<TT
CLASS="LITERAL"
->/Applications/Privoxy.app</TT
->.
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> will set itself up to start
- automatically on system bringup via
+>/Library/StartupItems/Privoxy</TT
+> (on OS X 10.4 'Tiger').</P
+><P
+> To manually start or stop the privoxy service, use the scripts startPrivoxy.sh
+ and stopPrivoxy.sh supplied in /Applications/Privoxy. They must be run from an
+ administrator account, using sudo.</P
+><P
+> To uninstall, run /Applications/Privoxy/uninstall.command as sudo from an
+ administrator account.</P
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="OS-X-INSTALL-FROM-SOURCE"
+>2.1.6. Installation from source</A
+></H4
+><P
+> To build and install the Privoxy source code on OS X you will need to obtain
+ the macsetup module from the Privoxy Sourceforge CVS repository (refer to
+ Sourceforge help for details of how to set up a CVS client to have read-only
+ access to the repository). This module contains scripts that leverage the usual
+ open-source tools (available as part of Apple's free of charge Xcode
+ distribution or via the usual open-source software package managers for OS X
+ (MacPorts, Homebrew, Fink etc.) to build and then install the privoxy binary
+ and associated files. The macsetup module's README file contains complete
+ instructions for its use.</P
+><P
+> The privoxy service will automatically start after a successful installation
+ (and thereafter every time your computer starts up) however you will need to
+ configure your web browser(s) to use it. To do so, configure them to use a
+ proxy for HTTP and HTTPS at the address 127.0.0.1:8118.</P
+><P
+> To prevent the privoxy service from automatically starting when your computer
+ starts up, remove or rename the file <TT
+CLASS="LITERAL"
+>/Library/LaunchDaemons/org.ijbswa.privoxy.plist</TT
+>
+ (on OS X 10.5 and higher) or the folder named
<TT
CLASS="LITERAL"
->/System/Library/StartupItems/Privoxy</TT
->.</P
+>/Library/StartupItems/Privoxy</TT
+> (on OS X 10.4 'Tiger').</P
+><P
+> To manually start or stop the privoxy service, use the Privoxy Utility
+ for Mac OS X (also part of the macsetup module). This application can start
+ and stop the privoxy service and display its log and configuration files.</P
+><P
+> To uninstall, run the macsetup module's uninstall.sh as sudo from an
+ administrator account.</P
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
-NAME="INSTALLATION-AMIGA"
->3.1.7. AmigaOS</A
+NAME="INSTALLATION-FREEBSD"
+>2.1.7. FreeBSD</A
></H3
><P
-> Copy and then unpack the <TT
-CLASS="FILENAME"
->lha</TT
-> archive to a suitable location.
- All necessary files will be installed into <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->
- directory, including all configuration and log files. To uninstall, just
- remove this directory.</P
-><P
-> Start <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> (with RUN <>NIL:) in your
- <TT
-CLASS="FILENAME"
->startnet</TT
-> script (AmiTCP), in
- <TT
-CLASS="FILENAME"
->s:user-startup</TT
-> (RoadShow), as startup program in your
- startup script (Genesis), or as startup action (Miami and MiamiDx).
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> will automatically quit when you quit your
- TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> is still running).</P
+> Privoxy is part of FreeBSD's Ports Collection, you can build and install
+ it with <TT
+CLASS="LITERAL"
+>cd /usr/ports/www/privoxy; make install clean</TT
+>.</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><A
NAME="INSTALLATION-SOURCE"
->3.2. Building from Source</A
+>2.2. Building from Source</A
></H2
><P
+> The most convenient way to obtain the <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> source
+ code is to download the source tarball from our
+ <A
+HREF="https://sourceforge.net/projects/ijbswa/files/Sources/"
+TARGET="_top"
+> project download page</A
+>,
+ or you can get the up-to-the-minute, possibly unstable, development version from
+ <A
+HREF="https://www.privoxy.org/"
+TARGET="_top"
+>https://www.privoxy.org/</A
+>.</P
+><P
> To build <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> from source,
- autoheader, autoconf, <A
+> from source,
+ <A
+HREF="http://www.gnu.org/software/autoconf/autoconf.html"
+TARGET="_top"
+>autoconf</A
+>,
+ <A
HREF="http://www.gnu.org/software/make/make.html"
TARGET="_top"
->GNU make
- (gmake)</A
->, and, of course, a C compiler are required.</P
+>GNU make (gmake)</A
+>,
+ and, of course, a C compiler like
+ <A
+HREF="http://www.gnu.org/software/gcc/gcc.html"
+TARGET="_top"
+>gcc</A
+> are required.</P
><P
-> When building from a source tarball (either release version or
- nightly CVS tarball), first unpack the source: </P
+> When building from a source tarball,
+ first unpack the source:</P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> tar xzvf privoxy-3.0.27-beta-src.tar.gz
+ cd privoxy-3.0.27-beta</PRE
+></TD
+></TR
+></TABLE
><P
-> <TABLE
+> To build the development version, you can get the source code by doing:</P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="SCREEN"
-> tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz]
- cd privoxy-2.9.14-beta
- </PRE
+> cd <root-dir>
+ git clone https://www.privoxy.org/git/privoxy.git</PRE
></TD
></TR
></TABLE
-></P
><P
-> For retrieving the current CVS sources, you'll need CVS installed.
- Note that sources from CVS are development quality, and may not be
- stable, or well tested. To download CVS source:</P
+> This will create a directory named <TT
+CLASS="FILENAME"
+><root-dir>/privoxy/</TT
+>,
+ which will contain the source tree.</P
><P
-> <TABLE
+> Note that source code in GIT is development quality, and may not be
+ stable or well tested.</P
+><P
+> It is strongly recommended to not run <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+ as root. You should configure/install/run <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> as
+ an unprivileged user, preferably by creating a <SPAN
+CLASS="QUOTE"
+>"privoxy"</SPAN
+> user
+ and group just for this purpose. See your local documentation for the correct
+ command line to do add new users and groups (something like
+ <B
+CLASS="COMMAND"
+>adduser</B
+>, but the command syntax may vary from platform
+ to platform).</P
+><P
+> <TT
+CLASS="FILENAME"
+>/etc/passwd</TT
+> might then look like:</P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="SCREEN"
-> cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
- cd current
- </PRE
+> privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell</PRE
></TD
></TR
></TABLE
-></P
><P
-> This will create a directory named <TT
+> And then <TT
CLASS="FILENAME"
->current/</TT
->, which will
- contain the source tree.</P
+>/etc/group</TT
+>, like:</P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> privoxy:*:7777:</PRE
+></TD
+></TR
+></TABLE
><P
-> Then, in either case, to build from unpacked tarball or CVS source:</P
+> Some binary packages may do this for you.</P
><P
-> <TABLE
+> Then, to build from either unpacked tarball or CVS source:</P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
> autoheader
autoconf
./configure # (--help to see options)
- make # (the make from gnu, gmake for *BSD)
- su
+ make # (the make from GNU, sometimes called gmake)
+ su # Possibly required
make -n install # (to see where all the files will go)
- make install # (to really install)
- </PRE
+ make -s install # (to really install, -s to silence output)</PRE
></TD
></TR
></TABLE
-></P
-><P
-> If you have gnu make, you can have the first four steps
- automatically done for you by just typing</P
><P
-> <TABLE
+> Using GNU <B
+CLASS="COMMAND"
+>make</B
+>, you can have the first four steps
+ automatically done for you by just typing:</P
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="SCREEN"
-> make
- </PRE
+> make</PRE
></TD
></TR
></TABLE
-></P
><P
> in the freshly downloaded or unpacked source directory.</P
><P
-> For more detailed instructions on how to build Redhat and SuSE RPMs,
+> To build an executable with security enhanced features so that
+ users cannot easily bypass the proxy (e.g. <SPAN
+CLASS="QUOTE"
+>"Go There Anyway"</SPAN
+>), or
+ alter their own configurations, <B
+CLASS="COMMAND"
+>configure</B
+> like this:</P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> ./configure --disable-toggle --disable-editor --disable-force</PRE
+></TD
+></TR
+></TABLE
+><P
+> Note that all of these options can also be disabled through the configuration file.</P
+><P
+> <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>WARNING:</I
+></SPAN
+> If installing as root, the install will fail
+ unless a non-root user or group is specified, or a <TT
+CLASS="LITERAL"
+>privoxy</TT
+>
+ user and group already exist on the system. If a non-root user is specified,
+ and no group, then the installation will try to also use a group of the same name
+ as <SPAN
+CLASS="QUOTE"
+>"user"</SPAN
+>. If a group is specified (and no user), then the
+ support files will be installed as writable by that group, and owned by the
+ user running the installation.</P
+><P
+> <B
+CLASS="COMMAND"
+>configure</B
+> accepts <TT
+CLASS="LITERAL"
+>--with-user</TT
+> and
+ <TT
+CLASS="LITERAL"
+>--with-group</TT
+> options for setting user and group ownership
+ of the configuration files (which need to be writable by the daemon). The
+ specified <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>user must already exist</I
+></SPAN
+>. When starting
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>, it must be run as this same user to
+ insure write access to configuration and log files!</P
+><P
+> Alternately, you can specify <TT
+CLASS="LITERAL"
+>user</TT
+> and <TT
+CLASS="LITERAL"
+>group</TT
+>
+ on the <B
+CLASS="COMMAND"
+>make</B
+> command line, but be sure both already exist:</P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> make -s install USER=privoxy GROUP=privoxy</PRE
+></TD
+></TR
+></TABLE
+><P
+> The default installation path for <B
+CLASS="COMMAND"
+>make install</B
+> is
+ <TT
+CLASS="FILENAME"
+>/usr/local</TT
+>. This may of course be customized with
+ the various <B
+CLASS="COMMAND"
+>./configure</B
+> path options. If you are doing
+ an install to anywhere besides <TT
+CLASS="FILENAME"
+>/usr/local</TT
+>, be
+ sure to set the appropriate paths with the correct configure options
+ (<B
+CLASS="COMMAND"
+>./configure --help</B
+>). Non-privileged users must of course
+ have write access permissions to wherever the target installation is going.</P
+><P
+> If you do install to <TT
+CLASS="FILENAME"
+>/usr/local</TT
+>, the install will use
+ <TT
+CLASS="LITERAL"
+>sysconfdir=$prefix/etc/privoxy</TT
+> by default. All other
+ destinations, and the direct usage of <TT
+CLASS="LITERAL"
+>--sysconfdir</TT
+> flag
+ behave like normal, i.e. will not add the extra <TT
+CLASS="FILENAME"
+>privoxy</TT
+>
+ directory. This is for a safer install, as there may already exist another
+ program that uses a file with the <SPAN
+CLASS="QUOTE"
+>"config"</SPAN
+> name, and thus makes
+ <TT
+CLASS="FILENAME"
+>/usr/local/etc</TT
+> cleaner.</P
+><P
+> If installing to <TT
+CLASS="FILENAME"
+>/usr/local</TT
+>, the documentation will go
+ by default to <TT
+CLASS="FILENAME"
+>$prefix/share/doc</TT
+>. But if this directory
+ doesn't exist, it will then try <TT
+CLASS="FILENAME"
+>$prefix/doc</TT
+> and install
+ there before creating a new <TT
+CLASS="FILENAME"
+>$prefix/share/doc</TT
+> just for
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>.</P
+><P
+> Again, if the installs goes to <TT
+CLASS="FILENAME"
+>/usr/local</TT
+>, the
+ <TT
+CLASS="LITERAL"
+>localstatedir</TT
+> (ie: <TT
+CLASS="FILENAME"
+>var/</TT
+>) will default
+ to <TT
+CLASS="FILENAME"
+>/var</TT
+> instead of <TT
+CLASS="LITERAL"
+>$prefix/var</TT
+> so
+ the logs will go to <TT
+CLASS="FILENAME"
+>/var/log/privoxy/</TT
+>, and the pid file
+ will be created in <TT
+CLASS="FILENAME"
+>/var/run/privoxy.pid</TT
+>.</P
+><P
+> <B
+CLASS="COMMAND"
+>make install</B
+> will attempt to set the correct values
+ in <TT
+CLASS="FILENAME"
+>config</TT
+> (main configuration file). You should
+ check this to make sure all values are correct. If appropriate,
+ an init script will be installed, but it is up to the user to determine
+ how and where to start <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>. The init
+ script should be checked for correct paths and values, if anything other than
+ a default install is done.</P
+><P
+> If install finds previous versions of local configuration files, most of
+ these will not be overwritten, and the new ones will be installed with a
+ <SPAN
+CLASS="QUOTE"
+>"new"</SPAN
+> extension. default.action and default.filter
+ <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>will be overwritten</I
+></SPAN
+>. You will then need
+ to manually update the other installed configuration files as needed. The
+ default template files <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>will</I
+></SPAN
+> be overwritten. If you have
+ customized, local templates, these should be stored safely in a separate
+ directory and defined in <TT
+CLASS="FILENAME"
+>config</TT
+> by the
+ <SPAN
+CLASS="QUOTE"
+>"templdir"</SPAN
+> directive. It is of course wise to always back-up any
+ important configuration files <SPAN
+CLASS="QUOTE"
+>"just in case"</SPAN
+>. If a previous
+ version of <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> is already running, you will
+ have to restart it manually.</P
+><P
+> For more detailed instructions on how to build Redhat RPMs,
Windows self-extracting installers, building on platforms with
special requirements etc, please consult the <A
-HREF="../developer-manual/newrelease.html"
+HREF="https://www.privoxy.org/developer-manual/newrelease.html"
TARGET="_top"
>developer manual</A
>.</P
+><DIV
+CLASS="SECT3"
+><H3
+CLASS="SECT3"
+><A
+NAME="WINBUILD-CYGWIN"
+>2.2.1. Windows</A
+></H3
+><DIV
+CLASS="SECT4"
+><H4
+CLASS="SECT4"
+><A
+NAME="WINBUILD-SETUP"
+>2.2.1.1. Setup</A
+></H4
+><P
+> Install the Cygwin utilities needed to build <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>.
+ If you have a 64 bit CPU (which most people do by now), get the
+ Cygwin setup-x86_64.exe program <A
+HREF="https://cygwin.com/setup-x86_64.exe"
+TARGET="_top"
+>here</A
+>
+ (the .sig file is <A
+HREF="https://cygwin.com/setup-x86_64.exe.sig"
+TARGET="_top"
+>here</A
+>).
+ </P
+><P
+> Run the setup program and from View / Category select:
+ </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> Devel
+ autoconf 2.5
+ automake 1.15
+ binutils
+ cmake
+ gcc-core
+ gcc-g++
+ git
+ make
+ mingw64-i686-gcc-core
+ mingw64-i686-zlib
+ Editors
+ vim
+ Libs
+ libxslt: GNOME XSLT library (runtime)
+ Net
+ curl
+ openssh
+ Text
+ docbook-dssl
+ docbook-sgml31
+ docbook-utils
+ openjade
+ Utils
+ gnupg
+ Web
+ w3m</PRE
+></TD
+></TR
+></TABLE
+><P
+> If you haven't already downloaded the Privoxy source code, get it now:
+ </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> mkdir <root-dir>
+ cd <root-dir>
+ git clone https://www.privoxy.org/git/privoxy.git</PRE
+></TD
+></TR
+></TABLE
+><P
+> Get the source code (.zip or .tar.gz) for tidy from
+ <A
+HREF="https://github.com/htacg/tidy-html5/releases"
+TARGET="_top"
+> https://github.com/htacg/tidy-html5/releases</A
+>,
+ unzip into <root-dir> and build the software:
+ </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> cd <root-dir>
+ cd tidy-html5-x.y.z/build/cmake
+ cmake ../.. -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIB:BOOL=OFF -DCMAKE_INSTALL_PREFIX=/usr/local
+ make && make install</PRE
+></TD
+></TR
+></TABLE
+><P
+> If you want to be able to make a Windows release package, get the NSIS .zip file from
+
+ <A
+HREF="https://sourceforge.net/projects/nsis/files/NSIS%203/"
+TARGET="_top"
+> https://sourceforge.net/projects/nsis/files/NSIS%203/</A
+>
+ and extract the NSIS directory to <TT
+CLASS="LITERAL"
+>privoxy/windows</TT
+>.
+ Then edit the windows/GNUmakefile to set the location of the NSIS executable - eg:
+ </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+># Path to NSIS
+MAKENSIS = ./nsis/makensis.exe</PRE
+></TD
+></TR
+></TABLE
+></DIV
+><DIV
+CLASS="SECT4"
+><H4
+CLASS="SECT4"
+><A
+NAME="WINBUILD-BUILD"
+>2.2.1.2. Build</A
+></H4
+><P
+> To build just the Privoxy executable and not the whole installation package, do:
+ </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="PROGRAMLISTING"
+> cd <root-dir>/privoxy
+ ./windows/MYconfigure && make</PRE
+></TD
+></TR
+></TABLE
+><P
+> Privoxy uses the <A
+HREF="https://en.wikipedia.org/wiki/GNU_build_system"
+TARGET="_top"
+>GNU Autotools</A
+>
+ for building software, so the process is:
+ </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="PROGRAMLISTING"
+> $ autoheader # creates config.h.in
+ $ autoconf # uses config.h.in to create the configure shell script
+ $ ./configure [options] # creates GNUmakefile
+ $ make [options] # builds the program</PRE
+></TD
+></TR
+></TABLE
+><P
+> The usual <TT
+CLASS="LITERAL"
+>configure</TT
+> options for building a native Windows application under cygwin are
+ </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="LITERALLAYOUT"
+> --host=i686-w64-mingw32
+ --enable-mingw32
+ --enable-zlib
+ --enable-static-linking
+ --disable-pthread
+ --disable-dynamic-pcre</PRE
+></TD
+></TR
+></TABLE
+><P
+> You can set the <TT
+CLASS="LITERAL"
+>CFLAGS</TT
+> and <TT
+CLASS="LITERAL"
+>LDFLAGS</TT
+> envars before
+ running <TT
+CLASS="LITERAL"
+>configure</TT
+> to set compiler and linker flags. For example:
+ </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="PROGRAMLISTING"
+> $ export CFLAGS="-O2" # set gcc optimization level
+ $ export LDFLAGS="-Wl,--nxcompat" # Enable DEP
+ $ ./configure --host=i686-w64-mingw32 --enable-mingw32 --enable-zlib \
+ > --enable-static-linking --disable-pthread --disable-dynamic-pcre
+ $ make # build Privoxy</PRE
+></TD
+></TR
+></TABLE
+><P
+> See the <A
+HREF="../developer-manual/newrelease.html#NEWRELEASE-WINDOWS"
+TARGET="_top"
+>Developer's Manual</A
+>
+ for building a Windows release package.
+ </P
+></DIV
+></DIV
+></DIV
+><DIV
+CLASS="SECT2"
+><H2
+CLASS="SECT2"
+><A
+NAME="INSTALLATION-KEEPUPDATED"
+>2.3. Keeping your Installation Up-to-Date</A
+></H2
+><P
+> If you wish to receive an email notification whenever we release updates of
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> or the actions file, <A
+HREF="https://lists.privoxy.org/mailman/listinfo/privoxy-announce"
+TARGET="_top"
+>subscribe
+ to our announce mailing list</A
+>, privoxy-announce@lists.privoxy.org.</P
+><P
+> In order not to lose your personal changes and adjustments when updating
+ to the latest <TT
+CLASS="LITERAL"
+>default.action</TT
+> file we <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>strongly
+ recommend</I
+></SPAN
+> that you use <TT
+CLASS="LITERAL"
+>user.action</TT
+> and
+ <TT
+CLASS="LITERAL"
+>user.filter</TT
+> for your local
+ customizations of <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>. See the <A
+HREF="actions-file.html"
+>Chapter on actions files</A
+> for details.</P
></DIV
></DIV
><DIV
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
VALIGN="top"
><A
HREF="introduction.html"
+ACCESSKEY="P"
>Prev</A
></TD
><TD
VALIGN="top"
><A
HREF="index.html"
+ACCESSKEY="H"
>Home</A
></TD
><TD
ALIGN="right"
VALIGN="top"
><A
-HREF="quickstart.html"
+HREF="whatsnew.html"
+ACCESSKEY="N"
>Next</A
></TD
></TR
WIDTH="33%"
ALIGN="right"
VALIGN="top"
->Quickstart to Using <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-></TD
+>What's New in this Release</TD
></TR
></TABLE
></DIV
projects / privoxy.git / blobdiff