generated
[privoxy.git] / doc / webserver / user-manual / installation.html
index 00b9bed..192498f 100644 (file)
@@ -77,164 +77,289 @@ NAME="INSTALLATION"
 > <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> is available as raw source code (tarball 
- or via CVS), or pre-compiled binaries for various platforms. See the <A
+> is available both in convenient pre-compiled
+ 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/"
 TARGET="_top"
 >Privoxy Project Page</A
-> for
- the most up to date release information.
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> is also available via <A
-HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/"
+>.</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"
->CVS</A
->.
- This is the recommended approach at this time. But
- please be aware that CVS is constantly changing, and it may break in
- mysterious ways.</P
+>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, and many flavors
- of Unix. There are source and binary releases for these available for
- download at <A
-HREF="http://sourceforge.net/project/showfiles.php?group_id=11118"
-TARGET="_top"
->http://sourceforge.net/project/showfiles.php?group_id=11118</A
->.</P
+ OSX, OS/2, AmigaOS, Linux (RedHat, Suse, Debian), FreeBSD, NetBSD, BeOS, and
+ many flavors of Unix.</P
 ><DIV
 CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="INSTALLATION-SOURCE"
->3.1. Source</A
+NAME="INSTALLATION-PACKAGES"
+>3.1. Binary Packages</A
 ></H2
 ><P
-> There are several ways to install <SPAN
+> 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
-> To build <SPAN
+> 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
+></H3
+><P
+> RPMs can be installed with <TT
+CLASS="LITERAL"
+>rpm -Uvh privoxy-2.9.14-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
-> from source, 
- autoconf and GNU make (gmake) are required. Source is available as gzipped
- tar archives. For this, first unpack the source: </P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
-> tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz]
- cd privoxy-2.9.14-beta
- </PRE
-></TD
-></TR
-></TABLE
-></P
+> 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
-> For retrieving the current CVS sources, you'll need the CVS 
- package installed first. Note CVS source is development quality, 
- and may not be stable, or well tested. To download CVS source:</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
 ><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><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
-></TD
-></TR
-></TABLE
-></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, before installing <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>.</P
+></DIV
+><DIV
+CLASS="SECT3"
+><H3
+CLASS="SECT3"
+><A
+NAME="INSTALLATION-DEB"
+>3.1.2. Debian</A
+></H3
 ><P
-> This will create a directory named <TT
-CLASS="FILENAME"
->current/</TT
->, which will 
- contain the source tree.</P
+> FIXME.</P
+></DIV
+><DIV
+CLASS="SECT3"
+><H3
+CLASS="SECT3"
+><A
+NAME="INSTALLATION-PACK-WIN"
+>3.1.3. Windows</A
+></H3
 ><P
-> Then, in either case, to build from unpacked tarball or CVS source:</P
+> Just double-click the installer, which will guide you through
+ the installation process.</P
+></DIV
+><DIV
+CLASS="SECT3"
+><H3
+CLASS="SECT3"
+><A
+NAME="INSTALLATION-PACK-BINTGZ"
+>3.1.4. Solaris, NetBSD, FreeBSD, HP-UX</A
+></H3
 ><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
-> autoheader
- autoconf
- ./configure      (--help to see options)
- make             (the make from gnu, gmake for *BSD) 
- su 
- make -n install  (to see where all the files will go)
- make install     (to really install)
- </PRE
-></TD
-></TR
-></TABLE
-></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
+></DIV
+><DIV
+CLASS="SECT3"
+><H3
+CLASS="SECT3"
+><A
+NAME="INSTALLATION-OS2"
+>3.1.5. OS/2</A
+></H3
 ><P
-> Redhat and SuSE src and binary RPMs can be built with 
+> First, make sure that no previous installations of
  <SPAN
-CLASS="QUOTE"
->"<B
-CLASS="COMMAND"
->make redhat-dist</B
->"</SPAN
-> or
+CLASS="APPLICATION"
+>Junkbuster</SPAN
+> and / or 
  <SPAN
-CLASS="QUOTE"
->"<B
-CLASS="COMMAND"
->make suse-dist</B
->"</SPAN
-> from unpacked sources. You
- will need to run <SPAN
-CLASS="QUOTE"
->"<B
-CLASS="COMMAND"
->autoconf; autoheader;
- ./configure</B
->"</SPAN
-> beforehand. *BSD will require gmake (from
- <A
-HREF="http://www.gnu.org"
-TARGET="_top"
->http://www.gnu.org</A
->). 
- </P
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> are left on your
+ system. You can do this by </P
+><P
+> Then, just double-click the WarpIN self-installing archive, which will
+ guide you through the installation process. A shadow of the
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> executable will be placed in your
+ startup folder so it will start automatically whenever OS/2 starts.</P
+><P
+> The directory you choose to install <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+ into will contain all of the configuration files.</P
+></DIV
+><DIV
+CLASS="SECT3"
+><H3
+CLASS="SECT3"
+><A
+NAME="INSTALLATION-MAC"
+>3.1.6. Max OSX</A
+></H3
 ><P
-> For Redhat and SuSE Linux RPM packages, see below.</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
+ <TT
+CLASS="LITERAL"
+>/Applications/Privoxy.app</TT
+>.
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> will set itself up to start 
+ automatically on system bringup via
+ <TT
+CLASS="LITERAL"
+>/System/Library/StartupItems/Privoxy</TT
+>.</P
+></DIV
 ><DIV
 CLASS="SECT3"
 ><H3
 CLASS="SECT3"
 ><A
-NAME="INSTALLATION-RH"
->3.1.1. Red Hat</A
+NAME="INSTALLATION-AMIGA"
+>3.1.7. AmigaOS</A
 ></H3
 ><P
