From 1ebaf56647ca9a7fdcc9c55a78cb740f31a6cd1d Mon Sep 17 00:00:00 2001 From: hal9 Date: Mon, 3 Jun 2002 00:28:17 +0000 Subject: [PATCH] Sync with various changes from 3.0 branch. Add two new files for config stuff. --- doc/source/announce.sgml | 20 +- doc/source/config.sgml | 35 + doc/source/contacting.sgml | 10 +- doc/source/developer-manual.sgml | 133 +- doc/source/faq.sgml | 11 +- doc/source/history.sgml | 3 +- doc/source/license.sgml | 3 +- doc/source/newfeatures.sgml | 3 +- doc/source/p-authors.sgml | 12 +- doc/source/p-config.sgml | 1992 ++++++++++++++++++++++++++ doc/source/privoxy-man-page.sgml | 2 +- doc/source/readme.sgml | 46 +- doc/source/supported.sgml | 5 +- doc/source/user-manual.sgml | 2230 ++++-------------------------- doc/source/webserver/index.sgml | 19 +- 15 files changed, 2452 insertions(+), 2072 deletions(-) create mode 100644 doc/source/config.sgml create mode 100644 doc/source/p-config.sgml diff --git a/doc/source/announce.sgml b/doc/source/announce.sgml index 28691e8c..220e9ec7 100644 --- a/doc/source/announce.sgml +++ b/doc/source/announce.sgml @@ -9,6 +9,7 @@ + @@ -18,7 +19,7 @@ Purpose : Announcement text - $Id: announce.sgml,v 1.0 2002/05/10 01:48:20 hal9 Exp $ + $Id: announce.sgml,v 1.1 2002/05/27 22:03:51 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -37,7 +38,7 @@ press release packages can contain both formats for those that might prefer HTML ready announce text. - This may require a small bit of hand editing before processing. + This will probably require some hand editing before and after processing. The intention is to minimize this as much as possible. To create: make announce @@ -65,6 +66,10 @@ &p-intro; + + &supported; + + In addition to the traditional features of Internet Junkbuster, such as ad and banner blocking, cookie @@ -82,24 +87,17 @@ - - Junkbuster was originally written by Anonymous - Coders and Junkbusters Corporation, and was released as free open-source - software under the GNU GPL. Stefan Waldherr made many improvements, and - started the SourceForge project Privoxy to rekindle development. There are - now several active developers contributing. - ]]> Download location: - http://sourceforge.net/projects/ijbswa/ + http://sourceforge.net/projects/ijbswa/ Home Page: - http://www.privoxy.org/ + http://www.privoxy.org/ diff --git a/doc/source/config.sgml b/doc/source/config.sgml new file mode 100644 index 00000000..563a4dcc --- /dev/null +++ b/doc/source/config.sgml @@ -0,0 +1,35 @@ + + + + + + + +]> + + +
+ + &config; + +
diff --git a/doc/source/contacting.sgml b/doc/source/contacting.sgml index d677c139..00f3a0ae 100644 --- a/doc/source/contacting.sgml +++ b/doc/source/contacting.sgml @@ -1,9 +1,9 @@ @@ -57,7 +59,7 @@ Before doing so, please make sure that the bug has not already been submitted - and observe the aditional hints at the top of the submit form. @@ -112,7 +114,7 @@ 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 Prixoxy-related mailing lists, +You can find an overview of all Privoxy-related mailing lists, including list archives, at: http://sourceforge.net/mail/?group_id=11118. diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml index 5eacaa2a..304514cb 100644 --- a/doc/source/developer-manual.sgml +++ b/doc/source/developer-manual.sgml @@ -8,8 +8,8 @@ - - + + @@ -23,16 +23,14 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: developer-manual.sgml,v 1.47 2002/05/26 04:55:11 mal0rd Exp $ + $Id: developer-manual.sgml,v 1.51 2002/05/29 00:30:59 mal0rd Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. ======================================================================== NOTE: Please read developer-manual/documentation.html before touching - anything in this, or other Privoxy documentation. You have been warned! - Failure to abide by this rule will result in the revocation of your license - to live a peaceful existence! + anything in this, or other Privoxy documentation. ======================================================================== --> @@ -50,7 +48,7 @@ - $Id: developer-manual.sgml,v 1.47 2002/05/26 04:55:11 mal0rd Exp $ + $Id: developer-manual.sgml,v 1.51 2002/05/29 00:30:59 mal0rd Exp $ ource$ @@ -1787,7 +1800,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION; #ifndef _FILENAME_H #define _FILENAME_H -#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.47 2002/05/26 04:55:11 mal0rd Exp $" +#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.46.2.4 2002/05/29 00:30:59 mal0rd Exp $" /********************************************************************* * * File : $Source$ @@ -1932,7 +1945,7 @@ at sourceforge. Three simple steps: intelligent (keep it short and precise). - Do not mail to the mailinglist (we cannot keep track on issues there). + Do not mail to the mailing list (we cannot keep track on issues there). @@ -1981,12 +1994,12 @@ at sourceforge. Three simple steps: Y, the version minor, represents the branch within the major version. At any point in time, there are two branches being maintained: The stable branch, with an even minor, say, 2N, in which no functionality is - being added and only bugfixes are made, and 2N+1, the development branch, in + being added and only bug-fixes are made, and 2N+1, the development branch, in which the further development of Privoxy takes place. This enables us to turn the code upside down and inside out, while at the same time providing and maintaining a stable version. - The minor is reset to zero (and one) when the major is inrcemented. When a development + The minor is reset to zero (and one) when the major is incremented. When a development branch has matured to the point where it can be turned into stable, the old stable branch 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the new stable branch 2N+2, and a new development branch 2N+3 is opened. @@ -2146,22 +2159,22 @@ at sourceforge. Three simple steps: - LICENSE (toplevel directory) + LICENSE (top-level directory) - README (toplevel directory) + README (top-level directory) - AUTHORS (toplevel directory) + AUTHORS (top-level directory) - man page (toplevel directory, Unix-like + man page (top-level directory, Unix-like platforms only) @@ -2177,8 +2190,8 @@ at sourceforge. Three simple steps: Also suggested: Developer Manual - (doc/webserver/devel-manual) and ChangeLog - (toplevel directory). FAQ and the manuals are + (doc/webserver/developer-manual) and ChangeLog + (top-level directory). FAQ and the manuals are HTML docs. There are also text versions in doc/text/ which could conceivably also be included. @@ -2186,14 +2199,18 @@ at sourceforge. Three simple steps: The documentation has been designed such that the manuals are linked to each other from parallel directories, and should be packaged - that way. index.html can also be included and - can serve as a focal point for docs and other links of interest. - This should be one level up from the manuals. There are two + that way. privoxy-index.html can also be + included and can serve as a focal point for docs and other links of + interest (and possibly renamed to index.html). + This should be one level up from the manuals. There is a link also + on this page to an HTMLized version of the man page. To avoid 404 for + this, it is in CVS as + doc/webserver/man-page/privoxy-man-page.html, + and should be included along with the manuals. There is also a css stylesheets that can be included for better presentation: - p_doc.css and p_web.css. - These should be in the same directory with - index.html, (i.e. one level up from the manual - directories). + p_doc.css. This should be in the same directory + with privoxy-index.html, (i.e. one level up from + the manual directories). @@ -2422,7 +2439,7 @@ at sourceforge. Three simple steps: - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup + cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup @@ -2432,8 +2449,8 @@ at sourceforge. Three simple steps: - cd winsetup - make + cd winsetup + make @@ -2454,32 +2471,22 @@ at sourceforge. Three simple steps: - debchange -v &p-version;-&p-status;-1 "New upstream version" - + debchange -v &p-version;-&p-status;-1 "New upstream version" + - After this simply run + Then, run: - dpkg-buildpackage -rfakeroot -us -uc -b - + dpkg-buildpackage -rfakeroot -us -uc -b + This will create ../privoxy_&p-version;-&p-status;-1_i386.deb - which can be uploaded. - - - Then, run: - - - - make debian-dist - - - - To upload the package to Sourceforge, simply issue + which can be uploaded. To upload the package to Sourceforge, simply + issue @@ -2522,7 +2529,7 @@ at sourceforge. Three simple steps: -zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg + zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg @@ -2535,7 +2542,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg FreeBSD - Login to Sourceforge's compilefarm via ssh: + Login to Sourceforge's compile-farm via ssh: @@ -2718,7 +2725,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg Update the Webserver When updating the webserver, please follow these steps to make - sure that no broken links, incosistent contents or permission + sure that no broken links, inconsistent contents or permission problems will occur: @@ -2727,7 +2734,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg - make dok # (or make redkat-dok if make dok doesn't work for you) + make dok # (or make redhat-dok if make dok doesn't work for you) @@ -2828,6 +2835,18 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: developer-manual.sgml,v $ + Revision 1.51 2002/05/29 00:30:59 mal0rd + Fixed a little formatting. Clarified debian section. + + Revision 1.50 2002/05/28 04:32:45 hal9 + Change hints on bundling index.html to privoxy-index.html + + Revision 1.49 2002/05/26 17:04:24 hal9 + -Spellcheck, very minor edits, and sync across branches + + Revision 1.48 2002/05/26 12:48:31 roro + Add releasing information about Debian. + Revision 1.47 2002/05/26 04:55:11 mal0rd Added debian-dist and debian-upload targets. Also documented usage. diff --git a/doc/source/faq.sgml b/doc/source/faq.sgml index e32b52df..bb5b5cf9 100644 --- a/doc/source/faq.sgml +++ b/doc/source/faq.sgml @@ -24,7 +24,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: faq.sgml,v 1.60 2002/05/22 17:17:48 oes Exp $ + $Id: faq.sgml,v 1.61 2002/05/25 12:37:25 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -50,9 +50,7 @@ ======================================================================== NOTE: Please read developer-manual/documentation.html before touching - anything in this, or other Privoxy documentation. You have been warned! - Failure to abide by this rule will result in the revocation of your license - to live a peaceful existence! + anything in this, or other Privoxy documentation. ======================================================================== @@ -72,7 +70,7 @@ -$Id: faq.sgml,v 1.60 2002/05/22 17:17:48 oes Exp $ +$Id: faq.sgml,v 1.61 2002/05/25 12:37:25 hal9 Exp $ diff --git a/doc/source/license.sgml b/doc/source/license.sgml index 79df71cb..04f48f4a 100644 --- a/doc/source/license.sgml +++ b/doc/source/license.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: license.sgml,v 1.1 2002/05/05 20:20:00 hal9 Exp $ + $Id: license.sgml,v 1.2 2002/05/10 01:48:20 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -21,7 +21,6 @@ user-manual developer-manual faq - webserver/index.sgml --> diff --git a/doc/source/newfeatures.sgml b/doc/source/newfeatures.sgml index 65a1e073..3ae7e951 100644 --- a/doc/source/newfeatures.sgml +++ b/doc/source/newfeatures.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: newfeatures.sgml,v 1.9 2002/05/10 01:48:20 hal9 Exp $ + $Id: newfeatures.sgml,v 1.10 2002/05/15 03:54:29 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -19,6 +19,7 @@ user-manual faq + announce.sgml --> diff --git a/doc/source/p-authors.sgml b/doc/source/p-authors.sgml index 8bc1f1e3..3637ce2b 100644 --- a/doc/source/p-authors.sgml +++ b/doc/source/p-authors.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: p-authors.sgml,v 1.8 2002/05/25 15:40:20 hal9 Exp $ + $Id: p-authors.sgml,v 1.9 2002/05/27 22:02:47 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -19,6 +19,7 @@ privoxy-man-page AUTHORS + user-manual --> ]]> Rodrigo Barbosa (RPM specfiles) + Moritz Barsnick Hal Burgiss (docs) Alexander Lazic Gábor Lipták @@ -52,13 +54,13 @@ Haroon Rafique Roland Rosenfeld David Schmidt (OS/2, Mac OSX ports) - Joerg Strohmayer (Amiga) + Joerg Strohmayer Sarantis Paskalis - Originally developed by: + Based in part on code originally developed by: @@ -73,17 +75,19 @@ Ken Arromdee + Devin Bayer Reiner Buehl Andrew J. Caines Clifford Caoile + Michael T. Davis Peter E Aaron Hamid Magnus Holmgren Paul Lieverse Roberto Ragusa + Maynard Riley Bart Schelstraete Darren Wiebe jwz - Michael T. Davis ]]> diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml new file mode 100644 index 00000000..cd9d1025 --- /dev/null +++ b/doc/source/p-config.sgml @@ -0,0 +1,1992 @@ + + + + +The Main Configuration File + + + Again, the main configuration file is named config on + Linux/Unix/BSD and OS/2, and config.txt on Windows. + Configuration lines consist of an initial keyword followed by a list of + values, all separated by whitespace (any number of spaces or tabs). For + example: + + + + + + + confdir /etc/privoxy + + + + + + Assigns the value /etc/privoxy to the option + confdir and thus indicates that the configuration + directory is named /etc/privoxy/. + + + + All options in the config file except for confdir and + logdir are optional. Watch out in the below description + for what happens if you leave them unset. + + + + The main config file controls all aspects of Privoxy's + operation that are not location dependent (i.e. they apply universally, no matter + where you may be surfing). + + +]]> + + + + + + @@TITLE<!-- between the @@ is stripped by Makefile -->@@ + Sample Configuration File for Privoxy v&p-version; + + +Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org + + +$Id: p-config.sgml,v 1.1.2.3 2002/05/31 02:56:25 hal9 Exp $ + + + + +################################################################# + # + Table of Contents # + # + I. INTRODUCTION # + II. FORMAT OF THE CONFIGURATION FILE # + # + 1. CONFIGURATION AND LOG FILE LOCATIONS # + 2. LOCAL SET-UP DOCUMENTATION # + 3. DEBUGGING # + 4. ACCESS CONTROL AND SECURITY # + 5. FORWARDING # + 6. WINDOWS GUI OPTIONS # + # +################################################################# + + + +I. INTRODUCTION + =============== + + + This file holds the Privoxy configuration. If you modify this + file, you will need to send a couple of requests to the proxy + before any changes take effect. + + + When starting Privoxy on Unix systems, give the name of this + file as an argument. On Windows systems, Privoxy will look for + this file with the name 'config.txt' in the same directory where + Privoxy is installed. + + + + + +II. FORMAT OF THE CONFIGURATION FILE +==================================== + + + Configuration lines consist of an initial keyword followed by a list + of values, all separated by whitespace (any number of spaces or + tabs). For example, + + + actionsfile default.action + + + Indicates that the actionsfile is named 'default.action'. + + + The '#' indicates a comment. Any part of a line following a '#' is + ignored, except if the '#' is preceded by a '\'. + + + Thus, by placing a # at the start of an existing configuration line, + you can make it a comment and it will be treated as if it weren't there. + This is called "commenting out" an option and can be useful. + + + Note that commenting out and option and leaving it at its default + are two completely different things! Most options behave very + differently when unset. See the the "Effect if unset" explanation + in each option's description for details. + + + Long lines can be continued on the next line by using a `\' as + the last character. + + +]]> + + + + + + + + +Configuration and Log File Locations + + + Privoxy can (and normally does) use a number of + other files for additional configuration, help and logging. + This section of the configuration file tells Privoxy + where to find those other files. + + + + The user running Privoxy, must have read + permission for all configuration files, and write permission to any files + that would be modified, such as log files and actions files. + + + + +confdir + + + + Specifies: + + The directory where the other configuration files are located + + + + Type of value: + + Path name + + + + Default value: + + /etc/privoxy (Unix) or Privoxy installation dir (Windows) + + + + Effect if unset: + + Mandatory + + + + Notes: + + + No trailing /, please + + + When development goes modular and multi-user, the blocker, filter, and + per-user config will be stored in subdirectories of confdir. + For now, the configuration directory structure is flat, except for + confdir/templates, where the HTML templates for CGI + output reside (e.g. Privoxy's 404 error page). + + + + + +@@confdir .]]> + + + + +logdir + + + + Specifies: + + + The directory where all logging takes place (i.e. where logfile and + jarfile are located) + + + + + Type of value: + + Path name + + + + Default value: + + /var/log/privoxy (Unix) or Privoxy installation dir (Windows) + + + + Effect if unset: + + Mandatory + + + + Notes: + + + No trailing /, please + + + + + +@@logdir .]]> + + + + + +actionsfile + + + + + + + + Specifies: + + + The actions file(s) to use + + + + + Type of value: + + File name, relative to confdir, without the .action suffix + + + + Default values: + + + + standard # Internal purposes, no editing recommended + + + default # Main actions file + + + user # User customizations + + + + + + Effect if unset: + + + No actions are taken at all. Simple neutral proxying. + + + + + Notes: + + + Multiple actionsfile lines are permitted, and are in fact recommended! + + + The default values include standard.action, which is used for internal + purposes and should be loaded, default.action, which is the + main actions file maintained by the developers, and + user.action, where you can make your personal additions. + + + Actions files are where all the per site and per URL configuration is done for + ad blocking, cookie management, privacy considerations, etc. + There is no point in using Privoxy without at + least one actions file. + + + + + + + +@@actionsfile standard # Internal purpose, recommended]]> +@@actionsfile default # Main actions file]]> +@@actionsfile user # User customizations]]> + + + +filterfile + + + + Specifies: + + + The filter file to use + + + + + Type of value: + + File name, relative to confdir + + + + Default value: + + default.filter (Unix) or default.filter.txt (Windows) + + + + Effect if unset: + + + No textual content filtering takes place, i.e. all + +filter{name} + actions in the actions files are turned neutral. + + + + + Notes: + + + The filter file contains content modification + rules that use regular expressions. These rules permit + powerful changes on the content of Web pages, e.g., you could disable your favorite + JavaScript annoyances, re-write the actual displayed text, or just have some + fun replacing Microsoft with MicroSuck wherever + it appears on a Web page. + + + The + +filter{name} + actions rely on the relevant filter (name) + to be defined in the filter file! + + + A pre-defined filter file called default.filter that contains + a bunch of handy filters for common problems is included in the distribution. + See the section on the filter + action for a list. + + + + + +@@filterfile default.filter]]> + + + + +logfile + + + + Specifies: + + + The log file to use + + + + + Type of value: + + File name, relative to logdir + + + + Default value: + + logfile (Unix) or privoxy.log (Windows) + + + + Effect if unset: + + + No log file is used, all log messages go to the console (STDERR). + + + + + Notes: + + + The windows version will additionally log to the console. + + + The logfile is where all logging and error messages are written. The level + of detail and number of messages are set with the debug + option (see below). The logfile can be useful for tracking down a problem with + Privoxy (e.g., it's not blocking an ad you + think it should block) but in most cases you probably will never look at it. + + + Your logfile will grow indefinitely, and you will probably want to + periodically remove it. On Unix systems, you can do this with a cron job + (see man cron). For Red Hat, a logrotate + script has been included. + + + On SuSE Linux systems, you can place a line like /var/log/privoxy.* + +1024k 644 nobody.nogroup in /etc/logfiles, with + the effect that cron.daily will automatically archive, gzip, and empty the + log, when it exceeds 1M size. + + + Any log files must be writable by whatever user Privoxy + is being run as (default on UNIX, user id is privoxy). + + + + + +@@logfile logfile]]> + + + + +jarfile + + + + Specifies: + + + The file to store intercepted cookies in + + + + + Type of value: + + File name, relative to logdir + + + + Default value: + + jarfile (Unix) or privoxy.jar (Windows) + + + + Effect if unset: + + + Intercepted cookies are not stored at all. + + + + + Notes: + + + The jarfile may grow to ridiculous sizes over time. + + + + + +@@jarfile jarfile]]> + + + + +trustfile + + + Specifies: + + + The trust file to use + + + + + Type of value: + + File name, relative to confdir + + + + Default value: + + Unset (commented out). When activated: trust (Unix) or trust.txt (Windows) + + + + Effect if unset: + + + The whole trust mechanism is turned off. + + + + + Notes: + + + The trust mechanism is an experimental feature for building white-lists and should + be used with care. It is NOT recommended for the casual user. + + + If you specify a trust file, Privoxy will only allow + access to sites that are named in the trustfile. + You can also mark sites as trusted referrers (with +), with + the effect that access to untrusted sites will be granted, if a link from a + trusted referrer was used. + The link target will then be added to the trustfile. + Possible applications include limiting Internet access for children. + + + If you use + operator in the trust file, it may grow considerably over time. + + + + + +@@#trustfile trust]]> + + + + + + + + +Local Set-up Documentation + + + If you intend to operate Privoxy for more users + than just yourself, it might be a good idea to let them know how to reach + you, what you block and why you do that, your policies, etc. + + + + +user-manual + + + Specifies: + + + Location of the Privoxy User Manual. + + + + + Type of value: + + A fully qualified URI + + + + Default value: + + Unset + + + + Effect if unset: + + + http://www.privoxy.org/version/user-manual/ + will be used, where version is the Privoxy version. + + + + + Notes: + + + The User Manual URI is used for help links from some of the internal CGI pages. + The manual itself is normally packaged with the binary distributions, so you probably want + to set this to a locally installed copy. For multi-user setups, you could provide a copy on + a local webserver for all your users and use the corresponding URL here. + + + Examples: + + + Unix, in local filesystem: + + + user-manual  file:///usr/share/doc/privoxy-&p-version;/user-manual/ + + + Any platform, on local webserver (called local-webserver): + + + user-manual  http://local-webserver/privoxy-user-manual/ + + + + + If set, this option should be the first option in the config + file, because it is used while the config file is being read. + + + ]]> + + + + WARNING!!! + +
+ + If set, this option should be the first option in the config + file, because it is used while the config file is being read. + +
+ ]]> + + + + + +@@#user-manual http://www.privoxy.org/user-manual/]]> + + + + +trust-info-url + + + + Specifies: + + + A URL to be displayed in the error page that users will see if access to an untrusted page is denied. + + + + + Type of value: + + URL + + + + Default value: + + Two example URL are provided + + + + Effect if unset: + + + No links are displayed on the "untrusted" error page. + + + + + Notes: + + + The value of this option only matters if the experimental trust mechanism has been + activated. (See trustfile above.) + + + If you use the trust mechanism, it is a good idea to write up some on-line + documentation about your trust policy and to specify the URL(s) here. + Use multiple times for multiple URLs. + + + The URL(s) should be added to the trustfile as well, so users don't end up + locked out from the information on why they were locked out in the first place! + + + + + +@@trust-info-url http://www.example.com/why_we_block.html]]> +@@trust-info-url http://www.example.com/what_we_allow.html]]> + + + + +admin-address + + + + Specifies: + + + An email address to reach the proxy administrator. + + + + + Type of value: + + Email address + + + + Default value: + + Unset + + + + Effect if unset: + + + No email address is displayed on error pages and the CGI user interface. + + + + + Notes: + + + If both admin-address and proxy-info-url + are unset, the whole "Local Privoxy Support" box on all generated pages will + not be shown. + + + + + +@@#admin-address privoxy-admin@example.com]]> + + + + +proxy-info-url + + + + Specifies: + + + A URL to documentation about the local Privoxy setup, + configuration or policies. + + + + + Type of value: + + URL + + + + Default value: + + Unset + + + + Effect if unset: + + + No link to local documentation is displayed on error pages and the CGI user interface. + + + + + Notes: + + + If both admin-address and proxy-info-url + are unset, the whole "Local Privoxy Support" box on all generated pages will + not be shown. + + + This URL shouldn't be blocked ;-) + + + + + +@@#proxy-info-url http://www.example.com/proxy-service.html]]> + + + + + + + +Debugging + + + These options are mainly useful when tracing a problem. + Note that you might also want to invoke + Privoxy with the --no-daemon + command line option when debugging. + + +debug + + + + Specifies: + + + Key values that determine what information gets logged to the + logfile. + + + + + Type of value: + + Integer values + + + + Default value: + + 12289 (i.e.: URLs plus informational and warning messages) + + + + Effect if unset: + + + Nothing gets logged. + + + + + Notes: + + + The available debug levels are: + + + + debug 1 # show each GET/POST/CONNECT request + debug 2 # show each connection status + debug 4 # show I/O status + debug 8 # show header parsing + debug 16 # log all data into the logfile + debug 32 # debug force feature + debug 64 # debug regular expression filter + debug 128 # debug fast redirects + debug 256 # debug GIF de-animation + debug 512 # Common Log Format + debug 1024 # debug kill pop-ups + debug 4096 # Startup banner and warnings. + debug 8192 # Non-fatal errors + + + + To select multiple debug levels, you can either add them or use + multiple debug lines. + + + A debug level of 1 is informative because it will show you each request + as it happens. 1, 4096 and 8192 are highly recommended + so that you will notice when things go wrong. The other levels are probably + only of interest if you are hunting down a specific problem. They can produce + a hell of an output (especially 16). + + + + The reporting of fatal errors (i.e. ones which crash + Privoxy) is always on and cannot be disabled. + + + If you want to use CLF (Common Log Format), you should set debug + 512 ONLY and not enable anything else. + + + + + +@@debug 1 # show each GET/POST/CONNECT request]]> +@@debug 4096 # Startup banner and warnings]]> +@@debug 8192 # Errors - *we highly recommended enabling this]]> + + + + +single-threaded + + + + Specifies: + + + Whether to run only one server thread + + + + + Type of value: + + None + + + + Default value: + + Unset + + + + Effect if unset: + + + Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to + serve multiple requests simultaneously. + + + + + Notes: + + + This option is only there for debug purposes and you should never + need to use it. It will drastically reduce performance. + + + + + +@@#single-threaded]]> + + + + + + + + + +Access Control and Security + + + This section of the config file controls the security-relevant aspects + of Privoxy's configuration. + + + + +listen-address + + + + Specifies: + + + The IP address and TCP port on which Privoxy will + listen for client requests. + + + + + Type of value: + + [IP-Address]:Port + + + + + Default value: + + 127.0.0.1:8118 + + + + Effect if unset: + + + Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for + home users who run Privoxy on the same machine as + their browser. + + + + + Notes: + + + You will need to configure your browser(s) to this proxy address and port. + + + If you already have another service running on port 8118, or if you want to + serve requests from other machines (e.g. on your local network) as well, you + will need to override the default. + + + If you leave out the IP address, Privoxy will + bind to all interfaces (addresses) on your machine and may become reachable + from the Internet. In that case, consider using access control lists (ACL's, see below), and/or + a firewall. + + + If you open Privoxy to untrusted users, you will + also want to turn off the enable-edit-actions and + enable-remote-toggle + options! + + + + + Example: + + + Suppose you are running Privoxy on + a machine which has the address 192.168.0.1 on your local private network + (192.168.0.0) and has another outside connection with a different address. + You want it to serve requests from inside only: + + + + listen-address 192.168.0.1:8118 + + + + + + +@@listen-address 127.0.0.1:8118]]> + + + + +toggle + + + + Specifies: + + + Initial state of "toggle" status + + + + + Type of value: + + 1 or 0 + + + + Default value: + + 1 + + + + Effect if unset: + + + Act as if toggled on + + + + + Notes: + + + If set to 0, Privoxy will start in + toggled off mode, i.e. behave like a normal, content-neutral + proxy where all ad blocking, filtering, etc are disabled. See + enable-remote-toggle below. This is not really useful + anymore, since toggling is much easier via the web interface than via + editing the conf file. + + + The windows version will only display the toggle icon in the system tray + if this option is present. + + + + + +@@toggle 1]]> + + + + +enable-remote-toggle + + + Specifies: + + + Whether or not the web-based toggle + feature may be used + + + + + Type of value: + + 0 or 1 + + + + Default value: + + 1 + + + + Effect if unset: + + + The web-based toggle feature is disabled. + + + + + Notes: + + + When toggled off, Privoxy acts like a normal, + content-neutral proxy, i.e. it acts as if none of the actions applied to + any URL. + + + For the time being, access to the toggle feature can not be + controlled separately by ACLs or HTTP authentication, + so that everybody who can access Privoxy (see + ACLs and listen-address above) can + toggle it for all users. So this option is not recommended + for multi-user environments with untrusted users. + + + Note that you must have compiled Privoxy with + support for this feature, otherwise this option has no effect. + + + + + +@@enable-remote-toggle 1]]> + + + + +enable-edit-actions + + + Specifies: + + + Whether or not the web-based actions + file editor may be used + + + + + Type of value: + + 0 or 1 + + + + Default value: + + 1 + + + + Effect if unset: + + + The web-based actions file editor is disabled. + + + + + Notes: + + + For the time being, access to the editor can not be + controlled separately by ACLs or HTTP authentication, + so that everybody who can access Privoxy (see + ACLs and listen-address above) can + modify its configuration for all users. So this option is not + recommended for multi-user environments with untrusted users. + + + Note that you must have compiled Privoxy with + support for this feature, otherwise this option has no effect. + + + + + +@@enable-edit-actions 1]]> + + + + +ACLs: permit-access and deny-access + + + + + + Specifies: + + + Who can access what. + + + + + Type of value: + + + src_addr[/src_masklen] + [dst_addr[/dst_masklen]] + + + Where src_addr and + dst_addr are IP addresses in dotted decimal notation or valid + DNS names, and src_masklen and + dst_masklen are subnet masks in CIDR notation, i.e. integer + values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole + destination part are optional. + + + + + Default value: + + Unset + + + + Effect if unset: + + + Don't restrict access further than implied by listen-address + + + + + Notes: + + + Access controls are included at the request of ISPs and systems + administrators, and are not usually needed by individual users. + For a typical home user, it will normally suffice to ensure that + Privoxy only listens on the localhost + (127.0.0.1) or internal (home) network address by means of the + listen-address + option. + + + Please see the warnings in the FAQ that this proxy is not intended to be a substitute + for a firewall or to encourage anyone to defer addressing basic security + weaknesses. + + + Multiple ACL lines are OK. + If any ACLs are specified, then the Privoxy + talks only to IP addresses that match at least one permit-access line + and don't match any subsequent deny-access line. In other words, the + last match wins, with the default being deny-access. + + + If Privoxy is using a forwarder (see forward below) + for a particular destination URL, the dst_addr + that is examined is the address of the forwarder and NOT the address + of the ultimate target. This is necessary because it may be impossible for the local + Privoxy to determine the IP address of the + ultimate target (that's often what gateways are used for). + + + You should prefer using IP addresses over DNS names, because the address lookups take + time. All DNS names must resolve! You can not use domain patterns + like *.org or partial domain names. If a DNS name resolves to multiple + IP addresses, only the first one is used. + + + Denying access to particular sites by ACL may have undesired side effects + if the site in question is hosted on a machine which also hosts other sites. + + + + + Examples: + + + Explicitly define the default behavior if no ACL and + listen-address are set: localhost + is OK. The absence of a dst_addr implies that + all destination addresses are OK: + + + + permit-access localhost + + + + Allow any host on the same class C subnet as www.privoxy.org access to + nothing but www.example.com: + + + + permit-access www.privoxy.org/24 www.example.com/32 + + + + Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere, + with the exception that 192.168.45.73 may not access www.dirty-stuff.example.com: + + + + permit-access 192.168.45.64/26 + deny-access 192.168.45.73 www.dirty-stuff.example.com + + + + + + + + + +buffer-limit + + + + Specifies: + + + Maximum size of the buffer for content filtering. + + + + + Type of value: + + Size in Kbytes + + + + Default value: + + 4096 + + + + Effect if unset: + + + Use a 4MB (4096 KB) limit. + + + + + Notes: + + + For content filtering, i.e. the +filter and + +deanimate-gif actions, it is necessary that + Privoxy buffers the entire document body. + This can be potentially dangerous, since a server could just keep sending + data indefinitely and wait for your RAM to exhaust -- with nasty consequences. + Hence this option. + + + When a document buffer size reaches the buffer-limit, it is + flushed to the client unfiltered and no further attempt to + filter the rest of the document is made. Remember that there may be multiple threads + running, which might require up to buffer-limit Kbytes + each, unless you have enabled single-threaded + above. + + + + + +@@buffer-limit 4096]]> + + + + + + + + + + +Forwarding + + + This feature allows routing of HTTP requests through a chain of + multiple proxies. + It can be used to better protect privacy and confidentiality when + accessing specific domains by routing requests to those domains + through an anonymous public proxy (see e.g. http://www.multiproxy.org/anon_list.htm) + Or to use a caching proxy to speed up browsing. Or chaining to a parent + proxy may be necessary because the machine that Privoxy + runs on has no direct Internet access. + + + + Also specified here are SOCKS proxies. Privoxy + supports the SOCKS 4 and SOCKS 4A protocols. + + +forward + + + Specifies: + + + To which parent HTTP proxy specific requests should be routed. + + + + + Type of value: + + + target_domain[:port] + http_parent[/port] + + + Where target_domain is a domain name pattern (see the + chapter on domain matching in the default.action file), + http_parent is the address of the parent HTTP proxy + as an IP addresses in dotted decimal notation or as a valid DNS name (or . to denote + no forwarding, and the optional + port parameters are TCP ports, i.e. integer + values from 1 to 64535 + + + + + Default value: + + Unset + + + + Effect if unset: + + + Don't use parent HTTP proxies. + + + + + Notes: + + + If http_parent is ., then requests are not + forwarded to another HTTP proxy but are made directly to the web servers. + + + Multiple lines are OK, they are checked in sequence, and the last match wins. + + + + + Examples: + + + Everything goes to an example anonymizing proxy, except SSL on port 443 (which it doesn't handle): + + + + forward .* anon-proxy.example.org:8080 + forward :443 . + + + + Everything goes to our example ISP's caching proxy, except for requests + to that ISP's sites: + + + + forward .*. caching-proxy.example-isp.net:8000 + forward .example-isp.net . + + + + + + + + + + +forward-socks4 and forward-socks4a + + + + + + Specifies: + + + Through which SOCKS proxy (and to which parent HTTP proxy) specific requests should be routed. + + + + + Type of value: + + + target_domain[:port] + socks_proxy[/port] + http_parent[/port] + + + Where target_domain is a domain name pattern (see the + chapter on domain matching in the default.action file), + http_parent and socks_proxy + are IP addresses in dotted decimal notation or valid DNS names (http_parent + may be . to denote no HTTP forwarding), and the optional + port parameters are TCP ports, i.e. integer values from 1 to 64535 + + + + + Default value: + + Unset + + + + Effect if unset: + + + Don't use SOCKS proxies. + + + + + Notes: + + + Multiple lines are OK, they are checked in sequence, and the last match wins. + + + The difference between forward-socks4 and forward-socks4a + is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS + server, while in SOCKS 4 it happens locally. + + + If http_parent is ., then requests are not + forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through + a SOCKS proxy. + + + + + Examples: + + + From the company example.com, direct connections are made to all + internal domains, but everything outbound goes through + their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to + the Internet. + + + + forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080 + forward .example.com . + + + + A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this: + + + + forward-socks4 .*. socks-gw.example.com:1080 . + + + + + + + + + +Advanced Forwarding Examples + + + If you have links to multiple ISPs that provide various special content + only to their subscribers, you can configure multiple Privoxies + which have connections to the respective ISPs to act as forwarders to each other, so that + your users can see the internal content of all ISPs. + + + + Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to + isp-b.net. Both run Privoxy. Their forwarding + configuration can look like this: + + + + host-a: + + + + + forward .*. . + forward .isp-b.net host-b:8118 + + + + + host-b: + + + + + forward .*. . + forward .isp-a.net host-a:8118 + + + + + Now, your users can set their browser's proxy to use either + host-a or host-b and be able to browse the internal content + of both isp-a and isp-b. + + + + If you intend to chain Privoxy and + squid locally, then chain as + browser -> squid -> privoxy is the recommended way. + + + + Assuming that Privoxy and squid + run on the same box, your squid configuration could then look like this: + + + + + # Define Privoxy as parent proxy (without ICP) + cache_peer 127.0.0.1 parent 8118 7 no-query + + # Define ACL for protocol FTP + acl ftp proto FTP + + # Do not forward FTP requests to Privoxy + always_direct allow ftp + + # Forward all the rest to Privoxy + never_direct allow all + + + + You would then need to change your browser's proxy settings to squid's address and port. + Squid normally uses port 3128. If unsure consult http_port in squid.conf. + + + +]]> + + + + + + + + + +Windows GUI Options + + Privoxy has a number of options specific to the + Windows GUI interface: + + + +@@]]> + + If activity-animation is set to 1, the + Privoxy icon will animate when + Privoxy is active. To turn off, set to 0. + + +@@#activity-animation 1]]> + + + + + activity-animation 1 + + + + +]]> + + +@@]]> + + If log-messages is set to 1, + Privoxy will log messages to the console + window: + + +@@#log-messages 1]]> + + + + + log-messages 1 + + + + +]]> + + +@@]]> + + If log-buffer-size is set to 1, the size of the log buffer, + i.e. the amount of memory used for the log messages displayed in the + console window, will be limited to log-max-lines (see below). + + + + Warning: Setting this to 0 will result in the buffer to grow infinitely and + eat up all your memory! + + +@@#log-buffer-size 1]]> + + + + + log-buffer-size 1 + + + + +]]> + + +@@]]> + + log-max-lines is the maximum number of lines held + in the log buffer. See above. + + +@@#log-max-lines 200]]> + + + + + log-max-lines 200 + + + + +]]> + + +@@]]> + + If log-highlight-messages is set to 1, + Privoxy will highlight portions of the log + messages with a bold-faced font: + + +@@#log-highlight-messages 1]]> + + + + + log-highlight-messages 1 + + + + +]]> + + +@@]]> + + The font used in the console window: + + +@@#log-font-name Comic Sans MS]]> + + + + + log-font-name Comic Sans MS + + + + +]]> + + +@@]]> + + Font size used in the console window: + + +@@#log-font-size 8]]> + + + + + log-font-size 8 + + + + +]]> + + +@@]]> + + show-on-task-bar controls whether or not + Privoxy will appear as a button on the Task bar + when minimized: + + +@@#show-on-task-bar 0]]> + + + + + show-on-task-bar 0 + + + + +]]> + + +@@]]> + + If close-button-minimizes is set to 1, the Windows close + button will minimize Privoxy instead of closing + the program (close with the exit option on the File menu). + + +@@#close-button-minimizes 1]]> + + + + + close-button-minimizes 1 + + + + +]]> + + +@@]]> + + The hide-console option is specific to the MS-Win console + version of Privoxy. If this option is used, + Privoxy will disconnect from and hide the + command console. + + +@@#hide-console]]> + + + + + #hide-console + + + + +]]> + + + + + + + + + + + + + + + +]]> + + diff --git a/doc/source/privoxy-man-page.sgml b/doc/source/privoxy-man-page.sgml index 4d91d670..4560bc11 100644 --- a/doc/source/privoxy-man-page.sgml +++ b/doc/source/privoxy-man-page.sgml @@ -5,7 +5,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: privoxy-man-page.sgml,v 1.13 2002/05/15 00:12:07 hal9 Exp $ + $Id: privoxy-man-page.sgml,v 1.14 2002/05/26 17:04:25 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index 0970d429..aa6c2f25 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -17,16 +17,14 @@ Purpose : README for Privoxy - $Id: readme.sgml,v 1.15 2002/05/05 17:35:32 hal9 Exp $ + $Id: readme.sgml,v 1.16 2002/05/26 17:04:25 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. ======================================================================== NOTE: Please read developer-manual/documentation.html before touching - anything in this, or other Privoxy documentation. You have been warned! - Failure to abide by this rule will result in the revocation of your license - to live a peaceful existence! + anything in this, or other Privoxy documentation. ======================================================================== =================================================================== @@ -45,18 +43,6 @@ to avoid extra blank lines, etc. ====================================================================== - For stable releases, change - - entity % p-not-stable "INCLUDE" - - to - - entity % p-not-stable "IGNORE" - - in the DTD at the top. This will toggle various text 'off'. BOTH - MUST be toggled in this case or you will get both text referencing - stable and unstable versions. You only want one or the other! - -->
@@ -158,7 +144,8 @@ USER[.GROUP]] [config_file] - See the man page or user-manual for a brief explanation of each option. + See the man page or User Manual for an explanation of each option, and + other configuration and usage issues. If no config_file is specified on the command line, Privoxy will look for a @@ -166,24 +153,27 @@ for 'config.txt'). If no config_file is found, Privoxy will fail to start. - Or for Red Hat: /etc/rc.d/init.d/privoxy start + 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 + CONFIGURATION See: 'config', 'default.action', 'user.action', and 'default.filter'. - 'user.action' is for personal configuration. 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 a run down of configuration options, - and examples: http://www.privoxy.org/user-manual/. + '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 <IP>:<Port>, or @@ -206,8 +196,8 @@ DOCUMENTATION 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 + 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. @@ -238,7 +228,7 @@ - +
diff --git a/doc/source/supported.sgml b/doc/source/supported.sgml index 072b815e..c16ad27d 100644 --- a/doc/source/supported.sgml +++ b/doc/source/supported.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: supported.sgml,v 1.9 2002/05/10 01:48:20 hal9 Exp $ + $Id: supported.sgml,v 1.10 2002/05/26 17:04:25 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -20,11 +20,12 @@ user-manual faq newfeatures + announce --> At present, Privoxy is known to run on - Windows(95, 98, ME, 2000, XP), Linux (RedHat, Suse, Debian, Conectiva), + Windows(95, 98, ME, 2000, XP), Linux (RedHat, SuSE, Debian, Conectiva), Mac OSX, OS/2, AmigaOS, BeOS, FreeBSD, NetBSD, Solaris, and many more flavors of Unix. diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 2673c6b1..8bc75084 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -10,6 +10,7 @@ + @@ -18,7 +19,8 @@ - + + @@ -30,7 +32,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.123 2002/05/24 23:19:23 hal9 Exp $ + $Id: user-manual.sgml,v 1.124 2002/05/29 02:01:02 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -56,7 +58,7 @@ -$Id: user-manual.sgml,v 1.123 2002/05/24 23:19:23 hal9 Exp $ +$Id: user-manual.sgml,v 1.124 2002/05/29 02:01:02 hal9 Exp $ @@ -258,6 +260,7 @@ automatically start Privoxy in the boot process. system. Check that no Junkbuster or Privoxy objects are in your startup folder. + @@ -296,15 +299,6 @@ automatically start Privoxy in the boot process. directory, including all configuration and log files. To uninstall, just remove this directory. - - Start Privoxy (with RUN <>NIL:) in your - startnet script (AmiTCP), in - s:user-startup (RoadShow), as startup program in your - startup script (Genesis), or as startup action (Miami and MiamiDx). - Privoxy will automatically quit when you quit your - TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that - Privoxy is still running). - @@ -579,7 +573,7 @@ automatically start Privoxy in the boot process. When you connect to a website, the full URL will either match one or more of the sections as defined in Privoxy's configuration, or not. If so, then Privoxy will perform the - respective actions. If not, then nothing special happens. Futhermore, web + respective actions. If not, then nothing special happens. Furthermore, web pages may contain embedded, secondary URLs that your web browser will use to load additional components of the page, as it parses the original page's HTML content. An ad image for instance, is just an URL @@ -617,10 +611,10 @@ automatically start Privoxy in the boot process. for all common image types (e.g. GIF), but there are many situations where this is not so easy to determine. So we'll force it in these cases. This is particularly important for ad blocking, since only if we know that it's an image of - some kind, can we replace it with an image of our chosing, instead of the + some kind, can we replace it with an image of our choosing, instead of the Privoxy BLOCKED page (which would only result in a broken image icon). There are some limitations to this - though. For instance, you can't just brute-force an image substituion for + though. For instance, you can't just brute-force an image substitution for an entire HTML page in most situations. @@ -640,7 +634,7 @@ automatically start Privoxy in the boot process. -    pattern - a checkboard pattern, so that an ad +    pattern - a checkerboard pattern, so that an ad replacement is obvious. This is the default. @@ -763,7 +757,7 @@ automatically start Privoxy in the boot process. For advanced users who want to hand edit their config files, you might want to now go to the Actions Files Tutorial. - The ideas explained thererin also apply to the web-based editor. + The ideas explained therein also apply to the web-based editor. @@ -855,9 +849,9 @@ automatically start Privoxy in the boot process. -RedHat and Conectiva +Red Hat and Conectiva - We use a script. Note that RedHat does not start Privoxy upon booting per + We use a script. Note that Red Hat does not start Privoxy upon booting per default. It will use the file /etc/privoxy/config as its main configuration file. @@ -903,7 +897,7 @@ your PC. Click on the Privoxy Icon to start Privoxy. If no configuration file is specified on the command line, Privoxy will look for a file named config.txt. Note that Windows will - automatically start Privoxy upon booting your PC. + automatically start Privoxy upon booting you PC. @@ -922,27 +916,38 @@ Example Unix startup command: OS/2 -During installation, Privoxy is configured to start automatically when the system restarts. -You can start it manually by double-clicking on the Privoxy icon in the Privoxy folder. + During installation, Privoxy is configured to + start automatically when the system restarts. You can start it manually by + double-clicking on the Privoxy icon in the + Privoxy folder. MAX OSX -During installation, Privoxy is configured to start automatically when the system restarts. -You can start it manually through the Termial with these commands: + During installation, Privoxy is configured to + start automatically when the system restarts. You can start it manually + through the Terminal with these commands: + + cd /Applications/Privoxy.app - ./privoxy - + ./privoxy + AmigaOS -FIXME. + Start Privoxy (with RUN <>NIL:) in your + startnet script (AmiTCP), in + s:user-startup (RoadShow), as startup program in your + startup script (Genesis), or as startup action (Miami and MiamiDx). + Privoxy will automatically quit when you quit your + TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that + Privoxy is still running). @@ -1040,1985 +1045,292 @@ must find a better place for this paragraph If you can't get rid of the problem at all, think you've found a bug in Privoxy, want to propose a new feature or smarter rules, please see the - section Contacting the - Developers below. - - ---> - - - -Command Line Options - - Privoxy may be invoked with the following - command-line options: - - - - - - - - --version - - - Print version info and exit. Unix only. - - - - - --help - - - Print short usage info and exit. Unix only. - - - - - --no-daemon - - - Don't become a daemon, i.e. don't fork and become process group - leader, and don't detach from controlling tty. Unix only. - - - - - --pidfile FILE - - - - On startup, write the process ID to FILE. Delete the - FILE on exit. Failure to create or delete the - FILE is non-fatal. If no FILE - option is given, no PID file will be used. Unix only. - - - - - --user USER[.GROUP] - - - - After (optionally) writing the PID file, assume the user ID of - USER, and if included the GID of GROUP. Exit if the - privileges are not sufficient to do so. Unix only. - - - - - configfile - - - If no configfile is included on the command line, - Privoxy will look for a file named - config in the current directory (except on Win32 - where it will look for config.txt instead). Specify - full path to avoid confusion. If no config file is found, - Privoxy will fail to start. - - - - - - - - - - - - - - -<application>Privoxy</application> Configuration - - All Privoxy configuration is stored - in text files. These files can be edited with a text editor. - Many important aspects of Privoxy can - also be controlled easily with a web browser. - - - - - - -Controlling <application>Privoxy</application> with Your Web Browser - - Privoxy's user interface can be reached through the special - URL http://config.privoxy.org/ - (shortcut: http://p.p/), - which is a built-in page and works without Internet access. - You will see the following section: - - - - - - -     Privoxy Menu - - - -         ▪  View & change the current configuration - - -         ▪  View the source code version numbers - - -         ▪  View the request headers. - - -         ▪  Look up which actions apply to a URL and why - - -         ▪  Toggle Privoxy on or off - - - - - - - - This should be self-explanatory. Note the first item leads to an editor for the - actions files, which is where the ad, banner, - cookie, and URL blocking magic is configured as well as other advanced features of - Privoxy. This is an easy way to adjust various - aspects of Privoxy configuration. The actions - file, and other configuration files, are explained in detail below. - - - - Toggle Privoxy On or Off is handy for sites that might - have problems with your current actions and filters. You can in fact use - it as a test to see whether it is Privoxy - causing the problem or not. Privoxy continues - to run as a proxy in this case, but all manipulation is disabled, i.e. - Privoxy acts like a normal forwarding proxy. There - is even a toggle Bookmarklet offered, so - that you can toggle Privoxy with one click from - your browser. - - - - - - - - - - - - -Configuration Files Overview - - For Unix, *BSD and Linux, all configuration files are located in - /etc/privoxy/ by default. For MS Windows, OS/2, and - AmigaOS these are all in the same directory as the - Privoxy executable. - - - - The installed defaults provide a reasonable starting point, though - some settings may be aggressive by some standards. For the time being, the - principle configuration files are: - - - - - - - - The main configuration file is named config - on Linux, Unix, BSD, OS/2, and AmigaOS and config.txt - on Windows. This is a required file. - - - - - - default.action (the main actions file) - is used to define which actions relating to banner-blocking, images, pop-ups, - content modification, cookie handling etc should be applied by default. It also defines many - exceptions (both positive and negative) from this default set of actions that enable - Privoxy to selectively eliminate the junk, and only the junk, on - as many websites as possible. - - - Multiple actions files may be defined in config. These - are processed in the order they are defined. Local customizations and locally - preferred exceptions to the default policies as defined in - default.action (which you will most probably want - to define sooner or later) are probably best applied in - user.action, where you can preserve them across - upgrades. standard.action is for - Privoxy's internal use. - - - There is also a web based editor that can be accessed from - http://config.privoxy.org/show-status - (Shortcut: http://p.p/show-status) for the - various actions files. - - - - - - default.filter (the filter - file) can be used to re-write the raw page content, including - viewable text as well as embedded HTML and JavaScript, and whatever else - lurks on any given web page. The filtering jobs are only pre-defined here; - whether to apply them or not is up to the actions files. - - - - - - - - All files use the # character to denote a - comment (the rest of the line will be ignored) and understand line continuation - through placing a backslash ("\") as the very last character - in a line. If the # is preceded by a backslash, it looses - its special function. Placing a # in front of an otherwise - valid configuration line to prevent it from being interpreted is called "commenting - out" that line. - - - - The actions files and default.filter - can use Perl style regular expressions for - maximum flexibility. - - - - After making any changes, there is no need to restart - Privoxy in order for the changes to take - effect. Privoxy detects such changes - automatically. Note, however, that it may take one or two additional - requests for the change to take effect. When changing the listening address - of Privoxy, these wake up requests - must obviously be sent to the old listening address. - - - - While under development, the configuration content is subject to change. - The below documentation may not be accurate by the time you read this. - Also, what constitutes a default setting, may change, so - please check all your configuration files on important issues. - -]]> - - - - - - - - - -The Main Configuration File - - - Again, the main configuration file is named config on - Linux/Unix/BSD and OS/2, and config.txt on Windows. - Configuration lines consist of an initial keyword followed by a list of - values, all separated by whitespace (any number of spaces or tabs). For - example: - - - - - - - confdir /etc/privoxy - - - - - - Assigns the value /etc/privoxy to the option - confdir and thus indicates that the configuration - directory is named /etc/privoxy/. - - - - All options in the config file except for confdir and - logdir are optional. Watch out in the below description - for what happens if you leave them unset. - - - - The main config file controls all aspects of Privoxy's - operation that are not location dependent (i.e. they apply universally, no matter - where you may be surfing). - - - - - - -Configuration and Log File Locations - - - Privoxy can (and normally does) use a number of - other files for additional configuration, help and logging. - This section of the configuration file tells Privoxy - where to find those other files. - - - - The user running Privoxy, must have read permission for all - configuration files, and write permission to any files that would - be modified, such as log files. - - -confdir - - - - Specifies: - - The directory where the other configuration files are located - - - - Type of value: - - Path name - - - - Default value: - - /etc/privoxy (Unix) or Privoxy installation dir (Windows) - - - - Effect if unset: - - Mandatory - - - - Notes: - - - No trailing /, please - - - When development goes modular and multi-user, the blocker, filter, and - per-user config will be stored in subdirectories of confdir. - For now, the configuration directory structure is flat, except for - confdir/templates, where the HTML templates for CGI - output reside (e.g. Privoxy's 404 error page). - - - - - - - -logdir - - - - Specifies: - - - The directory where all logging takes place (i.e. where logfile and - jarfile are located) - - - - - Type of value: - - Path name - - - - Default value: - - /var/log/privoxy (Unix) or Privoxy installation dir (Windows) - - - - Effect if unset: - - Mandatory - - - - Notes: - - - No trailing /, please - - - - - - - -actionsfile - - - - - - - - Specifies: - - - The actions file(s) to use - - - - - Type of value: - - File name, relative to confdir, without the .action suffix - - - - Default values: - - - - standard # Internal purposes, no editing recommended - - - default # Main actions file - - - user # User customizations - - - - - - Effect if unset: - - - No actions are taken at all. Simple neutral proxying. - - - - - Notes: - - - Multiple actionsfile lines are permitted, and are in fact recommended! - - - The default values include standard.action, which is used for internal - purposes and should be loaded, default.action, which is the - main actions file maintained by the developers, and - user.action, where you can make your personal additions. - - - Actions files are where all the per site and per URL configuration is done for - ad blocking, cookie management, privacy considerations, etc. - There is no point in using Privoxy without at - least one actions file. - - - - - - -filterfile - - - - Specifies: - - - The filter file to use - - - - - Type of value: - - File name, relative to confdir - - - - Default value: - - default.filter (Unix) or default.filter.txt (Windows) - - - - Effect if unset: - - - No textual content filtering takes place, i.e. all - +filter{name} - actions in the actions files are turned neutral. - - - - - Notes: - - - The filter file contains content modification - rules that use regular expressions. These rules permit - powerful changes on the content of Web pages, e.g., you could disable your favorite - JavaScript annoyances, re-write the actual displayed text, or just have some - fun replacing Microsoft with MicroSuck wherever - it appears on a Web page. - - - The - +filter{name} - actions rely on the relevant filter (name) - to be defined in the filter file! - - - A pre-defined filter file called default.filter that contains - a bunch of handy filters for common problems is included in the distribution. - See the section on the filter - action for a list. - - - - - - -logfile - - - - Specifies: - - - The log file to use - - - - - Type of value: - - File name, relative to logdir - - - - Default value: - - logfile (Unix) or privoxy.log (Windows) - - - - Effect if unset: - - - No log file is used, all log messages go to the console (stderr). - - - - - Notes: - - - The windows version will additionally log to the console. - - - The logfile is where all logging and error messages are written. The level - of detail and number of messages are set with the debug - option (see below). The logfile can be useful for tracking down a problem with - Privoxy (e.g., it's not blocking an ad you - think it should block) but in most cases you probably will never look at it. - - - Your logfile will grow indefinitely, and you will probably want to - periodically remove it. On Unix systems, you can do this with a cron job - (see man cron). For Red Hat, a logrotate - script has been included. - - - On SuSE Linux systems, you can place a line like /var/log/privoxy.* - +1024k 644 nobody.nogroup in /etc/logfiles, with - the effect that cron.daily will automatically archive, gzip, and empty the - log, when it exceeds 1M size. - - - Any log files must be writable by whatever user Privoxy - is being run as (default on UNIX, user id is privoxy). - - - - - - -jarfile - - - - Specifies: - - - The file to store intercepted cookies in - - - - - Type of value: - - File name, relative to logdir - - - - Default value: - - jarfile (Unix) or privoxy.jar (Windows) - - - - Effect if unset: - - - Intercepted cookies are not stored at all. - - - - - Notes: - - - The jarfile may grow to ridiculous sizes over time. - - - - - - -trustfile - - - Specifies: - - - The trust file to use - - - - - Type of value: - - File name, relative to confdir - - - - Default value: - - Unset (commented out). When activated: trust (Unix) or trust.txt (Windows) - - - - Effect if unset: - - - The whole trust mechanism is turned off. - - - - - Notes: - - - The trust mechanism is an experimental feature for building white-lists and should - be used with care. It is NOT recommended for the casual user. - - - If you specify a trust file, Privoxy will only allow - access to sites that are named in the trustfile. - You can also mark sites as trusted referrers (with +), with - the effect that access to untrusted sites will be granted, if a link from a - trusted referrer was used. - The link target will then be added to the trustfile. - Possible applications include limiting Internet access for children. - - - If you use + operator in the trust file, it may grow considerably over time. - - - - - - - - - - - - - - -Local Set-up Documentation - - - If you intend to operate Privoxy for more users - than just yourself, it might be a good idea to let them know how to reach - you, what you block and why you do that, your policies, etc. - - -user-manual - - - Specifies: - - - Location of the Privoxy User Manual. - - - - - Type of value: - - A fully qualified URI - - - - Default value: - - Unset - - - - Effect if unset: - - - http://www.privoxy.org/version/user-manual/ - will be used, where version is the Privoxy version. - - - - - Notes: - - - The User Manual URI is used for help links from some of the internal CGI pages. - The manual itself is normally packaged with the binary distributions, so you probably want - to set this to a locally installed copy. For multi-user setups, you could provide a copy on - a local webserver for all your users and use the corresponding URL here. - - - Examples: - - - Unix, in local filesystem: - - - user-manual  file:///usr/share/doc/privoxy-&p-version;/user-manual/ - - - Any platform, on local webserver (called local-webserver): - - - user-manual  http://local-webserver/privoxy-user-manual/ - - - - If set, this option should be the first option in the config file, because - it is used while the config file is being read. - - - - - - - -trust-info-url - - - - Specifies: - - - A URL to be displayed in the error page that users will see if access to an untrusted page is denied. - - - - - Type of value: - - URL - - - - Default value: - - Two example URL are provided - - - - Effect if unset: - - - No links are displayed on the "untrusted" error page. - - - - - Notes: - - - The value of this option only matters if the experimental trust mechanism has been - activated. (See trustfile above.) - - - If you use the trust mechanism, it is a good idea to write up some on-line - documentation about your trust policy and to specify the URL(s) here. - Use multiple times for multiple URLs. - - - The URL(s) should be added to the trustfile as well, so users don't end up - locked out from the information on why they were locked out in the first place! - - - - - - -admin-address - - - - Specifies: - - - An email address to reach the proxy administrator. - - - - - Type of value: - - Email address - - - - Default value: - - Unset - - - - Effect if unset: - - - No email address is displayed on error pages and the CGI user interface. - - - - - Notes: - - - If both admin-address and proxy-info-url - are unset, the whole "Local Privoxy Support" box on all generated pages will - not be shown. - - - - - - -proxy-info-url - - - - Specifies: - - - A URL to documentation about the local Privoxy setup, - configuration or policies. - - - - - Type of value: - - URL - - - - Default value: - - Unset - - - - Effect if unset: - - - No link to local documentation is displayed on error pages and the CGI user interface. - - - - - Notes: - - - If both admin-address and proxy-info-url - are unset, the whole "Local Privoxy Support" box on all generated pages will - not be shown. - - - This URL shouldn't be blocked ;-) - - - - - - - - - - - - -Debugging - - - These options are mainly useful when tracing a problem. - Note that you might also want to invoke - Privoxy with the --no-daemon - command line option when debugging. - - -debug - - - - Specifies: - - - Key values that determine what information gets logged to the - logfile. - - - - - Type of value: - - Integer values - - - - Default value: - - 12289 (i.e.: URLs plus informational and warning messages) - - - - Effect if unset: - - - Nothing gets logged. - - - - - Notes: - - - The available debug levels are: - - - - debug 1 # show each GET/POST/CONNECT request - debug 2 # show each connection status - debug 4 # show I/O status - debug 8 # show header parsing - debug 16 # log all data into the logfile - debug 32 # debug force feature - debug 64 # debug regular expression filter - debug 128 # debug fast redirects - debug 256 # debug GIF de-animation - debug 512 # Common Log Format - debug 1024 # debug kill pop-ups - debug 4096 # Startup banner and warnings. - debug 8192 # Non-fatal errors - - - - To select multiple debug levels, you can either add them or use - multiple debug lines. - - - A debug level of 1 is informative because it will show you each request - as it happens. 1, 4096 and 8192 are highly recommended - so that you will notice when things go wrong. The other levels are probably - only of interest if you are hunting down a specific problem. They can produce - a hell of an output (especially 16). - - - - The reporting of fatal errors (i.e. ones which crash - Privoxy) is always on and cannot be disabled. - - - If you want to use CLF (Common Log Format), you should set debug - 512 ONLY and not enable anything else. - - - - - - -single-threaded - - - - Specifies: - - - Whether to run only one server thread - - - - - Type of value: - - None - - - - Default value: - - Unset - - - - Effect if unset: - - - Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to - serve multiple requests simultaneously. - - - - - Notes: - - - This option is only there for debug purposes and you should never - need to use it. It will drastically reduce performance. - - - - - - - - - - - -Access Control and Security - - - This section of the config file controls the security-relevant aspects - of Privoxy's configuration. - - -listen-address - - - - Specifies: - - - The IP address and TCP port on which Privoxy will - listen for client requests. - - - - - Type of value: - - [IP-Address]:Port - - - - - Default value: - - 127.0.0.1:8118 - - - - Effect if unset: - - - Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for - home users who run Privoxy on the same machine as - their browser. - - - - - Notes: - - - You will need to configure your browser(s) to this proxy address and port. - - - If you already have another service running on port 8118, or if you want to - serve requests from other machines (e.g. on your local network) as well, you - will need to override the default. - - - If you leave out the IP address, Privoxy will - bind to all interfaces (addresses) on your machine and may become reachable - from the Internet. In that case, consider using access control lists (ACL's, see below), and/or - a firewall. - - - If you open Privoxy to untrusted users, you will - also want to turn off the enable-edit-actions and - enable-remote-toggle - options! - - - - - Example: - - - Suppose you are running Privoxy on - a machine which has the address 192.168.0.1 on your local private network - (192.168.0.0) and has another outside connection with a different address. - You want it to serve requests from inside only: - - - - listen-address 192.168.0.1:8118 - - - - - - - -toggle - - - - Specifies: - - - Initial state of "toggle" status - - - - - Type of value: - - 1 or 0 - - - - Default value: - - 1 - - - - Effect if unset: - - - Act as if toggled on - - - - - Notes: - - - If set to 0, Privoxy will start in - toggled off mode, i.e. behave like a normal, content-neutral - proxy where all ad blocking, filtering, etc are disabled. See - enable-remote-toggle below. This is not really useful - anymore, since toggling is much easier via the web interface than via - editing the conf file. - - - The windows version will only display the toggle icon in the system tray - if this option is present. - - - - - - - -enable-remote-toggle - - - Specifies: - - - Whether or not the web-based toggle - feature may be used - - - - - Type of value: - - 0 or 1 - - - - Default value: - - 1 - - - - Effect if unset: - - - The web-based toggle feature is disabled. - - - - - Notes: - - - When toggled off, Privoxy acts like a normal, - content-neutral proxy, i.e. it acts as if none of the actions applied to - any URL. - - - For the time being, access to the toggle feature can not be - controlled separately by ACLs or HTTP authentication, - so that everybody who can access Privoxy (see - ACLs and listen-address above) can - toggle it for all users. So this option is not recommended - for multi-user environments with untrusted users. - - - Note that you must have compiled Privoxy with - support for this feature, otherwise this option has no effect. - - - - - - - -enable-edit-actions - - - Specifies: - - - Whether or not the web-based actions - file editor may be used - - - - - Type of value: - - 0 or 1 - - - - Default value: - - 1 - - - - Effect if unset: - - - The web-based actions file editor is disabled. - - - - - Notes: - - - For the time being, access to the editor can not be - controlled separately by ACLs or HTTP authentication, - so that everybody who can access Privoxy (see - ACLs and listen-address above) can - modify its configuration for all users. So this option is not - recommended for multi-user environments with untrusted users. - - - Note that you must have compiled Privoxy with - support for this feature, otherwise this option has no effect. - - - - - - - -ACLs: permit-access and deny-access - - - - - - Specifies: - - - Who can access what. - - - - - Type of value: - - - src_addr[/src_masklen] - [dst_addr[/dst_masklen]] - - - Where src_addr and - dst_addr are IP addresses in dotted decimal notation or valid - DNS names, and src_masklen and - dst_masklen are subnet masks in CIDR notation, i.e. integer - values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole - destination part are optional. - - - - - Default value: - - Unset - - - - Effect if unset: - - - Don't restrict access further than implied by listen-address - - - - - Notes: - - - Access controls are included at the request of ISPs and systems - administrators, and are not usually needed by individual users. - For a typical home user, it will normally suffice to ensure that - Privoxy only listens on the localhost - (127.0.0.1) or internal (home) network address by means of the - listen-address - option. - - - Please see the warnings in the FAQ that this proxy is not intended to be a substitute - for a firewall or to encourage anyone to defer addressing basic security - weaknesses. - - - Multiple ACL lines are OK. - If any ACLs are specified, then the Privoxy - talks only to IP addresses that match at least one permit-access line - and don't match any subsequent deny-access line. In other words, the - last match wins, with the default being deny-access. - - - If Privoxy is using a forwarder (see forward below) - for a particular destination URL, the dst_addr - that is examined is the address of the forwarder and NOT the address - of the ultimate target. This is necessary because it may be impossible for the local - Privoxy to determine the IP address of the - ultimate target (that's often what gateways are used for). - - - You should prefer using IP addresses over DNS names, because the address lookups take - time. All DNS names must resolve! You can not use domain patterns - like *.org or partial domain names. If a DNS name resolves to multiple - IP addresses, only the first one is used. - - - Denying access to particular sites by ACL may have undesired side effects - if the site in question is hosted on a machine which also hosts other sites. - - - - - Examples: - - - Explicitly define the default behavior if no ACL and - listen-address are set: localhost - is OK. The absence of a dst_addr implies that - all destination addresses are OK: - - - - permit-access localhost - - - - Allow any host on the same class C subnet as www.privoxy.org access to - nothing but www.example.com: - - - - permit-access www.privoxy.org/24 www.example.com/32 - - - - Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere, - with the exception that 192.168.45.73 may not access www.dirty-stuff.example.com: - - - - permit-access 192.168.45.64/26 - deny-access 192.168.45.73 www.dirty-stuff.example.com - - - - - - - -buffer-limit - - - - Specifies: - - - Maximum size of the buffer for content filtering. - - - - - Type of value: - - Size in Kbytes - - - - Default value: - - 4096 - - - - Effect if unset: - - - Use a 4MB (4096 KB) limit. - - - - - Notes: - - - For content filtering, i.e. the +filter and - +deanimate-gif actions, it is necessary that - Privoxy buffers the entire document body. - This can be potentially dangerous, since a server could just keep sending - data indefinitely and wait for your RAM to exhaust -- with nasty consequences. - Hence this option. - - - When a document buffer size reaches the buffer-limit, it is - flushed to the client unfiltered and no further attempt to - filter the rest of the document is made. Remember that there may be multiple threads - running, which might require up to buffer-limit Kbytes - each, unless you have enabled single-threaded - above. - - - - - - - - - - - - - - -Forwarding - - - This feature allows routing of HTTP requests through a chain of - multiple proxies. - It can be used to better protect privacy and confidentiality when - accessing specific domains by routing requests to those domains - through an anonymous public proxy (see e.g. http://www.multiproxy.org/anon_list.htm) - Or to use a caching proxy to speed up browsing. Or chaining to a parent - proxy may be necessary because the machine that Privoxy - runs on has no direct Internet access. - - - - Also specified here are SOCKS proxies. Privoxy - supports the SOCKS 4 and SOCKS 4A protocols. - - -forward - - - Specifies: - - - To which parent HTTP proxy specific requests should be routed. - - - - - Type of value: - - - target_domain[:port] - http_parent[/port] - - - Where target_domain is a domain name pattern (see the - chapter on domain matching in the default.action file), - http_parent is the address of the parent HTTP proxy - as an IP addresses in dotted decimal notation or as a valid DNS name (or . to denote - no forwarding, and the optional - port parameters are TCP ports, i.e. integer - values from 1 to 64535 - - - - - Default value: - - Unset - - - - Effect if unset: - - - Don't use parent HTTP proxies. - - - - - Notes: - - - If http_parent is ., then requests are not - forwarded to another HTTP proxy but are made directly to the web servers. - - - Multiple lines are OK, they are checked in sequence, and the last match wins. - - - - - Examples: - - - Everything goes to an example anonymizing proxy, except SSL on port 443 (which it doesn't handle): - - - - forward .* anon-proxy.example.org:8080 - forward :443 . - - - - Everything goes to our example ISP's caching proxy, except for requests - to that ISP's sites: - - - - forward .*. caching-proxy.example-isp.net:8000 - forward .example-isp.net . - - - - - - - - -forward-socks4 and forward-socks4a - - - - - - Specifies: - - - Through which SOCKS proxy (and to which parent HTTP proxy) specific requests should be routed. - - - - - Type of value: - - - target_domain[:port] - socks_proxy[/port] - http_parent[/port] - - - Where target_domain is a domain name pattern (see the - chapter on domain matching in the default.action file), - http_parent and socks_proxy - are IP addresses in dotted decimal notation or valid DNS names (http_parent - may be . to denote no HTTP forwarding), and the optional - port parameters are TCP ports, i.e. integer values from 1 to 64535 - - - - - Default value: - - Unset - - - - Effect if unset: - - - Don't use SOCKS proxies. - - - - - Notes: - - - Multiple lines are OK, they are checked in sequence, and the last match wins. - - - The difference between forward-socks4 and forward-socks4a - is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS - server, while in SOCKS 4 it happens locally. - - - If http_parent is ., then requests are not - forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through - a SOCKS proxy. - - - - - Examples: - - - From the company example.com, direct connections are made to all - internal domains, but everything outbound goes through - their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to - the Internet. - - - - forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080 - forward .example.com . - - - - A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this: - - - - forward-socks4 .*. socks-gw.example.com:1080 . - - - - - - - -Advanced Forwarding Examples - - - If you have links to multiple ISPs that provide various special content - only to their subscribers, you can configure multiple Privoxies - which have connections to the respective ISPs to act as forwarders to each other, so that - your users can see the internal content of all ISPs. - - - - Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to - isp-b.net. Both run Privoxy. Their forwarding - configuration can look like this: - - - - host-a: - - - - - forward .*. . - forward .isp-b.net host-b:8118 - - - - - host-b: - - - - - forward .*. . - forward .isp-a.net host-a:8118 - - - - - Now, your users can set their browser's proxy to use either - host-a or host-b and be able to browse the internal content - of both isp-a and isp-b. + section Contacting the + Developers below. - - If you intend to chain Privoxy and - squid locally, then chain as - browser -> squid -> privoxy is the recommended way. - +--> + + +Command Line Options - Assuming that Privoxy and squid - run on the same box, your squid configuration could then look like this: + Privoxy may be invoked with the following + command-line options: - - # Define Privoxy as parent proxy (without ICP) - cache_peer 127.0.0.1 parent 8118 7 no-query - - # Define ACL for protocol FTP - acl ftp proto FTP - - # Do not forward FTP requests to Privoxy - always_direct allow ftp + - # Forward all the rest to Privoxy - never_direct allow all - + + + --version + + + Print version info and exit. Unix only. + + + + + --help + + + Print short usage info and exit. Unix only. + + + + + --no-daemon + + + Don't become a daemon, i.e. don't fork and become process group + leader, and don't detach from controlling tty. Unix only. + + + + + --pidfile FILE + + + + On startup, write the process ID to FILE. Delete the + FILE on exit. Failure to create or delete the + FILE is non-fatal. If no FILE + option is given, no PID file will be used. Unix only. + + + + + --user USER[.GROUP] + + + + After (optionally) writing the PID file, assume the user ID of + USER, and if included the GID of GROUP. Exit if the + privileges are not sufficient to do so. Unix only. + + + + + configfile + + + If no configfile is included on the command line, + Privoxy will look for a file named + config in the current directory (except on Win32 + where it will look for config.txt instead). Specify + full path to avoid confusion. If no config file is found, + Privoxy will fail to start. + + - - You would then need to change your browser's proxy settings to squid's address and port. - Squid normally uses port 3128. If unsure consult http_port in squid.conf. + - - + + +<application>Privoxy</application> Configuration + + All Privoxy configuration is stored + in text files. These files can be edited with a text editor. + Many important aspects of Privoxy can + also be controlled easily with a web browser. + - -Windows GUI Options - - Privoxy has a number of options specific to the - Windows GUI interface: - - - - If activity-animation is set to 1, the - Privoxy icon will animate when - Privoxy is active. To turn off, set to 0. - + + +Controlling <application>Privoxy</application> with Your Web Browser - - - - activity-animation 1 - - - - + Privoxy's user interface can be reached through the special + URL http://config.privoxy.org/ + (shortcut: http://p.p/), + which is a built-in page and works without Internet access. + You will see the following section: - - - If log-messages is set to 1, - Privoxy will log messages to the console - window: - - - - - log-messages 1 - - - - + + + +     Privoxy Menu - - - If log-buffer-size is set to 1, the size of the log buffer, - i.e. the amount of memory used for the log messages displayed in the - console window, will be limited to log-max-lines (see below). - + + +         ▪  View & change the current configuration + + +         ▪  View the source code version numbers + + +         ▪  View the request headers. + + +         ▪  Look up which actions apply to a URL and why + + +         ▪  Toggle Privoxy on or off + + + + - - Warning: Setting this to 0 will result in the buffer to grow infinitely and - eat up all your memory! - - - - - log-buffer-size 1 - - - + This should be self-explanatory. Note the first item leads to an editor for the + actions files, which is where the ad, banner, + cookie, and URL blocking magic is configured as well as other advanced features of + Privoxy. This is an easy way to adjust various + aspects of Privoxy configuration. The actions + file, and other configuration files, are explained in detail below. - - log-max-lines is the maximum number of lines held - in the log buffer. See above. + Toggle Privoxy On or Off is handy for sites that might + have problems with your current actions and filters. You can in fact use + it as a test to see whether it is Privoxy + causing the problem or not. Privoxy continues + to run as a proxy in this case, but all manipulation is disabled, i.e. + Privoxy acts like a normal forwarding proxy. There + is even a toggle Bookmarklet offered, so + that you can toggle Privoxy with one click from + your browser. - - - - - log-max-lines 200 - - - - + - - - If log-highlight-messages is set to 1, - Privoxy will highlight portions of the log - messages with a bold-faced font: - + - - - - - log-highlight-messages 1 - - - - - - - The font used in the console window: - + + + + +Configuration Files Overview - - - - log-font-name Comic Sans MS - - - + For Unix, *BSD and Linux, all configuration files are located in + /etc/privoxy/ by default. For MS Windows, OS/2, and + AmigaOS these are all in the same directory as the + Privoxy executable. - - Font size used in the console window: + The installed defaults provide a reasonable starting point, though + some settings may be aggressive by some standards. For the time being, the + principle configuration files are: - - - - log-font-size 8 - - - - + - - - show-on-task-bar controls whether or not - Privoxy will appear as a button on the Task bar - when minimized: - + + + The main configuration file is named config + on Linux, Unix, BSD, OS/2, and AmigaOS and config.txt + on Windows. This is a required file. + + - - - - - show-on-task-bar 0 - - - + + + default.action (the main actions file) + is used to define which actions relating to banner-blocking, images, pop-ups, + content modification, cookie handling etc should be applied by default. It also defines many + exceptions (both positive and negative) from this default set of actions that enable + Privoxy to selectively eliminate the junk, and only the junk, on + as many websites as possible. + + + Multiple actions files may be defined in config. These + are processed in the order they are defined. Local customizations and locally + preferred exceptions to the default policies as defined in + default.action (which you will most probably want + to define sooner or later) are probably best applied in + user.action, where you can preserve them across + upgrades. standard.action is for + Privoxy's internal use. + + + There is also a web based editor that can be accessed from + http://config.privoxy.org/show-status + (Shortcut: http://p.p/show-status) for the + various actions files. + + + + + + default.filter (the filter + file) can be used to re-write the raw page content, including + viewable text as well as embedded HTML and JavaScript, and whatever else + lurks on any given web page. The filtering jobs are only pre-defined here; + whether to apply them or not is up to the actions files. + + + + - - If close-button-minimizes is set to 1, the Windows close - button will minimize Privoxy instead of closing - the program (close with the exit option on the File menu). + All files use the # character to denote a + comment (the rest of the line will be ignored) and understand line continuation + through placing a backslash ("\") as the very last character + in a line. If the # is preceded by a backslash, it looses + its special function. Placing a # in front of an otherwise + valid configuration line to prevent it from being interpreted is called "commenting + out" that line. - - - - close-button-minimizes 1 - - - + The actions files and default.filter + can use Perl style regular expressions for + maximum flexibility. - - The hide-console option is specific to the MS-Win console - version of Privoxy. If this option is used, - Privoxy will disconnect from and hide the - command console. + After making any changes, there is no need to restart + Privoxy in order for the changes to take + effect. Privoxy detects such changes + automatically. Note, however, that it may take one or two additional + requests for the change to take effect. When changing the listening address + of Privoxy, these wake up requests + must obviously be sent to the old listening address. + - - - - #hide-console - - - + While under development, the configuration content is subject to change. + The below documentation may not be accurate by the time you read this. + Also, what constitutes a default setting, may change, so + please check all your configuration files on important issues. +]]> + + + + + + + + + &config; + + @@ -4197,7 +2509,7 @@ problem-host.example.com reflect the file type, like in the second example section. - Note that you cannot treat HTML pages as images in most cases. For instance, (inline) ad + Note that you cannot treat HTML pages as images in most cases. For instance, (in-line) ad frames require an HTML page to be sent, or they won't display properly. Forcing handle-as-image in this situation will not replace the ad frame with an image, but lead to error messages. @@ -6134,7 +4446,7 @@ s* industry[ -]leading \ These templates are stored in a subdirectory of the configuration - directory called templates. On unixish platforms, + directory called templates. On Unixish platforms, this is typically /etc/privoxy/templates/. @@ -6482,7 +4794,7 @@ Requests - For information on regular expression based substititions and their applications + For information on regular expression based substitutions and their applications in filters, please see the filter file tutorial in this manual. @@ -6529,7 +4841,7 @@ Requests There is a shortcut: http://p.p/ (But it - doesn't provide a fallback to a real page, in case the request is not + doesn't provide a fall-back to a real page, in case the request is not sent through Privoxy) @@ -6757,7 +5069,7 @@ Requests First, the server headers are read and processed to determine, among other things, the MIME type (document type) and encoding. The headers are then - filtered as deterimed by the + filtered as deterimined by the +crunch-incoming-cookies, +session-cookies-only, and +downgrade-http-version @@ -7195,6 +5507,24 @@ In file: user.action [ View ] [ Edit ] - - + + @@ -20,7 +20,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: index.sgml,v 1.17 2002/05/28 02:31:38 hal9 Exp $ + $Id: index.sgml,v 1.18 2002/05/28 02:31:38 hal9 Exp $ Copyright (C) 2001, 2002 Privoxy Developers See LICENSE. @@ -36,7 +36,7 @@ perl. Generates: index.html, for webserver home page. - privoxy-index.html, for packaging with docs + And privoxy-index.html, for packaging with docs. --> @@ -244,7 +244,16 @@ or write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - Revision 1.17 2002/05/26 17:40:02 hal9 + $Log: index.sgml,v $ + Revision 1.16.2.3 2002/05/28 02:31:38 hal9 + New file, privoxy-index.html, for bundling with documentation. Built from + index.sgml, like homepage, but with content toggles more suitable for this use. + + Revision 1.16.2.2 2002/05/26 22:04:46 hal9 + Add several comments, and reworded 'most recent release', ie we don't officially + release odd numbered versions. + + Revision 1.16.2.1 2002/05/26 17:40:02 hal9 Make team pictures link absolute for docs. Revision 1.16 2002/05/24 10:06:31 oes -- 2.39.2