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-2008 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.8. 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, managing HTTP cookies, controlling
42 access, and removing ads, banners, pop-ups and other obnoxious Internet junk.
43 Privoxy has a flexible configuration and can be customized to suit individual
44 needs and tastes. Privoxy has application for both stand-alone systems and
47 Privoxy is based on Internet Junkbuster (tm).
49 -------------------------------------------------------------------------------
53 NEWS! January 2008, Privoxy 3.0.8 stable is released. This is a significant
54 upgrade with many new and enhanced features, and many bugs fixed. All Privoxy
55 users are encouraged to upgrade. See the "ChangeLog", and the "What's New"
56 section and the "Upgrader's Notes" in the User Manual for details and
57 specifics. There are changes related to configuration, so anyone upgrading and
58 keeping their old configuration should read ahead first.
60 December 2007, Privoxy 3.0.7 is released. This is a beta release in preparation
61 for the forthcoming 3.0.8 release.
63 NEWS! November 2006, Privoxy 3.0.6 stable is released. This is a significant
64 upgrade with many new and enhanced features, and many bugs fixed.
66 There was and will not be an official 3.0.4 release. This release cycle was
67 used to gather our thoughts, play with some new ideas and refine some old ones.
68 It will remain a development cycle with no actual release. 3.0.5 is the fruit
71 -------------------------------------------------------------------------------
75 See the INSTALL file in this directory, for installing from raw source, and the
76 User Manual, for all other installation types.
78 -------------------------------------------------------------------------------
82 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
83 [.GROUP]] [--chroot] [--pre-chroot-nslookup HOSTNAME ][config_file]
85 See the man page or User Manual for an explanation of each option, and other
86 configuration and usage issues.
88 If no config_file is specified on the command line, Privoxy will look for a
89 file named 'config' in the current directory (except Win32 which will look for
90 'config.txt'). If no config_file is found, Privoxy will fail to start.
92 Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start
94 Or Debian: /etc/init.d/privoxy start
96 -------------------------------------------------------------------------------
100 See: 'config', 'default.action', 'user.action', 'default.filter', and
101 'user.filter'. 'user.action' and 'user.filter' are for personal and local
102 configuration preferences. These are all well commented. Most of the magic is
103 in '*.action' files. 'user.action' should be used for any actions
104 customizations. On Unix-like systems, these files are typically installed in /
105 etc/privoxy. On Windows, then wherever the executable itself is installed.
106 There are many significant changes and advances from earlier versions. The User
107 Manual has an explanation of all configuration options, and examples: http://
108 www.privoxy.org/user-manual/.
110 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
111 you specify in the config file under 'listen-address'. DEFAULT is
112 localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not
113 try it with FTP or other protocols for the simple reason it does not work.
115 The actions list can be configured via the web interface accessed via http://
116 p.p/, as well other options.
118 -------------------------------------------------------------------------------
122 There should be documentation in the 'doc' subdirectory. In particular, see the
123 User Manual there, the FAQ, and those interested in Privoxy development, should
124 look at developer-manual.
126 The source and configuration files are all well commented. The main
127 configuration files are: 'config', 'default.action', and 'default.filter'.
129 Included documentation may vary according to platform and packager. All
130 documentation is posted on http://www.privoxy.org, in case you don't have it,
133 -------------------------------------------------------------------------------
135 6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
137 We value your feedback. In fact, we rely on it to improve Privoxy and its
138 configuration. However, please note the following hints, so we can provide you
139 with the best support:
141 -------------------------------------------------------------------------------
145 For casual users, our support forum at SourceForge is probably best suited:
146 http://sourceforge.net/tracker/?group_id=11118&atid=211118
148 All users are of course welcome to discuss their issues on the users mailing
149 list, where the developers also hang around.
151 Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
152 addresses have to be accepted manually by a moderator. This may cause a delay
153 of several days and if you use a subject that doesn't clearly mention Privoxy
154 or one of its features, your message may be accidentally discarded as spam.
156 If you aren't subscribed, you should therefore spend a few seconds to come up
157 with a proper subject. Additionally you should make it clear that you want to
158 get CC'd. Otherwise some responses will be directed to the mailing list only,
159 and you won't see them.
161 -------------------------------------------------------------------------------
163 6.2. Reporting Problems
165 "Problems" for our purposes, come in two forms:
167 * Configuration issues, such as ads that slip through, or sites that don't
168 function properly due to one Privoxy "action" or another being turned "on".
170 * "Bugs" in the programming code that makes up Privoxy, such as that might
173 -------------------------------------------------------------------------------
175 6.2.1. Reporting Ads or Other Configuration Problems
177 Please send feedback on ads that slipped through, innocent images that were
178 blocked, sites that don't work properly, and other configuration related
179 problem of default.action file, to http://sourceforge.net/tracker/?group_id=
180 11118&atid=460288, the Actions File Tracker.
182 New, improved default.action files may occasionally be made available based on
183 your feedback. These will be announced on the ijbswa-announce list and
184 available from our the files section of our project page.
186 -------------------------------------------------------------------------------
188 6.2.2. Reporting Bugs
190 Please report all bugs through our bug tracker: http://sourceforge.net/tracker
191 /?group_id=11118&atid=111118.
193 Before doing so, please make sure that the bug has not already been submitted
194 and observe the additional hints at the top of the submit form. If already
195 submitted, please feel free to add any info to the original report that might
196 help to solve the issue.
198 Please try to verify that it is a Privoxy bug, and not a browser or site bug or
199 documented behaviour that just happens to be different than what you expected.
200 If unsure, try toggling off Privoxy, and see if the problem persists.
202 If you are using your own custom configuration, please try the stock configs to
203 see if the problem is configuration related. If you're having problems with a
204 feature that is disabled by default, please ask around on the mailing list if
205 others can reproduce the problem.
207 If you aren't using the latest Privoxy version, the bug may have been found and
208 fixed in the meantime. We would appreciate if you could take the time to
209 upgrade to the latest version (or even the latest CVS snapshot) and verify that
210 your bug still exists.
212 Please be sure to provide the following information:
214 * The exact Privoxy version you are using (if you got the source from CVS,
215 please also provide the source code revisions as shown in http://
216 config.privoxy.org/show-version).
218 * The operating system and versions you run Privoxy on, (e.g. Windows XP
219 SP2), if you are using a Unix flavor, sending the output of "uname -a"
220 should do, in case of GNU/Linux, please also name the distribution.
222 * The name, platform, and version of the browser you were using (e.g.
223 Internet Explorer v5.5 for Mac).
225 * The URL where the problem occurred, or some way for us to duplicate the
226 problem (e.g. http://somesite.example.com/?somethingelse=123).
228 * Whether your version of Privoxy is one supplied by the Privoxy developers
229 via SourceForge, or if you got your copy somewhere else.
231 * Whether you are using Privoxy in tandem with another proxy such as Tor. If
232 so, please temporary disable the other proxy to see if the symptoms change.
234 * Whether you are using a personal firewall product. If so, does Privoxy work
237 * Any other pertinent information to help identify the problem such as config
238 or log file excerpts (yes, you should have log file entries for each action
241 You don't have to tell us your actual name when filing a problem report, but
242 please use a nickname so we can differentiate between your messages and the
243 ones entered by other "anonymous" users that may respond to your request if
244 they have the same problem or already found a solution.
246 Please also check the status of your request a few days after submitting it, as
247 we may request additional information. If you use a SF id, you should
248 automatically get a mail when someone responds to your request.
250 The appendix of the Privoxy User Manual also has helpful information on
251 understanding actions, and action debugging.
253 -------------------------------------------------------------------------------
255 6.3. Request New Features
257 You are welcome to submit ideas on new features or other proposals for
258 improvement through our feature request tracker at http://sourceforge.net/
259 tracker/?atid=361118&group_id=11118.
261 -------------------------------------------------------------------------------
265 For any other issues, feel free to use the mailing lists. Technically
266 interested users and people who wish to contribute to the project are also
267 welcome on the developers list! You can find an overview of all Privoxy-related
268 mailing lists, including list archives, at: http://sourceforge.net/mail/?