README

   1 /*********************************************************************
   2  *
   3  * File        :  $Source: /cvsroot/ijbswa/current/README,v $
   4  *
   5  * Purpose     :  README file to give a short intro.
   6  *
   7  * Copyright   :  Written by and Copyright (C) 2001 - 2007  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 2007-11-03: The next stable release of Privoxy is being readied. The
  36 developers consider the current sources to stable, and are doing last minute
  37 house keeping and fine tuning. The are many new features and enhancements
  38 many of which may not be fully documented at this point. Please refer to the
  39 ChangeLog for what's new.
  40
  41 And PLEASE report any problems or comments!
  42
  43 -------------------------------------------------------------------------------
  44
  45 Privoxy is a web proxy with advanced filtering capabilities for protecting
  46 privacy, modifying web page data, managing cookies, controlling access, and
  47 removing ads, banners, pop-ups and other obnoxious Internet junk. Privoxy has a
  48 very flexible configuration and can be customized to suit individual needs and
  49 tastes. Privoxy has application for both stand-alone systems and multi-user
  50 networks.
  51
  52 Privoxy is based on Internet Junkbuster (tm).
  53
  54 -------------------------------------------------------------------------------
  55
  56 1. IMPORTANT CHANGES
  57
  58 NEWS! November 2006, Privoxy 3.0.6 is released. This is a significant upgrade
  59 with many new and enhanced features, and many bugs fixed. It is also the first
  60 stable release in quite some time. There are fifteen new actions available, and
  61 several actions have enhanced capabilities. Multiple filter files are now
  62 supported as well. There are many improvements and refinements. See the "What's
  63 New" section and the "Upgrader's Notes" in the User Manual for details and
  64 specifics. Preliminary work on 3.0.7 is already underway.
  65
  66 NEWS! September 2006, Privoxy 3.0.5 BETA is released. This is a significant
  67 upgrade with many new and enhanced features, and many bugs fixed.
  68
  69 There was and will not be an official 3.0.4 release. This release cycle was
  70 used to gather our thoughts, play with some new ideas and refine some old ones.
  71 It will remain a development cycle with no actual release. 3.0.5 is the fruit
  72 of these efforts.
  73
  74 NEWS! January 2004, Privoxy 3.0.3 is released. This is the another maintenance
  75 release of Privoxy which fixes more bugs, further refines the configuration and
  76 works around some known third-party problems. See the ChangeLog for complete
  77 details. Upgrading from 3.0.2 is recommended.
  78
  79 -------------------------------------------------------------------------------
  80
  81 2. INSTALL
  82
  83 See the INSTALL file in this directory, for installing from raw source, and the
  84 User Manual, for all other installation types.
  85
  86 -------------------------------------------------------------------------------
  87
  88 3. RUN
  89
  90 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
  91 [.GROUP]] [--chroot] [config_file]
  92
  93 See the man page or User Manual for an explanation of each option, and other
  94 configuration and usage issues.
  95
  96 If no config_file is specified on the command line, Privoxy will look for a
  97 file named 'config' in the current directory (except Win32 which will look for
  98 'config.txt'). If no config_file is found, Privoxy will fail to 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 localhost:
 116 8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
 117 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 -------------------------------------------------------------------------------
 156
 157 6.2. Reporting Problems
 158
 159 "Problems" for our purposes, come in two forms:
 160
 161   * Configuration issues, such as ads that slip through, or sites that don't
 162     function properly due to one Privoxy "action" or another being turned "on".
 163
 164   * "Bugs" in the programming code that makes up Privoxy, such as that might
 165     cause a crash.
 166
 167 -------------------------------------------------------------------------------
 168
 169 6.2.1. Reporting Ads or Other Configuration Problems
 170
 171 Please send feedback on ads that slipped through, innocent images that were
 172 blocked, sites that don't work properly, and other configuration related
 173 problem of default.action file, to http://sourceforge.net/tracker/?group_id=
 174 11118&atid=460288, the Actions File Tracker.
 175
 176 New, improved default.action files may occasionally be made available based on
 177 your feedback. These will be announced on the ijbswa-announce list and
 178 available from our the files section of our project page.
 179
 180 -------------------------------------------------------------------------------
 181
 182 6.2.2. Reporting Bugs
 183
 184 Please report all bugs only through our bug tracker: http://sourceforge.net/
 185 tracker/?group_id=11118&atid=111118.
 186
 187 Before doing so, please make sure that the bug has not already been submitted
 188 and observe the additional hints at the top of the submit form. If already
 189 submitted, please feel free to add any info to the original report that might
 190 help to solve the issue.
 191
 192 Please try to verify that it is a Privoxy bug, and not a browser or site bug
 193 first. If unsure, try toggling off Privoxy, and see if the problem persists. If
 194 you are using your own custom configuration, please try the stock configs to
 195 see if the problem is configuration related.
 196
 197 If not using the latest version, the bug may have been found and fixed in the
 198 meantime. We would appreciate if you could take the time to upgrade to the
 199 latest version (or even the latest CVS snapshot) and verify your bug.
 200
 201 Please be sure to provide the following information:
 202
 203   * The exact Privoxy version of the proxy software (if you got the source from
 204     CVS, please also provide the source code revisions as shown in http://
 205     config.privoxy.org/show-version).
 206
 207   * The operating system and versions you run Privoxy on, (e.g. Windows XP
 208     SP2), if you are using a Unix flavor, sending the output of "uname -a"
 209     should do.
 210
 211   * The name, platform, and version of the browser you were using (e.g.
 212     Internet Explorer v5.5 for Mac).
 213
 214   * The URL where the problem occurred, or some way for us to duplicate the
 215     problem (e.g. http://somesite.example.com/?somethingelse=123).
 216
 217   * Whether your version of Privoxy is one supplied by the developers of
 218     Privoxy via SourceForge, or somewhere else.
 219
 220   * Whether you are using Privoxy in tandem with another proxy such as Tor. If
 221     so, please try disabling the other proxy.
 222
 223   * Whether you are using a personal firewall product. If so, does Privoxy work
 224     without it?
 225
 226   * Any other pertinent information to help identify the problem such as config
 227     or log file excerpts (yes, you should have log file entries for each action
 228     taken).
 229
 230   * Please provide your SF login, or email address, in case we need to contact
 231     you.
 232
 233 The appendix of the Privoxy User Manual also has helpful information on
 234 understanding actions, and action debugging.
 235
 236 -------------------------------------------------------------------------------
 237
 238 6.3. Request New Features
 239
 240 You are welcome to submit ideas on new features or other proposals for
 241 improvement through our feature request tracker at http://sourceforge.net/
 242 tracker/?atid=361118&group_id=11118.
 243
 244 -------------------------------------------------------------------------------
 245
 246 6.4. Other
 247
 248 For any other issues, feel free to use the mailing lists. Technically
 249 interested users and people who wish to contribute to the project are also
 250 welcome on the developers list! You can find an overview of all Privoxy-related
 251 mailing lists, including list archives, at: http://sourceforge.net/mail/?
 252 group_id=11118.
 253