generated
[privoxy.git] / README
1
2 /*********************************************************************
3  *
4  * File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
5  *
6  * Purpose     :  README file to give a short intro.
7  *
8  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
9  *                Privoxy team. http://www.privoxy.org/
10  *
11  *                Based on the Internet Junkbuster originally written
12  *                by and Copyright (C) 1997 Anonymous Coders and 
13  *                Junkbusters Corporation.  http://www.junkbusters.com
14  *
15  *                This program is free software; you can redistribute it 
16  *                and/or modify it under the terms of the GNU General
17  *                Public License as published by the Free Software
18  *                Foundation; either version 2 of the License, or (at
19  *                your option) any later version.
20  *
21  *                This program is distributed in the hope that it will
22  *                be useful, but WITHOUT ANY WARRANTY; without even the
23  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
24  *                PARTICULAR PURPOSE.  See the GNU General Public
25  *                License for more details.
26  *
27  *                The GNU General Public License should be included with
28  *                this file.  If not, you can view it at
29  *                http://www.gnu.org/copyleft/gpl.html
30  *                or write to the Free Software Foundation, Inc., 59
31  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
32  *
33  *********************************************************************/
34    
35
36 This README is included with the development version of Privoxy 2.9.13, which
37 will eventually become Privoxy v3.0 (and soon we hope!). See http://
38 www.privoxy.org/ for more information. The current code level is beta, and
39 seems stable to us :).
40
41 Privoxy is a web proxy with advanced filtering capabilities for protecting
42 privacy, filtering web page content, managing cookies, controlling access, and
43 removing ads, banners, pop-ups and other obnoxious Internet junk. Privoxy has a
44 very flexible configuration and can be customized to suit individual needs and
45 tastes. Privoxy has application for both stand-alone systems and multi-user
46 networks.
47
48 Privoxy is based on the code of the Internet Junkbuster (tm). Junkbuster was
49 originally written by Junkbusters Corporation, and was released as free
50 open-source software under the GNU GPL. Stefan Waldherr made many improvements,
51 and started the SourceForge project to continue development.
52
53 Privoxy continues the Junkbuster tradition, but adds many refinements,
54 enhancements and new features.
55
56
57  IMPORTANT CHANGES
58 ------------------
59
60 NEWS! As of 03/24/02, the name of this project has been changed from ijbswa/
61 Junkbuster to Privoxy. This is reflected in many of the included files.
62
63 WARNING! If upgrading from earlier versions of this project via RPM packages,
64 the new package will delete any previously installed 'Junkbuster' packages.
65
66 IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
67 port is now 8118 due to conflicts with port 8000 assignment. You will need to
68 change your browser if upgrading!!! And maybe firewall, etc.
69
70
71  INSTALL
72 --------
73
74 There are several ways to install Privoxy.
75
76 To build Privoxy from source, autoconf and GNU make (gmake) are required.
77 Source is available as gzipped tar archives. For this, first unpack the source:
78
79  tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz]                           
80  cd privoxy-2.9.13-beta                                                        
81                                                                                
82
83 For retrieving the current CVS sources, you'll need the CVS package installed
84 first. Note CVS source is development quality, and may not be stable, or well
85 tested. To download CVS source:
86
87   cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login          
88   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current 
89   cd current                                                                         
90                                                                                      
91
92 This will create a directory named current/, which will contain the source
93 tree.
94
95 Then, in either case, to build from unpacked tarball or CVS source:
96
97  autoheader                                                                    
98  autoconf                                                                      
99  ./configure      (--help to see options)                                      
100  make             (the make from gnu, gmake for *BSD)                          
101  su                                                                            
102  make -n install  (to see where all the files will go)                         
103  make install     (to really install)                                          
104                                                                                
105
106 Redhat and SuSE src and binary RPMs can be built with "make redhat-dist" or "
107 make suse-dist" from unpacked sources. You will need to run "autoconf;
108 autoheader; ./configure" beforehand. *BSD will require gmake (from http://
109 www.gnu.org). See the user-manual for OS/2 build instructions.
110
111 For binary RPM installation, and other platforms, see the user-manual as well.
112
113
114  RUN
115 ---- 
116
117 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
118 [.GROUP]] [config_file]
119
120 See the man page or user-manual for a brief explanation of each option.
121
122 If no config_file is specified on the command line, Privoxy will look for a
123 file named 'config' in the current directory (except Win32 which will look for
124 'config.txt'). If no config_file is found, Privoxy will fail to start.
125
126 Or for Red Hat: /etc/rc.d/init.d/privoxy start
127
128 Or for SuSE: /etc/rc.d/privoxy start
129
130
131  CONFIGURATION
132 -------------- 
133
134 See: 'config', 'default.action', and 'default.filter'. There are several
135 actions files included. These are all well commented. Most of the magic is in '
136 *.action', and there are several of these included with varying degrees of
137 aggressiveness. On Unix-like systems, these files are installed in /etc/
138 privoxy. On Windows, then wherever the executable itself is installed. There
139 are many significant changes and advances since Junkbuster v2.0.x. The
140 user-manual has a run down of configuration options, and examples: http://
141 www.privoxy.org/user-manual/.
142
143 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
144 you specify in the config file under 'listen-address'. DEFAULT is localhost:
145 8118.
146
147 The default.action file can be configured via the web interface accessed via
148 http://p.p/, as well other options.
149
150 All configuration files are subject to unannounced changes during the
151 development process.
152
153
154  DOCUMENTATION
155 --------------
156
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.
160
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.
167
168 Included documentation may vary according to platform and packager.
169
170
171  CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
172 --------------------------------------------------------------
173
174 We value your feedback. However, to provide you with the best support, please
175 note:
176
177   *  Use the Sourceforge Support Forum to get help:
178        
179         http://sourceforge.net/tracker/?group_id=11118&atid=211118
180        
181    
182   *  Submit bugs only through our Sourceforge Bug Forum:
183      
184         http://sourceforge.net/tracker/?group_id=11118&atid=111118. 
185         
186    
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.
195    
196   *  Submit feature requests only through our Sourceforge feature request forum:
197      
198         http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
199        
200    
201   *  Submit missed ads and banners, and incorrectly blocked images, popups, etc:
202           
203         http://p.p/, and select "actions file feedback system"
204        
205    
206     This page can also be reached from many of the internal CGI pages.
207    
208   *  For any other issues, feel free to use the mailing lists:
209      
210         http://sourceforge.net/mail/?group_id=11118.
211      
212    
213     Anyone interested in actively participating in development and related
214     discussions can also join the appropriate mailing list. Archives are
215     available too.
216    
217  -------------------------------------------------------------------------
218  ijbswa-developers@lists.sourceforge.net
219  
220
221 $Id: readme.sgml,v 1.6 2002/04/08 22:59:26 hal9 Exp $
222