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,2002 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., 59
  30  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  31  *
  32  *********************************************************************/
  33
  34 This README is included with the development version of Privoxy 3.1.1, which
  35 will someday become Privoxy v3.2. See http://www.privoxy.org/ for more
  36 information. The current code level is technically alpha, but is not yet
  37 significantly different from the 3.0.0 stable branch at this time (other
  38 than more bugs).
  39
  40 There is not much reason to actually run this branch unless you want to help
  41 chase bugs, or with development.
  42
  43 -------------------------------------------------------------------------------
  44
  45 Privoxy is a web proxy with advanced filtering capabilities for protecting
  46 privacy, filtering web page content, 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 REALLY BIG NEWS! August 2002: The long-awaited, oft-delayed stable version of
  59 Privoxy 3.0 is finally released! This is way behind schedule, but better late
  60 than never. The developers all hope the wait was worth it.
  61
  62 NEWS! As of 03/24/02, the name of this project has been changed from ijbswa/
  63 Junkbuster to Privoxy. This is reflected in many of the included files.
  64
  65 WARNING! If upgrading from earlier versions of this project via RPM packages,
  66 the new package will delete any previously installed 'Junkbuster' packages.
  67
  68 IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
  69 port is now 8118 due to conflicts with port 8000 assignment. You will need to
  70 change your browser if upgrading!!! And maybe firewall, etc.
  71
  72 -------------------------------------------------------------------------------
  73
  74 2. INSTALL
  75
  76 See the INSTALL file in this directory, for installing from source, and the
  77 User Manual, for other installation types.
  78
  79 -------------------------------------------------------------------------------
  80
  81 3. RUN
  82
  83 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
  84 [.GROUP]] [config_file]
  85
  86 See the man page or User Manual for an explanation of each option, and other
  87 configuration and usage issues.
  88
  89 If no config_file is specified on the command line, Privoxy will look for a
  90 file named 'config' in the current directory (except Win32 which will look for
  91 'config.txt'). If no config_file is found, Privoxy will fail to start.
  92
  93 Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
  94
  95 Or for SuSE: /etc/rc.d/privoxy start
  96
  97 Or Debian: /etc/init.d/privoxy start
  98
  99 -------------------------------------------------------------------------------
 100
 101 4. CONFIGURATION
 102
 103 See: 'config', 'default.action', 'user.action', and 'default.filter'.
 104 'user.action' is for personal and local configuration preferences. These are
 105 all well commented. Most of the magic is in '*.action' files. 'user.action'
 106 should be used for any actions customizations. On Unix-like systems, these
 107 files are installed in /etc/privoxy. On Windows, then wherever the executable
 108 itself is installed. There are many significant changes and advances since
 109 Junkbuster v2.0.x. The User Manual has an explanation of all configuration
 110 options, and examples: http://www.privoxy.org/user-manual/.
 111
 112 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
 113 you specify in the config file under 'listen-address'. DEFAULT is localhost:
 114 8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
 115 with FTP or other protocols for the simple reason it does not work.
 116
 117 The actions list can be configured via the web interface accessed via http://
 118 p.p/, as well other options.
 119
 120 All configuration files are subject to unannounced changes during the
 121 development process.
 122
 123 -------------------------------------------------------------------------------
 124
 125 5. DOCUMENTATION
 126
 127 There should be documentation in the 'doc' subdirectory, but it is not
 128 completed at this point. In particular, see the User Manual there, the FAQ, and
 129 those interested in Privoxy development, should look at developer-manual.
 130
 131 The most up to date source of information on the current development version,
 132 may still be either comments in the source code, or the included configuration
 133 files. The source and configuration files are all well commented. The main
 134 configuration files are: 'config', 'default.action', and 'default.filter' in
 135 the toplevel source directory.
 136
 137 Included documentation may vary according to platform and packager. All
 138 documentation is posted on http://www.privoxy.org, in case you don't have it,
 139 or can't find it.
 140
 141 -------------------------------------------------------------------------------
 142
 143 6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 144
 145 We value your feedback. In fact, we rely on it to improve Privoxy and its
 146 configuration. However, please note the following hints, so we can provide you
 147 with the best support:
 148
 149 -------------------------------------------------------------------------------
 150
 151 6.1. Get Support
 152
 153 For casual users, our support forum at SourceForge is probably best suited:
 154 http://sourceforge.net/tracker/?group_id=11118&atid=211118
 155
 156 All users are of course welcome to discuss their issues on the users mailing
 157 list, where the developers also hang around.
 158
 159 -------------------------------------------------------------------------------
 160
 161 6.2. Report Bugs
 162
 163 Please report all bugs only through our bug tracker: http://sourceforge.net/
 164 tracker/?group_id=11118&atid=111118.
 165
 166 Before doing so, please make sure that the bug has not already been submitted
 167 and observe the additional hints at the top of the submit form.
 168
 169 Please try to verify that it is a Privoxy bug, and not a browser or site bug
 170 first. If unsure, try toggling off Privoxy, and see if the problem persists.
 171 The appendix of the user manual also has helpful information on action
 172 debugging. If you are using your own custom configuration, please try the stock
 173 configs to see if the problem is configuration related.
 174
 175 If not using the latest version, chances are that the bug has been found and
 176 fixed in the meantime. We would appreciate if you could take the time to
 177 upgrade to the latest version (or even the latest CVS snapshot) and verify your
 178 bug, but this is not required for reporting.
 179
 180 -------------------------------------------------------------------------------
 181
 182 6.3. Request New Features
 183
 184 You are welcome to submit ideas on new features or other proposals for
 185 improvement through our feature request tracker at http://sourceforge.net/
 186 tracker/?atid=361118&group_id=11118.
 187
 188 -------------------------------------------------------------------------------
 189
 190 6.4. Report Ads or Other Actions-Related Problems
 191
 192 Please send feedback on ads that slipped through, innocent images that were
 193 blocked, and any other problems relating to the default.action file through our
 194 actions feedback mechanism located at http://www.privoxy.org/actions/. On this
 195 page, you will also find a bookmark which will take you back there from any
 196 troubled site and even pre-fill the form!
 197
 198 New, improved default.action files will 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.5. Other
 205
 206 For any other issues, feel free to use the mailing lists. Technically
 207 interested users and people who wish to contribute to the project are also
 208 welcome on the developers list! You can find an overview of all Privoxy-related
 209 mailing lists, including list archives, at: http://sourceforge.net/mail/?
 210 group_id=11118.
 211