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