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