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