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-2009 the
   8  *                Privoxy team. https://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/licenses/old-licenses/gpl-2.0.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.25-beta-src.tar.gz
  44  cd privoxy-3.0.25-beta
  45
  46 For retrieving the current CVS sources, you'll need a CVS client installed.
  47 Note that sources from CVS are typically development quality, and may not be
  48 stable, or well tested. To download CVS source, check the Sourceforge
  49 documentation, which might give commands like:
  50
  51   cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
  52   cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current
  53   cd current
  54
  55 This will create a directory named current/, which will contain the source
  56 tree.
  57
  58 You can also check out any Privoxy "branch", just exchange the current name
  59 with the wanted branch name (Example: v_3_0_branch for the 3.0 cvs tree).
  60
  61 It is also strongly recommended to not run Privoxy as root. You should
  62 configure/install/run Privoxy as an unprivileged user, preferably by creating a
  63 "privoxy" user and group just for this purpose. See your local documentation
  64 for the correct command line to do add new users and groups (something like
  65 adduser, but the command syntax may vary from platform to platform).
  66
  67 /etc/passwd might then look like:
  68
  69   privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell
  70
  71 And then /etc/group, like:
  72
  73   privoxy:*:7777:
  74
  75 Some binary packages may do this for you.
  76
  77 Then, to build from either unpacked tarball or CVS source:
  78
  79  autoheader
  80  autoconf
  81  ./configure      # (--help to see options)
  82  make             # (the make from GNU, sometimes called gmake)
  83  su               # Possibly required
  84  make -n install  # (to see where all the files will go)
  85  make -s install  # (to really install, -s to silence output)
  86
  87 Using GNU make, you can have the first four steps automatically done for you by
  88 just typing:
  89
  90   make
  91
  92 in the freshly downloaded or unpacked source directory.
  93
  94 To build an executable with security enhanced features so that users cannot
  95 easily bypass the proxy (e.g. "Go There Anyway"), or alter their own
  96 configurations, configure like this:
  97
  98  ./configure  --disable-toggle  --disable-editor  --disable-force
  99
 100 Note that all of these options can also be disabled through the configuration
 101 file.
 102
 103 WARNING: If installing as root, the install will fail unless a non-root user or
 104 group is specified, or a privoxy user and group already exist on the system. If
 105 a non-root user is specified, and no group, then the installation will try to
 106 also use a group of the same name as "user". If a group is specified (and no
 107 user), then the support files will be installed as writable by that group, and
 108 owned by the user running the installation.
 109
 110 configure accepts --with-user and --with-group options for setting user and
 111 group ownership of the configuration files (which need to be writable by the
 112 daemon). The specified user must already exist. When starting Privoxy, it must
 113 be run as this same user to insure write access to configuration and log files!
 114
 115 Alternately, you can specify user and group on the make command line, but be
 116 sure both already exist:
 117
 118  make -s install  USER=privoxy GROUP=privoxy
 119
 120 The default installation path for make install is /usr/local. This may of
 121 course be customized with the various ./configure path options. If you are
 122 doing an install to anywhere besides /usr/local, be sure to set the appropriate
 123 paths with the correct configure options (./configure --help). Non-privileged
 124 users must of course have write access permissions to wherever the target
 125 installation is going.
 126
 127 If you do install to /usr/local, the install will use sysconfdir=$prefix/etc/
 128 privoxy by default. All other destinations, and the direct usage of
 129 --sysconfdir flag behave like normal, i.e. will not add the extra privoxy
 130 directory. This is for a safer install, as there may already exist another
 131 program that uses a file with the "config" name, and thus makes /usr/local/etc
 132 cleaner.
 133
 134 If installing to /usr/local, the documentation will go by default to $prefix/
 135 share/doc. But if this directory doesn't exist, it will then try $prefix/doc
 136 and install there before creating a new $prefix/share/doc just for Privoxy.
 137
 138 Again, if the installs goes to /usr/local, the localstatedir (ie: var/) will
 139 default to /var instead of $prefix/var so the logs will go to /var/log/privoxy
 140 /, and the pid file will be created in /var/run/privoxy.pid.
 141
 142 make install will attempt to set the correct values in config (main
 143 configuration file). You should check this to make sure all values are correct.
 144 If appropriate, an init script will be installed, but it is up to the user to
 145 determine how and where to start Privoxy. The init script should be checked for
 146 correct paths and values, if anything other than a default install is done.
 147
 148 If install finds previous versions of local configuration files, most of these
 149 will not be overwritten, and the new ones will be installed with a "new"
 150 extension. default.action and default.filter will be overwritten. You will then
 151 need to manually update the other installed configuration files as needed. The
 152 default template files will be overwritten. If you have customized, local
 153 templates, these should be stored safely in a separate directory and defined in
 154 config by the "templdir" directive. It is of course wise to always back-up any
 155 important configuration files "just in case". If a previous version of Privoxy
 156 is already running, you will have to restart it manually.
 157
 158 For more detailed instructions on how to build Redhat RPMs, Windows
 159 self-extracting installers, building on platforms with special requirements
 160 etc, please consult the developer manual.
 161
 162 The simplest command line to start Privoxy is $path/privoxy --user=privoxy
 163 $path/etc/privoxy/config. See privoxy --usage, or the man page, for other
 164 options, and configuration.
 165