1 /*********************************************************************
3 * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
5 * Purpose : README file to give a short intro.
7 * Copyright : Written by and Copyright (C) 2001-2009 the SourceForge
8 * Privoxy team. http://www.privoxy.org/
10 * Based on the Internet Junkbuster originally written
11 * by and Copyright (C) 1997 Anonymous Coders and
12 * Junkbusters Corporation. http://www.junkbusters.com
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.
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.
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.,
30 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
33 *********************************************************************/
35 This README is included with Privoxy 3.0.12. See http://www.privoxy.org/ for
36 more information. The current code maturity level is "stable".
38 -------------------------------------------------------------------------------
40 Privoxy is a non-caching web proxy with advanced filtering capabilities for
41 enhancing privacy, modifying web page data and HTTP headers, controlling
42 access, and removing ads and other obnoxious Internet junk. Privoxy has a
43 flexible configuration and can be customized to suit individual needs and
44 tastes. It has application for both stand-alone systems and multi-user
47 Privoxy is Free Software and licensed under the GPL2.
49 Privoxy is an associated project of Software in the Public Interest (SPI).
50 Donations are welcome.
52 -------------------------------------------------------------------------------
56 March 2009, Privoxy 3.0.12 is released.
58 This is primarily a bug fix release. See the "ChangeLog", and the "What's New"
59 section and the "Upgrader's Notes" in the User Manual for details.
61 February 2009, Privoxy 3.0.11 is released.
63 As usual there are changes that effect the configuration. See the "ChangeLog",
64 and the "What's New" section and the "Upgrader's Notes" in the User Manual for
65 details and specifics.
67 This is a stable release, and marks a departure for Privoxy development.
69 Previously, odd numbered releases were considered beta versions and were only
70 released at the end of the development cycle when the code was already believed
71 to be stable. Usually it was, so the stable release contained pretty much the
72 same code, but got a higher version number. In the future we intend to release
73 several snapshots between stable releases. There will probably still be about
74 two stable releases per year, but hopefully about six snapshots instead of the
75 two betas we have now. The intentions is to make testing without CVS access
78 -------------------------------------------------------------------------------
82 See the INSTALL file in this directory, for installing from raw source, and the
83 User Manual, for all other installation types.
85 -------------------------------------------------------------------------------
89 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
90 [.GROUP]] [--chroot] [--pre-chroot-nslookup HOSTNAME ][config_file]
92 See the man page or User Manual for an explanation of each option, and other
93 configuration and usage issues.
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.
99 Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start
101 Or Debian and Ubuntu: /etc/init.d/privoxy start
103 -------------------------------------------------------------------------------
107 See: 'config', 'default.action', 'user.action', 'default.filter', and
108 'user.filter'. 'user.action' and 'user.filter' are for personal and local
109 configuration preferences. These are all well commented. Most of the magic is
110 in '*.action' files. 'user.action' should be used for any actions
111 customizations. On Unix-like systems, these files are typically installed in /
112 etc/privoxy. On Windows, then wherever the executable itself is installed.
113 There are many significant changes and advances from earlier versions. The User
114 Manual has an explanation of all configuration options, and examples: http://
115 www.privoxy.org/user-manual/.
117 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
118 you specify in the config file under 'listen-address'. DEFAULT is
119 localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not
120 try it with FTP or other protocols for the simple reason it does not work.
122 The actions list can be configured via the web interface accessed via http://
123 p.p/, as well other options.
125 -------------------------------------------------------------------------------
129 There should be documentation in the 'doc' subdirectory. In particular, see the
130 User Manual there, the FAQ, and those interested in Privoxy development, should
131 look at developer-manual.
133 The source and configuration files are all well commented. The main
134 configuration files are: 'config', 'default.action', and 'default.filter'.
136 Included documentation may vary according to platform and packager. All
137 documentation is posted on http://www.privoxy.org, in case you don't have it,
140 -------------------------------------------------------------------------------
142 6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
144 We value your feedback. In fact, we rely on it to improve Privoxy and its
145 configuration. However, please note the following hints, so we can provide you
146 with the best support:
148 -------------------------------------------------------------------------------
152 For casual users, our support forum at SourceForge is probably best suited:
153 http://sourceforge.net/tracker/?group_id=11118&atid=211118
155 All users are of course welcome to discuss their issues on the users mailing
156 list, where the developers also hang around.
158 Please don't sent private support requests to individual Privoxy developers,
159 either use the mailing lists or the support trackers.
161 Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
162 addresses have to be accepted manually by a moderator. This may cause a delay
163 of several days and if you use a subject that doesn't clearly mention Privoxy
164 or one of its features, your message may be accidentally discarded as spam.
166 If you aren't subscribed, you should therefore spend a few seconds to come up
167 with a proper subject. Additionally you should make it clear that you want to
168 get CC'd. Otherwise some responses will be directed to the mailing list only,
169 and you won't see them.
171 -------------------------------------------------------------------------------
173 6.2. Reporting Problems
175 "Problems" for our purposes, come in two forms:
177 * Configuration issues, such as ads that slip through, or sites that don't
178 function properly due to one Privoxy "action" or another being turned "on".
180 * "Bugs" in the programming code that makes up Privoxy, such as that might
183 -------------------------------------------------------------------------------
185 6.2.1. Reporting Ads or Other Configuration Problems
187 Please send feedback on ads that slipped through, innocent images that were
188 blocked, sites that don't work properly, and other configuration related
189 problem of default.action file, to http://sourceforge.net/tracker/?group_id=
190 11118&atid=460288, the Actions File Tracker.
192 New, improved default.action files may occasionally be made available based on
193 your feedback. These will be announced on the ijbswa-announce list and
194 available from our the files section of our project page.
196 -------------------------------------------------------------------------------
198 6.2.2. Reporting Bugs
200 Please report all bugs through our bug tracker: http://sourceforge.net/tracker
201 /?group_id=11118&atid=111118.
203 Before doing so, please make sure that the bug has not already been submitted
204 and observe the additional hints at the top of the submit form. If already
205 submitted, please feel free to add any info to the original report that might
206 help to solve the issue.
208 Please try to verify that it is a Privoxy bug, and not a browser or site bug or
209 documented behaviour that just happens to be different than what you expected.
210 If unsure, try toggling off Privoxy, and see if the problem persists.
212 If you are using your own custom configuration, please try the stock configs to
213 see if the problem is configuration related. If you're having problems with a
214 feature that is disabled by default, please ask around on the mailing list if
215 others can reproduce the problem.
217 If you aren't using the latest Privoxy version, the bug may have been found and
218 fixed in the meantime. We would appreciate if you could take the time to
219 upgrade to the latest version (or even the latest CVS snapshot) and verify that
220 your bug still exists.
222 Please be sure to provide the following information:
224 * The exact Privoxy version you are using (if you got the source from CVS,
225 please also provide the source code revisions as shown in http://
226 config.privoxy.org/show-version).
228 * The operating system and versions you run Privoxy on, (e.g. Windows XP
229 SP2), if you are using a Unix flavor, sending the output of "uname -a"
230 should do, in case of GNU/Linux, please also name the distribution.
232 * The name, platform, and version of the browser you were using (e.g.
233 Internet Explorer v5.5 for Mac).
235 * The URL where the problem occurred, or some way for us to duplicate the
236 problem (e.g. http://somesite.example.com/?somethingelse=123).
238 * Whether your version of Privoxy is one supplied by the Privoxy developers
239 via SourceForge, or if you got your copy somewhere else.
241 * Whether you are using Privoxy in tandem with another proxy such as Tor. If
242 so, please temporary disable the other proxy to see if the symptoms change.
244 * Whether you are using a personal firewall product. If so, does Privoxy work
247 * Any other pertinent information to help identify the problem such as config
248 or log file excerpts (yes, you should have log file entries for each action
251 You don't have to tell us your actual name when filing a problem report, but
252 please use a nickname so we can differentiate between your messages and the
253 ones entered by other "anonymous" users that may respond to your request if
254 they have the same problem or already found a solution.
256 Please also check the status of your request a few days after submitting it, as
257 we may request additional information. If you use a SF id, you should
258 automatically get a mail when someone responds to your request.
260 The appendix of the Privoxy User Manual also has helpful information on
261 understanding actions, and action debugging.
263 -------------------------------------------------------------------------------
265 6.3. Request New Features
267 You are welcome to submit ideas on new features or other proposals for
268 improvement through our feature request tracker at http://sourceforge.net/
269 tracker/?atid=361118&group_id=11118.
271 -------------------------------------------------------------------------------
275 For any other issues, feel free to use the mailing lists. Technically
276 interested users and people who wish to contribute to the project are also
277 welcome on the developers list! You can find an overview of all Privoxy-related
278 mailing lists, including list archives, at: http://sourceforge.net/mail/?