rebuild docs
[privoxy.git] / doc / webserver / user-manual / installation.html
index 8d89706..de3aedd 100644 (file)
@@ -7,7 +7,7 @@
 NAME="GENERATOR"
 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="HOME"
-TITLE="Privoxy 3.0.18 User Manual"
+TITLE="Privoxy 3.0.27 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="Introduction"
@@ -42,7 +42,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy 3.0.18 User Manual</TH
+>Privoxy 3.0.27 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -89,14 +89,14 @@ CLASS="APPLICATION"
  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
 >.</P
 ><P
-> Note: 
- On some platforms, the installer may remove previously installed versions, if 
+> 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
@@ -123,68 +123,8 @@ CLASS="SECT3"
 ><H3
 CLASS="SECT3"
 ><A
-NAME="INSTALLATION-PACK-RPM"
->2.1.1. Red Hat and Fedora RPMs</A
-></H3
-><P
-> RPMs can be installed with <TT
-CLASS="LITERAL"
->rpm -Uvh privoxy-3.0.18-1.rpm</TT
->,
- and will use <TT
-CLASS="FILENAME"
->/etc/privoxy</TT
-> for the location 
- of configuration files.</P
-><P
-> Note that on Red Hat, <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> will
- <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->not</I
-></SPAN
-> 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 methods. </P
-><P
-> If you have problems with failed dependencies, try rebuilding the SRC RPM: 
- <TT
-CLASS="LITERAL"
->rpm --rebuild privoxy-3.0.18-1.src.rpm</TT
->. This 
- will use your locally installed libraries and RPM version. </P
-><P
-> Also note that if you have a <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
-CLASS="APPLICATION"
->Junkbuster</SPAN
->
- automatically if found, before installing <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->.</P
-></DIV
-><DIV
-CLASS="SECT3"
-><H3
-CLASS="SECT3"
-><A
 NAME="INSTALLATION-DEB"
->2.1.2. Debian and Ubuntu</A
+>2.1.1. Debian and Ubuntu</A
 ></H3
 ><P
 > DEBs can be installed with <TT
@@ -194,7 +134,7 @@ CLASS="LITERAL"
  and will use <TT
 CLASS="FILENAME"
 >/etc/privoxy</TT
-> for the location of 
+> for the location of
  configuration files.</P
 ></DIV
 ><DIV
@@ -203,7 +143,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-PACK-WIN"
->2.1.3. Windows</A
+>2.1.2. Windows</A
 ></H3
 ><P
 > Just double-click the installer, which will guide you through
@@ -211,7 +151,7 @@ NAME="INSTALLATION-PACK-WIN"
  in the same directory as you installed <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> in. </P
+> in.</P
 ><P
 > Version 3.0.5 beta introduced full <SPAN
 CLASS="APPLICATION"
@@ -300,7 +240,7 @@ 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 
+ actually exists, or it will not be permitted to
  write to its log and configuration files.</P
 ></DIV
 ><DIV
@@ -308,31 +248,15 @@ CLASS="SECT3"
 ><H3
 CLASS="SECT3"
 ><A
-NAME="INSTALLATION-PACK-BINTGZ"
->2.1.4. Solaris</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. </P
-></DIV
-><DIV
-CLASS="SECT3"
-><H3
-CLASS="SECT3"
-><A
 NAME="INSTALLATION-OS2"
->2.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
@@ -345,7 +269,7 @@ CLASS="APPLICATION"
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > objects are in
- your startup folder.&#13;</P
+ 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
@@ -367,122 +291,105 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-MAC"
->2.1.6. Mac OS X</A
+>2.1.4. Mac OS X</A
 ></H3
 ><P
-> Unzip the downloaded file (you can either double-click on the zip file
- icon from the Finder, or from the desktop if you downloaded it there).
- Then, double-click on the package installer icon and follow the
- installation process.</P
-><P
-> The privoxy service will automatically start after a successful
- installation (in addition to every time your computer starts up).  To
- prevent the privoxy service from automatically starting when your
- computer starts up, remove or rename the folder named
- <TT
-CLASS="LITERAL"
->/Library/StartupItems/Privoxy</TT
->. </P
-><P
-> To manually start or stop the privoxy service, use the Privoxy Utility
- for Mac OS X.  This application controls the privoxy service (e.g.
- starting and stopping the service as well as uninstalling the software).</P
+> 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"
-><H3
+><H4
 CLASS="SECT3"
 ><A
-NAME="INSTALLATION-AMIGA"
->2.1.7. AmigaOS</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
+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
 >
- directory, including all configuration and log files. To uninstall, just 
- remove this directory.</P
+ (on OS X 10.5 and higher) or the folder named
+ <TT
+CLASS="LITERAL"
+>/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"
-><H3
+><H4
 CLASS="SECT3"
 ><A
