INSTALL

   1 Polipo installation instructions -*-text-*-
   2 ********************************
   3
   4 1. Building and running polipo
   5 ******************************
   6
   7   $ make all
   8   $ su -c 'make install'
   9   $ man polipo
  10   $ polipo &
  11
  12 If you want Polipo to put itself into the background, you may replace
  13 the last line with:
  14
  15   $ polipo daemonise=true logFile="/var/log/polipo.log"
  16
  17 On SVR4 systems (Solaris, HP/UX), you will need to use one of the
  18 following (whichever works):
  19
  20   $ make PLATFORM_DEFINES=-DSVR4 all
  21   $ make PLATFORM_DEFINES=-DSVR4 LDLIBS='-lsocket -lnsl -lresolv' all
  22
  23 You can also use Polipo without installing:
  24
  25   $ make
  26   $ nroff -man polipo.man | more
  27   $ ./polipo &
  28
  29 For information about building on Windows, please see the file README.Windows.
  30
  31 2. Configuring your user-agent
  32 ******************************
  33
  34 Once polipo is running, configure your user-agent (web browser) to use
  35 the proxy on `http://localhost:8123/'.  Depending on the user-agent,
  36 this is done either by setting the environment variable http_proxy,
  37 e.g.
  38
  39   $ http_proxy=http://localhost:8123; export http_proxy
  40
  41 or by using the browser's ``preferences'' menu.
  42
  43 3. Configuring polipo
  44 *********************
  45
  46 If you want to use an on-disk cache, you will need to create its root
  47 directory:
  48
  49   $ mkdir /var/cache/polipo/
  50
  51 You should then arrange for cron to run the following on a regular
  52 basis:
  53
  54   killall -USR1 polipo
  55   sleep 1
  56   polipo -x
  57   killall -USR2 polipo
  58
  59 If you want to use a configuration file, you should put it in one of
  60 the locations `/etc/polipo/config' or `~/.polipo'; you can also use
  61 the `-c' flag to put it in a non-standard location.  See the file
  62 `config.sample' for an example.
  63
  64 You might also want to create a forbidden URLs file, which you should
  65 put either in one of `/etc/polipo/forbidden' or `~/.polipo-forbidden';
  66 you can set the variable `forbiddenFile' in your config file if you
  67 want to put it in a non-standard location.  See `forbidden.sample' for
  68 an example.
  69
  70
  71                                         Juliusz Chroboczek
  72                                         <jch@pps.jussieu.fr>