Synthetic commit for tag v_3_0_1
[privoxy.git] / doc / webserver / user-manual / installation.html
index 0acb075..b46f244 100644 (file)
@@ -7,7 +7,7 @@ NAME="GENERATOR"
 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
 "><LINK
 REL="HOME"
-TITLE="Privoxy 3.0.1 User Manual"
+TITLE="Privoxy 3.0.0 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="Introduction"
@@ -37,7 +37,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy 3.0.1 User Manual</TH
+>Privoxy 3.0.0 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -73,9 +73,7 @@ CLASS="SECT1"
 ><H1
 CLASS="SECT1"
 ><A
-NAME="INSTALLATION"
-></A
->2. Installation</H1
+NAME="INSTALLATION">2. Installation</H1
 ><P
 > <SPAN
 CLASS="APPLICATION"
@@ -117,9 +115,7 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="INSTALLATION-PACKAGES"
-></A
->2.1. Binary Packages</H2
+NAME="INSTALLATION-PACKAGES">2.1. Binary Packages</H2
 ><P
 >How to install the binary packages depends on your operating system:</P
 ><DIV
@@ -127,13 +123,11 @@ CLASS="SECT3"
 ><H3
 CLASS="SECT3"
 ><A
-NAME="INSTALLATION-PACK-RPM"
-></A
->2.1.1. Red Hat, SuSE and Conectiva RPMs</H3
+NAME="INSTALLATION-PACK-RPM">2.1.1. Red Hat, SuSE and Conectiva RPMs</H3
 ><P
 > RPMs can be installed with <TT
 CLASS="LITERAL"
->rpm -Uvh privoxy-3.0.1-1.rpm</TT
+>rpm -Uvh privoxy-3.0.0-1.rpm</TT
 >,
  and will use <TT
 CLASS="FILENAME"
@@ -165,7 +159,7 @@ automatically start Privoxy in the boot process.</P
 > If you have problems with failed dependencies, try rebuilding the SRC RPM: 
  <TT
 CLASS="LITERAL"
->rpm --rebuild privoxy-3.0.1-1.src.rpm</TT
+>rpm --rebuild privoxy-3.0.0-1.src.rpm</TT
 >. This 
  will use your locally installed libraries and RPM version. </P
 ><P
@@ -188,14 +182,12 @@ CLASS="SECT3"
 ><H3
 CLASS="SECT3"
 ><A
-NAME="INSTALLATION-DEB"
-></A
->2.1.2. Debian</H3
+NAME="INSTALLATION-DEB">2.1.2. Debian</H3
 ><P
 > DEBs can be installed with <TT
 CLASS="LITERAL"
 >dpkg -i
- privoxy_3.0.1-1.deb</TT
+ privoxy_3.0.0-1.deb</TT
 >, and will use
  <TT
 CLASS="FILENAME"
@@ -208,9 +200,7 @@ CLASS="SECT3"
 ><H3
 CLASS="SECT3"
 ><A
-NAME="INSTALLATION-PACK-WIN"
-></A
->2.1.3. Windows</H3
+NAME="INSTALLATION-PACK-WIN">2.1.3. Windows</H3
 ><P
 > Just double-click the installer, which will guide you through
  the installation process. You will find the configuration files
@@ -222,9 +212,7 @@ CLASS="SECT3"
 ><H3
 CLASS="SECT3"
 ><A
-NAME="INSTALLATION-PACK-BINTGZ"
-></A
->2.1.4. Solaris, NetBSD, FreeBSD, HP-UX</H3
+NAME="INSTALLATION-PACK-BINTGZ">2.1.4. Solaris, NetBSD, FreeBSD, HP-UX</H3
 ><P
 > Create a new directory, <TT
 CLASS="LITERAL"
@@ -238,9 +226,7 @@ CLASS="SECT3"
 ><H3
 CLASS="SECT3"
 ><A
-NAME="INSTALLATION-OS2"
-></A
->2.1.5. OS/2</H3
+NAME="INSTALLATION-OS2">2.1.5. OS/2</H3
 ><P
 > First, make sure that no previous installations of
  <SPAN
@@ -280,9 +266,7 @@ CLASS="SECT3"
 ><H3
 CLASS="SECT3"
 ><A
-NAME="INSTALLATION-MAC"
-></A
->2.1.6. Mac OSX</H3
+NAME="INSTALLATION-MAC">2.1.6. Mac OSX</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).
@@ -340,9 +324,7 @@ CLASS="SECT3"
 ><H3
 CLASS="SECT3"
 ><A
-NAME="INSTALLATION-AMIGA"
-></A
->2.1.7. AmigaOS</H3
+NAME="INSTALLATION-AMIGA">2.1.7. AmigaOS</H3
 ><P
 > Copy and then unpack the <TT
 CLASS="FILENAME"
