-
/*********************************************************************
*
- * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
+ * File : $Source: /cvsroot/ijbswa/current/README,v $
*
* Purpose : README file to give a short intro.
*
- * Copyright : Written by and Copyright (C) 2001 the SourceForge
+ * Copyright : Written by and Copyright (C) 2001 - 2006 the SourceForge
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
* 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 Privoxy 2.9.13, which
-will eventually become Privoxy v3.0 (and soon we hope!). See http://
-www.privoxy.org/ for more information. The current code level is BETA, and
-seems stable to us :).
+This README is included with Privoxy > 3.0.6 -> 3.0.7.
+See http://www.privoxy.org/ for more information. The current code maturity
+level is "unknown". Development work is in progress. There may be new
+features, bugs, partially working aspects, etc, all of which may not be
+documented. Use 3.0.6 for production systems and where stability is necessary.
+Please report any problems.
+
+-------------------------------------------------------------------------------
Privoxy is a web proxy with advanced filtering capabilities for protecting
-privacy, filtering web page content, managing cookies, controlling access, and
+privacy, modifying web page data, managing cookies, controlling access, and
removing ads, banners, pop-ups and other obnoxious Internet junk. Privoxy has a
very flexible configuration and can be customized to suit individual needs and
tastes. Privoxy has application for both stand-alone systems and multi-user
networks.
-Privoxy is based on the code of the Internet Junkbuster. 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 based on Internet Junkbuster (tm).
-Privoxy continues the Junkbuster tradition, but adds many refinements and
-enhancements.
+-------------------------------------------------------------------------------
+1. IMPORTANT CHANGES
- IMPORTANT CHANGES
-------------------
+NEWS! November 2006, Privoxy 3.0.6 is released. This is a significant upgrade
+with many new and enhanced features, and many bugs fixed. It is also the first
+stable release in quite some time. There are fifteen new actions available, and
+several actions have enhanced capabilities. Multiple filter files are now
+supported as well. There are many improvements and refinements. See the "What's
+New" section and the "Upgrader's Notes" in the User Manual for details and
+specifics. Preliminary work on 3.0.7 is already underway.
-NEWS! As of 03/24/02, the name of this project has been changed from ijbswa/
-Junkbuster to Privoxy. This is reflected in many of the included files.
+NEWS! September 2006, Privoxy 3.0.5 BETA is released. This is a significant
+upgrade with many new and enhanced features, and many bugs fixed.
-WARNING! If upgrading from earlier versions of this project via RPM packages,
-the new package will delete any previously installed 'Junkbuster' packages.
+There was and will not be an official 3.0.4 release. This release cycle was
+used to gather our thoughts, play with some new ideas and refine some old ones.
+It will remain a development cycle with no actual release. 3.0.5 is the fruit
+of these efforts.
-IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
-port is now 8118 due to conflicts with port 8000 assignment. You will need to
-change your browser if upgrading!!! And maybe firewall, etc.
+NEWS! January 2004, Privoxy 3.0.3 is released. This is the another maintenance
+release of Privoxy which fixes more bugs, further refines the configuration and
+works around some known third-party problems. See the ChangeLog for complete
+details. Upgrading from 3.0.2 is recommended.
+-------------------------------------------------------------------------------
- INSTALL
---------
+2. INSTALL
-There are several ways to install Privoxy.
+See the INSTALL file in this directory, for installing from raw source, and the
+User Manual, for all other installation types.
-To build Privoxy from source, autoconf and GNU make (gmake) are required.
-Source is available as gzipped tar archives. For this, first unpack the source:
+-------------------------------------------------------------------------------
- tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz]
- cd privoxy-2.9.13-beta
-
+3. RUN
-For retrieving the current CVS sources, you'll need the CVS package installed
-first. Note CVS source is development quality, and may not be stable, or well
-tested. To download CVS source:
+privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
+[.GROUP]] [--chroot] [config_file]
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
- cd current
-
+See the man page or User Manual for an explanation of each option, and other
+configuration and usage issues.
-This will create a directory named current/, which will contain the source
-tree.
+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.
-Then, in either case, to build from unpacked tarball or CVS source:
+Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start
- autoheader
- autoconf
- ./configure (--help to see options)
- make (the make from gnu, gmake for *BSD)
- su
- make -n install (to see where all the files will go)
- make install (to really install)
-
+Or Debian: /etc/init.d/privoxy start
-Redhat and SuSE src and binary RPMs can be built with "make redhat-dist" or "
-make suse-dist" from unpacked sources. You will need to run "autoconf;
-autoheader; ./configure" beforehand. *BSD will require gmake (from http://
-gnu.org). See the user-manual for OS/2 build instructions.
+-------------------------------------------------------------------------------
-For binary RPM installation, and other platforms, see the user-manual as well.
+4. CONFIGURATION
+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/.
- RUN
-----
+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.
-privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
-[.GROUP]] [config_file]
+The actions list can be configured via the web interface accessed via http://
+p.p/, as well other options.
-See the man page or user-manual for a brief explanation of each option.
+-------------------------------------------------------------------------------
-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.
+5. DOCUMENTATION
-Or for Red Hat: /etc/rc.d/init.d/privoxy start
+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.
-Or for SuSE: /etc/rc.d/privoxy start
+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.
- CONFIGURATION
---------------
+-------------------------------------------------------------------------------
-See: 'config', 'default.action', and 'default.filter'. There are several
-actions files included. These are all well commented. Most of the magic is in '
-*.action', and there are several of these included with varying degrees of
-aggressiveness. On Unix-like systems, these files are installed in /etc/
-privoxy. On Windows, then wherever the executable itself is installed. There
-are many significant changes and advances since Junkbuster v2.0.x. The
-user-manual has a run down of configuration options, and examples: http://
-www.privoxy.org/user-manual/.
+6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
-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.
+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:
-The default.action file can be configured via the web interface accessed via
-http://p.p/, as well other options.
+-------------------------------------------------------------------------------
-All configuration files are subject to unannounced changes during the
-development process.
+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
- DOCUMENTATION
---------------
+All users are of course welcome to discuss their issues on the users mailing
+list, where the developers also hang around.
-There should be documentation in the 'doc' subdirectory, but it is not
-completed at this point. In particular, see the user-manual there, the faq, and
-those interested in Privoxy development, should look at developer-manual.
+-------------------------------------------------------------------------------
-The most up to date source of information on the current development version,
-may still be either comments in the source code, or the included configuration
-files. The source and configuration files are all well commented. The main
-configuration files are: 'config', 'default.action', and 'default.filter' in
-the toplevel source directory. There are several *.action files included, with
-varying levels of aggressiveness.
+6.2. Reporting Problems
-Included documentation may vary according to platform and packager.
+"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 only 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
+first. 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.
- CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
---------------------------------------------------------------
+If not using the latest 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 your bug.
-We value your feedback. However, to provide you with the best support, please
-note:
+Please be sure to provide the following information:
- * Use the Sourceforge Support Forum to get help:
-
- http://sourceforge.net/tracker/?group_id=11118&atid=211118
-
+ * The exact Privoxy version of the proxy software (if you got the source from
+ CVS, please also provide the source code revisions as shown in http://
+ config.privoxy.org/show-version).
- * Submit bugs only through our Sourceforge Bug Forum:
-
- http://sourceforge.net/tracker/?group_id=11118&atid=111118.
-
+ * 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.
- Make sure that the bug has not already been submitted. Please try to verify
- that it is a Privoxy bug, and not a browser or site bug first. If you are
- using your own custom configuration, please try the stock configs to see if
- the problem is a configuration related bug. And if not using the latest
- development snapshot, please try the latest one. Or even better, CVS
- sources. Please be sure to include the Privoxy/Junkbuster version,
- platform, browser, any pertinent log data, any other relevant details
- (please be specific) and, if possible, some way to reproduce the bug.
+ * The name, platform, and version of the browser you were using (e.g.
+ Internet Explorer v5.5 for Mac).
- * Submit feature requests only through our Sourceforge feature request
- forum:
-
- http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
-
+ * The URL where the problem occurred, or some way for us to duplicate the
+ problem (e.g. http://somesite.example.com/?somethingelse=123).
- * For any other issues, feel free to use the mailing lists:
-
- http://sourceforge.net/mail/?group_id=11118.
-
+ * Whether your version of Privoxy is one supplied by the developers of
+ Privoxy via SourceForge, or somewhere else.
- Anyone interested in actively participating in development and related
- discussions can also join the appropriate mailing list. Archives are
- available too.
+ * Whether you are using Privoxy in tandem with another proxy such as Tor. If
+ so, please try disabling the other proxy.
- -------------------------------------------------------------------------
- ijbswa-developers@lists.sourceforge.net
-
+ * 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).
+
+ * Please provide your SF login, or email address, in case we need to contact
+ you.
+
+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
-$Id: readme.sgml,v 1.1 2002/04/03 06:01:41 hal9 Exp $
+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.
projects / privoxy.git / blobdiff