X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=README;h=40c2190e389ceaa83b8da9274120fc08df7c2a8f;hp=197c16b8946bae1c5e71b6c9fce61fc782fc31fc;hb=520cd9953f7ad41fde7ad7e837276f547463e5d4;hpb=0c09ece6cb12fe06ab88015a9f9de34d0cedb307 diff --git a/README b/README index 197c16b8..40c2190e 100644 --- a/README +++ b/README @@ -1,11 +1,11 @@ /********************************************************************* * - * 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 + * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and @@ -31,111 +31,210 @@ * *********************************************************************/ -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 the development version of Privoxy 3.1.1, which +will eventually become Privoxy v3.2. See http://www.privoxy.org/ for more +information. The current code level is alpha, and may break in mysterious ways +:) There may be features only partially implemented, or worse, not functional. -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 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. Privoxy has application for both stand-alone systems and multi-user +networks. - INSTALL --------- +Privoxy is based on Internet Junkbuster (tm). -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) +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. -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. +WARNING! If upgrading from earlier versions of this project via RPM packages, +the new package will delete any previously installed 'Junkbuster' packages. -Junkbuster is also available via anonymous CVS: +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. - cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current +------------------------------------------------------------------------------- -This will create a directory named 'current'. Then, 'cd current', and then -build as above. +2. INSTALL +To build Privoxy from source, autoconf, GNU make (gmake), and, of course, a C +compiler like gcc are required. - RUN ----- +When building from a source tarball (either release version or nightly CVS +tarball), first unpack the source: - junkbuster /etc/junkbuster/config + tar xzvf privoxy-3.1.1-beta-src* [.tgz or .tar.gz] + cd privoxy-3.1.1-beta -Or for RedHat: /etc/rc.d/init.d/junkbuster start -Or for SuSE: /etc/rc.d/junkbuster start +For retrieving the current CVS sources, you'll need CVS installed. Note that +sources from CVS are development quality, and may not be stable, or well +tested. To download CVS source: -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. + 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 +This will create a directory named current/, which will contain the source +tree. - CONFIGURATION --------------- +Then, in either case, to build from unpacked tarball or CVS source: -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/. + 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) -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:8000. +If you have gnu make, you can have the first four steps automatically done for +you by just typing: -The ijb.action file can be configured via the web interface accessed via -http://i.j.b/, as well other options. + make +in the freshly downloaded or unpacked source directory. - DOCUMENTATION --------------- +For more detailed instructions on how to build Redhat and SuSE RPMs, Windows +self-extracting installers, building on platforms with special requirements +etc, please consult the developer manual. -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. +For binary RPM installation, and other platforms, see the user-manual as well. -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'. +------------------------------------------------------------------------------- -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. +3. RUN +privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER +[.GROUP]] [config_file] - BUGS ------ +See the man page or User Manual for an explanation of each option, and other +configuration and usage issues. -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. +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. -------------------------------------------------------------------------- -ijbswa-developers@lists.sourceforge.net +Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start + +Or for SuSE: /etc/rc.d/privoxy start + +Or Debian: /etc/init.d/privoxy start + +------------------------------------------------------------------------------- + +4. CONFIGURATION + +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/. + +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 actions list 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. + +------------------------------------------------------------------------------- + +5. DOCUMENTATION + +There should be documentation in the 'doc' subdirectory, but it may not be in +sync with current code. 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 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. + +Included documentation may vary according to platform and packager. + +------------------------------------------------------------------------------- + +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. + +------------------------------------------------------------------------------- + +6.2. Report 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. + +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. + +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. + +------------------------------------------------------------------------------- + +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. Report Ads or Other Actions-Related Problems + +Please send feedback on ads that slipped through, innocent images that were +blocked, and any other problems relating to the default.action file through our +actions feedback mechanism located at http://www.privoxy.org/actions/. On this +page, you will also find a bookmark which will take you back there from any +troubled site and even pre-fill the form! + +New, improved default.action files will occasionally be made available based on +your feedback. These will be announced on the ijbswa-announce list and +available from our project page. + +------------------------------------------------------------------------------- + +6.5. 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 $