README

   1 /*********************************************************************
   2  *
   3  * File        :  $Source: /cvsroot/ijbswa/current/README,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://ijbswa.sourceforge.net
   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,
  35 which will eventually become Privoxy v3.0 (and soon we hope!). See
  36 http://ijbswa.sourceforge.net.
  37
  38 Privoxy is a web proxy with advanced filtering capabilities for
  39 protecting privacy, filtering web page content, managing cookies,
  40 controlling access, and removing ads, banners, pop-ups and other
  41 obnoxious Internet junk. Privoxy has a very flexible configuration and
  42 can be customized to suit individual needs and tastes. Internet
  43 Privoxy has application for both stand-alone systems and multi-user
  44 networks.
  45
  46 Privoxy is based on the code of the Internet Junkbuster. Junkbuster
  47 was originally written by JunkBusters Corporation, and was released as
  48 free open-source software under the GNU GPL. Stefan Waldherr made many
  49 improvements, and started the SourceForge project to continue
  50 development. Several other developers are now contributing.
  51
  52
  53  IMPORTANT CHANGE
  54 -----------------
  55
  56 IMPORTANT! READ! Configuration Change as of 03/04/02: The default
  57 listening port is now 8118 due to conflicts with port 8000 assignment.
  58 You will need to change your browser if upgrading!!! And maybe
  59 firewall, etc.
  60
  61
  62  INSTALL
  63 --------
  64
  65 For tarball, first unpack:
  66
  67  tar xzvf ijb-2.9.11-beta-src.tar.gz
  68  cd ijb-2.9.11-beta
  69
  70  autoheader   [suggested for CVS source]
  71  autoconf     [suggested for CVS source]
  72  ./configure    (--help to see options)
  73  gmake          (the make from gnu)
  74  su
  75  make -n install        (to see where all the files will go)
  76  make install           (to really install)
  77
  78 Redhat and SuSE src and binary RPMs can be built with 'make
  79 redhat-dist' or 'make suse-dist' (run ./configure first) from unpacked
  80 sources. BSD will (probably?) require gmake (from http://gnu.org). See
  81 the user-manual for OS/2 build instructions.
  82
  83 Privoxy is also available via anonymous CVS:
  84
  85  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
  86  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
  87
  88 This will create a directory named 'current'. Then, 'cd current', and
  89 then build as above.
  90
  91
  92  RUN
  93 ----
  94
  95 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE]
  96  [--user USER] [config_file]
  97
  98 Or for RedHat: /etc/rc.d/init.d/privoxy start
  99 Or for SuSE:   /etc/rc.d/privoxy start
 100
 101 See the man page or user-manual for a brief explanation of each.
 102
 103
 104  CONFIGURATION
 105 --------------
 106
 107 See: 'config', 'ijb.action', and 're_filterfile'. These are all well
 108 commented. On Unix-like systems, these files are installed in
 109 /etc/privoxy.  On Windows, then wherever the executable itself is
 110 installed. There are many significant changes and advances since
 111 v2.0.x. The user-manual has a run down of configuration options, and
 112 examples: http://ijbswa.sourceforge.net/user-manual/.
 113
 114 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or
 115 whatever you specify in the config file under 'listen-address'.
 116 DEFAULT is localhost:8118.
 117
 118 The ijb.action file can be configured via the web interface accessed
 119 via http://i.j.b/, as well other options.
 120
 121
 122  DOCUMENTATION
 123 --------------
 124
 125 There is a growing amount of documentation in the 'doc' subdirectory,
 126 but it is not finished at this point. In particular, see the
 127 user-manual there, and developers should look at developer-manual.
 128
 129 The best source of information on the current development version, may
 130 still be either comments in the source code, or the included
 131 configuration files, which are all well commented. These are 'config',
 132 'ijb.action', and 're_filterfile' in the toplevel source directory.
 133
 134 Some legacy documentation may also be included only to give an idea of
 135 what Privoxy can do under doc/obsolete/*. Much has changed since
 136 these docs were written, so beware.
 137
 138 Included documentation may vary according to platform and packager.
 139
 140
 141  CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 142 -----
 143
 144 We value your feedback. However, to provide you with the best support,
 145 please note:
 146
 147  * Use the support forum to get help:
 148    http://sourceforge.net/tracker/?group_id=11118&atid=211118
 149  * Submit bugs only thru our bug forum:
 150    http://sourceforge.net/tracker/?group_id=11118&atid=111118
 151    Make sure that the bug has not already been submitted. Please try
 152    to verify that it is a Privoxy bug, and not a browser or site
 153    bug first. If you are using your own custom configuration, please
 154    try the stock configs to see if the problem is a configuration
 155    related bug. And if not using the latest development snapshot,
 156    please try the latest one. Or even better, CVS sources.
 157  * Submit feature requests only thru our feature request forum:
 158    http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse
 159
 160 For any other issues, feel free to use the mailing lists:
 161 http://sourceforge.net/mail/?group_id=11118
 162
 163 Anyone interested in actively participating in development and related
 164 discussions can join the appropriate mailing list here:
 165 http://sourceforge.net/mail/?group_id=11118. Archives are available
 166 here too.
 167
 168 -------------------------------------------------------------------------
 169 ijbswa-developers@lists.sourceforge.net
 170
 171 $Id: README,v 1.16 2002/03/09 14:52:43 swa Exp $