X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=README;h=b5015b8b2d02823213d5ae8c0e641cb3491415b5;hb=6c1cc912902f8fbc91214475afe53db15753400a;hp=d4cd5a6e429912e304fa57a30644e98c7a5248a0;hpb=97110184221edacdb7d4dfc29de0e38d63f4d831;p=privoxy.git diff --git a/README b/README index d4cd5a6e..b5015b8b 100644 --- a/README +++ b/README @@ -4,7 +4,7 @@ * * Purpose : README file to give a short intro. * - * Copyright : Written by and Copyright (C) 2001 the SourceForge + * Copyright : Written by and Copyright (C) 2001 - 2004 the SourceForge * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written @@ -31,150 +31,167 @@ * *********************************************************************/ -This README is included with the development version of Privoxy, -which will eventually become Privoxy v3.0 (and soon we hope!). See -http://www.privoxy.org/. +This README is included with Privoxy 3.0.4-beta. The current code maturity +level is "beta". Various changes and improvements are underway, and +preparations are being made for an update of Privoxy. Please report any +problems to the developers. -Privoxy 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. Privoxy has a very flexible configuration and -can be customized to suit individual needs and tastes. Internet -Privoxy has application for both stand-alone systems and multi-user +------------------------------------------------------------------------------- + +Privoxy is a web proxy with advanced filtering capabilities for protecting +privacy, modifying web page content, 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. Several other developers are now contributing. +Privoxy is based on Internet Junkbuster (tm). + +------------------------------------------------------------------------------- + +1. IMPORTANT CHANGES + +MORE 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. + +NEWS! March 2003, Privoxy 3.0.2 is released. This is the first maintenance +release of Privoxy. There are no significant new features in this release. Some +bugs are fixed, and some existing features have been enhanced. See ChangeLog +for details. Upgrading from 3.0.0 is recommended. + +REALLY BIG NEWS! August 2002: The long-awaited, oft-delayed stable version of +Privoxy 3.0 is finally released! This is way behind schedule, but better late +than never. The developers all hope the wait was worth it. + +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. + +WARNING! If upgrading from earlier versions of this project via RPM packages, +the new package will delete any previously installed 'Junkbuster' packages. + +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. + +------------------------------------------------------------------------------- + +2. INSTALL + +See the INSTALL file in this directory, for installing from source, and the +User Manual, for other installation types. + +------------------------------------------------------------------------------- + +3. RUN + +privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER +[.GROUP]] [--chroot] [config_file] +See the man page or User Manual for an explanation of each option, and other +configuration and usage issues. - IMPORTANT CHANGES ------------------- +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. -NEWS! As of 03/24/02, the name of this project has been changed -from Junkbuster to Privoxy. This is reflected in many of the -included files. +Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start -WARNING! If upgrading from earlier versions of this project via -RPM packages, the new package will delete any previously installed -'Junkbuster' packages. +Or for SuSE: /etc/rc.d/privoxy start -IMPORTANT! READ! Configuration Change as of 3 Apr 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. +Or Debian: /etc/init.d/privoxy start +------------------------------------------------------------------------------- - INSTALL --------- +4. CONFIGURATION -For tarball, first unpack: +See: 'config', 'default.action', 'user.action', and 'default.filter'. +'user.action' is 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 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 an explanation of all configuration +options, and examples: http://www.privoxy.org/user-manual/. - tar xzvf privoxy-2.9.13-beta-src.tar.gz - cd privoxy-2.9.13-beta +Be sure to set your browser(s) for HTTP/HTTPS Proxy at :, 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. - autoheader - autoconf - ./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) +The actions list can be configured via the web interface accessed via http:// +p.p/, as well other options. -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. +------------------------------------------------------------------------------- -Privoxy is also available via anonymous CVS: +5. DOCUMENTATION - cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current +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. -This will create a directory named 'current'. Then, 'cd current', and -then build as above. +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. - RUN ----- +------------------------------------------------------------------------------- -privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] - [--user USER] [config_file] +6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS -Or for RedHat: /etc/rc.d/init.d/privoxy start -Or for SuSE: /etc/rc.d/privoxy start +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: -See the man page or user-manual for a brief explanation of each. +------------------------------------------------------------------------------- +6.1. Get Support - CONFIGURATION --------------- +For casual users, our support forum at SourceForge is probably best suited: +http://sourceforge.net/tracker/?group_id=11118&atid=211118 -See: 'config', '*.action', and 'default.filter'. 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/. +All users are of course welcome to discuss their issues on the users mailing +list, where the developers also hang around. -Be sure to set your browser(s) for HTTP/HTTPS Proxy at :, or -whatever you specify in the config file under 'listen-address'. -DEFAULT is localhost:8118. +------------------------------------------------------------------------------- -The default.action file can be configured via the web interface accessed -via http://p.p/, as well other options. +6.2. Report Bugs +Please report all bugs only through our bug tracker: http://sourceforge.net/ +tracker/?group_id=11118&atid=111118. - DOCUMENTATION --------------- +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. -There is a growing amount of documentation in the 'doc' subdirectory, -but it is not finished at this point. In particular, see the -user-manual there, and developers should look at developer-manual. +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. +The appendix of the user manual also has helpful information on action +debugging. If you are using your own custom configuration, please try the stock +configs to see if the problem is configuration related. -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, which are all well commented. These are 'config', '*.action', and -'default.filter' in the toplevel source directory. +If not using the latest version, chances are that the bug has 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, but this is not required for reporting. -Some legacy Junkbuster documentation may also be included only to give an idea -of what Privoxy can do under doc/obsolete/*. Much has changed since these docs -were written, so beware. +------------------------------------------------------------------------------- -Included documentation may vary according to platform and packager. +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. - CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS --------------------------------------------------------------- +------------------------------------------------------------------------------- -We value your feedback. However, to provide you with the best support, -please note: - - * Use the support forum to get help: - http://sourceforge.net/tracker/?group_id=11118&atid=211118 - * Submit bugs only thru our bug forum: - http://sourceforge.net/tracker/?group_id=11118&atid=111118 - 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. - * Submit feature requests only thru our feature request forum: - http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse - -For any other issues, feel free to use the mailing lists: -http://sourceforge.net/mail/?group_id=11118 - -Anyone interested in actively participating in development and related -discussions can join the appropriate mailing list here: -http://sourceforge.net/mail/?group_id=11118. Archives are available -here too. +6.5. Other -------------------------------------------------------------------------- -ijbswa-developers@lists.sourceforge.net +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.20 2002/03/24 19:57:28 hal9 Exp $