INSTALL

   1 /*********************************************************************
   2  *
   3  * File        :  $Source: /cvsroot/ijbswa/current/doc/source/install.sgml,v $
   4  *
   5  * Purpose     :  INSTALL file to help with installing from source.
   6  *
   7  * Copyright   :  Written by and Copyright (C) 2001-2008 the SourceForge
   8  *                Privoxy team. http://www.privoxy.org/
   9  *
  10  *                Based on the Internet Junkbuster originally written
  11  *                by and Copyright (C) 1997 Anonymous Coders and
  12  *                Junkbusters Corporation.  http://www.junkbusters.com
  13  *
  14  *                This program is free software; you can redistribute it
  15  *                and/or modify it under the terms of the GNU General
  16  *                Public License as published by the Free Software
  17  *                Foundation; either version 2 of the License, or (at
  18  *                your option) any later version.
  19  *
  20  *                This program is distributed in the hope that it will
  21  *                be useful, but WITHOUT ANY WARRANTY; without even the
  22  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  23  *                PARTICULAR PURPOSE.  See the GNU General Public
  24  *                License for more details.
  25  *
  26  *                The GNU General Public License should be included with
  27  *                this file.  If not, you can view it at
  28  *                http://www.gnu.org/copyleft/gpl.html
  29  *                or write to the Free Software Foundation, Inc.,
  30  *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  31  *                USA
  32  *
  33  *********************************************************************/
  34
  35
  36 -------------------------------------------------------------------------------
  37
  38 To build Privoxy from source, autoconf, GNU make (gmake), and, of course, a C
  39 compiler like gcc are required.
  40
  41 When building from a source tarball, first unpack the source:
  42
  43  tar xzvf privoxy-3.0.9-beta-src* [.tgz or .tar.gz]
  44  cd privoxy-3.0.9-beta
  45
  46
  47 For retrieving the current CVS sources, you'll need a CVS client installed.
  48 Note that sources from CVS are typically development quality, and may not be
  49 stable, or well tested. To download CVS source, check the Sourceforge
  50 documentation, which might give commands like:
  51
  52   cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
  53   cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current
  54   cd current
  55
  56
  57 This will create a directory named current/, which will contain the source
  58 tree.
  59
  60 You can also check out any Privoxy "branch", just exchange the current name
  61 with the wanted branch name (Example: v_3_0_branch for the 3.0 cvs tree).
  62
  63 It is also strongly recommended to not run Privoxy as root. You should
  64 configure/install/run Privoxy as an unprivileged user, preferably by creating a
  65 "privoxy" user and group just for this purpose. See your local documentation
  66 for the correct command line to do add new users and groups (something like
  67 adduser, but the command syntax may vary from platform to platform).
  68
  69 /etc/passwd might then look like:
  70
  71   privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell
  72
  73
  74 And then /etc/group, like:
  75
  76   privoxy:*:7777:
  77
  78
  79 Some binary packages may do this for you.
  80
  81 Then, to build from either unpacked tarball or CVS source:
  82
  83  autoheader
  84  autoconf
  85  ./configure      # (--help to see options)
  86  make             # (the make from GNU, sometimes called gmake)
  87  su               # Possibly required
  88  make -n install  # (to see where all the files will go)
  89  make -s install  # (to really install, -s to silence output)
  90
  91
  92 Using GNU make, you can have the first four steps automatically done for you by
  93 just typing:
  94
  95   make
  96
  97
  98 in the freshly downloaded or unpacked source directory.
  99
 100 To build an executable with security enhanced features so that users cannot
 101 easily bypass the proxy (e.g. "Go There Anyway"), or alter their own
 102 configurations, configure like this:
 103
 104  ./configure  --disable-toggle  --disable-editor  --disable-force
 105
 106
 107 Then build as above. In Privoxy 3.0.7 and later, all of these options can also
 108 be disabled through the configuration file.
 109
 110 WARNING: If installing as root, the install will fail unless a non-root user or
 111 group is specified, or a privoxy user and group already exist on the system. If
 112 a non-root user is specified, and no group, then the installation will try to
 113 also use a group of the same name as "user". If a group is specified (and no
 114 user), then the support files will be installed as writable by that group, and
 115 owned by the user running the installation.
 116
 117 configure accepts --with-user and --with-group options for setting user and
 118 group ownership of the configuration files (which need to be writable by the
 119 daemon). The specified user must already exist. When starting Privoxy, it must
 120 be run as this same user to insure write access to configuration and log files!
 121
 122 Alternately, you can specify user and group on the make command line, but be
 123 sure both already exist:
 124
 125  make -s install  USER=privoxy GROUP=privoxy
 126
 127
 128 The default installation path for make install is /usr/local. This may of
 129 course be customized with the various ./configure path options. If you are
 130 doing an install to anywhere besides /usr/local, be sure to set the appropriate
 131 paths with the correct configure options (./configure --help). Non-privileged
 132 users must of course have write access permissions to wherever the target
 133 installation is going.
 134
 135 If you do install to /usr/local, the install will use sysconfdir=$prefix/etc/
 136 privoxy by default. All other destinations, and the direct usage of
 137 --sysconfdir flag behave like normal, i.e. will not add the extra privoxy
 138 directory. This is for a safer install, as there may already exist another
 139 program that uses a file with the "config" name, and thus makes /usr/local/etc
 140 cleaner.
 141
 142 If installing to /usr/local, the documentation will go by default to $prefix/
 143 share/doc. But if this directory doesn't exist, it will then try $prefix/doc
 144 and install there before creating a new $prefix/share/doc just for Privoxy.
 145
 146 Again, if the installs goes to /usr/local, the localstatedir (ie: var/) will
 147 default to /var instead of $prefix/var so the logs will go to /var/log/privoxy
 148 /, and the pid file will be created in /var/run/privoxy.pid.
 149
 150 make install will attempt to set the correct values in config (main
 151 configuration file). You should check this to make sure all values are correct.
 152 If appropriate, an init script will be installed, but it is up to the user to
 153 determine how and where to start Privoxy. The init script should be checked for
 154 correct paths and values, if anything other than a default install is done.
 155
 156 If install finds previous versions of local configuration files, most of these
 157 will not be overwritten, and the new ones will be installed with a "new"
 158 extension. default.action, default.filter, and standard.action will be
 159 overwritten. You will then need to manually update the other installed
 160 configuration files as needed. The default template files will be overwritten.
 161 If you have customized, local templates, these should be stored safely in a
 162 separate directory and defined in config by the "templdir" directive. It is of
 163 course wise to always back-up any important configuration files "just in case".
 164 If a previous version of Privoxy is already running, you will have to restart
 165 it manually.
 166
 167 For more detailed instructions on how to build Redhat RPMs, Windows
 168 self-extracting installers, building on platforms with special requirements
 169 etc, please consult the developer manual.
 170
 171 The simplest command line to start Privoxy is $path/privoxy --user=privoxy
 172 $path/etc/privoxy/config. See privoxy --usage, or the man page, for other
 173 options, and configuration.
 174