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