-> To build Redhat RPM packages from source, install source as above. Then:</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 &#60;&#62;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
+></DIV
+></DIV
+><DIV
+CLASS="SECT2"
+><H2
+CLASS="SECT2"
+><A
+NAME="INSTALLATION-SOURCE"
+>3.2. Building from Source</A
+></H2
+><P
+> To build <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> from source, 
+ autoheader, autoconf, <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
+><P
+> When building from a source tarball (either release version or
+ nightly CVS tarball), first unpack the source: </P
 ><P
 > <TABLE
 BORDER="0"
@@ -244,23 +369,17 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
-> autoheader
- autoconf
- ./configure
- make redhat-dist
+> tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz]
+ cd privoxy-2.9.14-beta
  </PRE
 ></TD
 ></TR
 ></TABLE
 ></P
 ><P
-> This will create both binary and src RPMs in the usual places. Example:</P
-><P
->    /usr/src/redhat/RPMS/i686/privoxy-2.9.14-1.i686.rpm</P
-><P
->    /usr/src/redhat/SRPMS/privoxy-2.9.14-1.src.rpm</P
-><P
-> To install, of course:</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
 ><P
 > <TABLE
 BORDER="0"
@@ -270,47 +389,22 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
-> rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-2.9.14-1.i686.rpm
+>  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
 ></TD
 ></TR
 ></TABLE
 ></P
 ><P
-> This will place the <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> configuration 
- files in <TT
-CLASS="FILENAME"
->/etc/privoxy/</TT
->, and log files in 
- <TT
+> This will create a directory named <TT
 CLASS="FILENAME"
->/var/log/privoxy/</TT
->. Run 
- <SPAN
-CLASS="QUOTE"
->"<B
-CLASS="COMMAND"
->chkconfig privoxy on</B
->"</SPAN
-> to have
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> start automatically during init.&#13;</P
-></DIV
-><DIV
-CLASS="SECT3"
-><H3
-CLASS="SECT3"
-><A
-NAME="INSTALLATION-SUSE"
->3.1.2. SuSE</A
-></H3
+>current/</TT
+>, which will 
+ contain the source tree.</P
 ><P
-> To build SuSE RPM packages, install source as above. Then:</P
+> Then, in either case, to build from unpacked tarball or CVS source:</P
 ><P
 > <TABLE
 BORDER="0"
@@ -322,21 +416,19 @@ WIDTH="100%"
 CLASS="SCREEN"
 > autoheader
  autoconf
- ./configure
- make suse-dist
+ ./configure      # (--help to see options)
+ make             # (the make from gnu, gmake for *BSD) 
+ su 
+ make -n install  # (to see where all the files will go)
+ make install     # (to really install)
  </PRE
 ></TD
 ></TR
 ></TABLE
 ></P
 ><P
-> This will create both binary and src RPMs in the usual places. Example:</P
-><P
->    /usr/src/packages/RPMS/i686/privoxy-2.9.14-1.i686.rpm</P
-><P
->    /usr/src/packages/SRPMS/privoxy-2.9.14-1.src.rpm</P
-><P
-> To install, of course:</P
+>  If you have gnu make, you can have the first four steps 
+  automatically done for you by just typing</P
 ><P
 > <TABLE
 BORDER="0"
@@ -346,100 +438,22 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
-> rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.14-1.i686.rpm
+>  make
  </PRE
 ></TD
 ></TR
 ></TABLE
 ></P
 ><P
-> This will place the <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> configuration 
- files in <TT
-CLASS="FILENAME"
->/etc/privoxy/</TT
->, and log files in 
- <TT
-CLASS="FILENAME"
->/var/log/privoxy/</TT
->. </P
-></DIV
-><DIV
-CLASS="SECT3"
-><H3
-CLASS="SECT3"
-><A
-NAME="INSTALLATION-OS2"
->3.1.3. OS/2</A
-></H3
-><P
-> <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> is packaged in a WarpIN self-
- installing archive.  The self-installing program will be named depending
- on the release version, something like:
- <TT
-CLASS="FILENAME"
->privoxyos2_setup_2.9.14.exe</TT
->.  In order to install it, simply
- run this executable or double-click on its icon and follow the WarpIN
- installation panels.  A shadow of the <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->
- executable will be placed in your startup folder so it will start 
- automatically whenever OS/2 starts.</P
-><P
-> The directory you choose to install <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->
- into will contain all of the configuration files.</P
-></DIV
-><DIV
-CLASS="SECT3"
-><H3
-CLASS="SECT3"
-><A
-NAME="INSTALLATION-WIN"
->3.1.4. Windows</A
-></H3
-><P
->Click-click. (I need help on this. Not a clue here. Also for 
-configuration section below. HB.)</P
-></DIV
-><DIV
-CLASS="SECT3"
-><H3
-CLASS="SECT3"
-><A
-NAME="INSTALLATION-OTHER"
->3.1.5. Other</A
-></H3
-><P
-> Some quick notes on other Operating Systems.</P
+>  in the freshly downloaded or unpacked source directory.</P
 ><P
-> For FreeBSD (and other *BSDs?), the build will require <B
-CLASS="COMMAND"
->gmake</B
-> 
- instead of the included <B
-CLASS="COMMAND"
->make</B
->. <B
-CLASS="COMMAND"
->gmake</B
-> is
- available from <A
-HREF="http://www.gnu.org"
+> For more detailed instructions on how to build Redhat and SuSE RPMs,
+ Windows self-extracting installers, building on platforms with
+ special requirements etc, please consult the <A
+HREF="../developer-manual/newrelease.html"
 TARGET="_top"
->http://www.gnu.org</A
->.
- The rest should be the same as above for Linux/Unix.</P
-></DIV
+>developer manual</A
+>.</P
 ></DIV
 ></DIV
 ><DIV