/*********************************************************************
*
- * File : $Source: /cvsroot/ijbswa/current/README,v $
+ * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
*
* Purpose : README file to give a short intro.
*
- * Copyright : Written by and Copyright (C) 2001 the SourceForge
- * IJBSWA team. http://ijbswa.sourceforge.net
+ * Copyright : Written by and Copyright (C) 2001-2009 the SourceForge
+ * Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
* by and Copyright (C) 1997 Anonymous Coders and
* The GNU General Public License should be included with
* this file. If not, you can view it at
* http://www.gnu.org/copyleft/gpl.html
- * or write to the Free Software Foundation, Inc., 59
- * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * or write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+ * USA
*
*********************************************************************/
-This README is included with the development version of Junkbuster,
-which will eventually become Junkbuster v3.0 (and soon we hope!). See
-http://ijbswa.sourceforge.net.
+This README is included with Privoxy 3.0.12. See http://www.privoxy.org/ for
+more information. The current code maturity level is "stable".
-Internet Junkbuster is a web proxy with advanced filtering
-capabilities for protecting privacy, filtering web page content,
-managing cookies, controlling access, and removing ads, banners,
-pop-ups and other obnoxious Internet Junk. Junkbuster has a very
-flexible configuration and can be customized to suit individual needs
-and tastes. Internet Junkbuster has application for both stand-alone
-systems and multi-user networks.
+-------------------------------------------------------------------------------
-JunkBuster was originally written by JunkBusters Corporation, and was
-released as free open-source software under the GNU GPL. Stefan
-Waldherr made many improvements, and started the SourceForge project
-to continue development.
+Privoxy is a non-caching web proxy with advanced filtering capabilities for
+enhancing privacy, modifying web page data and HTTP headers, controlling
+access, and removing ads and other obnoxious Internet junk. Privoxy has a
+flexible configuration and can be customized to suit individual needs and
+tastes. It has application for both stand-alone systems and multi-user
+networks.
- INSTALL
---------
+Privoxy is Free Software and licensed under the GPL2.
-For tarball, first unpack:
+-------------------------------------------------------------------------------
- tar xzvf ijb-2.9.11-beta-src.tar.gz
- cd ijb-2.9.11-beta
+1. IMPORTANT CHANGES
- autoheader [suggested for CVS source]
- autoconf [suggested for CVS source]
- ./configure (--help to see options)
- gmake (the make from gnu)
- su
- make -n install (to see where all the files will go)
- make install (to really install)
+March 2009, Privoxy 3.0.12 is released.
-Redhat and SuSE src and binary RPMs can be built with 'make
-redhat-dist' or 'make suse-dist' (run ./configure first) from unpacked
-sources. BSD will (probably?) require gmake (from http://gnu.org). See the
-user-manual for OS/2 build instructions.
+This is primarily a bug fix release. See the "ChangeLog", and the "What's New"
+section and the "Upgrader's Notes" in the User Manual for details.
-Junkbuster is also available via anonymous CVS:
+February 2009, Privoxy 3.0.11 is released.
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
+As usual there are changes that effect the configuration. See the "ChangeLog",
+and the "What's New" section and the "Upgrader's Notes" in the User Manual for
+details and specifics.
-This will create a directory named 'current'. Then, 'cd current', and then
-build as above.
+This is a stable release, and marks a departure for Privoxy development.
+Previously, odd numbered releases were considered beta versions and were only
+released at the end of the development cycle when the code was already believed
+to be stable. Usually it was, so the stable release contained pretty much the
+same code, but got a higher version number. In the future we intend to release
+several snapshots between stable releases. There will probably still be about
+two stable releases per year, but hopefully about six snapshots instead of the
+two betas we have now. The intentions is to make testing without CVS access
+easier.
- RUN
-----
+-------------------------------------------------------------------------------
- junkbuster /etc/junkbuster/config
+2. INSTALL
-Or for RedHat: /etc/rc.d/init.d/junkbuster start
-Or for SuSE: /etc/rc.d/junkbuster start
+See the INSTALL file in this directory, for installing from raw source, and the
+User Manual, for all other installation types.
-The only command line option supported is the location of the
-main configuration file. If none is specified, Junkbuster will
-look for a file named 'config' for unix, config.txt for Win32
-in the current directory.
+-------------------------------------------------------------------------------
+3. RUN
- CONFIGURATION
---------------
+privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
+[.GROUP]] [--chroot] [--pre-chroot-nslookup HOSTNAME ][config_file]
-See: 'config', 'ijb.action', and 're_filterfile'. These are all well
-commented. On Unix-like systems, these files are installed in /etc/junkbuster.
-On Windows, then wherever the executable itself is installed. There are many
-significant changes and advances since v2.0.x. The user-manual has a
-run down of configuration options, and examples:
-http://ijbswa.sourceforge.net/user-manual/.
+See the man page or User Manual for an explanation of each option, and other
+configuration and usage issues.
-Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>,
-or whatever you specify in the config file under 'listen-address'.
-DEFAULT is localhost:8000.
+If no config_file is specified on the command line, Privoxy will look for a
+file named 'config' in the current directory (except Win32 which will look for
+'config.txt'). If no config_file is found, Privoxy will fail to start.
-The ijb.action file can be configured via the web interface accessed via
-http://i.j.b/, as well other options.
+Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start
+Or Debian and Ubuntu: /etc/init.d/privoxy start
- DOCUMENTATION
---------------
+-------------------------------------------------------------------------------
-The best source of information on the current development version, is
-either comments in the source code, or the included configuration
-files, which are all well commented. These are 'config',
-'actionsfile', and 're_filterfile' in the toplevel source directory.
+4. CONFIGURATION
-There is a growing amount of new documentation in the 'doc'
-subdirectory, but it is sparse at this point. In particular, see
-the user-manual there, which is 'nearly there'.
+See: 'config', 'default.action', 'user.action', 'default.filter', and
+'user.filter'. 'user.action' and 'user.filter' are for personal and local
+configuration preferences. These are all well commented. Most of the magic is
+in '*.action' files. 'user.action' should be used for any actions
+customizations. On Unix-like systems, these files are typically installed in /
+etc/privoxy. On Windows, then wherever the executable itself is installed.
+There are many significant changes and advances from earlier versions. The User
+Manual has an explanation of all configuration options, and examples: http://
+www.privoxy.org/user-manual/.
-Some legacy documentation is also included only to give an idea of
-what Junkbuster can do under doc/obsolete/*. Much has changed since
-these docs were written, so beware.
+Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
+you specify in the config file under 'listen-address'. DEFAULT is
+localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not
+try it with FTP or other protocols for the simple reason it does not work.
+The actions list can be configured via the web interface accessed via http://
+p.p/, as well other options.
- BUGS
------
+-------------------------------------------------------------------------------
-Use the form at
-http://sourceforge.net/tracker/index.php?group_id=11118&atid=111118 to
-report bugs. Please read the exising bug reports before submitting
-anything new.
+5. DOCUMENTATION
--------------------------------------------------------------------------
-ijbswa-developers@lists.sourceforge.net
+There should be documentation in the 'doc' subdirectory. In particular, see the
+User Manual there, the FAQ, and those interested in Privoxy development, should
+look at developer-manual.
+
+The source and configuration files are all well commented. The main
+configuration files are: 'config', 'default.action', and 'default.filter'.
+
+Included documentation may vary according to platform and packager. All
+documentation is posted on http://www.privoxy.org, in case you don't have it,
+or can't find it.
+
+-------------------------------------------------------------------------------
+
+6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
+
+We value your feedback. In fact, we rely on it to improve Privoxy and its
+configuration. However, please note the following hints, so we can provide you
+with the best support:
+
+-------------------------------------------------------------------------------
+
+6.1. Get Support
+
+For casual users, our support forum at SourceForge is probably best suited:
+http://sourceforge.net/tracker/?group_id=11118&atid=211118
+
+All users are of course welcome to discuss their issues on the users mailing
+list, where the developers also hang around.
+
+Please don't sent private support requests to individual Privoxy developers,
+either use the mailing lists or the support trackers.
+
+Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
+addresses have to be accepted manually by a moderator. This may cause a delay
+of several days and if you use a subject that doesn't clearly mention Privoxy
+or one of its features, your message may be accidentally discarded as spam.
+
+If you aren't subscribed, you should therefore spend a few seconds to come up
+with a proper subject. Additionally you should make it clear that you want to
+get CC'd. Otherwise some responses will be directed to the mailing list only,
+and you won't see them.
+
+-------------------------------------------------------------------------------
+
+6.2. Reporting Problems
+
+"Problems" for our purposes, come in two forms:
+
+ * Configuration issues, such as ads that slip through, or sites that don't
+ function properly due to one Privoxy "action" or another being turned "on".
+
+ * "Bugs" in the programming code that makes up Privoxy, such as that might
+ cause a crash.
+
+-------------------------------------------------------------------------------
+
+6.2.1. Reporting Ads or Other Configuration Problems
+
+Please send feedback on ads that slipped through, innocent images that were
+blocked, sites that don't work properly, and other configuration related
+problem of default.action file, to http://sourceforge.net/tracker/?group_id=
+11118&atid=460288, the Actions File Tracker.
+
+New, improved default.action files may occasionally be made available based on
+your feedback. These will be announced on the ijbswa-announce list and
+available from our the files section of our project page.
+
+-------------------------------------------------------------------------------
+
+6.2.2. Reporting Bugs
+
+Please report all bugs through our bug tracker: http://sourceforge.net/tracker
+/?group_id=11118&atid=111118.
+
+Before doing so, please make sure that the bug has not already been submitted
+and observe the additional hints at the top of the submit form. If already
+submitted, please feel free to add any info to the original report that might
+help to solve the issue.
+
+Please try to verify that it is a Privoxy bug, and not a browser or site bug or
+documented behaviour that just happens to be different than what you expected.
+If unsure, try toggling off Privoxy, and see if the problem persists.
+
+If you are using your own custom configuration, please try the stock configs to
+see if the problem is configuration related. If you're having problems with a
+feature that is disabled by default, please ask around on the mailing list if
+others can reproduce the problem.
+
+If you aren't using the latest Privoxy version, the bug may have been found and
+fixed in the meantime. We would appreciate if you could take the time to
+upgrade to the latest version (or even the latest CVS snapshot) and verify that
+your bug still exists.
+
+Please be sure to provide the following information:
+
+ * The exact Privoxy version you are using (if you got the source from CVS,
+ please also provide the source code revisions as shown in http://
+ config.privoxy.org/show-version).
+
+ * The operating system and versions you run Privoxy on, (e.g. Windows XP
+ SP2), if you are using a Unix flavor, sending the output of "uname -a"
+ should do, in case of GNU/Linux, please also name the distribution.
+
+ * The name, platform, and version of the browser you were using (e.g.
+ Internet Explorer v5.5 for Mac).
+
+ * The URL where the problem occurred, or some way for us to duplicate the
+ problem (e.g. http://somesite.example.com/?somethingelse=123).
+
+ * Whether your version of Privoxy is one supplied by the Privoxy developers
+ via SourceForge, or if you got your copy somewhere else.
+
+ * Whether you are using Privoxy in tandem with another proxy such as Tor. If
+ so, please temporary disable the other proxy to see if the symptoms change.
+
+ * Whether you are using a personal firewall product. If so, does Privoxy work
+ without it?
+
+ * Any other pertinent information to help identify the problem such as config
+ or log file excerpts (yes, you should have log file entries for each action
+ taken).
+
+You don't have to tell us your actual name when filing a problem report, but
+please use a nickname so we can differentiate between your messages and the
+ones entered by other "anonymous" users that may respond to your request if
+they have the same problem or already found a solution.
+
+Please also check the status of your request a few days after submitting it, as
+we may request additional information. If you use a SF id, you should
+automatically get a mail when someone responds to your request.
+
+The appendix of the Privoxy User Manual also has helpful information on
+understanding actions, and action debugging.
+
+-------------------------------------------------------------------------------
+
+6.3. Request New Features
+
+You are welcome to submit ideas on new features or other proposals for
+improvement through our feature request tracker at http://sourceforge.net/
+tracker/?atid=361118&group_id=11118.
+
+-------------------------------------------------------------------------------
+
+6.4. Other
+
+For any other issues, feel free to use the mailing lists. Technically
+interested users and people who wish to contribute to the project are also
+welcome on the developers list! You can find an overview of all Privoxy-related
+mailing lists, including list archives, at: http://sourceforge.net/mail/?
+group_id=11118.
-$Id: README,v 1.10 2002/02/24 05:20:35 hal9 Exp $
projects / privoxy.git / blobdiff