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 - 2006  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.5. 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 web proxy with advanced filtering capabilities for protecting
  42 privacy, modifying web page data, managing cookies, controlling access, and
  43 removing ads, banners, pop-ups and other obnoxious Internet junk. Privoxy has a
  44 very flexible configuration and can be customized to suit individual needs and
  45 tastes. Privoxy has application for both stand-alone systems and multi-user
  46 networks.
  47
  48 Privoxy is based on Internet Junkbuster (tm).
  49
  50 -------------------------------------------------------------------------------
  51
  52 1. IMPORTANT CHANGES
  53
  54 BIG NEWS! September 2006, Privoxy 3.0.5 is released. This is a significant
  55 upgrade with many new and enhanced features, and many bugs fixed. There are
  56 fifteen new actions available, and several actions have enhanced capabilities.
  57 Multiple filter files are now supported as well. See the "What's New" section
  58 and the "Upgrader's Notes" in the User Manual for details and specifics.
  59
  60 There was and will not be an official 3.0.4 release. This release cycle was
  61 used to gather our thoughts, play with some new ideas and refine some old ones.
  62 It will remain a development cycle with no actual release. 3.0.5 is the fruit
  63 of these efforts.
  64
  65 NEWS! January 2004, Privoxy 3.0.3 is released. This is the another maintenance
  66 release of Privoxy which fixes more bugs, further refines the configuration and
  67 works around some known third-party problems. See the ChangeLog for complete
  68 details. Upgrading from 3.0.2 is recommended.
  69
  70 -------------------------------------------------------------------------------
  71
  72 2. INSTALL
  73
  74 See the INSTALL file in this directory, for installing from raw source, and the
  75 User Manual, for all other installation types.
  76
  77 -------------------------------------------------------------------------------
  78
  79 3. RUN
  80
  81 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
  82 [.GROUP]] [--chroot] [config_file]
  83
  84 See the man page or User Manual for an explanation of each option, and other
  85 configuration and usage issues.
  86
  87 If no config_file is specified on the command line, Privoxy will look for a
  88 file named 'config' in the current directory (except Win32 which will look for
  89 'config.txt'). If no config_file is found, Privoxy will fail to start.
  90
  91 Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start
  92
  93 Or Debian: /etc/init.d/privoxy start
  94
  95 -------------------------------------------------------------------------------
  96
  97 4. CONFIGURATION
  98
  99 See: 'config', 'default.action', 'user.action', 'default.filter', and
 100 'user.filter'. 'user.action' and 'user.filter' are for personal and local
 101 configuration preferences. These are all well commented. Most of the magic is
 102 in '*.action' files. 'user.action' should be used for any actions
 103 customizations. On Unix-like systems, these files are typically installed in /
 104 etc/privoxy. On Windows, then wherever the executable itself is installed.
 105 There are many significant changes and advances from earlier versions. The User
 106 Manual has an explanation of all configuration options, and examples: http://
 107 www.privoxy.org/user-manual/.
 108
 109 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
 110 you specify in the config file under 'listen-address'. DEFAULT is localhost:
 111 8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
 112 with FTP or other protocols for the simple reason it does not work.
 113
 114 The actions list can be configured via the web interface accessed via http://
 115 p.p/, as well other options.
 116
 117 All configuration files are subject to unannounced changes during the
 118 development process.
 119
 120 -------------------------------------------------------------------------------
 121
 122 5. DOCUMENTATION
 123
 124 There should be documentation in the 'doc' subdirectory, but it may not be
 125 completed at this point. In particular, see the User Manual there, the FAQ, and
 126 those interested in Privoxy development, should look at developer-manual.
 127
 128 The most up to date source of information on the current development version,
 129 may still be either comments in the source code, or the included configuration
 130 files. The source and configuration files are all well commented. The main
 131 configuration files are: 'config', 'default.action', and 'default.filter' in
 132 the top-level source directory.
 133
 134 Included documentation may vary according to platform and packager. All
 135 documentation is posted on http://www.privoxy.org, in case you don't have it,
 136 or can't find it.
 137
 138 -------------------------------------------------------------------------------
 139
 140 6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 141
 142 We value your feedback. In fact, we rely on it to improve Privoxy and its
 143 configuration. However, please note the following hints, so we can provide you
 144 with the best support:
 145
 146 -------------------------------------------------------------------------------
 147
 148 6.1. Get Support
 149
 150 For casual users, our support forum at SourceForge is probably best suited:
 151 http://sourceforge.net/tracker/?group_id=11118&atid=211118
 152
 153 All users are of course welcome to discuss their issues on the users mailing
 154 list, where the developers also hang around.
 155
 156 -------------------------------------------------------------------------------
 157
 158 6.2. Reporting Problems
 159
 160 "Problems" for our purposes, come in two forms:
 161
 162   * Configuration issues, such as ads that slip through, or sites that don't
 163     function properly due to one Privoxy "action" or another being turned "on".
 164
 165   * "Bugs" in the programming code that makes up Privoxy, such as that might
 166     cause a crash.
 167
 168 -------------------------------------------------------------------------------
 169
 170 6.2.1. Reporting Ads or Other Configuration Problems
 171
 172 Please send feedback on ads that slipped through, innocent images that were
 173 blocked, sites that don't work properly, and other configuration related
 174 problem of default.action file, to http://sourceforge.net/tracker/?group_id=
 175 11118&atid=460288, the Actions File Tracker.
 176
 177 New, improved default.action files may occasionally be made available based on
 178 your feedback. These will be announced on the ijbswa-announce list and
 179 available from our the files section of our project page.
 180
 181 -------------------------------------------------------------------------------
 182
 183 6.2.2. Reporting Bugs
 184
 185 Please report all bugs only through our bug tracker: http://sourceforge.net/
 186 tracker/?group_id=11118&atid=111118.
 187
 188 Before doing so, please make sure that the bug has not already been submitted
 189 and observe the additional hints at the top of the submit form. If already
 190 submitted, please feel free to add any info to the original report that might
 191 help solve the issue.
 192
 193 Please try to verify that it is a Privoxy bug, and not a browser or site bug
 194 first. If unsure, try toggling off Privoxy, and see if the problem persists. If
 195 you are using your own custom configuration, please try the stock configs to
 196 see if the problem is configuration related.
 197
 198 If not using the latest version, the bug may have been found and fixed in the
 199 meantime. We would appreciate if you could take the time to upgrade to the
 200 latest version (or even the latest CVS snapshot) and verify your bug.
 201
 202 Please be sure to provide the following information:
 203
 204   * The exact Privoxy version of the proxy software (if you got the source from
 205     CVS, please also give the date).
 206
 207   * The operating system and versions you run Privoxy on, (e.g. Windows XP).
 208
 209   * The name, platform, and version of the browser you were using (e.g.
 210     Internet Explorer v5.5 for Mac).
 211
 212   * The URL where the problem occurred, or some way for us to duplicate the
 213     problem (e.g. http://somesite.example.com?somethingelse=123).
 214
 215   * Whether your version of Privoxy is one supplied by the developers of
 216     Privoxy via SourceForge, or somewhere else.
 217
 218   * Whether you are using Privoxy in tandem with another proxy such as TOR. If
 219     so, please try disabling the other proxy.
 220
 221   * Whether you are using a personal firewall product. If so, does Privoxy work
 222     without it?
 223
 224   * Any other pertinent information to help identify the problem such as config
 225     or log file excerpts (yes, you should have log file entries for each action
 226     taken).
 227
 228   * Please provide your SF login, or email address, in case we need to contact
 229     you.
 230
 231 The appendix of the user manual also has helpful information on understanding
 232 actions, and action debugging.
 233
 234 -------------------------------------------------------------------------------
 235
 236 6.3. Request New Features
 237
 238 You are welcome to submit ideas on new features or other proposals for
 239 improvement through our feature request tracker at http://sourceforge.net/
 240 tracker/?atid=361118&group_id=11118.
 241
 242 -------------------------------------------------------------------------------
 243
 244 6.4. Other
 245
 246 For any other issues, feel free to use the mailing lists. Technically
 247 interested users and people who wish to contribute to the project are also
 248 welcome on the developers list! You can find an overview of all Privoxy-related
 249 mailing lists, including list archives, at: http://sourceforge.net/mail/?
 250 group_id=11118.
 251