README

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