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-2009  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.,
  30  *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  31  *                USA
  32  *
  33  *********************************************************************/
  34
  35 This README is included with Privoxy 3.0.11. See http://www.privoxy.org/ for
  36 more information. The current code maturity level is "stable".
  37
  38 -------------------------------------------------------------------------------
  39
  40 Privoxy is a non-caching web proxy with advanced filtering capabilities for
  41 enhancing privacy, modifying web page data, managing HTTP cookies, controlling
  42 access, and removing ads, banners, pop-ups and other obnoxious Internet junk.
  43 Privoxy has a flexible configuration and can be customized to suit individual
  44 needs and tastes. Privoxy has application for both stand-alone systems and
  45 multi-user networks.
  46
  47 Privoxy is based on Internet Junkbuster (tm).
  48
  49 -------------------------------------------------------------------------------
  50
  51 1. IMPORTANT CHANGES
  52
  53 February 2009, Privoxy 3.0.11 is released. This is a stable release, and marks
  54 a departure for Privoxy development. Previously, odd numbered releases were
  55 considered beta releases. Each release now will be considered stable.
  56
  57 As usual there are changes that effect the configuration. See the "ChangeLog",
  58 and the "What's New" section and the "Upgrader's Notes" in the User Manual for
  59 details and specifics.
  60
  61 August 2008, Privoxy 3.0.10 is released! There are not any major new features,
  62 but many improvements and refinements.
  63
  64 June 2008, Privoxy 3.0.9 beta is released. There are no major new features, but
  65 many improvements and refinements.
  66
  67 -------------------------------------------------------------------------------
  68
  69 2. INSTALL
  70
  71 See the INSTALL file in this directory, for installing from raw source, and the
  72 User Manual, for all other installation types.
  73
  74 -------------------------------------------------------------------------------
  75
  76 3. RUN
  77
  78 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
  79 [.GROUP]] [--chroot] [--pre-chroot-nslookup HOSTNAME ][config_file]
  80
  81 See the man page or User Manual for an explanation of each option, and other
  82 configuration and usage issues.
  83
  84 If no config_file is specified on the command line, Privoxy will look for a
  85 file named 'config' in the current directory (except Win32 which will look for
  86 'config.txt'). If no config_file is found, Privoxy will fail to start.
  87
  88 Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start
  89
  90 Or Debian and Ubuntu: /etc/init.d/privoxy start
  91
  92 -------------------------------------------------------------------------------
  93
  94 4. CONFIGURATION
  95
  96 See: 'config', 'default.action', 'user.action', 'default.filter', and
  97 'user.filter'. 'user.action' and 'user.filter' are for personal and local
  98 configuration preferences. These are all well commented. Most of the magic is
  99 in '*.action' files. 'user.action' should be used for any actions
 100 customizations. On Unix-like systems, these files are typically installed in /
 101 etc/privoxy. On Windows, then wherever the executable itself is installed.
 102 There are many significant changes and advances from earlier versions. The User
 103 Manual has an explanation of all configuration options, and examples: http://
 104 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
 108 localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not
 109 try it 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 Please don't sent private support requests to individual Privoxy developers,
 148 either use the mailing lists or the support trackers.
 149
 150 Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
 151 addresses have to be accepted manually by a moderator. This may cause a delay
 152 of several days and if you use a subject that doesn't clearly mention Privoxy
 153 or one of its features, your message may be accidentally discarded as spam.
 154
 155 If you aren't subscribed, you should therefore spend a few seconds to come up
 156 with a proper subject. Additionally you should make it clear that you want to
 157 get CC'd. Otherwise some responses will be directed to the mailing list only,
 158 and you won't see them.
 159
 160 -------------------------------------------------------------------------------
 161
 162 6.2. Reporting Problems
 163
 164 "Problems" for our purposes, come in two forms:
 165
 166   * Configuration issues, such as ads that slip through, or sites that don't
 167     function properly due to one Privoxy "action" or another being turned "on".
 168
 169   * "Bugs" in the programming code that makes up Privoxy, such as that might
 170     cause a crash.
 171
 172 -------------------------------------------------------------------------------
 173
 174 6.2.1. Reporting Ads or Other Configuration Problems
 175
 176 Please send feedback on ads that slipped through, innocent images that were
 177 blocked, sites that don't work properly, and other configuration related
 178 problem of default.action file, to http://sourceforge.net/tracker/?group_id=
 179 11118&atid=460288, the Actions File Tracker.
 180
 181 New, improved default.action files may occasionally be made available based on
 182 your feedback. These will be announced on the ijbswa-announce list and
 183 available from our the files section of our project page.
 184
 185 -------------------------------------------------------------------------------
 186
 187 6.2.2. Reporting Bugs
 188
 189 Please report all bugs through our bug tracker: http://sourceforge.net/tracker
 190 /?group_id=11118&atid=111118.
 191
 192 Before doing so, please make sure that the bug has not already been submitted
 193 and observe the additional hints at the top of the submit form. If already
 194 submitted, please feel free to add any info to the original report that might
 195 help to solve the issue.
 196
 197 Please try to verify that it is a Privoxy bug, and not a browser or site bug or
 198 documented behaviour that just happens to be different than what you expected.
 199 If unsure, try toggling off Privoxy, and see if the problem persists.
 200
 201 If you are using your own custom configuration, please try the stock configs to
 202 see if the problem is configuration related. If you're having problems with a
 203 feature that is disabled by default, please ask around on the mailing list if
 204 others can reproduce the problem.
 205
 206 If you aren't using the latest Privoxy version, the bug may have been found and
 207 fixed in the meantime. We would appreciate if you could take the time to
 208 upgrade to the latest version (or even the latest CVS snapshot) and verify that
 209 your bug still exists.
 210
 211 Please be sure to provide the following information:
 212
 213   * The exact Privoxy version you are using (if you got the source from CVS,
 214     please also provide the source code revisions as shown in http://
 215     config.privoxy.org/show-version).
 216
 217   * The operating system and versions you run Privoxy on, (e.g. Windows XP
 218     SP2), if you are using a Unix flavor, sending the output of "uname -a"
 219     should do, in case of GNU/Linux, please also name the distribution.
 220
 221   * The name, platform, and version of the browser you were using (e.g.
 222     Internet Explorer v5.5 for Mac).
 223
 224   * The URL where the problem occurred, or some way for us to duplicate the
 225     problem (e.g. http://somesite.example.com/?somethingelse=123).
 226
 227   * Whether your version of Privoxy is one supplied by the Privoxy developers
 228     via SourceForge, or if you got your copy somewhere else.
 229
 230   * Whether you are using Privoxy in tandem with another proxy such as Tor. If
 231     so, please temporary disable the other proxy to see if the symptoms change.
 232
 233   * Whether you are using a personal firewall product. If so, does Privoxy work
 234     without it?
 235
 236   * Any other pertinent information to help identify the problem such as config
 237     or log file excerpts (yes, you should have log file entries for each action
 238     taken).
 239
 240 You don't have to tell us your actual name when filing a problem report, but
 241 please use a nickname so we can differentiate between your messages and the
 242 ones entered by other "anonymous" users that may respond to your request if
 243 they have the same problem or already found a solution.
 244
 245 Please also check the status of your request a few days after submitting it, as
 246 we may request additional information. If you use a SF id, you should
 247 automatically get a mail when someone responds to your request.
 248
 249 The appendix of the Privoxy User Manual also has helpful information on
 250 understanding actions, and action debugging.
 251
 252 -------------------------------------------------------------------------------
 253
 254 6.3. Request New Features
 255
 256 You are welcome to submit ideas on new features or other proposals for
 257 improvement through our feature request tracker at http://sourceforge.net/
 258 tracker/?atid=361118&group_id=11118.
 259
 260 -------------------------------------------------------------------------------
 261
 262 6.4. Other
 263
 264 For any other issues, feel free to use the mailing lists. Technically
 265 interested users and people who wish to contribute to the project are also
 266 welcome on the developers list! You can find an overview of all Privoxy-related
 267 mailing lists, including list archives, at: http://sourceforge.net/mail/?
 268 group_id=11118.
 269