X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fp-config.sgml;h=8fe318369ad6fbf4ee03e0627d6ec95bab4a9409;hp=80964e1a8198d44ae1ff5a6b860615906653ce9d;hb=89c571890a7f2ba82241d297abb5bdc462f21799;hpb=7b56ac7e18f40c1e9fad12dbbb6a260b9279e14c diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml index 80964e1a..8fe31836 100644 --- a/doc/source/p-config.sgml +++ b/doc/source/p-config.sgml @@ -3,9 +3,9 @@ Purpose : Used with other docs and files only. - $Id: p-config.sgml,v 2.2 2002/09/05 05:45:30 hal9 Exp $ + $Id: p-config.sgml,v 2.36 2009/01/23 14:06:07 fabiankeil Exp $ - Copyright (C) 2001, 2002 Privoxy Developers + Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/ See LICENSE. ======================================================================== @@ -95,10 +95,10 @@ Sample Configuration File for Privoxy v&p-version; - $Id: p-config.sgml,v 2.2 2002/09/05 05:45:30 hal9 Exp $ + $Id: p-config.sgml,v 2.36 2009/01/23 14:06:07 fabiankeil Exp $ -Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org +Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/ @@ -110,8 +110,8 @@ Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org I. INTRODUCTION # II. FORMAT OF THE CONFIGURATION FILE # # - 1. CONFIGURATION AND LOG FILE LOCATIONS # - 2. LOCAL SET-UP DOCUMENTATION # + 1. LOCAL SET-UP DOCUMENTATION # + 2. CONFIGURATION AND LOG FILE LOCATIONS # 3. DEBUGGING # 4. ACCESS CONTROL AND SECURITY # 5. FORWARDING # @@ -125,15 +125,21 @@ Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org =============== - 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. + This file holds Privoxy's main configuration. Privoxy detects + configuration changes automatically, so you don't have to restart it + unless you want to load a different configuration file. - 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. + The configuration will be reloaded with the first request after the + change was done, this request itself will still use the old configuration, + though. In other words: it takes two requests before you see the result of + your changes. Requests that are dropped due to ACL don't trigger reloads. + + + When starting Privoxy on Unix systems, give the location of this + file as last argument. On Windows systems, Privoxy will look for + this file with the name 'config.txt' in the current working directory + of the Privoxy process. @@ -160,12 +166,13 @@ II. FORMAT OF THE CONFIGURATION FILE 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. + This is called "commenting out" an option and can be useful. Removing + the # again is called "uncommenting". - Note that commenting out and option and leaving it at its default + Note that commenting out an 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 + differently when unset. See the "Effect if unset" explanation in each option's description for details. @@ -179,163 +186,223 @@ II. FORMAT OF THE CONFIGURATION FILE - - -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. - + + +Local Set-up Documentation - - 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. - + + 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. + -confdir - +user-manual Specifies: - The directory where the other configuration files are located + + Location of the Privoxy User Manual. + Type of value: - Path name + A fully qualified URI Default value: - /etc/privoxy (Unix) or Privoxy installation dir (Windows) + Unset Effect if unset: - Mandatory + + http://www.privoxy.org/version/user-manual/ + will be used, where version is the Privoxy version. + Notes: + + The User Manual URI is the single best source of information on + Privoxy, and 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. + + + Examples: + + + + The best all purpose solution is simply to put the full local + PATH to where the User Manual is + located: + + +   user-manual  /usr/share/doc/privoxy/user-manual + + + The User Manual is then available to anyone with access to + Privoxy, by following the built-in URL: + http://config.privoxy.org/user-manual/ + (or the shortcut: http://p.p/user-manual/). + + + If the documentation is not on the local system, it can be accessed + from a remote server, as: + + +   user-manual  http://example.com/privoxy/user-manual/ + + + - No trailing /, please + If set, this option should be the first option in the config + file, because it is used while the config file is being read + on start-up. + + ]]> + + - 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). + 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. + +
+ ]]> + + -@@confdir .]]> +@@#user-manual http://www.privoxy.org/user-manual/]]> -logdir +trust-info-url Specifies: - The directory where all logging takes place (i.e. where logfile and - jarfile are located) + A URL to be displayed in the error page that users will see if access to an untrusted page is denied. Type of value: - Path name + URL Default value: - /var/log/privoxy (Unix) or Privoxy installation dir (Windows) + Two example URLs are provided Effect if unset: - Mandatory + + No links are displayed on the "untrusted" error page. + Notes: - No trailing /, please + The value of this option only matters if the experimental trust mechanism has been + activated. (See trustfile below.) + + + 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! -@@logdir .]]> +@@trust-info-url http://www.example.com/why_we_block.html]]> +@@trust-info-url http://www.example.com/what_we_allow.html]]> - -actionsfile - - - - - +admin-address + Specifies: - The actions file(s) to use + An email address to reach the Privoxy administrator. Type of value: - File name, relative to confdir, without the .action suffix + Email address - Default values: + Default value: - - - standard # Internal purposes, no editing recommended - - - default # Main actions file - - - user # User customizations - - + Unset Effect if unset: - No actions are taken at all. Simple neutral proxying. + No email address is displayed on error pages and the CGI user interface. @@ -343,62 +410,48 @@ actionsfile 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. - + If both admin-address and proxy-info-url + are unset, the whole "Local Privoxy Support" box on all generated pages will + not be shown. + - - -@@actionsfile standard # Internal purpose, recommended]]> -@@actionsfile default # Main actions file]]> -@@actionsfile user # User customizations]]> +@@#admin-address privoxy-admin@example.com]]> + -filterfile - +proxy-info-url + Specifies: - The filter file to use + A URL to documentation about the local Privoxy setup, + configuration or policies. Type of value: - File name, relative to confdir + URL Default value: - default.filter (Unix) or default.filter.txt (Windows) + Unset Effect if unset: - No textual content filtering takes place, i.e. all - +filter{name} - actions in the actions files are turned neutral. + No link to local documentation is displayed on error pages and the CGI user interface. @@ -406,370 +459,303 @@ actionsfile 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! - + If both admin-address and proxy-info-url + are unset, the whole "Local Privoxy Support" box on all generated pages will + not be shown. + - 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. - + This URL shouldn't be blocked ;-) + -@@filterfile default.filter]]> +@@#proxy-info-url http://www.example.com/proxy-service.html]]> + + + + -logfile + + +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 log file to use - + The directory where the other configuration files are located. Type of value: - File name, relative to logdir + Path name Default value: - logfile (Unix) or privoxy.log (Windows) + /etc/privoxy (Unix) or Privoxy installation dir (Windows) Effect if unset: - - No log file is used, all log messages go to the console (STDERR). - + Mandatory 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. + No trailing /, please. + -@@logfile logfile]]> +@@confdir .]]> - -jarfile +templdir Specifies: - - The file to store intercepted cookies in - + An alternative directory where the templates are loaded from. Type of value: - File name, relative to logdir + Path name Default value: - jarfile (Unix) or privoxy.jar (Windows) + unset Effect if unset: - - Intercepted cookies are not stored at all. - + The templates are assumed to be located in confdir/template. Notes: - The jarfile may grow to ridiculous sizes over time. + Privoxy's original templates are usually + overwritten with each update. Use this option to relocate customized + templates that should be kept. As template variables might change + between updates, you shouldn't expect templates to work with + Privoxy releases other than the one + they were part of, though. -@@jarfile jarfile]]> +@@#templdir .]]> -trustfile +logdir + Specifies: - The trust file to use + The directory where all logging takes place + (i.e. where the logfile is located). Type of value: - File name, relative to confdir + Path name Default value: - Unset (commented out). When activated: trust (Unix) or trust.txt (Windows) + /var/log/privoxy (Unix) or Privoxy installation dir (Windows) Effect if unset: - - The whole trust mechanism is turned off. - + Mandatory 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 specified in the trustfile. Sites can be listed - in one of two ways: - - - Prepending a ~ character limits access to this site - only (and any sub-paths within this site), e.g. - ~www.example.com. - - - Or, you can designate sites as trusted referrers, by - prepending the name with a + character. The effect is that - access to untrusted sites will be granted -- but only if a link from this - trusted referrer was used. The link target will then be added to the - trustfile so that future, direct accesses will be granted. - Sites added via this mechanism do not become trusted referrers themselves - (i.e. they are added with a ~ designation). - - - If you use the + operator in the trust file, it may grow - considerably over time. - - - It is recommended that Privoxy be compiled with - the --disable-force, --disable-toggle and - --disable-editor options, if this feature is to be - used. - - - Possible applications include limiting Internet access for children. + No trailing /, please. -@@#trustfile trust]]> +@@logdir .]]> - - - - - - - -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 + +actionsfile + + + + + Specifies: - Location of the Privoxy User Manual. + The actions file(s) to use Type of value: - A fully qualified URI + Complete file name, relative to confdir - Default value: + Default values: - Unset + + + match-all.action # Actions that are applied to all sites and maybe overruled later on. + + + default.action # Main actions file + + + user.action # User customizations + + Effect if unset: - http://www.privoxy.org/version/user-manual/ - will be used, where version is the Privoxy version. + No actions are taken at all. More or less neutral proxying. 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: + Multiple actionsfile lines are permitted, and are in fact recommended! - - - Unix, in local filesystem: - - -  user-manual  file:///usr/share/doc/privoxy-&p-version;/user-manual/index.html - - - Windows, in local filesystem, must use forward slash notation, and %20 to denote - spaces in path names: - - -  user-manual  file:///c:/some%20dir/privoxy/user-manual/index.html - - - Windows, UNC notation (forward slashes required again): - - -  user-manual  file://///some-server/some-path/privoxy/user-manual/index.html - - - 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. + + The default values are default.action, which is the + main actions file maintained by the developers, and + user.action, where you can make your personal additions. + + + Actions files contain all the per site and per URL configuration for + ad blocking, cookie management, privacy considerations, etc. + There is no point in using Privoxy without at + least one actions file. - - ]]> - - - WARNING!!! + Note that since Privoxy 3.0.7, the complete filename, including the .action + extension has to be specified. The syntax change was necessary to be consistent + with the other file options and to allow previously forbidden characters. -
- - 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/]]> + + +@@actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.]]> +@@actionsfile default.action # Main actions file]]> + +@@actionsfile user.action # User customizations]]> - -trust-info-url - +filterfile + Specifies: - A URL to be displayed in the error page that users will see if access to an untrusted page is denied. + The filter file(s) to use Type of value: - URL + File name, relative to confdir Default value: - Two example URL are provided + default.filter (Unix) or default.filter.txt (Windows) Effect if unset: - No links are displayed on the "untrusted" error page. + No textual content filtering takes place, i.e. all + +filter{name} + actions in the actions files are turned neutral. @@ -777,105 +763,140 @@ actionsfile Notes: - The value of this option only matters if the experimental trust mechanism has been - activated. (See trustfile above.) + Multiple filterfile lines are permitted. - 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 filter files contain content modification + rules that use regular expressions. These rules permit + powerful changes on the content of Web pages, and optionally the headers + as well, e.g., you could try to disable your favorite JavaScript annoyances, + re-write the actual displayed text, or just have some fun + playing buzzword bingo with web pages. - 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! + The + +filter{name} + actions rely on the relevant filter (name) + to be defined in a filter file! + + + A pre-defined filter file called default.filter that contains + a number of useful filters for common problems is included in the distribution. + See the section on the filter + action for a list. + + + It is recommended to place any locally adapted filters into a separate + file, such as user.filter. -@@trust-info-url http://www.example.com/why_we_block.html]]> -@@trust-info-url http://www.example.com/what_we_allow.html]]> +@@filterfile default.filter]]> +@@#filterfile user.filter # User customizations]]> -admin-address +logfile Specifies: - An email address to reach the proxy administrator. + The log file to use Type of value: - Email address + File name, relative to logdir Default value: - Unset + Unset (commented out). When activated: logfile (Unix) or privoxy.log (Windows). Effect if unset: - No email address is displayed on error pages and the CGI user interface. + No logfile is written. 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. - + + 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) and it can help you to monitor what your browser + is doing. + + + Depending on the debug options below, the logfile may be a privacy risk + if third parties can get access to it. As most users will never look + at it, Privoxy 3.0.7 and later only log fatal + errors by default. + + + For most troubleshooting purposes, you will have to change that, + please refer to the debugging section for details. + + + 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 based Linux distributions, a + logrotate script has been included. + + + Any log files must be writable by whatever user Privoxy + is being run as (on Unix, default user id is privoxy). + -@@#admin-address privoxy-admin@example.com]]> +@@logfile logfile]]> -proxy-info-url - +trustfile Specifies: - A URL to documentation about the local Privoxy setup, - configuration or policies. + The name of the trust file to use Type of value: - URL + File name, relative to confdir Default value: - Unset + Unset (commented out). When activated: trust (Unix) or trust.txt (Windows) Effect if unset: - No link to local documentation is displayed on error pages and the CGI user interface. + The entire trust mechanism is disabled. @@ -883,21 +904,53 @@ actionsfile 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. - + 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. + - This URL shouldn't be blocked ;-) - + If you specify a trust file, Privoxy will only allow + access to sites that are specified in the trustfile. Sites can be listed + in one of two ways: + + + Prepending a ~ character limits access to this site + only (and any sub-paths within this site), e.g. + ~www.example.com allows access to + ~www.example.com/features/news.html, etc. + + + Or, you can designate sites as trusted referrers, by + prepending the name with a + character. The effect is that + access to untrusted sites will be granted -- but only if a link from this + trusted referrer was used to get there. The link target will then be added + to the trustfile so that future, direct accesses will be + granted. Sites added via this mechanism do not become trusted referrers + themselves (i.e. they are added with a ~ designation). + There is a limit of 512 such entries, after which new entries will not be + made. + + + If you use the + operator in the trust file, it may grow + considerably over time. + + + It is recommended that Privoxy be compiled with + the --disable-force, --disable-toggle and + --disable-editor options, if this feature is to be + used. + + + Possible applications include limiting Internet access for children. + + -@@#proxy-info-url http://www.example.com/proxy-service.html]]> +@@#trustfile trust]]> - + @@ -918,8 +971,7 @@ actionsfile Specifies: - Key values that determine what information gets logged to the - logfile. + Key values that determine what information gets logged. @@ -932,14 +984,14 @@ actionsfile Default value: - 12289 (i.e.: URLs plus informational and warning messages) + 0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged) Effect if unset: - Nothing gets logged. + Default value is used (see above). @@ -951,20 +1003,20 @@ actionsfile - 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 2048 # CGI user interface - debug 4096 # Startup banner and warnings. - debug 8192 # Non-fatal errors + debug 1 # Log the destination for each request &my-app; let through. See also debug 1024. + debug 2 # show each connection status + debug 4 # show I/O status + debug 8 # show header parsing + debug 16 # log all data written to the network into the logfile + debug 32 # debug force feature + debug 64 # debug regular expression filters + debug 128 # debug redirects + debug 256 # debug GIF de-animation + debug 512 # Common Log Format + debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why. + debug 2048 # CGI user interface + debug 4096 # Startup banner and warnings. + debug 8192 # Non-fatal errors @@ -973,27 +1025,43 @@ actionsfile 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). + as it happens. 1, 4096 and 8192 are 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. + &my-app; used to ship with the debug levels recommended above enabled by + default, but due to privacy concerns 3.0.7 and later are configured to + only log fatal errors. + + + If you are used to the more verbose settings, simply enable the debug lines + below again. - If you want to use CLF (Common Log Format), you should set debug + If you want to use pure CLF (Common Log Format), you should set debug 512 ONLY and not enable anything else. + + Privoxy has a hard-coded limit for the + length of log messages. If it's reached, messages are logged truncated + and marked with ... [too long, truncated]. + + + Please don't file any support requests without trying to reproduce + the problem with increased debug level first. Once you read the log + messages, you may even be able to solve the problem on your own. + -@@debug 1 # show each GET/POST/CONNECT request]]> -@@debug 4096 # Startup banner and warnings]]> -@@debug 8192 # Errors - *we highly recommended enabling this*]]> +@@#debug 1 # Log the destination for each request &my-app; let through.]]> +@@#debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why.]]> +@@#debug 4096 # Startup banner and warnings]]> +@@#debug 8192 # Non-fatal errors]]> @@ -1005,7 +1073,7 @@ actionsfile Specifies: - Whether to run only one server thread + Whether to run only one server thread. @@ -1034,8 +1102,8 @@ actionsfile Notes: - This option is only there for debug purposes and you should never - need to use it. It will drastically reduce performance. + This option is only there for debugging purposes. + It will drastically reduce performance. @@ -1044,16 +1112,72 @@ actionsfile @@#single-threaded]]> - - - - - - -Access Control and Security +hostname - + + + Specifies: + + + The hostname shown on the CGI pages. + + + + + Type of value: + + Text + + + + Default value: + + Unset + + + + Effect if unset: + + + The hostname provided by the operating system is used. + + + + + Notes: + + + On some misconfigured systems resolving the hostname fails or + takes too much time and slows Privoxy down. Setting a fixed hostname + works around the problem. + + + In other circumstances it might be desirable to show a hostname + other than the one returned by the operating system. For example + if the system has several different hostnames and you don't want + to use the first one. + + + Note that Privoxy does not validate the specified hostname value. + + + + + +@@#hostname hostname.example.org]]> + + + + + + + + + +Access Control and Security + + This section of the config file controls the security-relevant aspects of Privoxy's configuration. @@ -1115,10 +1239,9 @@ actionsfile If you open Privoxy to untrusted users, you will - also want to turn off the enable-edit-actions and enable-remote-toggle - options! @@ -1181,12 +1304,17 @@ actionsfile 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 + toggled off mode, i.e. mostly behave like a normal, + content-neutral proxy with both ad blocking and content filtering + disabled. See enable-remote-toggle below. + The windows version will only display the toggle icon in the system tray @@ -1221,7 +1349,7 @@ actionsfile Default value: - 1 + 0 @@ -1236,18 +1364,25 @@ actionsfile 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. + When toggled off, Privoxy mostly acts like a normal, + content-neutral proxy, i.e. doesn't block ads or filter content. - For the time being, access to the toggle feature can not be + 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 malicious client side code (e.g Java) is also + capable of using this option. + + + As a lot of Privoxy users don't read + documentation, this feature is disabled by default. + Note that you must have compiled Privoxy with support for this feature, otherwise this option has no effect. @@ -1256,7 +1391,65 @@ actionsfile -@@enable-remote-toggle 1]]> +@@enable-remote-toggle 0]]> + + + + +enable-remote-http-toggle + + + Specifies: + + + Whether or not Privoxy recognizes special HTTP headers to change its behaviour. + + + + + Type of value: + + 0 or 1 + + + + Default value: + + 0 + + + + Effect if unset: + + + Privoxy ignores special HTTP headers. + + + + + Notes: + + + When toggled on, the client can change Privoxy's + behaviour by setting special HTTP headers. Currently the only supported + special header is X-Filter: No, to disable filtering for + the ongoing request, even if it is enabled in one of the action files. + + + This feature is disabled by default. If you are using + Privoxy in a environment with trusted clients, + you may enable this feature at your discretion. Note that malicious client + side code (e.g Java) is also capable of using this feature. + + + This option will be removed in future releases as it has been obsoleted + by the more general header taggers. + + + + + +@@enable-remote-http-toggle 0]]> @@ -1281,7 +1474,7 @@ actionsfile Default value: - 1 + 0 @@ -1296,12 +1489,22 @@ actionsfile Notes: - For the time being, access to the editor can not be + 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. + modify its configuration for all users. + + + This option is not recommended for environments + with untrusted users and as a lot of Privoxy + users don't read documentation, this feature is disabled by default. + + + Note that malicious client side code (e.g Java) is also + capable of using the actions editor and you shouldn't enable + this options unless you understand the consequences and are + sure your browser is configured correctly. Note that you must have compiled Privoxy with @@ -1311,9 +1514,84 @@ actionsfile -@@enable-edit-actions 1]]> +@@enable-edit-actions 0]]> + + + +enforce-blocks + + + Specifies: + + + Whether the user is allowed to ignore blocks and can go there anyway. + + + + + Type of value: + + + 0 or 1 + + + + + Default value: + + 0 + + + + Effect if unset: + + + Blocks are not enforced. + + + + + Notes: + + + Privoxy is mainly used to block and filter + requests as a service to the user, for example to block ads and other + junk that clogs the pipes. Privoxy's configuration + isn't perfect and sometimes innocent pages are blocked. In this situation it + makes sense to allow the user to enforce the request and have + Privoxy ignore the block. + + + In the default configuration Privoxy's + Blocked page contains a go there anyway + link to adds a special string (the force prefix) to the request URL. + If that link is used, Privoxy will + detect the force prefix, remove it again and let the request pass. + + + Of course Privoxy can also be used to enforce + a network policy. In that case the user obviously should not be able to + bypass any blocks, and that's what the enforce-blocks + option is for. If it's enabled, Privoxy hides + the go there anyway link. If the user adds the force + prefix by hand, it will not be accepted and the circumvention attempt + is logged. + + + + + Examples: + + + enforce-blocks 1 + + + + +@@enforce-blocks 0]]> + ACLs: permit-access and deny-access @@ -1373,14 +1651,14 @@ ACLs: permit-access and deny-access 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. + Please see the warnings in the FAQ that Privoxy + 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 + If any ACLs are specified, Privoxy only talks + 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. @@ -1400,7 +1678,8 @@ ACLs: permit-access and deny-access 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. + if the site in question is hosted on a machine which also hosts other sites + (most sites are). @@ -1420,7 +1699,7 @@ ACLs: permit-access and deny-access Allow any host on the same class C subnet as www.privoxy.org access to - nothing but www.example.com: + nothing but www.example.com (or other domains hosted on the same system): @@ -1429,7 +1708,8 @@ ACLs: permit-access and deny-access 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: + with the exception that 192.168.45.73 may not access the IP address behind + www.dirty-stuff.example.com: @@ -1514,13 +1794,20 @@ ACLs: permit-access and deny-access 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. + + + Forwarding can be used to chain Privoxy with a caching proxy to speed + up browsing. Using a parent proxy may also be necessary if the machine + that Privoxy runs on has no direct Internet access. + + + Note that parent proxies can severely decrease your privacy level. + For example a parent proxy could add your IP address to the request + headers and if it's a caching proxy it may add the Etag + header to revalidation requests again, even though you configured Privoxy + to remove it. It may also ignore Privoxy's header time randomization and use the + original values which could be used by the server as cookie replacement + to track your steps between visits. @@ -1586,11 +1873,11 @@ ACLs: permit-access and deny-access Examples: - Everything goes to an example anonymizing proxy, except SSL on port 443 (which it doesn't handle): + Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle): - forward / anon-proxy.example.org:8080 + forward / parent-proxy.example.org:8080 forward :443 . @@ -1600,8 +1887,8 @@ ACLs: permit-access and deny-access - forward / caching-proxy.example-isp.net:8000 - forward .example-isp.net . + forward / caching-proxy.isp.example.net:8000 + forward .isp.example.net . @@ -1612,7 +1899,7 @@ ACLs: permit-access and deny-access -forward-socks4 and forward-socks4a +forward-socks4, forward-socks4a and forward-socks5 @@ -1621,7 +1908,7 @@ forward-socks4 and forward-socks4a Specifies: - Through which SOCKS proxy (and to which parent HTTP proxy) specific requests should be routed. + Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed. @@ -1634,13 +1921,16 @@ forward-socks4 and forward-socks4a http_parent[:port] - where target_pattern is a URL pattern - that specifies to which requests (i.e. URLs) this forward rule shall apply. Use / to - denote all URLs. - http_parent and socks_proxy - are IP addresses in dotted decimal notation or valid DNS names (http_parent + where target_pattern is a + URL pattern that specifies to which + requests (i.e. URLs) this forward rule shall apply. Use / to + denote all URLs. 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 + port parameters are TCP ports, + i.e. integer values from 1 to 65535 @@ -1669,6 +1959,9 @@ 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. + + With forward-socks5 the DNS resolution will happen on the remote server as well. + 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 @@ -1687,7 +1980,7 @@ forward-socks4 and forward-socks4a - forward-socks4a / socks-gw.example.com:1080 www-cache.example-isp.net:8080 + forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080 forward .example.com . @@ -1699,6 +1992,47 @@ forward-socks4 and forward-socks4a forward-socks4 / socks-gw.example.com:1080 . + + + To chain Privoxy and Tor, both running on the same system, you would use + something like: + + + + forward-socks4a / 127.0.0.1:9050 . + + + + + The public Tor network can't be used to + reach your local network, if you need to access local servers you + therefore might want to make some exceptions: + + + + forward 192.168.*.*/ . + forward 10.*.*.*/ . + forward 127.*.*.*/ . + + + + Unencrypted connections to systems in these address ranges will + be as (un)secure as the local network is, but the alternative is that you + can't reach the local network through Privoxy + at all. Of course this may actually be desired and there is no reason + to make these exceptions if you aren't sure you need them. + + + If you also want to be able to reach servers in your local network by + using their names, you will need additional exceptions that look like + this: + + + + forward localhost/ . + + + @@ -1716,8 +2050,8 @@ forward-socks4 and forward-socks4a - 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 + Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to + isp-b.example.org. Both run Privoxy. Their forwarding configuration can look like this: @@ -1728,7 +2062,7 @@ forward-socks4 and forward-socks4a forward / . - forward .isp-b.net host-b:8118 + forward .isp-b.example.net host-b:8118 @@ -1739,7 +2073,7 @@ forward-socks4 and forward-socks4a forward / . - forward .isp-a.net host-a:8118 + forward .isp-a.example.org host-a:8118 @@ -1751,7 +2085,7 @@ forward-socks4 and forward-socks4a If you intend to chain Privoxy and - squid locally, then chain as + squid locally, then chaining as browser -> squid -> privoxy is the recommended way. @@ -1781,8 +2115,9 @@ forward-socks4 and forward-socks4a - You could just as well decide to only forward requests for Windows executables through - a virus-scanning parent proxy, say, on antivir.example.com, port 8010: + You could just as well decide to only forward requests you suspect + of leading to Windows executables through a virus-scanning parent proxy, + say, on antivir.example.com, port 8010: @@ -1794,6 +2129,359 @@ forward-socks4 and forward-socks4a ]]> +forwarded-connect-retries + + + Specifies: + + + How often Privoxy retries if a forwarded connection request fails. + + + + + Type of value: + + + Number of retries. + + + + + Default value: + + 0 + + + + Effect if unset: + + + Connections forwarded through other proxies are treated like direct connections and no retry attempts are made. + + + + + Notes: + + + forwarded-connect-retries is mainly interesting + for socks4a connections, where Privoxy can't detect why the connections failed. + The connection might have failed because of a DNS timeout in which case a retry makes sense, + but it might also have failed because the server doesn't exist or isn't reachable. In this + case the retry will just delay the appearance of Privoxy's error message. + + + Note that in the context of this option, forwarded connections includes all connections + that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method. + + + Only use this option, if you are getting lots of forwarding-related error messages + that go away when you try again manually. Start with a small value and check Privoxy's + logfile from time to time, to see how many retries are usually needed. + + + + + Examples: + + + forwarded-connect-retries 1 + + + + +@@forwarded-connect-retries 0]]> + + +accept-intercepted-requests + + + Specifies: + + + Whether intercepted requests should be treated as valid. + + + + + Type of value: + + + 0 or 1 + + + + + Default value: + + 0 + + + + Effect if unset: + + + Only proxy requests are accepted, intercepted requests are treated as invalid. + + + + + Notes: + + + If you don't trust your clients and want to force them + to use Privoxy, enable this + option and configure your packet filter to redirect outgoing + HTTP connections into Privoxy. + + + Make sure that Privoxy's own requests + aren't redirected as well. Additionally take care that + Privoxy can't intentionally connect + to itself, otherwise you could run into redirection loops if + Privoxy's listening port is reachable + by the outside or an attacker has access to the pages you visit. + + + + + Examples: + + + accept-intercepted-requests 1 + + + + +@@accept-intercepted-requests 0]]> + + +allow-cgi-request-crunching + + + Specifies: + + + Whether requests to Privoxy's CGI pages can be blocked or redirected. + + + + + Type of value: + + + 0 or 1 + + + + + Default value: + + 0 + + + + Effect if unset: + + + Privoxy ignores block and redirect actions for its CGI pages. + + + + + Notes: + + + By default Privoxy ignores block or redirect actions + for its CGI pages. Intercepting these requests can be useful in multi-user + setups to implement fine-grained access control, but it can also render the complete + web interface useless and make debugging problems painful if done without care. + + + Don't enable this option unless you're sure that you really need it. + + + + + Examples: + + + allow-cgi-request-crunching 1 + + + + +@@allow-cgi-request-crunching 0]]> + + +split-large-forms + + + Specifies: + + + Whether the CGI interface should stay compatible with broken HTTP clients. + + + + + Type of value: + + + 0 or 1 + + + + + Default value: + + 0 + + + + Effect if unset: + + + The CGI form generate long GET URLs. + + + + + Notes: + + + Privoxy's CGI forms can lead to + rather long URLs. This isn't a problem as far as the HTTP + standard is concerned, but it can confuse clients with arbitrary + URL length limitations. + + + Enabling split-large-forms causes Privoxy + to divide big forms into smaller ones to keep the URL length down. + It makes editing a lot less convenient and you can no longer + submit all changes at once, but at least it works around this + browser bug. + + + If you don't notice any editing problems, there is no reason + to enable this option, but if one of the submit buttons appears + to be broken, you should give it a try. + + + + + Examples: + + + split-large-forms 1 + + + + +@@split-large-forms 0]]> + + +keep-alive-timeout + + + Specifies: + + + Number of seconds after which an open connection will no longer be reused. + + + + + Type of value: + + + Time in seconds. + + + + + Default value: + + None + + + + Effect if unset: + + + Connections are not reused. + + + + + Notes: + + + This option has no effect if Privoxy + has been compiled without keep-alive support. + + + + + Examples: + + + keep-alive-timeout 300 + + + + +@@keep-alive-timeout 300]]> + + + +socket-timeout + + + Specifies: + + + Number of seconds after which a socket times out if + no data is received. + + + + + Type of value: + + + Time in seconds. + + + + + Default value: + + None + + + + Effect if unset: + + + A default value of 180 seconds is used. + + + + + Examples: + + + socket-timeout 180 + + + + +@@socket-timeout 180]]> + + + @@ -2002,7 +2690,7 @@ forward-socks4 and forward-socks4a 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 + Privoxy will disconnect from and hide the command console.