Update.
[privoxy.git] / 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 - 2004  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 Privoxy 3.0.4-beta. The current code maturity
35 level is "beta". Various changes and improvements are underway, and
36 preparations are being made for an update of Privoxy. Please report any
37 problems to the developers.
38
39 -------------------------------------------------------------------------------
40
41 Privoxy is a web proxy with advanced filtering capabilities for protecting
42 privacy, modifying 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 Internet Junkbuster (tm).
49
50 -------------------------------------------------------------------------------
51
52 1. IMPORTANT CHANGES
53
54 MORE NEWS! January 2004, Privoxy 3.0.3 is released. This is the another
55 maintenance release of Privoxy which fixes more bugs, further refines the
56 configuration and works around some known third-party problems. See the
57 ChangeLog for complete details. Upgrading from 3.0.2 is recommended.
58
59 NEWS! March 2003, Privoxy 3.0.2 is released. This is the first maintenance
60 release of Privoxy. There are no significant new features in this release. Some
61 bugs are fixed, and some existing features have been enhanced. See ChangeLog
62 for details. Upgrading from 3.0.0 is recommended.
63
64 REALLY BIG NEWS! August 2002: The long-awaited, oft-delayed stable version of
65 Privoxy 3.0 is finally released! This is way behind schedule, but better late
66 than never. The developers all hope the wait was worth it.
67
68 NEWS! As of 03/24/02, the name of this project has been changed from ijbswa/
69 Junkbuster to Privoxy. This is reflected in many of the included files.
70
71 WARNING! If upgrading from earlier versions of this project via RPM packages,
72 the new package will delete any previously installed 'Junkbuster' packages.
73
74 IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
75 port is now 8118 due to conflicts with port 8000 assignment. You will need to
76 change your browser if upgrading!!! And maybe firewall, etc.
77
78 -------------------------------------------------------------------------------
79
80 2. INSTALL
81
82 See the INSTALL file in this directory, for installing from source, and the
83 User Manual, for other installation types.
84
85 -------------------------------------------------------------------------------
86
87 3. RUN
88
89 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
90 [.GROUP]] [--chroot] [config_file]
91
92 See the man page or User Manual for an explanation of each option, and other
93 configuration and usage issues.
94
95 If no config_file is specified on the command line, Privoxy will look for a
96 file named 'config' in the current directory (except Win32 which will look for
97 'config.txt'). If no config_file is found, Privoxy will fail to start.
98
99 Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
100
101 Or for SuSE: /etc/rc.d/privoxy start
102
103 Or Debian: /etc/init.d/privoxy start
104
105 -------------------------------------------------------------------------------
106
107 4. CONFIGURATION
108
109 See: 'config', 'default.action', 'user.action', and 'default.filter'.
110 'user.action' is for personal and local configuration preferences. These are
111 all well commented. Most of the magic is in '*.action' files. 'user.action'
112 should be used for any actions customizations. On Unix-like systems, these
113 files are installed in /etc/privoxy. On Windows, then wherever the executable
114 itself is installed. There are many significant changes and advances since
115 Junkbuster v2.0.x. The User Manual has an explanation of all configuration
116 options, and examples: http://www.privoxy.org/user-manual/.
117
118 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
119 you specify in the config file under 'listen-address'. DEFAULT is
120 localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not
121 try it with FTP or other protocols for the simple reason it does not work.
122
123 The actions list can be configured via the web interface accessed via http://
124 p.p/, as well other options.
125
126 -------------------------------------------------------------------------------
127
128 5. DOCUMENTATION
129
130 There should be documentation in the 'doc' subdirectory. In particular, see the
131 User Manual there, the FAQ, and those interested in Privoxy development, should
132 look at developer-manual.
133
134 The source and configuration files are all well commented. The main
135 configuration files are: 'config', 'default.action', and 'default.filter'.
136
137 Included documentation may vary according to platform and packager. All
138 documentation is posted on http://www.privoxy.org, in case you don't have it,
139 or can't find it.
140
141 -------------------------------------------------------------------------------
142
143 6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
144
145 We value your feedback. In fact, we rely on it to improve Privoxy and its
146 configuration. However, please note the following hints, so we can provide you
147 with the best support:
148
149 -------------------------------------------------------------------------------
150
151 6.1. Get Support
152
153 For casual users, our support forum at SourceForge is probably best suited:
154 http://sourceforge.net/tracker/?group_id=11118&atid=211118
155
156 All users are of course welcome to discuss their issues on the users mailing
157 list, where the developers also hang around.
158
159 -------------------------------------------------------------------------------
160
161 6.2. Report Bugs
162
163 Please report all bugs only through our bug tracker: http://sourceforge.net/
164 tracker/?group_id=11118&atid=111118.
165
166 Before doing so, please make sure that the bug has not already been submitted
167 and observe the additional hints at the top of the submit form.
168
169 Please try to verify that it is a Privoxy bug, and not a browser or site bug
170 first. If unsure, try toggling off Privoxy, and see if the problem persists.
171 The appendix of the user manual also has helpful information on action
172 debugging. If you are using your own custom configuration, please try the stock
173 configs to see if the problem is configuration related.
174
175 If not using the latest version, chances are that the bug has been found and
176 fixed in the meantime. We would appreciate if you could take the time to
177 upgrade to the latest version (or even the latest CVS snapshot) and verify your
178 bug, but this is not required for reporting.
179
180 -------------------------------------------------------------------------------
181
182 6.3. Request New Features
183
184 You are welcome to submit ideas on new features or other proposals for
185 improvement through our feature request tracker at http://sourceforge.net/
186 tracker/?atid=361118&group_id=11118.
187
188 -------------------------------------------------------------------------------
189
190 6.5. Other
191
192 For any other issues, feel free to use the mailing lists. Technically
193 interested users and people who wish to contribute to the project are also
194 welcome on the developers list! You can find an overview of all Privoxy-related
195 mailing lists, including list archives, at: http://sourceforge.net/mail/?
196 group_id=11118.
197