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.0. 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 To build Privoxy from source, autoconf, GNU make (gmake), and, of course, a C
  71 compiler like gcc are required.
  72
  73 When building from a source tarball (either release version or nightly CVS
  74 tarball), first unpack the source:
  75
  76  tar xzvf privoxy-3.0.0-src* [.tgz or .tar.gz]
  77  cd privoxy-3.0.0
  78
  79 For retrieving the current CVS sources, you'll need CVS installed. Note that
  80 sources from CVS are development quality, and may not be stable, or well
  81 tested. To download CVS source:
  82
  83   cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
  84   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
  85   cd current
  86
  87 This will create a directory named current/, which will contain the source
  88 tree.
  89
  90 Then, in either case, to build from unpacked tarball or CVS source:
  91
  92  autoheader
  93  autoconf
  94  ./configure      # (--help to see options)
  95  make             # (the make from gnu, gmake for *BSD)
  96  su
  97  make -n install  # (to see where all the files will go)
  98  make install     # (to really install)
  99
 100 +-----------------------------------------------------------------------------+
 101 |                                   Warning                                   |
 102 |-----------------------------------------------------------------------------|
 103 |The "make install" target is temporary quite broken! It is recommended to use|
 104 |a binary package, or do a source build, and manually install the components. |
 105 |Sorry.                                                                       |
 106 +-----------------------------------------------------------------------------+
 107
 108 If you have gnu make, you can have the first four steps automatically done for
 109 you by just typing:
 110
 111   make
 112
 113 in the freshly downloaded or unpacked source directory.
 114
 115 For more detailed instructions on how to build Redhat and SuSE RPMs, Windows
 116 self-extracting installers, building on platforms with special requirements
 117 etc, please consult the developer manual.
 118
 119 For binary RPM installation, and other platforms, see the user-manual as well.
 120
 121 -------------------------------------------------------------------------------
 122
 123 3. RUN
 124
 125 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
 126 [.GROUP]] [config_file]
 127
 128 See the man page or User Manual for an explanation of each option, and other
 129 configuration and usage issues.
 130
 131 If no config_file is specified on the command line, Privoxy will look for a
 132 file named 'config' in the current directory (except Win32 which will look for
 133 'config.txt'). If no config_file is found, Privoxy will fail to start.
 134
 135 Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
 136
 137 Or for SuSE: /etc/rc.d/privoxy start
 138
 139 Or Debian: /etc/init.d/privoxy start
 140
 141 -------------------------------------------------------------------------------
 142
 143 4. CONFIGURATION
 144
 145 See: 'config', 'default.action', 'user.action', and 'default.filter'.
 146 'user.action' is for personal and local configuration preferences. These are
 147 all well commented. Most of the magic is in '*.action' files. 'user.action'
 148 should be used for any actions customizations. On Unix-like systems, these
 149 files are installed in /etc/privoxy. On Windows, then wherever the executable
 150 itself is installed. There are many significant changes and advances since
 151 Junkbuster v2.0.x. The User Manual has an explanation of all configuration
 152 options, and examples: http://www.privoxy.org/user-manual/.
 153
 154 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
 155 you specify in the config file under 'listen-address'. DEFAULT is localhost:
 156 8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
 157 with FTP or other protocols for the simple reason it does not work.
 158
 159 The actions list can be configured via the web interface accessed via http://
 160 p.p/, as well other options.
 161
 162 -------------------------------------------------------------------------------
 163
 164 5. DOCUMENTATION
 165
 166 There should be documentation in the 'doc' subdirectory. In particular, see the
 167 User Manual there, the FAQ, and those interested in Privoxy development, should
 168 look at developer-manual.
 169
 170 The source and configuration files are all well commented. The main
 171 configuration files are: 'config', 'default.action', and 'default.filter'.
 172
 173 Included documentation may vary according to platform and packager. All
 174 documentation is posted on http://www.privoxy.org, in case you don't have it,
 175 or can't find it.
 176
 177 -------------------------------------------------------------------------------
 178
 179 6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 180
 181 We value your feedback. In fact, we rely on it to improve Privoxy and its
 182 configuration. However, please note the following hints, so we can provide you
 183 with the best support:
 184
 185 -------------------------------------------------------------------------------
 186
 187 6.1. Get Support
 188
 189 For casual users, our support forum at SourceForge is probably best suited:
 190 http://sourceforge.net/tracker/?group_id=11118&atid=211118
 191
 192 All users are of course welcome to discuss their issues on the users mailing
 193 list, where the developers also hang around.
 194
 195 -------------------------------------------------------------------------------
 196
 197 6.2. Report Bugs
 198
 199 Please report all bugs only through our bug tracker: http://sourceforge.net/
 200 tracker/?group_id=11118&atid=111118.
 201
 202 Before doing so, please make sure that the bug has not already been submitted
 203 and observe the additional hints at the top of the submit form.
 204
 205 Please try to verify that it is a Privoxy bug, and not a browser or site bug
 206 first. If unsure, try toggling off Privoxy, and see if the problem persists.
 207 The appendix of the user manual also has helpful information on action
 208 debugging. If you are using your own custom configuration, please try the stock
 209 configs to see if the problem is configuration related.
 210
 211 If not using the latest version, chances are that the bug has been found and
 212 fixed in the meantime. We would appreciate if you could take the time to
 213 upgrade to the latest version (or even the latest CVS snapshot) and verify your
 214 bug, but this is not required for reporting.
 215
 216 -------------------------------------------------------------------------------
 217
 218 6.3. Request New Features
 219
 220 You are welcome to submit ideas on new features or other proposals for
 221 improvement through our feature request tracker at http://sourceforge.net/
 222 tracker/?atid=361118&group_id=11118.
 223
 224 -------------------------------------------------------------------------------
 225
 226 6.4. Report Ads or Other Actions-Related Problems
 227
 228 Please send feedback on ads that slipped through, innocent images that were
 229 blocked, and any other problems relating to the default.action file through our
 230 actions feedback mechanism located at http://www.privoxy.org/actions/. On this
 231 page, you will also find a bookmark which will take you back there from any
 232 troubled site and even pre-fill the form!
 233
 234 New, improved default.action files will occasionally be made available based on
 235 your feedback. These will be announced on the ijbswa-announce list and
 236 available from our the files section of our project page.
 237
 238 -------------------------------------------------------------------------------
 239
 240 6.5. Other
 241
 242 For any other issues, feel free to use the mailing lists. Technically
 243 interested users and people who wish to contribute to the project are also
 244 welcome on the developers list! You can find an overview of all Privoxy-related
 245 mailing lists, including list archives, at: http://sourceforge.net/mail/?
 246 group_id=11118.
 247