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