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