X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fp-config.sgml;h=0e47644d809229ac1dc895a990d144502c2b63ce;hp=50265291a5bd8ee78aa5b1ecaf65390cba6ad752;hb=f4107f65b676b63a199fe4230e58695757f9f199;hpb=b101107b0df7aa3b6c4ab7df6c09f3b95e877b30;ds=sidebyside
diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index 50265291..0e47644d 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.16 2007/06/01 14:14:29 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.29 2008/03/26 18:07:18 fabiankeil Exp $
- Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2008 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.16 2007/06/01 14:14:29 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.29 2008/03/26 18:07:18 fabiankeil Exp $
-Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
+Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/
@@ -172,7 +172,7 @@ II. FORMAT OF THE CONFIGURATION FILE
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.
@@ -269,12 +269,13 @@ II. FORMAT OF THE CONFIGURATION FILE
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 the proxy, by
- following the built-in URL: http://config.privoxy.org/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/).
@@ -337,7 +338,7 @@ II. FORMAT OF THE CONFIGURATION FILE
Default value:
- Two example URL are provided
+ Two example URLs are provided
@@ -353,7 +354,7 @@ II. FORMAT OF THE CONFIGURATION FILE
The value of this option only matters if the experimental trust mechanism has been
- activated. (See trustfile above.)
+ activated. (See trustfile below.)
If you use the trust mechanism, it is a good idea to write up some on-line
@@ -381,7 +382,7 @@ II. FORMAT OF THE CONFIGURATION FILE
Specifies:
- An email address to reach the proxy administrator.
+ An email address to reach the Privoxy administrator.
@@ -408,7 +409,7 @@ II. FORMAT OF THE CONFIGURATION FILE
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.
@@ -503,7 +504,7 @@ II. FORMAT OF THE CONFIGURATION FILE
Specifies:
- The directory where the other configuration files are located
+ The directory where the other configuration files are located.
@@ -528,7 +529,7 @@ II. FORMAT OF THE CONFIGURATION FILE
Notes:
- No trailing /, please
+ No trailing /, please.
@@actionsfile standard.action # Internal purpose, recommended]]>
@@actionsfile default.action # Main actions file]]>
+
@@actionsfile user.action # User customizations]]>
@@ -762,7 +771,7 @@ actionsfile
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 disable your favorite JavaScript annoyances,
+ 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.
@@ -812,49 +821,47 @@ actionsfile
Default value:
- logfile (Unix) or privoxy.log (Windows)
+ Unset (commented out). When activated: logfile (Unix) or privoxy.log (Windows).Effect if unset:
- No log file is used, all log messages go to the console (STDERR).
+ No logfile is written.
Notes:
-
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.
+ 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, a logrotate
- script has been included.
+ (see man cron). For Red Hat based Linux distributions, 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).
+ is being run as (on Unix, default user id is privoxy).
@@ -885,7 +892,7 @@ actionsfile
Default value:
- Unset (commented out). When activated: jarfile (Unix) or privoxy.jar (Windows)
+ Unset (commented out). When activated: jarfile (Unix) or privoxy.jar (Windows).
@@ -904,7 +911,10 @@ actionsfile
If debug 8 (show header parsing) is enabled, cookies are
- written to the logfile with the rest of the headers.
+ also written to the logfile with the rest of the headers.
+ Therefore this option isn't very useful and may be removed
+ in future releases. Please report to the developers if you
+ are still using it.
@@ -1016,8 +1026,7 @@ actionsfile
Specifies:
- Key values that determine what information gets logged to the
- logfile.
+ Key values that determine what information gets logged.
@@ -1030,14 +1039,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).
@@ -1049,7 +1058,7 @@ actionsfile
- debug 1 # show each GET/POST/CONNECT request
+ debug 1 # log each request destination (and the crunch reason if &my-app; intercepted the request)
debug 2 # show each connection status
debug 4 # show I/O status
debug 8 # show header parsing
@@ -1059,7 +1068,7 @@ actionsfile
debug 128 # debug redirects
debug 256 # debug GIF de-animation
debug 512 # Common Log Format
- debug 1024 # debug kill pop-ups
+ debug 1024 # Unused
debug 2048 # CGI user interface
debug 4096 # Startup banner and warnings.
debug 8192 # Non-fatal errors
@@ -1071,18 +1080,23 @@ 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 causes
- Privoxy to exit) 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 want to use CLF (Common Log Format), you should set debug
+ If you are used to the more verbose settings, simply enable the debug lines
+ below again.
+
+
+ If you want to use pure CLF (Common Log Format), you should set debug
512ONLY and not enable anything else.
@@ -1090,13 +1104,18 @@ actionsfile
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 each request destination (and the crunch reason if &my-app; intercepted the request)]]>
+@@#debug 4096 # Startup banner and warnings]]>
+@@#debug 8192 # Non-fatal errors]]>
@@ -1108,7 +1127,7 @@ actionsfile
Specifies:
- Whether to run only one server thread
+ Whether to run only one server thread.
@@ -1137,8 +1156,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.
@@ -1147,6 +1166,62 @@ actionsfile
@@#single-threaded]]>
+
+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]]>
+
+
@@ -1218,10 +1293,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!
@@ -1285,11 +1359,16 @@ actionsfile
If set to 0, Privoxy will start in
toggled off mode, i.e. mostly 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
+ 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
@@ -1324,7 +1403,7 @@ actionsfile
Default value:
- 1
+ 0
@@ -1340,17 +1419,24 @@ actionsfile
When toggled off, Privoxy mostly acts like a normal,
- content-neutral proxy, i.e. it acts as if none of the actions applied to
- any URL.
+ 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.
@@ -1359,7 +1445,7 @@ actionsfile
-@@enable-remote-toggle 1]]>
+@@enable-remote-toggle 0]]>
@@ -1383,7 +1469,7 @@ actionsfile
Default value:
- 1
+ 0
@@ -1404,16 +1490,20 @@ actionsfile
the ongoing request, even if it is enabled in one of the action files.
- If you are using Privoxy in a
- multi-user environment or with untrustworthy clients and want to
- enforce filtering, you will have to disable this option,
- otherwise you can ignore it.
+ 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 1]]>
+@@enable-remote-http-toggle 0]]>
@@ -1438,7 +1528,7 @@ actionsfile
Default value:
- 1
+ 0
@@ -1453,12 +1543,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
@@ -1468,7 +1568,7 @@ actionsfile
-@@enable-edit-actions 1]]>
+@@enable-edit-actions 0]]>
@@ -1605,9 +1705,9 @@ 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.
@@ -1841,8 +1941,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 .
@@ -1853,7 +1953,7 @@ ACLs: permit-access and deny-access
-forward-socks4 and forward-socks4a
+forward-socks4, forward-socks4a and forward-socks5
@@ -1875,13 +1975,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
@@ -1910,6 +2013,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
@@ -1928,7 +2034,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 .
@@ -1942,18 +2048,19 @@ forward-socks4 and forward-socks4a
- To chain Privoxy and Tor, both running on the same system, you should use
- the rule:
+ To chain Privoxy and Tor, both running on the same system, you would use
+ something like:
- forward-socks4 / 127.0.0.1:9050 .
+ forward-socks4a / 127.0.0.1:9050 .
- The public Tor network can't be used to reach your local network,
- therefore it's a good idea to make some exceptions:
+ 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:
@@ -1965,7 +2072,9 @@ forward-socks4 and forward-socks4a
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 network at all.
+ 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
@@ -1995,8 +2104,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:
@@ -2007,7 +2116,7 @@ forward-socks4 and forward-socks4a
forward / .
- forward .isp-b.net host-b:8118
+ forward .isp-b.example.net host-b:8118
@@ -2018,7 +2127,7 @@ forward-socks4 and forward-socks4a
forward / .
- forward .isp-a.net host-a:8118
+ forward .isp-a.example.org host-a:8118
@@ -2030,7 +2139,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.
@@ -2060,8 +2169,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:
@@ -2120,7 +2230,7 @@ forward-socks4 and forward-socks4a
that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
- Only use this option, if you are getting many forwarding related error messages,
+ 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.
@@ -2298,11 +2408,11 @@ forward-socks4 and forward-socks4a
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 lenght limitations.
+ URL length limitations.
Enabling split-large-forms causes Privoxy
- to devide big forms into smaller ones to keep the URL length down.
+ 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.
@@ -2534,7 +2644,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.