All HTML docs for 3.0.6 release.
[privoxy.git] / doc / webserver / user-manual / installation.html
index 611c4e9..576a77b 100644 (file)
@@ -7,7 +7,7 @@ NAME="GENERATOR"
 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
 "><LINK
 REL="HOME"
-TITLE="Privoxy 3.0.4 User Manual"
+TITLE="Privoxy 3.0.6 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="Introduction"
@@ -17,7 +17,9 @@ 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">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
 ><BODY
 CLASS="SECT1"
 BGCOLOR="#EEEEEE"
@@ -37,7 +39,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy 3.0.4 User Manual</TH
+>Privoxy 3.0.6 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -90,27 +92,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"
@@ -129,11 +122,11 @@ 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</H3
 ><P
 > RPMs can be installed with <TT
 CLASS="LITERAL"
->rpm -Uvh privoxy-3.0.4-1.rpm</TT
+>rpm -Uvh privoxy-3.0.6-1.rpm</TT
 >,
  and will use <TT
 CLASS="FILENAME"
@@ -159,13 +152,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.6-1.src.rpm</TT
 >. This 
  will use your locally installed libraries and RPM version. </P
 ><P
@@ -178,7 +170,7 @@ CLASS="APPLICATION"
 CLASS="APPLICATION"
 >Junkbuster</SPAN
 >
- automatically, before installing <SPAN
+ automatically if found, before installing <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
 >.</P
@@ -213,7 +205,100 @@ NAME="INSTALLATION-PACK-WIN"
 ><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.4 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"
@@ -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.6</TT
 >
  and the Log directory is in <TT
 CLASS="FILENAME"
@@ -414,10 +499,11 @@ NAME="INSTALLATION-SOURCE"
 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&package_id=10571"
 TARGET="_top"
->project
+>project download
  page</A
 >.</P
 ><P
@@ -450,8 +536,8 @@ TARGET="_top"
 >gcc</A
 > are required.</P
 ><P
-> When building from a source tarball (either release version or
a nightly CVS tarball, first unpack the source: </P
+> When building from a source tarball,
+ first unpack the source: </P
 ><P
 > <TABLE
 BORDER="0"
@@ -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.6-src* [.tgz or .tar.gz]
+ cd privoxy-3.0.6</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,32 @@ 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.</P
+><P
 > <SPAN
 CLASS="emphasis"
 ><I
@@ -646,8 +767,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 +808,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 +816,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 +848,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 +900,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,21 +910,33 @@ 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, default.filter, and 
+ standard.action <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. All
+ template files will be overwritten. If you have customized, local templates,
+ you should save these first, and in fact it is wise to always save 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"
@@ -856,8 +990,12 @@ CLASS="EMPHASIS"
 > that you use <TT
 CLASS="LITERAL"
 >user.action</TT
-> for your
- customization of <SPAN
+> and 
+ <TT
+CLASS="LITERAL"
+>user.filter</TT
+> for your local
+ customizations of <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
 >. See the <A