@@ -360,9 +342,7 @@ CLASS="SECT3"
 ><H3
 CLASS="SECT3"
 ><A
-NAME="INSTALLATTION-GENTOO"
-></A
->2.1.8. Gentoo</H3
+NAME="INSTALLATTION-GENTOO">2.1.8. Gentoo</H3
 ><P
 > Gentoo source packages (Ebuilds) for <SPAN
 CLASS="APPLICATION"
@@ -395,7 +375,7 @@ CLASS="FILENAME"
 >, the 
  documentation is in <TT
 CLASS="FILENAME"
->/usr/share/doc/privoxy-3.0.1</TT
+>/usr/share/doc/privoxy-3.0.0</TT
 >
  and the Log directory is in <TT
 CLASS="FILENAME"
@@ -408,9 +388,7 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="INSTALLATION-SOURCE"
-></A
->2.2. Building from Source</H2
+NAME="INSTALLATION-SOURCE">2.2. Building from Source</H2
 ><P
 > The most convenient way to obtain the <SPAN
 CLASS="APPLICATION"
@@ -473,8 +451,8 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
-> tar xzvf privoxy-3.0.1-src* [.tgz or .tar.gz]
- cd privoxy-3.0.1</PRE
+> tar xzvf privoxy-3.0.0-src* [.tgz or .tar.gz]
+ cd privoxy-3.0.0</PRE
 ></TD
 ></TR
 ></TABLE
@@ -506,35 +484,7 @@ CLASS="FILENAME"
 >, which will 
  contain the source tree.</P
 ><P
-> You can also check out any <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->
- <SPAN
-CLASS="QUOTE"
->"branch"</SPAN
->, just exchange the <SPAN
-CLASS="APPLICATION"
->current</SPAN
->
- name with the wanted branch name (Example: v_3_0_branch for the 3.0 cvs
- tree).</P
-><P
-> It is also strongly recommended to not run <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->
- as root, and instead it is suggested to create 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
-><P
-> <TT
-CLASS="FILENAME"
->/etc/passwd</TT
-> might then look like:</P
+> Then, in either case, to build from unpacked tarball or CVS source:</P
 ><P
 > <TABLE
 BORDER="0"
@@ -544,59 +494,50 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
->  privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell</PRE
+> 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
+><DIV
+CLASS="WARNING"
 ><P
-> And then <TT
-CLASS="FILENAME"
->/etc/group</TT
->, like:</P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
+></P
+><TABLE
+CLASS="WARNING"
+BORDER="1"
 WIDTH="100%"
 ><TR
 ><TD
-><PRE
-CLASS="SCREEN"
->  privoxy:*:7777:</PRE
+ALIGN="CENTER"
+><B
+>Warning</B
 ></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
-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 -s install  # (to really install, -s to silence output)</PRE
+ALIGN="LEFT"
+><P
+> 
+  The <SPAN
+CLASS="QUOTE"
+>"make install"</SPAN
+> target is temporary quite broken! It is
+  recommended to use a binary package, or do a source build, and manually 
+  install the components. Sorry.
+ </P
 ></TD
 ></TR
 ></TABLE
-></P
+></DIV
 ><P
->  If you have GNU <B
-CLASS="COMMAND"
->make</B
->, you can have the first four steps
+>  If you have gnu make, you can have the first four steps 
   automatically done for you by just typing:</P
 ><P
 > <TABLE
@@ -615,206 +556,6 @@ CLASS="SCREEN"
 ><P
 >  in the freshly downloaded or unpacked source directory.</P
 ><P
-> <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->WARNING:</I
-></SPAN
-> If installing as root, the install will fail
- unless another user is specified. <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
->. Or if there is already a privoxy user on the system, and no
- user was specified during configure, <B
-CLASS="COMMAND"
->make install</B
-> then
- will use the privoxy user. When starting <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->,
- it should be run as this same user that owns the 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
-><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
-><P
-> If no <TT
-CLASS="LITERAL"
->group</TT
-> is specified, the install will assume a group
- exists with the same name as the specified <TT
-CLASS="LITERAL"
->user</TT
->.</P
-><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 
- a root install to anywhere else 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
->).</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 docs 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 may want 
- to 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 any configuration files, 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
- 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,
  Windows self-extracting installers, building on platforms with
  special requirements etc, please consult the <A
@@ -828,9 +569,7 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="INSTALLATION-KEEPUPDATED"
-></A
->2.3. Keeping your Installation Up-to-Date</H2
+NAME="INSTALLATION-KEEPUPDATED">2.3. Keeping your Installation Up-to-Date</H2
 ><P
 > As user feedback comes in and development continues, we will make updated versions
  of both the main <A