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 CHANGES
  54 ------------------
  55
  56 NEWS! As of 03/24/02, the name of this project has been changed
  57 from Junkbuster to Privoxy. This is reflected in many of the
  58 included files.
  59
  60 WARNING! If upgrading from earlier versions of this project via
  61 RPM packages, the new package will delete any previously installed
  62 'Junkbuster' packages.
  63
  64 IMPORTANT! READ! Configuration Change as of 03/04/02: The default
  65 listening port is now 8118 due to conflicts with port 8000 assignment.
  66 You will need to change your browser if upgrading!!! And maybe
  67 firewall, etc.
  68
  69
  70  INSTALL
  71 --------
  72
  73 For tarball, first unpack:
  74
  75  tar xzvf privoxy-2.9.13-beta-src.tar.gz
  76  cd privoxy-2.9.13-beta
  77
  78  autoheader
  79  autoconf
  80  ./configure    (--help to see options)
  81  gmake          (the make from gnu)
  82  su
  83  make -n install        (to see where all the files will go)
  84  make install           (to really install)
  85
  86 Redhat and SuSE src and binary RPMs can be built with 'make
  87 redhat-dist' or 'make suse-dist' (run ./configure first) from unpacked
  88 sources. BSD will (probably?) require gmake (from http://gnu.org). See
  89 the user-manual for OS/2 build instructions.
  90
  91 Privoxy is also available via anonymous CVS:
  92
  93  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
  94  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
  95
  96 This will create a directory named 'current'. Then, 'cd current', and
  97 then build as above.
  98
  99
 100  RUN
 101 ----
 102
 103 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE]
 104  [--user USER] [config_file]
 105
 106 Or for RedHat: /etc/rc.d/init.d/privoxy start
 107 Or for SuSE:   /etc/rc.d/privoxy start
 108
 109 See the man page or user-manual for a brief explanation of each.
 110
 111
 112  CONFIGURATION
 113 --------------
 114
 115 See: 'config', '*.action', and 'default.filter'. These are all well
 116 commented. Most of the magic is in '*.action', and there are several
 117 of these included with varying degrees of aggressiveness. On Unix-like
 118 systems, these files are installed in /etc/privoxy.  On Windows, then wherever
 119 the executable itself is installed. There are many significant changes and
 120 advances since Junkbuster v2.0.x. The user-manual has a run down of
 121 configuration options, and examples: http://ijbswa.sourceforge.net/user-manual/.
 122
 123 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or
 124 whatever you specify in the config file under 'listen-address'.
 125 DEFAULT is localhost:8118.
 126
 127 The default.action file can be configured via the web interface accessed
 128 via http://p.p/, as well other options.
 129
 130
 131  DOCUMENTATION
 132 --------------
 133
 134 There is a growing amount of documentation in the 'doc' subdirectory,
 135 but it is not finished at this point. In particular, see the
 136 user-manual there, and developers should look at developer-manual.
 137
 138 The most up to date source of information on the current development version,
 139 may still be either comments in the source code, or the included configuration
 140 files, which are all well commented. These are 'config', '*.action', and
 141 'default.filter' in the toplevel source directory.
 142
 143 Some legacy Junkbuster documentation may also be included only to give an idea
 144 of what Privoxy can do under doc/obsolete/*. Much has changed since these docs
 145 were written, so beware.
 146
 147 Included documentation may vary according to platform and packager.
 148
 149
 150  CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 151 --------------------------------------------------------------
 152
 153 We value your feedback. However, to provide you with the best support,
 154 please note:
 155
 156  * Use the support forum to get help:
 157    http://sourceforge.net/tracker/?group_id=11118&atid=211118
 158  * Submit bugs only thru our bug forum:
 159    http://sourceforge.net/tracker/?group_id=11118&atid=111118
 160    Make sure that the bug has not already been submitted. Please try
 161    to verify that it is a Privoxy bug, and not a browser or site
 162    bug first. If you are using your own custom configuration, please
 163    try the stock configs to see if the problem is a configuration
 164    related bug. And if not using the latest development snapshot,
 165    please try the latest one. Or even better, CVS sources.
 166  * Submit feature requests only thru our feature request forum:
 167    http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse
 168
 169 For any other issues, feel free to use the mailing lists:
 170 http://sourceforge.net/mail/?group_id=11118
 171
 172 Anyone interested in actively participating in development and related
 173 discussions can join the appropriate mailing list here:
 174 http://sourceforge.net/mail/?group_id=11118. Archives are available
 175 here too.
 176
 177 -------------------------------------------------------------------------
 178 ijbswa-developers@lists.sourceforge.net
 179
 180 $Id: README,v 1.19 2002/03/24 16:15:18 swa Exp $