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