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