-NAME="INSTALLATION-TBZ"
->2.1.8. FreeBSD</A
-></H3
-><P
-> Privoxy is part of FreeBSD's Ports Collection, you can build and install
- it with <TT
+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"
->cd /usr/ports/www/privoxy; make install clean</TT
->.</P
-><P
-> If you don't use the ports, you can fetch and install
- the package with <TT
+>/Library/LaunchDaemons/org.ijbswa.privoxy.plist</TT
+>
+ (on OS X 10.5 and higher) or the folder named
+ <TT
 CLASS="LITERAL"
->pkg_add -r privoxy</TT
->.</P
+>/Library/StartupItems/Privoxy</TT
+> (on OS X 10.4 'Tiger').</P
 ><P
-> The port skeleton and the package can also be downloaded from the
- <A
-HREF="https://sourceforge.net/project/showfiles.php?group_id=11118"
-TARGET="_top"
->File Release
- Page</A
->, but there's no reason to use them unless you're interested in the
- beta releases which are only available there.</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="INSTALLATTION-GENTOO"
->2.1.9. Gentoo</A
+NAME="INSTALLATION-FREEBSD"
+>2.1.7. FreeBSD</A
 ></H3
 ><P
-> Gentoo source packages (Ebuilds) for <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> are 
- contained in the Gentoo  Portage Tree (they are not on the download page, 
- but there is a Gentoo section, where you can see when a new 
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> Version is added to the  Portage Tree).</P
-><P
-> Before installing <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> under Gentoo just do 
- first <TT
-CLASS="LITERAL"
->emerge --sync</TT
-> to get the latest changes from the 
- Portage tree. With <TT
+> Privoxy is part of FreeBSD's Ports Collection, you can build and install
+ it with <TT
 CLASS="LITERAL"
->emerge privoxy</TT
-> you install the latest 
- version.</P
-><P
-> Configuration files are in <TT
-CLASS="FILENAME"
->/etc/privoxy</TT
->, the 
- documentation is in <TT
-CLASS="FILENAME"
->/usr/share/doc/privoxy-3.0.18</TT
->
- and the Log directory is in <TT
-CLASS="FILENAME"
->/var/log/privoxy</TT
+>cd /usr/ports/www/privoxy; make install clean</TT
 >.</P
 ></DIV
 ></DIV
@@ -499,9 +406,9 @@ NAME="INSTALLATION-SOURCE"
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > sources
- is to download the source tarball from our 
+ is to download the source tarball from our
  <A
-HREF="http://sourceforge.net/project/showfiles.php?group_id=11118&#38;package_id=10571"
+HREF="https://sourceforge.net/projects/ijbswa/files/Sources/"
 TARGET="_top"
 >project download
  page</A
@@ -510,16 +417,16 @@ TARGET="_top"
 > 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"
+HREF="https://sourceforge.net/p/ijbswa/code/?source=navbar"
 TARGET="_top"
 >the
  CVS repository</A
->. </P
+>.</P
 ><P
 > To build <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> from source, 
+> from source,
  <A
 HREF="http://www.gnu.org/software/autoconf/autoconf.html"
 TARGET="_top"
@@ -537,9 +444,8 @@ TARGET="_top"
 > are required.</P
 ><P
 > When building from a source tarball,
- first unpack the source: </P
-><P
-> <TABLE
+ first unpack the source:</P
+><TABLE
 BORDER="0"
 BGCOLOR="#E0E0E0"
 WIDTH="100%"
@@ -547,19 +453,17 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
-> tar xzvf privoxy-3.0.18-beta-src.tar.gz
- cd privoxy-3.0.18-beta</PRE
+> tar xzvf privoxy-3.0.27-beta-src.tar.gz
+ cd privoxy-3.0.27-beta</PRE
 ></TD
 ></TR
 ></TABLE
-></P
 ><P
 > For retrieving the current CVS sources, you'll need a CVS client installed.
  Note that sources from CVS are typically development quality, and may not be
  stable, or well tested. To download CVS source, check the Sourceforge
  documentation, which might give commands like:</P
-><P
-> <TABLE
+><TABLE
 BORDER="0"
 BGCOLOR="#E0E0E0"
 WIDTH="100%"
@@ -573,12 +477,11 @@ CLASS="SCREEN"
 ></TD
 ></TR
 ></TABLE
-></P
 ><P
 > This will create a directory named <TT
 CLASS="FILENAME"
 >current/</TT
->, which will 
+>, which will
  contain the source tree.</P
 ><P
 > You can also check out any <SPAN
@@ -613,14 +516,13 @@ CLASS="QUOTE"
 CLASS="COMMAND"
 >adduser</B
 >, but the command syntax may vary from platform
- to platform). </P
+ to platform).</P
 ><P
 > <TT
 CLASS="FILENAME"
 >/etc/passwd</TT
 > might then look like:</P
-><P
-> <TABLE
+><TABLE
 BORDER="0"
 BGCOLOR="#E0E0E0"
 WIDTH="100%"
@@ -632,14 +534,12 @@ CLASS="SCREEN"
 ></TD
 ></TR
 ></TABLE
-></P
 ><P
 > And then <TT
 CLASS="FILENAME"
 >/etc/group</TT
 >, like:</P
