Rebuild for 3.0.17 stable
[privoxy.git] / doc / webserver / user-manual / installation.html
index 34b4d0a..f610c6b 100644 (file)
@@ -1,13 +1,13 @@
+<!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.76b+
-"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="HOME"
-TITLE="Privoxy 3.0.4 User Manual"
+TITLE="Privoxy 3.0.17 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="Introduction"
@@ -17,7 +17,12 @@ 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"
@@ -37,7 +42,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy 3.0.4 User Manual</TH
+>Privoxy 3.0.17 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -74,8 +79,8 @@ CLASS="SECT1"
 CLASS="SECT1"
 ><A
 NAME="INSTALLATION"
-></A
->2. Installation</H1
+>2. Installation</A
+></H1
 ><P
 > <SPAN
 CLASS="APPLICATION"
@@ -90,27 +95,18 @@ TARGET="_top"
  Page</A
 >.</P
 ><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.  On some platforms, this may be done for you as part
- of their installation procedure. (See below for your platform). In any case
- <SPAN
+> 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
+>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
+>note to upgraders</A
 > section below.</P
 ><DIV
 CLASS="SECT2"
@@ -118,8 +114,8 @@ CLASS="SECT2"
 CLASS="SECT2"
 ><A
 NAME="INSTALLATION-PACKAGES"
-></A
->2.1. Binary Packages</H2
+>2.1. Binary Packages</A
+></H2
 ><P
 >How to install the binary packages depends on your operating system:</P
 ><DIV
@@ -128,12 +124,12 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-PACK-RPM"
-></A
->2.1.1. Red Hat, SuSE and Conectiva RPMs</H3
+>2.1.1. Red Hat and Fedora RPMs</A
+></H3
 ><P
 > RPMs can be installed with <TT
 CLASS="LITERAL"
->rpm -Uvh privoxy-3.0.4-1.rpm</TT
+>rpm -Uvh privoxy-3.0.17-1.rpm</TT
 >,
  and will use <TT
 CLASS="FILENAME"
@@ -159,13 +155,12 @@ CLASS="COMMAND"
  <B
 CLASS="COMMAND"
 >ntsysv</B
->, or similar methods. Note that SuSE will 
-automatically start Privoxy in the boot process.</P
+>, 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.4-1.src.rpm</TT
+>rpm --rebuild privoxy-3.0.17-1.src.rpm</TT
 >. This 
  will use your locally installed libraries and RPM version. </P
 ><P
@@ -178,7 +173,7 @@ CLASS="APPLICATION"
 CLASS="APPLICATION"
 >Junkbuster</SPAN
 >
- automatically, before installing <SPAN
+ automatically if found, before installing <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
 >.</P
@@ -189,8 +184,8 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-DEB"
-></A
->2.1.2. Debian</H3
+>2.1.2. Debian and Ubuntu</A
+></H3
 ><P
 > DEBs can be installed with <TT
 CLASS="LITERAL"
@@ -208,12 +203,105 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-PACK-WIN"
-></A
->2.1.3. Windows</H3
+>2.1.3. Windows</A
+></H3
 ><P
 > 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 Privoxy in. </P
+ in the same directory as you installed <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> in. </P
+><P
+> Version 3.0.5 beta introduced full <SPAN
+CLASS="APPLICATION"
+>Windows</SPAN
+> service
+ functionality. On Windows only, the <SPAN
+CLASS="APPLICATION"
+>Privoxy</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
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Arguments:</DT
+><DD
+><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
+><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"
@@ -221,8 +309,8 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-PACK-BINTGZ"
-></A
->2.1.4. Solaris, NetBSD, FreeBSD, HP-UX</H3
+>2.1.4. Solaris</A
+></H3
 ><P
 > Create a new directory, <TT
 CLASS="LITERAL"
@@ -237,8 +325,8 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-OS2"
-></A
->2.1.5. OS/2</H3
+>2.1.5. OS/2</A
+></H3
 ><P
 > First, make sure that no previous installations of
  <SPAN
@@ -279,59 +367,26 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-MAC"
-></A
->2.1.6. Mac OSX</H3
+>2.1.6. Mac OS X</A
+></H3
 ><P
-> Unzip the downloaded file (you can either double-click on the file
- from the finder, or from the desktop if you downloaded it there).
- Then, double-click on the package installer icon named
- <TT
-CLASS="LITERAL"
->Privoxy.pkg</TT
->
- and follow the installation process.
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> will be installed in the folder
- <TT
-CLASS="LITERAL"
->/Library/Privoxy</TT
->.
- It will start automatically whenever you start up.  To prevent it from
- starting automatically, remove or rename the folder
+> 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 start Privoxy by hand, double-click on 
- <TT
-CLASS="LITERAL"
->StartPrivoxy.command</TT
-> in the
- <TT
-CLASS="LITERAL"
->/Library/Privoxy</TT
-> folder.
- Or, type this command in the Terminal:</P
-><P
->  <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->  /Library/Privoxy/StartPrivoxy.command
-  </PRE
-></TD
-></TR
-></TABLE
-></P
-><P
-> You will be prompted for the administrator password.</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
 ></DIV
 ><DIV
 CLASS="SECT3"
@@ -339,8 +394,8 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-AMIGA"
-></A
->2.1.7. AmigaOS</H3
+>2.1.7. AmigaOS</A
+></H3
 ><P
 > Copy and then unpack the <TT
 CLASS="FILENAME"
