3 /*********************************************************************
5 * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
7 * Purpose : README file to give a short intro.
9 * Copyright : Written by and Copyright (C) 2001 the SourceForge
10 * Privoxy team. http://www.privoxy.org/
12 * Based on the Internet Junkbuster originally written
13 * by and Copyright (C) 1997 Anonymous Coders and
14 * Junkbusters Corporation. http://www.junkbusters.com
16 * This program is free software; you can redistribute it
17 * and/or modify it under the terms of the GNU General
18 * Public License as published by the Free Software
19 * Foundation; either version 2 of the License, or (at
20 * your option) any later version.
22 * This program is distributed in the hope that it will
23 * be useful, but WITHOUT ANY WARRANTY; without even the
24 * implied warranty of MERCHANTABILITY or FITNESS FOR A
25 * PARTICULAR PURPOSE. See the GNU General Public
26 * License for more details.
28 * The GNU General Public License should be included with
29 * this file. If not, you can view it at
30 * http://www.gnu.org/copyleft/gpl.html
31 * or write to the Free Software Foundation, Inc., 59
32 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
34 *********************************************************************/
37 This README is included with the development version of Privoxy 2.9.13, which
38 will eventually become Privoxy v3.0 (and soon we hope!). See http://
39 www.privoxy.org/ for more information. The current code level is BETA, and
40 seems stable to us :).
42 Privoxy is a web proxy with advanced filtering capabilities for protecting
43 privacy, filtering web page content, managing cookies, controlling access, and
44 removing ads, banners, pop-ups and other obnoxious Internet junk. Privoxy has a
45 very flexible configuration and can be customized to suit individual needs and
46 tastes. Privoxy has application for both stand-alone systems and multi-user
49 Privoxy is based on the code of the Internet Junkbuster (tm). Junkbuster was
50 originally written by JunkBusters Corporation, and was released as free
51 open-source software under the GNU GPL. Stefan Waldherr made many improvements,
52 and started the SourceForge project to continue development.
54 Privoxy continues the Junkbuster tradition, but adds many refinements,
55 enhancements and new features.
61 NEWS! As of 03/24/02, the name of this project has been changed from ijbswa/
62 Junkbuster to Privoxy. This is reflected in many of the included files.
64 WARNING! If upgrading from earlier versions of this project via RPM packages,
65 the new package will delete any previously installed 'Junkbuster' packages.
67 IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
68 port is now 8118 due to conflicts with port 8000 assignment. You will need to
69 change your browser if upgrading!!! And maybe firewall, etc.
75 There are several ways to install Privoxy.
77 To build Privoxy from source, autoconf and GNU make (gmake) are required.
78 Source is available as gzipped tar archives. For this, first unpack the source:
80 tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz]
81 cd privoxy-2.9.13-beta
84 For retrieving the current CVS sources, you'll need the CVS package installed
85 first. Note CVS source is development quality, and may not be stable, or well
86 tested. To download CVS source:
88 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
89 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
93 This will create a directory named current/, which will contain the source
96 Then, in either case, to build from unpacked tarball or CVS source:
100 ./configure (--help to see options)
101 make (the make from gnu, gmake for *BSD)
103 make -n install (to see where all the files will go)
104 make install (to really install)
107 Redhat and SuSE src and binary RPMs can be built with "make redhat-dist" or "
108 make suse-dist" from unpacked sources. You will need to run "autoconf;
109 autoheader; ./configure" beforehand. *BSD will require gmake (from http://
110 www.gnu.org). See the user-manual for OS/2 build instructions.
112 For binary RPM installation, and other platforms, see the user-manual as well.
118 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
119 [.GROUP]] [config_file]
121 See the man page or user-manual for a brief explanation of each option.
123 If no config_file is specified on the command line, Privoxy will look for a
124 file named 'config' in the current directory (except Win32 which will look for
125 'config.txt'). If no config_file is found, Privoxy will fail to start.
127 Or for Red Hat: /etc/rc.d/init.d/privoxy start
129 Or for SuSE: /etc/rc.d/privoxy start
135 See: 'config', 'default.action', and 'default.filter'. There are several
136 actions files included. These are all well commented. Most of the magic is in '
137 *.action', and there are several of these included with varying degrees of
138 aggressiveness. On Unix-like systems, these files are installed in /etc/
139 privoxy. On Windows, then wherever the executable itself is installed. There
140 are many significant changes and advances since Junkbuster v2.0.x. The
141 user-manual has a run down of configuration options, and examples: http://
142 www.privoxy.org/user-manual/.
144 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
145 you specify in the config file under 'listen-address'. DEFAULT is localhost:
148 The default.action file can be configured via the web interface accessed via
149 http://p.p/, as well other options.
151 All configuration files are subject to unannounced changes during the
157 There should be documentation in the 'doc' subdirectory, but it is not
158 completed at this point. In particular, see the user-manual there, the faq, and
159 those interested in Privoxy development, should look at developer-manual.
161 The most up to date source of information on the current development version,
162 may still be either comments in the source code, or the included configuration
163 files. The source and configuration files are all well commented. The main
164 configuration files are: 'config', 'default.action', and 'default.filter' in
165 the toplevel source directory. There are several *.action files included, with
166 varying levels of aggressiveness.
168 Included documentation may vary according to platform and packager.
171 CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
172 --------------------------------------------------------------
174 We value your feedback. However, to provide you with the best support, please
177 * Use the Sourceforge Support Forum to get help:
179 http://sourceforge.net/tracker/?group_id=11118&atid=211118
182 * Submit bugs only through our Sourceforge Bug Forum:
184 http://sourceforge.net/tracker/?group_id=11118&atid=111118.
187 Make sure that the bug has not already been submitted. Please try to verify
188 that it is a Privoxy bug, and not a browser or site bug first. If you are
189 using your own custom configuration, please try the stock configs to see if
190 the problem is a configuration related bug. And if not using the latest
191 development snapshot, please try the latest one. Or even better, CVS
192 sources. Please be sure to include the Privoxy/Junkbuster version,
193 platform, browser, any pertinent log data, any other relevant details
194 (please be specific) and, if possible, some way to reproduce the bug.
196 * Submit feature requests only through our Sourceforge feature request
199 http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
202 * We will soon have an automated way to submit advertisements, incorrectly
203 blocked images, popups and the like. Check back.
206 * For any other issues, feel free to use the mailing lists:
208 http://sourceforge.net/mail/?group_id=11118.
211 Anyone interested in actively participating in development and related
212 discussions can also join the appropriate mailing list. Archives are
216 -------------------------------------------------------------------------
217 ijbswa-developers@lists.sourceforge.net
220 $Id: readme.sgml,v 1.4 2002/04/06 05:07:29 hal9 Exp $