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.
  54
  55 As usual there are changes that effect the configuration. See the "ChangeLog",
  56 and the "What's New" section and the "Upgrader's Notes" in the User Manual for
  57 details and specifics.
  58
  59 This is a stable release, and marks a departure for Privoxy development.
  60
  61 Previously, odd numbered releases were considered beta versions and were only
  62 released at the end of the development cycle when the code was already believed
  63 to be stable. Usually it was, so the stable release contained pretty much the
  64 same code, but got a higher version number. In the future we intend to release
  65 several snapshots between stable releases. There will probably still be about
  66 two stable releases per year, but hopefully about six snapshots instead of the
  67 two betas we have now. The intentions is to make testing without CVS access
  68 easier.
  69
  70 -------------------------------------------------------------------------------
  71
  72 2. INSTALL
  73
  74 See the INSTALL file in this directory, for installing from raw source, and the
  75 User Manual, for all other installation types.
  76
  77 -------------------------------------------------------------------------------
  78
  79 3. RUN
  80
  81 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
  82 [.GROUP]] [--chroot] [--pre-chroot-nslookup HOSTNAME ][config_file]
  83
  84 See the man page or User Manual for an explanation of each option, and other
  85 configuration and usage issues.
  86
  87 If no config_file is specified on the command line, Privoxy will look for a
  88 file named 'config' in the current directory (except Win32 which will look for
  89 'config.txt'). If no config_file is found, Privoxy will fail to start.
  90
  91 Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start
  92
  93 Or Debian and Ubuntu: /etc/init.d/privoxy start
  94
  95 -------------------------------------------------------------------------------
  96
  97 4. CONFIGURATION
  98
  99 See: 'config', 'default.action', 'user.action', 'default.filter', and
 100 'user.filter'. 'user.action' and 'user.filter' are for personal and local
 101 configuration preferences. These are all well commented. Most of the magic is
 102 in '*.action' files. 'user.action' should be used for any actions
 103 customizations. On Unix-like systems, these files are typically installed in /
 104 etc/privoxy. On Windows, then wherever the executable itself is installed.
 105 There are many significant changes and advances from earlier versions. The User
 106 Manual has an explanation of all configuration options, and examples: http://
 107 www.privoxy.org/user-manual/.
 108
 109 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
 110 you specify in the config file under 'listen-address'. DEFAULT is
 111 localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not
 112 try it with FTP or other protocols for the simple reason it does not work.
 113
 114 The actions list can be configured via the web interface accessed via http://
 115 p.p/, as well other options.
 116
 117 -------------------------------------------------------------------------------
 118
 119 5. DOCUMENTATION
 120
 121 There should be documentation in the 'doc' subdirectory. In particular, see the
 122 User Manual there, the FAQ, and those interested in Privoxy development, should
 123 look at developer-manual.
 124
 125 The source and configuration files are all well commented. The main
 126 configuration files are: 'config', 'default.action', and 'default.filter'.
 127
 128 Included documentation may vary according to platform and packager. All
 129 documentation is posted on http://www.privoxy.org, in case you don't have it,
 130 or can't find it.
 131
 132 -------------------------------------------------------------------------------
 133
 134 6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 135
 136 We value your feedback. In fact, we rely on it to improve Privoxy and its
 137 configuration. However, please note the following hints, so we can provide you
 138 with the best support:
 139
 140 -------------------------------------------------------------------------------
 141
 142 6.1. Get Support
 143
 144 For casual users, our support forum at SourceForge is probably best suited:
 145 http://sourceforge.net/tracker/?group_id=11118&atid=211118
 146
 147 All users are of course welcome to discuss their issues on the users mailing
 148 list, where the developers also hang around.
 149
 150 Please don't sent private support requests to individual Privoxy developers,
 151 either use the mailing lists or the support trackers.
 152
 153 Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
 154 addresses have to be accepted manually by a moderator. This may cause a delay
 155 of several days and if you use a subject that doesn't clearly mention Privoxy
 156 or one of its features, your message may be accidentally discarded as spam.
 157
 158 If you aren't subscribed, you should therefore spend a few seconds to come up
 159 with a proper subject. Additionally you should make it clear that you want to
 160 get CC'd. Otherwise some responses will be directed to the mailing list only,
 161 and you won't see them.
 162
 163 -------------------------------------------------------------------------------
 164
 165 6.2. Reporting Problems
 166
 167 "Problems" for our purposes, come in two forms:
 168
 169   * Configuration issues, such as ads that slip through, or sites that don't
 170     function properly due to one Privoxy "action" or another being turned "on".
 171
 172   * "Bugs" in the programming code that makes up Privoxy, such as that might
 173     cause a crash.
 174
 175 -------------------------------------------------------------------------------
 176
 177 6.2.1. Reporting Ads or Other Configuration Problems
 178
 179 Please send feedback on ads that slipped through, innocent images that were
 180 blocked, sites that don't work properly, and other configuration related
 181 problem of default.action file, to http://sourceforge.net/tracker/?group_id=
 182 11118&atid=460288, the Actions File Tracker.
 183
 184 New, improved default.action files may occasionally be made available based on
 185 your feedback. These will be announced on the ijbswa-announce list and
 186 available from our the files section of our project page.
 187
 188 -------------------------------------------------------------------------------
 189
 190 6.2.2. Reporting Bugs
 191
 192 Please report all bugs through our bug tracker: http://sourceforge.net/tracker
 193 /?group_id=11118&atid=111118.
 194
 195 Before doing so, please make sure that the bug has not already been submitted
 196 and observe the additional hints at the top of the submit form. If already
 197 submitted, please feel free to add any info to the original report that might
 198 help to solve the issue.
 199
 200 Please try to verify that it is a Privoxy bug, and not a browser or site bug or
 201 documented behaviour that just happens to be different than what you expected.
 202 If unsure, try toggling off Privoxy, and see if the problem persists.
 203
 204 If you are using your own custom configuration, please try the stock configs to
 205 see if the problem is configuration related. If you're having problems with a
 206 feature that is disabled by default, please ask around on the mailing list if
 207 others can reproduce the problem.
 208
 209 If you aren't using the latest Privoxy version, the bug may have been found and
 210 fixed in the meantime. We would appreciate if you could take the time to
 211 upgrade to the latest version (or even the latest CVS snapshot) and verify that
 212 your bug still exists.
 213
 214 Please be sure to provide the following information:
 215
 216   * The exact Privoxy version you are using (if you got the source from CVS,
 217     please also provide the source code revisions as shown in http://
 218     config.privoxy.org/show-version).
 219
 220   * The operating system and versions you run Privoxy on, (e.g. Windows XP
 221     SP2), if you are using a Unix flavor, sending the output of "uname -a"
 222     should do, in case of GNU/Linux, please also name the distribution.
 223
 224   * The name, platform, and version of the browser you were using (e.g.
 225     Internet Explorer v5.5 for Mac).
 226
 227   * The URL where the problem occurred, or some way for us to duplicate the
 228     problem (e.g. http://somesite.example.com/?somethingelse=123).
 229
 230   * Whether your version of Privoxy is one supplied by the Privoxy developers
 231     via SourceForge, or if you got your copy somewhere else.
 232
 233   * Whether you are using Privoxy in tandem with another proxy such as Tor. If
 234     so, please temporary disable the other proxy to see if the symptoms change.
 235
 236   * Whether you are using a personal firewall product. If so, does Privoxy work
 237     without it?
 238
 239   * Any other pertinent information to help identify the problem such as config
 240     or log file excerpts (yes, you should have log file entries for each action
 241     taken).
 242
 243 You don't have to tell us your actual name when filing a problem report, but
 244 please use a nickname so we can differentiate between your messages and the
 245 ones entered by other "anonymous" users that may respond to your request if
 246 they have the same problem or already found a solution.
 247
 248 Please also check the status of your request a few days after submitting it, as
 249 we may request additional information. If you use a SF id, you should
 250 automatically get a mail when someone responds to your request.
 251
 252 The appendix of the Privoxy User Manual also has helpful information on
 253 understanding actions, and action debugging.
 254
 255 -------------------------------------------------------------------------------
 256
 257 6.3. Request New Features
 258
 259 You are welcome to submit ideas on new features or other proposals for
 260 improvement through our feature request tracker at http://sourceforge.net/
 261 tracker/?atid=361118&group_id=11118.
 262
 263 -------------------------------------------------------------------------------
 264
 265 6.4. Other
 266
 267 For any other issues, feel free to use the mailing lists. Technically
 268 interested users and people who wish to contribute to the project are also
 269 welcome on the developers list! You can find an overview of all Privoxy-related
 270 mailing lists, including list archives, at: http://sourceforge.net/mail/?
 271 group_id=11118.
 272