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