Rebuild docs with updated license info
[privoxy.git] / README
1 /*********************************************************************
2  *
3  * File        :  doc/source/readme.sgml
4  *
5  * Purpose     :  README file to give a short intro.
6  *
7  * Copyright   :  Written by and Copyright (C) 2001-2018 the
8  *                Privoxy team. https://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.,
30  *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
31  *                USA
32  *
33  *********************************************************************/
34
35 This README is included with the development version of Privoxy 3.0.29. See
36 https://www.privoxy.org/ for more information. The current code maturity level
37 is "UNRELEASED", but seems stable to us :).
38
39 -------------------------------------------------------------------------------
40
41 Privoxy is a non-caching web proxy with advanced filtering capabilities for
42 enhancing privacy, modifying web page data and HTTP headers, controlling
43 access, and removing ads and other obnoxious Internet junk. Privoxy has a
44 flexible configuration and can be customized to suit individual needs and
45 tastes. It has application for both stand-alone systems and multi-user
46 networks.
47
48 Privoxy is Free Software. You can redistribute it and/or modify it under the
49 terms of the GNU GPLv2 or (at your option) any later version published by the
50 FSF.
51
52 Privoxy is an associated project of Software in the Public Interest (SPI).
53
54 Helping hands and donations are welcome:
55
56   * https://www.privoxy.org/faq/general.html#PARTICIPATE
57
58   * https://www.privoxy.org/faq/general.html#DONATE
59
60 -------------------------------------------------------------------------------
61
62 1. CHANGES
63
64 For a list of changes in this release, please have a look at the "ChangeLog",
65 the "What's New" section or the "Upgrader's Notes" in the User Manual.
66
67 -------------------------------------------------------------------------------
68
69 2. INSTALL
70
71 See the INSTALL file in this directory, for installing from raw source, and the
72 User Manual, for all other installation types.
73
74 -------------------------------------------------------------------------------
75
76 3. RUN
77
78 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
79 [.GROUP]] [--chroot] [--pre-chroot-nslookup HOSTNAME ][config_file]
80
81 See the man page or User Manual for an explanation of each option, and other
82 configuration and usage issues.
83
84 If no config_file is specified on the command line, Privoxy will look for a
85 file named 'config' in the current directory (except Win32 which will look for
86 'config.txt'). If no config_file is found, Privoxy will fail to start.
87
88 -------------------------------------------------------------------------------
89
90 4. CONFIGURATION
91
92 See: 'config', 'default.action', 'user.action', 'default.filter', and
93 'user.filter'. 'user.action' and 'user.filter' are for personal and local
94 configuration preferences. These are all well commented. Most of the magic is
95 in '*.action' files. 'user.action' should be used for any actions
96 customizations. On Unix-like systems, these files are typically installed in /
97 etc/privoxy. On Windows, then wherever the executable itself is installed.
98 There are many significant changes and advances from earlier versions. The User
99 Manual has an explanation of all configuration options, and examples: https://
100 www.privoxy.org/user-manual/.
101
102 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
103 you specify in the config file under 'listen-address'. DEFAULT is
104 127.0.0.1:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not
105 try it with FTP or other protocols for the simple reason it does not work.
106
107 The actions list can be configured via the web interface accessed via http://
108 p.p/, as well other options.
109
110 All configuration files are subject to unannounced changes during the
111 development process.
112
113 -------------------------------------------------------------------------------
114
115 5. DOCUMENTATION
116
117 There should be documentation in the 'doc' subdirectory, but it may not be
118 completed at this point. In particular, see the User Manual there, the FAQ, and
119 those interested in Privoxy development, should look at developer-manual.
120
121 The most up to date source of information on the current development version,
122 may still be either comments in the source code, or the included configuration
123 files. The source and configuration files are all well commented. The main
124 configuration files are: 'config', 'default.action', and 'default.filter' in
125 the top-level source directory.
126
127 Included documentation may vary according to platform and packager. All
128 documentation is posted on https://www.privoxy.org, in case you don't have it,
129 or can't find it.
130
131 -------------------------------------------------------------------------------
132
133 6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
134
135 We value your feedback. In fact, we rely on it to improve Privoxy and its
136 configuration. However, please note the following hints, so we can provide you
137 with the best support.
138
139 -------------------------------------------------------------------------------
140
141 6.1. Please provide sufficient information
142
143 A lot of support requests don't contain enough information and can't be solved
144 without a lot of back and forth which causes unnecessary delays. Reading this
145 section should help to prevent that.
146
147 Before contacting us to report a problem, please try to verify that it is a 
148 Privoxy problem, and not a browser or site problem or documented behaviour that
149 just happens to be different than what you expected. If unsure, try toggling
150 off Privoxy, and see if the problem persists.
151
152 If you are using your own custom configuration, please try the default
153 configuration to see if the problem is configuration related. If you're having
154 problems with a feature that is disabled by default, please ask around on the
155 mailing list if others can reproduce the problem.
156
157 If you aren't using the latest Privoxy version, the problem may have been found
158 and fixed in the meantime. We would appreciate if you could take the time to
159 upgrade to the latest version and verify that the problem still exists.
160
161 Please be sure to provide the following information when reporting problems or
162 requesting support:
163
164   * The exact Privoxy version you are using.
165
166   * The operating system and versions you run Privoxy on, e.g. Windows XP SP2.
167
168   * The name, platform, and version of the browser you were using (e.g. 
169     Internet Explorer v5.5 for Mac).
170
171   * The URL where the problem occurred, or some way for us to duplicate the
172     problem (e.g. http://somesite.example.com/?somethingelse=123).
173
174   * Whether your version of Privoxy is one supplied by the Privoxy developers
175     via SourceForge, or if you got your copy somewhere else.
176
177   * Whether you are using Privoxy together with another proxy such as Tor. If
178     so, please temporary disable the other proxy to see if the symptoms change.
179
180   * Whether you are using a personal firewall product. If so, does Privoxy work
181     without it?
182
183   * Any other pertinent information to help identify the problem such as config
184     or log file excerpts (yes, you should have log file entries for each action
185     taken). To get a meaningful logfile, please make sure that the logfile
186     directive is being used and the following debug options are enabled (all of
187     them):
188
189     debug     1 # Log the destination for each request Privoxy let through.
190                 #   See also debug 1024.
191     debug     2 # show each connection status
192     debug     4 # show I/O status
193     debug     8 # show header parsing
194     debug   128 # debug redirects
195     debug   256 # debug GIF de-animation
196     debug   512 # Common Log Format
197     debug  1024 # Log the destination for requests Privoxy didn't let through,
198                 #   and the reason why.
199     debug  4096 # Startup banner and warnings.
200     debug  8192 # Non-fatal errors
201     debug 65536 # Log applying actions
202
203     If you are having trouble with a filter, please additionally enable
204
205     debug    64 # debug regular expression filters
206
207     If you suspect that Privoxy interprets the request or the response
208     incorrectly, please enable
209
210     debug 32768 # log all data read from the network
211
212     It's easy for us to ignore log messages that aren't relevant but missing
213     log messages may make it impossible to investigate a problem. If you aren't
214     sure which of the debug directives are relevant, please just enable all of
215     them and let us worry about it.
216
217     Note that Privoxy log files may contain sensitive information so please
218     don't submit any logfiles you didn't read first. You can mask sensitive
219     information as long as it's clear that you removed something.
220
221 You don't have to tell us your actual name when filing a problem report, but if
222 you don't, please use a nickname so we can differentiate between your messages
223 and the ones entered by other "anonymous" users that may respond to your
224 request if they have the same problem or already found a solution. Note that
225 due to spam the trackers may not always allow to post without being logged into
226 SourceForge. If that's the case, you are still free to create a login that
227 isn't directly linked to your name, though.
228
229 Please also check the status of your request a few days after submitting it, as
230 we may request additional information. If you use a SF id, you should
231 automatically get a mail when someone responds to your request. Please don't
232 bother to add an email address when using the tracker. If you prefer to
233 communicate through email, just use one of the mailing lists directly.
234
235 If you are new to reporting problems, you might be interested in How to Report
236 Bugs Effectively.
237
238 The appendix of the Privoxy User Manual also has helpful information on
239 understanding actions, and action debugging.
240
241 -------------------------------------------------------------------------------
242
243 6.2. Get Support
244
245 All users are welcome to discuss their issues on the users mailing list, where
246 the developers also hang around.
247
248 Please don't send private support requests to individual Privoxy developers,
249 either use the mailing lists or the support trackers.
250
251 If you have to contact a Privoxy developer directly for other reasons, please
252 send a real mail and do not bother with SourceForge's messaging system. Answers
253 to SourceForge messages are usually bounced by SourceForge's mail server in
254 which case the developer wasted time writing a response you don't get. From
255 your point of view it will look like your message has been completely ignored,
256 so this is frustrating for all parties involved.
257
258 Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
259 addresses have to be accepted manually by a moderator. This may cause a delay
260 of several days and if you use a subject that doesn't clearly mention Privoxy
261 or one of its features, your message may be accidentally discarded as spam.
262
263 If you aren't subscribed, you should therefore spend a few seconds to come up
264 with a proper subject. Additionally you should make it clear that you want to
265 get CC'd. Otherwise some responses will be directed to the mailing list only,
266 and you won't see them.
267
268 -------------------------------------------------------------------------------
269
270 6.3. Reporting Problems
271
272 "Problems" for our purposes, come in two forms:
273
274   * Configuration issues, such as ads that slip through, or sites that don't
275     function properly due to one Privoxy "action" or another being turned "on".
276
277   * "Bugs" in the programming code that makes up Privoxy, such as that might
278     cause a crash. Documentation issues, for example spelling errors and
279     unclear descriptions, are bugs, too.
280
281 -------------------------------------------------------------------------------
282
283 6.3.1. Reporting Ads or Other Configuration Problems
284
285 Please send feedback on ads that slipped through, innocent images that were
286 blocked, sites that don't work properly, and other configuration related
287 problem of default.action file, to https://sourceforge.net/tracker/?group_id=
288 11118&atid=460288, the Actions File Tracker.
289
290 -------------------------------------------------------------------------------
291
292 6.3.2. Reporting Bugs
293
294 Before reporting bugs, please make sure that the bug has not already been
295 submitted and observe the additional hints at the top of the submit form. If
296 already submitted, please feel free to add any info to the original report that
297 might help to solve the issue.
298
299 -------------------------------------------------------------------------------
300
301 6.4. Reporting security problems
302
303 If you discovered a security problem or merely suspect that a bug might be a
304 security issue, please mail Fabian Keil <fk@fabiankeil.de> (OpenPGP
305 fingerprint: 4F36 C17F 3816 9136 54A1 E850 6918 2291 8BA2 371C).
306
307 Usually you should get a response within a day, otherwise it's likely that
308 either your mail or the response didn't make it. If that happens, please mail
309 to the developer list to request a status update.
310
311 -------------------------------------------------------------------------------
312
313 6.5. Mailing Lists
314
315 If you prefer to communicate through email, instead of using a web interface,
316 feel free to use one of the mailing lists. To discuss issues that haven't been
317 completely diagnosed yet, please use the Privoxy users list. Technically
318 interested users and people who wish to contribute to the project are always
319 welcome on the developers list. You can find an overview of all Privoxy-related
320 mailing lists, including list archives, at: https://lists.privoxy.org/mailman/
321 listinfo. The lists hosted on privoxy.org have been created in 2016, the
322 previously-used lists hosted at SourceForge are deprecated but the archives may
323 still be useful: https://sourceforge.net/mail/?group_id=11118.
324
325 -------------------------------------------------------------------------------
326
327 6.6. SourceForge support trackers
328
329 The SourceForge support trackers may be used as well, but have various
330 technical problems that are unlikely to be fixed anytime soon. If you don't get
331 a timely response, please try the mailing list as well.
332