-><P
-> <TABLE
+><TABLE
 BORDER="0"
 BGCOLOR="#E0E0E0"
 WIDTH="100%"
@@ -651,13 +551,11 @@ CLASS="SCREEN"
 ></TD
 ></TR
 ></TABLE
-></P
 ><P
 > Some binary packages may do this for you.</P
 ><P
 > Then, to build from either unpacked tarball or CVS source:</P
-><P
-> <TABLE
+><TABLE
 BORDER="0"
 BGCOLOR="#E0E0E0"
 WIDTH="100%"
@@ -668,22 +566,20 @@ CLASS="SCREEN"
 > autoheader
  autoconf
  ./configure      # (--help to see options)
- make             # (the make from GNU, sometimes called gmake) 
+ make             # (the make from GNU, sometimes called gmake)
  su               # Possibly required
  make -n install  # (to see where all the files will go)
  make -s install  # (to really install, -s to silence output)</PRE
 ></TD
 ></TR
 ></TABLE
-></P
 ><P
 >  Using GNU <B
 CLASS="COMMAND"
 >make</B
 >, you can have the first four steps
   automatically done for you by just typing:</P
-><P
-> <TABLE
+><TABLE
 BORDER="0"
 BGCOLOR="#E0E0E0"
 WIDTH="100%"
@@ -695,11 +591,10 @@ CLASS="SCREEN"
 ></TD
 ></TR
 ></TABLE
-></P
 ><P
 >  in the freshly downloaded or unpacked source directory.</P
 ><P
-> To build an executable with security enhanced features so that 
+> 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
@@ -708,8 +603,7 @@ CLASS="QUOTE"
 CLASS="COMMAND"
 >configure</B
 > like this:</P
-><P
-> <TABLE
+><TABLE
 BORDER="0"
 BGCOLOR="#E0E0E0"
 WIDTH="100%"
@@ -721,10 +615,8 @@ CLASS="SCREEN"
 ></TD
 ></TR
 ></TABLE
-></P
 ><P
->Then build as above. In Privoxy 3.0.7 and later, all of these options
-can also be disabled through the configuration file.</P
+> Note that all of these options can also be disabled through the configuration file.</P
 ><P
 > <SPAN
 CLASS="emphasis"
@@ -782,8 +674,7 @@ CLASS="LITERAL"
 CLASS="COMMAND"
 >make</B
 > command line, but be sure both already exist:</P
-><P
-> <TABLE
+><TABLE
 BORDER="0"
 BGCOLOR="#E0E0E0"
 WIDTH="100%"
@@ -795,20 +686,19 @@ CLASS="SCREEN"
 ></TD
 ></TR
 ></TABLE
-></P
 ><P
 > The default installation path for <B
 CLASS="COMMAND"
 >make install</B
-> is 
+> is
  <TT
 CLASS="FILENAME"
 >/usr/local</TT
->. This may of course be customized with 
+>. This may of course be customized with
  the various <B
 CLASS="COMMAND"
 >./configure</B
-> path options. If you are doing 
+> path options. If you are doing
  an install to anywhere besides <TT
 CLASS="FILENAME"
 >/usr/local</TT
@@ -892,22 +782,22 @@ CLASS="FILENAME"
  will be created in <TT
 CLASS="FILENAME"
 >/var/run/privoxy.pid</TT
->. </P
+>.</P
 ><P
 > <B
 CLASS="COMMAND"
 >make install</B
-> will attempt to set the correct values 
+> will attempt to set the correct values
  in <TT
 CLASS="FILENAME"
 >config</TT
-> (main configuration file). You should  
+> (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 
+ 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 
+>. The init
  script should be checked for correct paths and values, if anything other than
  a default install is done.</P
 ><P
@@ -954,7 +844,7 @@ CLASS="APPLICATION"
 > 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="http://www.privoxy.org/developer-manual/newrelease.html"
+HREF="https://www.privoxy.org/developer-manual/newrelease.html"
 TARGET="_top"
 >developer manual</A
 >.</P
@@ -968,28 +858,16 @@ NAME="INSTALLATION-KEEPUPDATED"
 >2.3. Keeping your Installation Up-to-Date</A
 ></H2
 ><P
-> As user feedback comes in and development continues, we will make updated versions
- of both the main <A
-HREF="actions-file.html"
->actions file</A
-> (as a <A
-HREF="http://sourceforge.net/project/showfiles.php?group_id=11118&#38;release_id=103670"
-TARGET="_top"
->separate
- package</A
->) and the software itself (including the actions file) available for
- download.</P
-><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="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce/"
+HREF="https://lists.privoxy.org/mailman/listinfo/privoxy-announce"
 TARGET="_top"
 >subscribe
- to our announce  mailing list</A
->, ijbswa-announce@lists.sourceforge.net.</P
+ 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
@@ -1005,7 +883,7 @@ CLASS="EMPHASIS"
 > that you use <TT
 CLASS="LITERAL"
 >user.action</TT
-> and 
+> and
  <TT
 CLASS="LITERAL"
 >user.filter</TT