@@ -358,9 +413,39 @@ CLASS="SECT3"
 ><H3
 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
+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
+CLASS="LITERAL"
+>pkg_add -r privoxy</TT
+>.</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
+></DIV
+><DIV
+CLASS="SECT3"
+><H3
+CLASS="SECT3"
+><A
 NAME="INSTALLATTION-GENTOO"
-></A
->2.1.8. Gentoo</H3
+>2.1.9. Gentoo</A
+></H3
 ><P
 > Gentoo source packages (Ebuilds) for <SPAN
 CLASS="APPLICATION"
@@ -379,7 +464,7 @@ CLASS="APPLICATION"
 > under Gentoo just do 
  first <TT
 CLASS="LITERAL"
->emerge rsync</TT
+>emerge --sync</TT
 > to get the latest changes from the 
  Portage tree. With <TT
 CLASS="LITERAL"
@@ -393,7 +478,7 @@ CLASS="FILENAME"
 >, the 
  documentation is in <TT
 CLASS="FILENAME"
->/usr/share/doc/privoxy-3.0.4</TT
+>/usr/share/doc/privoxy-3.0.17</TT
 >
  and the Log directory is in <TT
 CLASS="FILENAME"
@@ -407,17 +492,18 @@ CLASS="SECT2"
 CLASS="SECT2"
 ><A
 NAME="INSTALLATION-SOURCE"
-></A
->2.2. Building from Source</H2
+>2.2. Building from Source</A
+></H2
 ><P
 > The most convenient way to obtain the <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > sources
- is to download the source tarball from our <A
-HREF="http://sf.net/projects/ijbswa/"
+ is to download the source tarball from our 
+ <A
+HREF="http://sourceforge.net/project/showfiles.php?group_id=11118&#38;package_id=10571"
 TARGET="_top"
->project
+>project download
  page</A
 >.</P
 ><P
@@ -461,15 +547,15 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
-> tar xzvf privoxy-3.0.4-beta-src* [.tgz or .tar.gz]
- cd privoxy-3.0.4-beta</PRE
+> tar xzvf privoxy-3.0.17-stable-src.tar.gz
+ cd privoxy-3.0.17-stable</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
+> 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
@@ -513,12 +599,21 @@ CLASS="APPLICATION"
 CLASS="APPLICATION"
 >Privoxy</SPAN
 >
- as root, and instead it is suggested to create a <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 for this purpose. See your local documentation for the correct 
- command line to do this. </P
+ 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"
@@ -574,7 +669,7 @@ CLASS="SCREEN"
  autoconf
  ./configure      # (--help to see options)
  make             # (the make from GNU, sometimes called gmake) 
- su 
+ 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
@@ -582,7 +677,7 @@ CLASS="SCREEN"
 ></TABLE
 ></P
 ><P
->  If you have GNU <B
+>  Using GNU <B
 CLASS="COMMAND"
 >make</B
 >, you can have the first four steps
@@ -604,6 +699,33 @@ CLASS="SCREEN"
 ><P
 >  in the freshly downloaded or unpacked source directory.</P
 ><P
+> 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
+><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
+><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
+><P
 > <SPAN
 CLASS="emphasis"
 ><I
@@ -646,8 +768,8 @@ CLASS="EMPHASIS"
  <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
->, it should be run as this same user to
- insure write access to configuration and log files.</P
+>, 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"
@@ -687,7 +809,7 @@ CLASS="FILENAME"
 CLASS="COMMAND"
 >./configure</B
 > path options. If you are doing 
- a root install to anywhere else besides <TT
+ an install to anywhere besides <TT
 CLASS="FILENAME"
 >/usr/local</TT
 >, be
@@ -695,7 +817,8 @@ CLASS="FILENAME"
  (<B
 CLASS="COMMAND"
 >./configure --help</B
->).</P
+>). 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"
@@ -726,16 +849,16 @@ CLASS="FILENAME"
 > If installing to <TT
 CLASS="FILENAME"
 >/usr/local</TT
->, the docs will go by default
- to <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
+>. 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
+> and install
there before creating a new <TT
 CLASS="FILENAME"
 >$prefix/share/doc</TT
 > just for
@@ -778,8 +901,8 @@ CLASS="COMMAND"
  in <TT
 CLASS="FILENAME"
 >config</TT
-> (main configuration file). You may want 
to check this to make sure all values are correct. If appropriate,
+> (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"
@@ -788,24 +911,50 @@ CLASS="APPLICATION"
  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 any configuration files, these will not
- be overwritten, and the new ones will be installed with a <SPAN
+> 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. You will then need to manually update the installed configuration
- files as needed. All template files will be overwritten. If you have
- customized, local templates, you should save these first. If a previous
+> 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 and SuSE RPMs,
+> 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="http://www.privoxy.org/developer-manual/newrelease.html"
 TARGET="_top"
 >developer manual</A
 >.</P
@@ -816,15 +965,15 @@ CLASS="SECT2"
 CLASS="SECT2"
 ><A
 NAME="INSTALLATION-KEEPUPDATED"
-></A
->2.3. Keeping your Installation Up-to-Date</H2
+>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&release_id=103670"
+HREF="http://sourceforge.net/project/showfiles.php?group_id=11118&#38;release_id=103670"
 TARGET="_top"
 >separate
  package</A
@@ -930,4 +1079,4 @@ VALIGN="top"
 ></DIV
 ></BODY
 ></HTML
->
\ No newline at end of file
+>