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-2009 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 the development version of Privoxy 3.0.15. See
  36 http://www.privoxy.org/ for more information. The current code maturity level
  37 is "beta", 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 and licensed under the GPL2.
  49
  50 Privoxy is an associated project of Software in the Public Interest (SPI).
  51 Donations are welcome.
  52
  53 -------------------------------------------------------------------------------
  54
  55 1. IMPORTANT CHANGES
  56
  57 October 2009, Privoxy 3.0.15 beta is released.
  58
  59 This is a bugfix-release for the previous betas which introduced IPv6 support,
  60 improved keep-alive support and a bunch of minor improvements. See the
  61 "ChangeLog", and the "What's New" section and the "Upgrader's Notes" in the
  62 User Manual for details.
  63
  64 Depending on the feedback it will be either followed by yet another beta
  65 release, or by a stable release with the same feature set.
  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 Or Debian and Ubuntu: /etc/init.d/privoxy start
  89
  90 -------------------------------------------------------------------------------
  91
  92 4. CONFIGURATION
  93
  94 See: 'config', 'default.action', 'user.action', 'default.filter', and
  95 'user.filter'. 'user.action' and 'user.filter' are for personal and local
  96 configuration preferences. These are all well commented. Most of the magic is
  97 in '*.action' files. 'user.action' should be used for any actions
  98 customizations. On Unix-like systems, these files are typically installed in /
  99 etc/privoxy. On Windows, then wherever the executable itself is installed.
 100 There are many significant changes and advances from earlier versions. The User
 101 Manual has an explanation of all configuration options, and examples: http://
 102 www.privoxy.org/user-manual/.
 103
 104 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
 105 you specify in the config file under 'listen-address'. DEFAULT is
 106 localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not
 107 try it with FTP or other protocols for the simple reason it does not work.
 108
 109 The actions list can be configured via the web interface accessed via http://
 110 p.p/, as well other options.
 111
 112 All configuration files are subject to unannounced changes during the
 113 development process.
 114
 115 -------------------------------------------------------------------------------
 116
 117 5. DOCUMENTATION
 118
 119 There should be documentation in the 'doc' subdirectory, but it may not be
 120 completed at this point. In particular, see the User Manual there, the FAQ, and
 121 those interested in Privoxy development, should look at developer-manual.
 122
 123 The most up to date source of information on the current development version,
 124 may still be either comments in the source code, or the included configuration
 125 files. The source and configuration files are all well commented. The main
 126 configuration files are: 'config', 'default.action', and 'default.filter' in
 127 the top-level source directory.
 128
 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,
 131 or can't find it.
 132
 133 -------------------------------------------------------------------------------
 134
 135 6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 136
 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:
 140
 141 -------------------------------------------------------------------------------
 142
 143 6.1. Get Support
 144
 145 For casual users, our support forum at SourceForge is probably best suited:
 146 http://sourceforge.net/tracker/?group_id=11118&atid=211118
 147
 148 All users are of course welcome to discuss their issues on the users mailing
 149 list, where the developers also hang around.
 150
 151 Please don't sent private support requests to individual Privoxy developers,
 152 either use the mailing lists or the support trackers.
 153
 154 Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
 155 addresses have to be accepted manually by a moderator. This may cause a delay
 156 of several days and if you use a subject that doesn't clearly mention Privoxy
 157 or one of its features, your message may be accidentally discarded as spam.
 158
 159 If you aren't subscribed, you should therefore spend a few seconds to come up
 160 with a proper subject. Additionally you should make it clear that you want to
 161 get CC'd. Otherwise some responses will be directed to the mailing list only,
 162 and you won't see them.
 163
 164 -------------------------------------------------------------------------------
 165
 166 6.2. Reporting Problems
 167
 168 "Problems" for our purposes, come in two forms:
 169
 170   * Configuration issues, such as ads that slip through, or sites that don't
 171     function properly due to one Privoxy "action" or another being turned "on".
 172
 173   * "Bugs" in the programming code that makes up Privoxy, such as that might
 174     cause a crash.
 175
 176 -------------------------------------------------------------------------------
 177
 178 6.2.1. Reporting Ads or Other Configuration Problems
 179
 180 Please send feedback on ads that slipped through, innocent images that were
 181 blocked, sites that don't work properly, and other configuration related
 182 problem of default.action file, to http://sourceforge.net/tracker/?group_id=
 183 11118&atid=460288, the Actions File Tracker.
 184
 185 New, improved default.action files may occasionally be made available based on
 186 your feedback. These will be announced on the ijbswa-announce list and
 187 available from our the files section of our project page.
 188
 189 -------------------------------------------------------------------------------
 190
 191 6.2.2. Reporting Bugs
 192
 193 Please report all bugs through our bug tracker: http://sourceforge.net/tracker
 194 /?group_id=11118&atid=111118.
 195
 196 Before doing so, please make sure that the bug has not already been submitted
 197 and observe the additional hints at the top of the submit form. If already
 198 submitted, please feel free to add any info to the original report that might
 199 help to solve the issue.
 200
 201 Please try to verify that it is a Privoxy bug, and not a browser or site bug or
 202 documented behaviour that just happens to be different than what you expected.
 203 If unsure, try toggling off Privoxy, and see if the problem persists.
 204
 205 If you are using your own custom configuration, please try the stock configs to
 206 see if the problem is configuration related. If you're having problems with a
 207 feature that is disabled by default, please ask around on the mailing list if
 208 others can reproduce the problem.
 209
 210 If you aren't using the latest Privoxy version, the bug may have been found and
 211 fixed in the meantime. We would appreciate if you could take the time to
 212 upgrade to the latest version (or even the latest CVS snapshot) and verify that
 213 your bug still exists.
 214
 215 Please be sure to provide the following information:
 216
 217   * The exact Privoxy version you are using (if you got the source from CVS,
 218     please also provide the source code revisions as shown in http://
 219     config.privoxy.org/show-version).
 220
 221   * The operating system and versions you run Privoxy on, (e.g. Windows XP
 222     SP2), if you are using a Unix flavor, sending the output of "uname -a"
 223     should do, in case of GNU/Linux, please also name the distribution.
 224
 225   * The name, platform, and version of the browser you were using (e.g.
 226     Internet Explorer v5.5 for Mac).
 227
 228   * The URL where the problem occurred, or some way for us to duplicate the
 229     problem (e.g. http://somesite.example.com/?somethingelse=123).
 230
 231   * Whether your version of Privoxy is one supplied by the Privoxy developers
 232     via SourceForge, or if you got your copy somewhere else.
 233
 234   * Whether you are using Privoxy in tandem with another proxy such as Tor. If
 235     so, please temporary disable the other proxy to see if the symptoms change.
 236
 237   * Whether you are using a personal firewall product. If so, does Privoxy work
 238     without it?
 239
 240   * Any other pertinent information to help identify the problem such as config
 241     or log file excerpts (yes, you should have log file entries for each action
 242     taken).
 243
 244 You don't have to tell us your actual name when filing a problem report, but
 245 please use a nickname so we can differentiate between your messages and the
 246 ones entered by other "anonymous" users that may respond to your request if
 247 they have the same problem or already found a solution.
 248
 249 Please also check the status of your request a few days after submitting it, as
 250 we may request additional information. If you use a SF id, you should
 251 automatically get a mail when someone responds to your request.
 252
 253 The appendix of the Privoxy User Manual also has helpful information on
 254 understanding actions, and action debugging.
 255
 256 -------------------------------------------------------------------------------
 257
 258 6.3. Request New Features
 259
 260 You are welcome to submit ideas on new features or other proposals for
 261 improvement through our feature request tracker at http://sourceforge.net/
 262 tracker/?atid=361118&group_id=11118.
 263
 264 -------------------------------------------------------------------------------
 265
 266 6.4. Other
 267
 268 For any other issues, feel free to use the mailing lists. Technically
 269 interested users and people who wish to contribute to the project are also
 270 welcome on the developers list! You can find an overview of all Privoxy-related
 271 mailing lists, including list archives, at: http://sourceforge.net/mail/?
 272 group_id=11118.
 273