README

   1 /*********************************************************************
   2  *
   3  * File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
   4  *
   5  * Purpose     :  README file to give a short intro.
   6  *
   7  * Copyright   :  Written by and Copyright (C) 2001 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., 59
  30  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  31  *
  32  *********************************************************************/
  33
  34 This README is included with the development version of Privoxy 2.9.14, which
  35 will eventually become Privoxy v3.0 (and soon we hope!). See http://
  36 www.privoxy.org/ for more information. The current code level is beta, and
  37 seems stable to us :).
  38
  39 Privoxy is a web proxy with advanced filtering capabilities for protecting
  40 privacy, filtering web page content, managing cookies, controlling access, and
  41 removing ads, banners, pop-ups and other obnoxious Internet junk. Privoxy has a
  42 very flexible configuration and can be customized to suit individual needs and
  43 tastes. Privoxy has application for both stand-alone systems and multi-user
  44 networks.
  45
  46 Privoxy is based on Internet Junkbuster (tm).
  47
  48
  49  IMPORTANT CHANGES
  50 ------------------
  51
  52 NEWS! As of 03/24/02, the name of this project has been changed from ijbswa/
  53 Junkbuster to Privoxy. This is reflected in many of the included files.
  54
  55 WARNING! If upgrading from earlier versions of this project via RPM packages,
  56 the new package will delete any previously installed 'Junkbuster' packages.
  57
  58 IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
  59 port is now 8118 due to conflicts with port 8000 assignment. You will need to
  60 change your browser if upgrading!!! And maybe firewall, etc.
  61
  62
  63  INSTALL
  64 --------
  65
  66 To build Privoxy from source, autoheader, autoconf, GNU make (gmake), and, of
  67 course, a C compiler are required.
  68
  69 When building from a source tarball (either release version or nightly CVS
  70 tarball), first unpack the source:
  71
  72  tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz]
  73  cd privoxy-2.9.14-beta
  74
  75 For retrieving the current CVS sources, you'll need CVS installed. Note that
  76 sources from CVS are development quality, and may not be stable, or well
  77 tested. To download CVS source:
  78
  79   cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
  80   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
  81   cd current
  82
  83 This will create a directory named current/, which will contain the source
  84 tree.
  85
  86 Then, in either case, to build from unpacked tarball or CVS source:
  87
  88  autoheader
  89  autoconf
  90  ./configure      # (--help to see options)
  91  make             # (the make from gnu, gmake for *BSD)
  92  su
  93  make -n install  # (to see where all the files will go)
  94  make install     # (to really install)
  95
  96 If you have gnu make, you can have the first four steps automatically done for
  97 you by just typing:
  98
  99   make
 100
 101 in the freshly downloaded or unpacked source directory.
 102
 103 For more detailed instructions on how to build Redhat and SuSE RPMs, Windows
 104 self-extracting installers, building on platforms with special requirements
 105 etc, please consult the developer manual.
 106
 107 For binary RPM installation, and other platforms, see the user-manual as well.
 108
 109
 110  RUN
 111 ----
 112
 113 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
 114 [.GROUP]] [config_file]
 115
 116 See the man page or user-manual for a brief explanation of each option.
 117
 118 If no config_file is specified on the command line, Privoxy will look for a
 119 file named 'config' in the current directory (except Win32 which will look for
 120 'config.txt'). If no config_file is found, Privoxy will fail to start.
 121
 122 Or for Red Hat: /etc/rc.d/init.d/privoxy start
 123
 124 Or for SuSE: /etc/rc.d/privoxy start
 125
 126
 127  CONFIGURATION
 128 --------------
 129
 130 See: 'config', 'default.action', 'user.action', and 'default.filter'.
 131 'user.action' is for personal configuration. These are all well commented. Most
 132 of the magic is in '*.action' files. 'user.action' should be used for any
 133 actions customizations. On Unix-like systems, these files are installed in /etc
 134 /privoxy. On Windows, then wherever the executable itself is installed. There
 135 are many significant changes and advances since Junkbuster v2.0.x. The
 136 user-manual has a run down of configuration options, and examples: http://
 137 www.privoxy.org/user-manual/.
 138
 139 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
 140 you specify in the config file under 'listen-address'. DEFAULT is localhost:
 141 8118.
 142
 143 The actions list can be configured via the web interface accessed via http://
 144 p.p/, as well other options.
 145
 146 All configuration files are subject to unannounced changes during the
 147 development process.
 148
 149
 150  DOCUMENTATION
 151 --------------
 152
 153 There should be documentation in the 'doc' subdirectory, but it is not
 154 completed at this point. In particular, see the user-manual there, the faq, and
 155 those interested in Privoxy development, should look at developer-manual.
 156
 157 The most up to date source of information on the current development version,
 158 may still be either comments in the source code, or the included configuration
 159 files. The source and configuration files are all well commented. The main
 160 configuration files are: 'config', 'default.action', and 'default.filter' in
 161 the toplevel source directory.
 162
 163 Included documentation may vary according to platform and packager.
 164
 165
 166  CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 167 --------------------------------------------------------------
 168
 169  -------------------------------------------------------------------------
 170  ijbswa-developers@lists.sourceforge.net
 171
 172 $Id: readme.sgml,v 1.12 2002/04/26 17:45:36 swa Exp $
 173