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