README

   1 /*********************************************************************
   2  *
   3  * File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
   4  *
   5  * Purpose     :  README file to give a short intro.
   6  *
   7  * Copyright   :  Written by and Copyright (C) 2001-2010 the
   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.,
  30  *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  31  *                USA
  32  *
  33  *********************************************************************/
  34
  35 This README is included with Privoxy 3.0.16. See http://www.privoxy.org/ for
  36 more information. The current code maturity level is "stable".
  37
  38 -------------------------------------------------------------------------------
  39
  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
  45 networks.
  46
  47 Privoxy is Free Software and licensed under the GPL2.
  48
  49 Privoxy is an associated project of Software in the Public Interest (SPI).
  50 Donations are welcome.
  51
  52 -------------------------------------------------------------------------------
  53
  54 1. IMPORTANT CHANGES
  55
  56 February 2010, Privoxy 3.0.16 stable is released.
  57
  58 This is the first stable release since 3.0.12. It mainly contains bugfixes for
  59 the previous betas which introduced IPv6 support, improved keep-alive support
  60 and a bunch of minor improvements. See the "ChangeLog", and the "What's New"
  61 section and the "Upgrader's Notes" in the User Manual for details.
  62
  63 -------------------------------------------------------------------------------
  64
  65 2. INSTALL
  66
  67 See the INSTALL file in this directory, for installing from raw source, and the
  68 User Manual, for all other installation types.
  69
  70 -------------------------------------------------------------------------------
  71
  72 3. RUN
  73
  74 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
  75 [.GROUP]] [--chroot] [--pre-chroot-nslookup HOSTNAME ][config_file]
  76
  77 See the man page or User Manual for an explanation of each option, and other
  78 configuration and usage issues.
  79
  80 If no config_file is specified on the command line, Privoxy will look for a
  81 file named 'config' in the current directory (except Win32 which will look for
  82 'config.txt'). If no config_file is found, Privoxy will fail to start.
  83
  84 Or Debian and Ubuntu: /etc/init.d/privoxy start
  85
  86 -------------------------------------------------------------------------------
  87
  88 4. CONFIGURATION
  89
  90 See: 'config', 'default.action', 'user.action', 'default.filter', and
  91 'user.filter'. 'user.action' and 'user.filter' are for personal and local
  92 configuration preferences. These are all well commented. Most of the magic is
  93 in '*.action' files. 'user.action' should be used for any actions
  94 customizations. On Unix-like systems, these files are typically installed in /
  95 etc/privoxy. On Windows, then wherever the executable itself is installed.
  96 There are many significant changes and advances from earlier versions. The User
  97 Manual has an explanation of all configuration options, and examples: http://
  98 www.privoxy.org/user-manual/.
  99
 100 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
 101 you specify in the config file under 'listen-address'. DEFAULT is
 102 localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not
 103 try it with FTP or other protocols for the simple reason it does not work.
 104
 105 The actions list can be configured via the web interface accessed via http://
 106 p.p/, as well other options.
 107
 108 -------------------------------------------------------------------------------
 109
 110 5. DOCUMENTATION
 111
 112 There should be documentation in the 'doc' subdirectory. In particular, see the
 113 User Manual there, the FAQ, and those interested in Privoxy development, should
 114 look at developer-manual.
 115
 116 The source and configuration files are all well commented. The main
 117 configuration files are: 'config', 'default.action', and 'default.filter'.
 118
 119 Included documentation may vary according to platform and packager. All
 120 documentation is posted on http://www.privoxy.org, in case you don't have it,
 121 or can't find it.
 122
 123 -------------------------------------------------------------------------------
 124
 125 6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 126
 127 We value your feedback. In fact, we rely on it to improve Privoxy and its
 128 configuration. However, please note the following hints, so we can provide you
 129 with the best support:
 130
 131 -------------------------------------------------------------------------------
 132
 133 6.1. Get Support
 134
 135 For casual users, our support forum at SourceForge is probably best suited:
 136 http://sourceforge.net/tracker/?group_id=11118&atid=211118
 137
 138 All users are of course welcome to discuss their issues on the users mailing
 139 list, where the developers also hang around.
 140
 141 Please don't sent private support requests to individual Privoxy developers,
 142 either use the mailing lists or the support trackers.
 143
 144 Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
 145 addresses have to be accepted manually by a moderator. This may cause a delay
 146 of several days and if you use a subject that doesn't clearly mention Privoxy
 147 or one of its features, your message may be accidentally discarded as spam.
 148
 149 If you aren't subscribed, you should therefore spend a few seconds to come up
 150 with a proper subject. Additionally you should make it clear that you want to
 151 get CC'd. Otherwise some responses will be directed to the mailing list only,
 152 and you won't see them.
 153
 154 -------------------------------------------------------------------------------
 155
 156 6.2. Reporting Problems
 157
 158 "Problems" for our purposes, come in two forms:
 159
 160   * Configuration issues, such as ads that slip through, or sites that don't
 161     function properly due to one Privoxy "action" or another being turned "on".
 162
 163   * "Bugs" in the programming code that makes up Privoxy, such as that might
 164     cause a crash.
 165
 166 -------------------------------------------------------------------------------
 167
 168 6.2.1. Reporting Ads or Other Configuration Problems
 169
 170 Please send feedback on ads that slipped through, innocent images that were
 171 blocked, sites that don't work properly, and other configuration related
 172 problem of default.action file, to http://sourceforge.net/tracker/?group_id=
 173 11118&atid=460288, the Actions File Tracker.
 174
 175 New, improved default.action files may occasionally be made available based on
 176 your feedback. These will be announced on the ijbswa-announce list and
 177 available from our the files section of our project page.
 178
 179 -------------------------------------------------------------------------------
 180
 181 6.2.2. Reporting Bugs
 182
 183 Please report all bugs through our bug tracker: http://sourceforge.net/tracker
 184 /?group_id=11118&atid=111118.
 185
 186 Before doing so, please make sure that the bug has not already been submitted
 187 and observe the additional hints at the top of the submit form. If already
 188 submitted, please feel free to add any info to the original report that might
 189 help to solve the issue.
 190
 191 Please try to verify that it is a Privoxy bug, and not a browser or site bug or
 192 documented behaviour that just happens to be different than what you expected.
 193 If unsure, try toggling off Privoxy, and see if the problem persists.
 194
 195 If you are using your own custom configuration, please try the stock configs to
 196 see if the problem is configuration related. If you're having problems with a
 197 feature that is disabled by default, please ask around on the mailing list if
 198 others can reproduce the problem.
 199
 200 If you aren't using the latest Privoxy version, the bug may have been found and
 201 fixed in the meantime. We would appreciate if you could take the time to
 202 upgrade to the latest version (or even the latest CVS snapshot) and verify that
 203 your bug still exists.
 204
 205 Please be sure to provide the following information:
 206
 207   * The exact Privoxy version you are using (if you got the source from CVS,
 208     please also provide the source code revisions as shown in http://
 209     config.privoxy.org/show-version).
 210
 211   * The operating system and versions you run Privoxy on, (e.g. Windows XP
 212     SP2), if you are using a Unix flavor, sending the output of "uname -a"
 213     should do, in case of GNU/Linux, please also name the distribution.
 214
 215   * The name, platform, and version of the browser you were using (e.g.
 216     Internet Explorer v5.5 for Mac).
 217
 218   * The URL where the problem occurred, or some way for us to duplicate the
 219     problem (e.g. http://somesite.example.com/?somethingelse=123).
 220
 221   * Whether your version of Privoxy is one supplied by the Privoxy developers
 222     via SourceForge, or if you got your copy somewhere else.
 223
 224   * Whether you are using Privoxy in tandem with another proxy such as Tor. If
 225     so, please temporary disable the other proxy to see if the symptoms change.
 226
 227   * Whether you are using a personal firewall product. If so, does Privoxy work
 228     without it?
 229
 230   * Any other pertinent information to help identify the problem such as config
 231     or log file excerpts (yes, you should have log file entries for each action
 232     taken). To get a meaningful logfile, please make sure that the logfile
 233     directive is being used and the following debug options are enabled:
 234
 235     debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
 236     debug     2 # show each connection status
 237     debug     4 # show I/O status
 238     debug     8 # show header parsing
 239     debug   128 # debug redirects
 240     debug   256 # debug GIF de-animation
 241     debug   512 # Common Log Format
 242     debug  1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
 243     debug  4096 # Startup banner and warnings.
 244     debug  8192 # Non-fatal errors
 245
 246     If you are having trouble with a filter, please additionally enable
 247
 248     debug    64 # debug regular expression filters
 249
 250     Note that Privoxy log files may contain sensitive information so please
 251     don't submit any logfiles you didn't read first. You can mask sensitive
 252     information as long as it's clear that you removed something.
 253
 254 You don't have to tell us your actual name when filing a problem report, but if
 255 you don't, please use a nickname so we can differentiate between your messages
 256 and the ones entered by other "anonymous" users that may respond to your
 257 request if they have the same problem or already found a solution.
 258
 259 Please also check the status of your request a few days after submitting it, as
 260 we may request additional information. If you use a SF id, you should
 261 automatically get a mail when someone responds to your request.
 262
 263 The appendix of the Privoxy User Manual also has helpful information on
 264 understanding actions, and action debugging.
 265
 266 -------------------------------------------------------------------------------
 267
 268 6.3. Request New Features
 269
 270 You are welcome to submit ideas on new features or other proposals for
 271 improvement through our feature request tracker at http://sourceforge.net/
 272 tracker/?atid=361118&group_id=11118.
 273
 274 -------------------------------------------------------------------------------
 275
 276 6.4. Other
 277
 278 For any other issues, feel free to use the mailing lists. Technically
 279 interested users and people who wish to contribute to the project are also
 280 welcome on the developers list! You can find an overview of all Privoxy-related
 281 mailing lists, including list archives, at: http://sourceforge.net/mail/?
 282 group_id=11118.
 283