X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fp-config.sgml;h=a7405d9692ca6bea70c6b62d43bc0b0cb5afc2b0;hp=fdec02bb7ff30599d5e1e3851cae299981170c17;hb=4d554d8176039481313a3fb2ab2cf56e5a84cb4e;hpb=ee8c5375bb792166036b8593e56163c8060cfef2
diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index fdec02bb..a7405d96 100644
--- a/doc/source/p-config.sgml
+++ b/doc/source/p-config.sgml
@@ -3,39 +3,39 @@
Purpose : Used with other docs and files only.
- $Id: p-config.sgml,v 2.46 2009/04/17 11:31:48 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.122 2016/05/22 12:41:50 fabiankeil Exp $
- Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2016 Privoxy Developers https://www.privoxy.org/
See LICENSE.
========================================================================
- NOTE: Please read developer-manual/documentation.html before touching
+ NOTE: Please read developer-manual/documentation.html before touching
anything in this, or other Privoxy documentation.
========================================================================
-
- This file contains all the config file comments and options. It used to
+
+ This file contains all the config file comments and options. It used to
build both the user-manual config sections, and all of config (yes, the main
config file) itself.
- Rationale: This is broken up into two files since a file with a prolog
+ Rationale: This is broken up into two files since a file with a prolog
(DTD, etc) cannot be sourced as a secondary file. config.sgml is basically
a wrapper for this file.
IMPORTANT:
- OPTIONS: The actual options are included in this file and prefixed with
- '@@', and processed by the Makefile to strip the '@@'. Default options
- that should appear commented out should be listed as: '@@#OPTION'.
+ OPTIONS: The actual options are included in this file and prefixed with
+ '@@', and processed by the Makefile to strip the '@@'. Default options
+ that should appear commented out should be listed as: '@@#OPTION'.
Otherwise, as '@@OPTION'. Example:
@@listen-address 127.0.0.1:8118
- The Makefile does significant other processing too. The final results
- should be checked to make sure that the perl processing does not
+ The Makefile does significant other processing too. The final results
+ should be checked to make sure that the perl processing does not
fubar something!!! Makefile processing requires w3m, fmt (shell line
formatter), and perl.
-
+
This file is included into:
@@ -50,8 +50,8 @@
The Main Configuration File
- Again, the main configuration file is named config on
- Linux/Unix/BSD and OS/2, and config.txt on Windows.
+ By default, the main configuration file is named config,
+ with the exception of Windows, where it is named config.txt.
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:
@@ -59,11 +59,11 @@
-
+ confdir /etc/privoxy
-
+
@@ -81,7 +81,9 @@
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).
+ where you may be surfing). Like the filter and action files, the config file is
+ a plain text file and can be modified with a text editor like emacs, vim or
+ notepad.exe.
]]>
@@ -92,32 +94,33 @@
@@TITLE<!-- between the @@ is stripped by Makefile -->@@
- Sample Configuration File for Privoxy v&p-version;
+ Sample Configuration File for Privoxy &p-version;
- $Id: p-config.sgml,v 2.46 2009/04/17 11:31:48 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.122 2016/05/22 12:41:50 fabiankeil Exp $
-Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
+Copyright (C) 2001-2016 Privoxy Developers https://www.privoxy.org/
-#################################################################
- #
- Table of Contents #
- #
- I. INTRODUCTION #
- II. FORMAT OF THE CONFIGURATION FILE #
- #
- 1. LOCAL SET-UP DOCUMENTATION #
- 2. CONFIGURATION AND LOG FILE LOCATIONS #
- 3. DEBUGGING #
- 4. ACCESS CONTROL AND SECURITY #
- 5. FORWARDING #
- 6. WINDOWS GUI OPTIONS #
- #
-#################################################################
+##################################################################
+ #
+ Table of Contents #
+ #
+ I. INTRODUCTION #
+ II. FORMAT OF THE CONFIGURATION FILE #
+ #
+ 1. LOCAL SET-UP DOCUMENTATION #
+ 2. CONFIGURATION AND LOG FILE LOCATIONS #
+ 3. DEBUGGING #
+ 4. ACCESS CONTROL AND SECURITY #
+ 5. FORWARDING #
+ 6. MISCELLANEOUS #
+ 7. WINDOWS GUI OPTIONS #
+ #
+##################################################################
@@ -165,7 +168,7 @@ 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.
+ 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. Removing
the # again is called "uncommenting".
@@ -226,7 +229,7 @@ II. FORMAT OF THE CONFIGURATION FILE
Effect if unset:
- http://www.privoxy.org/version/user-manual/
+ https://www.privoxy.org/version/user-manual/
will be used, where version is the Privoxy version.
@@ -235,11 +238,11 @@ II. FORMAT OF THE CONFIGURATION FILE
Notes:
- The User Manual URI is the single best source of information on
+ 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.
+ installed copy.
Examples:
@@ -263,7 +266,7 @@ II. FORMAT OF THE CONFIGURATION FILE
user-manual file://///some-server/some-path/privoxy-&p-version;/user-manual/
- -->
+ -->
The best all purpose solution is simply to put the full local
PATH to where the User Manual is
@@ -279,7 +282,7 @@ II. FORMAT OF THE CONFIGURATION FILE
(or the shortcut: http://p.p/user-manual/).
- If the documentation is not on the local system, it can be accessed
+ If the documentation is not on the local system, it can be accessed
from a remote server, as:
@@ -293,7 +296,7 @@ II. FORMAT OF THE CONFIGURATION FILE
file, because it is used while the config file is being read
on start-up.
-
+
]]>
-
+
If set, this option should be the first option in the config
file, because it is used while the config file is being read.
@@ -313,7 +316,7 @@ II. FORMAT OF THE CONFIGURATION FILE
-@@#user-manual http://www.privoxy.org/user-manual/]]>
+@@#user-manual https://www.privoxy.org/user-manual/]]>
@@ -325,7 +328,7 @@ II. FORMAT OF THE CONFIGURATION FILE
Specifies:
- A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
+ A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
@@ -413,7 +416,7 @@ II. FORMAT OF THE CONFIGURATION 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.
-
+
@@ -462,10 +465,10 @@ II. FORMAT OF THE CONFIGURATION 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.
-
+
This URL shouldn't be blocked ;-)
-
+
@@ -487,7 +490,7 @@ II. FORMAT OF THE CONFIGURATION FILE
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.
+ where to find those other files.
@@ -531,16 +534,6 @@ II. FORMAT OF THE CONFIGURATION FILE
No trailing /, please.
-
@@ -595,6 +588,55 @@ II. FORMAT OF THE CONFIGURATION FILE
+
+temporary-directory
+
+
+
+ Specifies:
+
+ A directory where Privoxy can create temporary files.
+
+
+
+ Type of value:
+
+ Path name
+
+
+
+ Default value:
+
+ unset
+
+
+
+ Effect if unset:
+
+ No temporary files are created, external filters don't work.
+
+
+
+ Notes:
+
+
+ To execute external filters,
+ Privoxy has to create temporary files.
+ This directive specifies the directory the temporary files should
+ be written to.
+
+
+ It should be a directory only Privoxy
+ (and trusted users) can access.
+
+
+
+
+
+@@#temporary-directory .]]>
+
+
+
logdir
@@ -683,7 +725,7 @@ actionsfile
Effect if unset:
- No actions are taken at all. More or less neutral proxying.
+ No actions are taken at all. More or less neutral proxying.
@@ -693,21 +735,14 @@ actionsfile
Multiple actionsfile lines are permitted, and are in fact recommended!
-
+
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.
-
- 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.
+ Actions files contain all the per site and per URL configuration for
+ ad blocking, cookie management, privacy considerations, etc.
@@ -770,7 +805,7 @@ actionsfile
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
+ re-write the actual displayed text, or just have some fun
playing buzzword bingo with web pages.
@@ -794,7 +829,7 @@ actionsfile
@@filterfile default.filter]]>
-@@#filterfile user.filter # User customizations]]>
+@@filterfile user.filter # User customizations]]>
@@ -844,23 +879,22 @@ actionsfile
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.
+ at it, Privoxy only logs 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).
+
+ To prevent the logfile from growing indefinitely, it is recommended to
+ periodically rotate or shorten it. Many operating systems support log
+ rotation out of the box, some require additional software to do it.
+ For details, please refer to the documentation for your operating system.
+
@@ -909,14 +943,14 @@ actionsfile
If you specify a trust file, Privoxy will only allow
- access to sites that are specified in the trustfile. Sites can be listed
+ 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.
+ 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.
+ ~www.example.com/features/news.html, etc.
Or, you can designate sites as trusted referrers, by
@@ -930,7 +964,7 @@ actionsfile
made.
- If you use the + operator in the trust file, it may grow
+ If you use the + operator in the trust file, it may grow
considerably over time.
@@ -942,7 +976,7 @@ actionsfile
Possible applications include limiting Internet access for children.
-
+
@@ -1007,7 +1041,7 @@ actionsfile
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 16 # log all data written to the network
debug 32 # debug force feature
debug 64 # debug regular expression filters
debug 128 # debug redirects
@@ -1017,6 +1051,8 @@ actionsfile
debug 2048 # CGI user interface
debug 4096 # Startup banner and warnings.
debug 8192 # Non-fatal errors
+ debug 32768 # log all data read from the network
+ debug 65536 # Log the applying actions
@@ -1029,12 +1065,6 @@ actionsfile
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).
-
-
-
- &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
@@ -1080,13 +1110,13 @@ actionsfile
Type of value:
- None
+ 1 or 0Default value:
- Unset
+ 0
@@ -1109,7 +1139,7 @@ actionsfile
-@@#single-threaded]]>
+@@#single-threaded 1]]>
@@ -1191,7 +1221,7 @@ actionsfile
Specifies:
- The IP address and TCP port on which Privoxy will
+ The address and TCP port on which Privoxy will
listen for client requests.
@@ -1200,6 +1230,7 @@ actionsfile
Type of value:[IP-Address]:Port
+ [Hostname]:Port
@@ -1230,17 +1261,56 @@ actionsfile
serve requests from other machines (e.g. on your local network) as well, you
will need to override the default.
+
+ You can use this statement multiple times to make
+ Privoxy listen on more ports or more
+ IP addresses. Suitable if your operating system does not
+ support sharing IPv6 and IPv4 protocols
+ on the same socket.
+
+
+ If a hostname is used instead of an IP address, Privoxy
+ will try to resolve it to an IP address and if there are multiple, use the first
+ one returned.
+
+
+ If the address for the hostname isn't already known on the system
+ (for example because it's in /etc/hostname), this may result in DNS
+ traffic.
+
+
+ If the specified address isn't available on the system, or if the
+ hostname can't be resolved, Privoxy
+ will fail to start.
+
IPv6 addresses containing colons have to be quoted by brackets.
+ They can only be used if Privoxy has
+ been compiled with IPv6 support. If you aren't sure if your version
+ supports it, have a look at
+ http://config.privoxy.org/show-status.
+
+
+ Some operating systems will prefer IPv6 to IPv4 addresses even if the
+ system has no IPv6 connectivity which is usually not expected by the user.
+ Some even rely on DNS to resolve localhost which mean the "localhost" address
+ used may not actually be local.
+
+
+ It is therefore recommended to explicitly configure the intended IP address
+ instead of relying on the operating system, unless there's a strong reason not to.
- If you leave out the IP address, Privoxy will
- bind to all IPv4 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 the hostname is localhost, Privoxy
- will explicitly try to bind to an IPv4 address. For other hostnames it depends
- on the operating system which IP version will be used.
+ If you leave out the address, Privoxy will bind to all
+ IPv4 interfaces (addresses) on your machine and may become reachable from the
+ Internet and/or the local network. Be aware that some GNU/Linux distributions
+ modify that behaviour without updating the documentation. Check for non-standard
+ patches if your Privoxy version behaves differently.
+
+
+ If you configure Privoxy to be reachable from the
+ network, consider using access control lists
+ (ACL's, see below), and/or a firewall.
If you open Privoxy to untrusted users, you will
@@ -1322,18 +1392,6 @@ actionsfile
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
- if this option is present.
@@ -1400,7 +1458,7 @@ actionsfile
Note that you must have compiled Privoxy with
- support for this feature, otherwise this option has no effect.
+ support for this feature, otherwise this option has no effect.
@@ -1523,7 +1581,7 @@ actionsfile
Note that you must have compiled Privoxy with
- support for this feature, otherwise this option has no effect.
+ support for this feature, otherwise this option has no effect.
@@ -1630,7 +1688,7 @@ ACLs: permit-access and deny-access
[dst_addr[:port][/dst_masklen]]
- Where src_addr and
+ Where src_addr and
dst_addr are IPv4 addresses in dotted decimal notation or valid
DNS names, port is a port
number, and src_masklen and
@@ -1677,11 +1735,11 @@ ACLs: permit-access and deny-access
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
+ 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.
+ option.
Please see the warnings in the FAQ that Privoxy
@@ -1710,9 +1768,9 @@ ACLs: permit-access and deny-access
IP addresses, only the first one is used.
- Some systems allows IPv4 client to connect to IPv6 server socket.
- Then the client's IPv4 address will be translated by system into
- IPv6 address space with special prefix ::ffff/96 (so called IPv4
+ Some systems allow IPv4 clients to connect to IPv6 server sockets.
+ Then the client's IPv4 address will be translated by the system into
+ IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4
mapped IPv6 address). Privoxy can handle it
and maps such ACL addresses automatically.
@@ -1818,7 +1876,7 @@ ACLs: permit-access and deny-access
For content filtering, i.e. the +filter and
- +deanimate-gif actions, it is necessary that
+ +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.
@@ -1839,6 +1897,67 @@ ACLs: permit-access and deny-access
@@buffer-limit 4096]]>
+
+enable-proxy-authentication-forwarding
+
+
+ Specifies:
+
+
+ Whether or not proxy authentication through &my-app; should work.
+
+
+
+
+ Type of value:
+
+ 0 or 1
+
+
+
+ Default value:
+
+ 0
+
+
+
+ Effect if unset:
+
+
+ Proxy authentication headers are removed.
+
+
+
+
+ Notes:
+
+
+ Privoxy itself does not support proxy authentication, but can
+ allow clients to authenticate against Privoxy's parent proxy.
+
+
+ By default Privoxy (3.0.21 and later) don't do that and remove
+ Proxy-Authorization headers in requests and Proxy-Authenticate
+ headers in responses to make it harder for malicious sites to
+ trick inexperienced users into providing login information.
+
+
+ If this option is enabled the headers are forwarded.
+
+
+ Enabling this option is not recommended if there is
+ no parent proxy that requires authentication or if the local network between
+ Privoxy and the parent proxy isn't trustworthy. If proxy authentication is
+ only required for some requests, it is recommended to use a client header filter
+ to remove the authentication headers for requests where they aren't needed.
+
+
+
+
+
+@@enable-proxy-authentication-forwarding 0]]>
+
+
@@ -1891,7 +2010,7 @@ ACLs: permit-access and deny-access
http_parent[:port]
- where target_pattern is a URL pattern
+ 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[:port]
@@ -1964,7 +2083,7 @@ ACLs: permit-access and deny-access
- foward / [2001:DB8::1]:8000
+ forward / [2001:DB8::1]:8000
@@ -1985,7 +2104,7 @@ ACLs: permit-access and deny-access
-forward-socks4, forward-socks4a and forward-socks5
+forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
@@ -2014,7 +2133,7 @@ forward-socks4, forward-socks4a and forward-socks5
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
+ may be . to denote no HTTP forwarding), and the optional
port parameters are TCP ports,
i.e. integer values from 1 to 65535
@@ -2048,6 +2167,12 @@ forward-socks4, forward-socks4a and forward-socks5
With forward-socks5 the DNS resolution will happen on the remote server as well.
+
+ forward-socks5t works like vanilla forward-socks5 but
+ lets &my-app; additionally use Tor-specific SOCKS extensions. Currently the only supported
+ SOCKS extension is optimistic data which can reduce the latency for the first request made
+ on a newly created connection.
+ socks_proxy and
http_parent can be a
@@ -2089,18 +2214,23 @@ forward-socks4, forward-socks4a and forward-socks5
forward-socks4 / socks-gw.example.com:1080 .
-
+
- To chain Privoxy and Tor, both running on the same system, you would use
+ To chain Privoxy and Tor, both running on the same system, you would use
something like:
- forward-socks5 / 127.0.0.1:9050 .
+ forward-socks5t / 127.0.0.1:9050 .
-
-
+
+ Note that if you got Tor through one of the bundles, you may
+ have to change the port from 9050 to 9150 (or even another one).
+ For details, please check the documentation on the
+ Tor website.
+
+
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:
@@ -2140,7 +2270,7 @@ forward-socks4, forward-socks4a and forward-socks5
Advanced Forwarding Examples
- If you have links to multiple ISPs that provide various special content
+ 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.
@@ -2181,9 +2311,9 @@ forward-socks4, forward-socks4a and forward-socks5
- If you intend to chain Privoxy and
- squid locally, then chaining as
- browser -> squid -> privoxy is the recommended way.
+ If you intend to chain Privoxy and
+ squid locally, then chaining as
+ browser -> squid -> privoxy is the recommended way.
@@ -2193,14 +2323,14 @@ forward-socks4, forward-socks4a and forward-socks5
- # Define Privoxy as parent proxy (without ICP)
- cache_peer 127.0.0.1 parent 8118 7 no-query
+ # 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
+ # Define ACL for protocol FTP
+ acl ftp proto FTP
# Do not forward FTP requests to Privoxy
- always_direct allow ftp
+ always_direct allow ftp
# Forward all the rest to Privoxy
never_direct allow all
@@ -2220,7 +2350,7 @@ forward-socks4, forward-socks4a and forward-socks5
forward / .
- forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010
+ forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010
@@ -2232,7 +2362,7 @@ forward-socks4, forward-socks4a and forward-socks5
Specifies:
- How often Privoxy retries if a forwarded connection request fails.
+ How often Privoxy retries if a forwarded connection request fails.
@@ -2291,6 +2421,11 @@ forward-socks4, forward-socks4a and forward-socks5
@@forwarded-connect-retries 0]]>
+
+
+
+Miscellaneous
+
accept-intercepted-requests
@@ -2330,7 +2465,10 @@ forward-socks4, forward-socks4a and forward-socks5
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.
+ HTTP connections into Privoxy.
+
+
+ Note that intercepting encrypted connections (HTTPS) isn't supported.
Make sure that Privoxy's own requests
@@ -2340,6 +2478,12 @@ forward-socks4, forward-socks4a and forward-socks5
Privoxy's listening port is reachable
by the outside or an attacker has access to the pages you visit.
+
+ If you are running Privoxy as intercepting proxy without being
+ able to intercept all client requests you may want to adjust
+ the CGI templates to make sure they don't reference content from
+ config.privoxy.org.
+
@@ -2507,34 +2651,115 @@ forward-socks4, forward-socks4a and forward-socks5
Effect if unset:
- Connections are not reused.
+ Connections are not kept alive.
Notes:
+
+ This option allows clients to keep the connection to &my-app;
+ alive. If the server supports it, &my-app; will keep
+ the connection to the server alive as well. Under certain
+ circumstances this may result in speed-ups.
+
+
+ By default, &my-app; will close the connection to the server if
+ the client connection gets closed, or if the specified timeout
+ has been reached without a new request coming in. This behaviour
+ can be changed with the connection-sharing option.
+
This option has no effect if Privoxy
has been compiled without keep-alive support.
+
+ Note that a timeout of five seconds as used in the default
+ configuration file significantly decreases the number of
+ connections that will be reused. The value is used because
+ some browsers limit the number of connections they open to
+ a single host and apply the same limit to proxies. This can
+ result in a single website grabbing all the
+ connections the browser allows, which means connections to
+ other websites can't be opened until the connections currently
+ in use time out.
+
+
+ Several users have reported this as a Privoxy bug, so the
+ default value has been reduced. Consider increasing it to
+ 300 seconds or even more if you think your browser can handle
+ it. If your browser appears to be hanging, it probably can't.
+
+
+
+
+ Examples:
+
+
+ keep-alive-timeout 300
+
+
+
+
+@@keep-alive-timeout 5]]>
+
+
+
+tolerate-pipelining
+
+
+ Specifies:
+
+
+ Whether or not pipelined requests should be served.
+
+
+
+
+ Type of value:
+
+
+ 0 or 1.
+
+
+
+
+ Default value:
+
+ None
+
+
+
+ Effect if unset:
+
+
+ If Privoxy receives more than one request at once, it terminates the
+ client connection after serving the first one.
+ Notes:
- Note that reusing connections doesn't necessary cause speedups.
- There are also a few privacy implications you should be aware of.
+ &my-app; currently doesn't pipeline outgoing requests,
+ thus allowing pipelining on the client connection is not
+ guaranteed to improve the performance.
+
+
+ By default &my-app; tries to discourage clients from pipelining
+ by discarding aggressively pipelined requests, which forces the
+ client to resend them through a new connection.
+
+
+ This option lets &my-app; tolerate pipelining. Whether or not
+ that improves performance mainly depends on the client configuration.
- Outgoing connections are shared between clients (if there are more
- than one) and closing the client that initiated the outgoing connection
- does not affect the connection between &my-app; and the server unless
- the client's request hasn't been completed yet. If the outgoing connection
- is idle, it will not be closed until either Privoxy's
- or the server's timeout is reached. While it's open, the server knows
- that the system running &my-app; is still there.
+ If you are seeing problems with pages not properly loading,
+ disabling this option could work around the problem.
@@ -2542,23 +2767,22 @@ forward-socks4, forward-socks4a and forward-socks5
Examples:
- keep-alive-timeout 300
+ tolerate-pipelining 1
-@@keep-alive-timeout 300]]>
+@@tolerate-pipelining 1]]>
-socket-timeout
+default-server-timeoutSpecifies:
- Number of seconds after which a socket times out if
- no data is received.
+ Assumed server-side keep-alive timeout if not specified by the server.
@@ -2580,7 +2804,8 @@ forward-socks4, forward-socks4a and forward-socks5
Effect if unset:
- A default value of 300 seconds is used.
+ Connections for which the server didn't specify the keep-alive
+ timeout are not reused.
@@ -2588,9 +2813,34 @@ forward-socks4, forward-socks4a and forward-socks5
Notes:
- For SOCKS requests the timeout currently doesn't start until
- the SOCKS server accepted the request. This will be fixed in
- the next release.
+ Enabling this option significantly increases the number of connections
+ that are reused, provided the keep-alive-timeout option
+ is also enabled.
+
+
+ While it also increases the number of connections problems
+ when &my-app; tries to reuse a connection that already has
+ been closed on the server side, or is closed while &my-app;
+ is trying to reuse it, this should only be a problem if it
+ happens for the first request sent by the client. If it happens
+ for requests on reused client connections, &my-app; will simply
+ close the connection and the client is supposed to retry the
+ request without bothering the user.
+
+
+ Enabling this option is therefore only recommended if the
+ connection-sharing option
+ is disabled.
+
+
+ It is an error to specify a value larger than the keep-alive-timeout value.
+
+
+ This option has no effect if Privoxy
+ has been compiled without keep-alive support.
@@ -2598,74 +2848,798 @@ forward-socks4, forward-socks4a and forward-socks5
Examples:
- socket-timeout 300
+ default-server-timeout 60
-@@socket-timeout 300]]>
+@@#default-server-timeout 60]]>
-
-
-
-
-
-
-
-
-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
-
-
+connection-sharing
+
+
+ Specifies:
+
+
+ Whether or not outgoing connections that have been kept alive
+ should be shared between different incoming connections.
+
+
+
+
+ Type of value:
+
+
+ 0 or 1
+
+
+
+
+ Default value:
+
+ None
+
+
+
+ Effect if unset:
+
+
+ Connections are not shared.
+
+
+
+
+ Notes:
+
+
+ This option has no effect if Privoxy
+ has been compiled without keep-alive support, or if it's disabled.
+
+
+
+
+ Notes:
+
+
+ Note that reusing connections doesn't necessary cause speedups.
+ There are also a few privacy implications you should be aware of.
+
+
+ If this option is effective, outgoing connections are shared between
+ clients (if there are more than one) and closing the browser that initiated
+ the outgoing connection does no longer affect the connection between &my-app;
+ and the server unless the client's request hasn't been completed yet.
+
+
+ If the outgoing connection is idle, it will not be closed until either
+ Privoxy's or the server's timeout is reached.
+ While it's open, the server knows that the system running &my-app; is still
+ there.
+
+
+ If there are more than one client (maybe even belonging to multiple users),
+ they will be able to reuse each others connections. This is potentially
+ dangerous in case of authentication schemes like NTLM where only the
+ connection is authenticated, instead of requiring authentication for
+ each request.
+
+
+ If there is only a single client, and if said client can keep connections
+ alive on its own, enabling this option has next to no effect. If the client
+ doesn't support connection keep-alive, enabling this option may make sense
+ as it allows &my-app; to keep outgoing connections alive even if the client
+ itself doesn't support it.
+
+
+ You should also be aware that enabling this option increases the likelihood
+ of getting the "No server or forwarder data" error message, especially if you
+ are using a slow connection to the Internet.
+
+
+ This option should only be used by experienced users who
+ understand the risks and can weight them against the benefits.
+
+
+
+
+ Examples:
+
+
+ connection-sharing 1
+
+
+
+
+@@#connection-sharing 1]]>
+
+
+
+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 300 seconds is used.
+
+
+
+
+ Notes:
+
+
+ The default is quite high and you probably want to reduce it.
+ If you aren't using an occasionally slow proxy like Tor, reducing
+ it to a few seconds should be fine.
+
+
+
+
+ Examples:
+
+
+ socket-timeout 300
+
+
+
+
+@@socket-timeout 300]]>
+
+
+
+max-client-connections
+
+
+ Specifies:
+
+
+ Maximum number of client connections that will be served.
+
+
+
+
+ Type of value:
+
+
+ Positive number.
+
+
+
+
+ Default value:
+
+ 128
+
+
+
+ Effect if unset:
+
+
+ Connections are served until a resource limit is reached.
+
+
+
+
+ Notes:
+
+
+ &my-app; creates one thread (or process) for every incoming client
+ connection that isn't rejected based on the access control settings.
+
+
+ If the system is powerful enough, &my-app; can theoretically deal with
+ several hundred (or thousand) connections at the same time, but some
+ operating systems enforce resource limits by shutting down offending
+ processes and their default limits may be below the ones &my-app; would
+ require under heavy load.
+
+
+ Configuring &my-app; to enforce a connection limit below the thread
+ or process limit used by the operating system makes sure this doesn't
+ happen. Simply increasing the operating system's limit would work too,
+ but if &my-app; isn't the only application running on the system,
+ you may actually want to limit the resources used by &my-app;.
+
+
+ If &my-app; is only used by a single trusted user, limiting the
+ number of client connections is probably unnecessary. If there
+ are multiple possibly untrusted users you probably still want to
+ additionally use a packet filter to limit the maximal number of
+ incoming connections per client. Otherwise a malicious user could
+ intentionally create a high number of connections to prevent other
+ users from using &my-app;.
+
+
+ Obviously using this option only makes sense if you choose a limit
+ below the one enforced by the operating system.
+
+
+ One most POSIX-compliant systems &my-app; can't properly deal with
+ more than FD_SETSIZE file descriptors at the same time and has to reject
+ connections if the limit is reached. This will likely change in a
+ future version, but currently this limit can't be increased without
+ recompiling &my-app; with a different FD_SETSIZE limit.
+
+
+
+
+ Examples:
+
+
+ max-client-connections 256
+
+
+
+
+@@#max-client-connections 256]]>
+
+
+
+handle-as-empty-doc-returns-ok
+
+
+ Specifies:
+
+
+ The status code Privoxy returns for pages blocked with
+
+ +handle-as-empty-document.
+
+
+
+
+ Type of value:
+
+
+ 0 or 1
+
+
+
+
+ Default value:
+
+ 0
+
+
+
+ Effect if unset:
+
+
+ Privoxy returns a status 403(forbidden) for all blocked pages.
+
+
+
+
+ Effect if set:
+
+
+ Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
+ and a status 403(Forbidden) for all other blocked pages.
+
+
+
+
+ Notes:
+
+
+ This directive was added as a work-around for Firefox bug 492459:
+ Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.
+ (https://bugzilla.mozilla.org/show_bug.cgi?id=492459),
+ the bug has been fixed for quite some time, but this directive is also useful
+ to make it harder for websites to detect whether or not resources are being
+ blocked.
+
+
+
+
+@@#handle-as-empty-doc-returns-ok 1]]>
+
+
+
+enable-compression
+
+
+ Specifies:
+
+
+ Whether or not buffered content is compressed before delivery.
+
+
+
+
+ Type of value:
+
+
+ 0 or 1
+
+
+
+
+ Default value:
+
+ 0
+
+
+
+ Effect if unset:
+
+
+ Privoxy does not compress buffered content.
+
+
+
+
+ Effect if set:
+
+
+ Privoxy compresses buffered content before delivering it to the client,
+ provided the client supports it.
+
+
+
+
+ Notes:
+
+
+ This directive is only supported if Privoxy has been compiled with
+ FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB.
+
+
+ Compressing buffered content is mainly useful if Privoxy and the
+ client are running on different systems. If they are running on the
+ same system, enabling compression is likely to slow things down.
+ If you didn't measure otherwise, you should assume that it does
+ and keep this option disabled.
+
+
+ Privoxy will not compress buffered content below a certain length.
+
+
+
+
+@@#enable-compression 1]]>
+
+
+
+compression-level
+
+
+ Specifies:
+
+
+ The compression level that is passed to the zlib library when compressing buffered content.
+
+
+
+
+ Type of value:
+
+
+ Positive number ranging from 0 to 9.
+
+
+
+
+ Default value:
+
+ 1
+
+
+
+ Notes:
+
+
+ Compressing the data more takes usually longer than compressing
+ it less or not compressing it at all. Which level is best depends
+ on the connection between Privoxy and the client. If you can't
+ be bothered to benchmark it for yourself, you should stick with
+ the default and keep compression disabled.
+
+
+ If compression is disabled, the compression level is irrelevant.
+
+
+
+
+ Examples:
+
+
+
+ # Best speed (compared to the other levels)
+ compression-level 1
+ # Best compression
+ compression-level 9
+ # No compression. Only useful for testing as the added header
+ # slightly increases the amount of data that has to be sent.
+ # If your benchmark shows that using this compression level
+ # is superior to using no compression at all, the benchmark
+ # is likely to be flawed.
+ compression-level 0
+
+
+
+
+
+@@#compression-level 1]]>
+
+
+
+client-header-order
+
+
+ Specifies:
+
+
+ The order in which client headers are sorted before forwarding them.
+
+
+
+
+ Type of value:
+
+
+ Client header names delimited by spaces or tabs
+
+
+
+
+ Default value:
+
+ None
+
+
+
+ Notes:
+
+
+ By default &my-app; leaves the client headers in the order they
+ were sent by the client. Headers are modified in-place, new headers
+ are added at the end of the already existing headers.
+
+
+ The header order can be used to fingerprint client requests
+ independently of other headers like the User-Agent.
+
+
+ This directive allows to sort the headers differently to better
+ mimic a different User-Agent. Client headers will be emitted
+ in the order given, headers whose name isn't explicitly specified
+ are added at the end.
+
+
+ Note that sorting headers in an uncommon way will make fingerprinting
+ actually easier. Encrypted headers are not affected by this directive.
+
+
+
+
+@@#client-header-order Host \
+ User-Agent \
+ Accept \
+ Accept-Language \
+ Accept-Encoding \
+ Proxy-Connection \
+ Referer \
+ Cookie \
+ DNT \
+ If-Modified-Since \
+ Cache-Control \
+ Content-Length \
+ Content-Type
+]]>
+
+
+
+client-specific-tag
+
+
+ Specifies:
+
+
+ The name of a tag that will always be set for clients that
+ requested it through the webinterface.
+
+
+
+
+ Type of value:
+
+
+ Tag name followed by a description that will be shown in the webinterface
+
+
+
+
+ Default value:
+
+ None
+
+
+
+ Notes:
+
+
+
+ This is an experimental feature. The syntax is likely to change
+ in future versions.
+
+
+
+ Client-specific tags allow Privoxy admins to create different
+ profiles and let the users chose which one they want without
+ impacting other users.
+
+
+ One use case is allowing users to circumvent certain blocks
+ without having to allow them to circumvent all blocks.
+ This is not possible with the
+ enable-remote-toggle feature
+ because it would bluntly disable all blocks for all users and also affect
+ other actions like filters.
+ It also is set globally which renders it useless in most multi-user setups.
+
+
+ After a client-specific tag has been defined with the client-specific-tag
+ directive, action sections can be activated based on the tag by using a
+ CLIENT-TAG pattern.
+ The CLIENT-TAG pattern is evaluated at the same priority
+ as URL patterns, as a result the last matching pattern wins.
+ Tags that are created based on client or server headers are evaluated
+ later on and can overrule CLIENT-TAG and URL patterns!
+
+
+ The tag is set for all requests that come from clients that requested
+ it to be set.
+ Note that "clients" are differentiated by IP address,
+ if the IP address changes the tag has to be requested again.
+
+
+ Clients can request tags to be set by using the CGI interface http://config.privoxy.org/client-tags.
+ The specific tag description is only used on the web page and should
+ be phrased in away that the user understand the effect of the tag.
+
+
+
+
+ Examples:
+
+
+
+ # Define a couple of tags, the described effect requires action sections
+ # that are enabled based on CLIENT-TAG patterns.
+ client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
+ disable-content-filters Disable content-filters but do not affect other actions
+
+
+
+
+
+
+
+
+
+client-tag-lifetime
+
+
+ Specifies:
+
+
+ How long a temporarily enabled tag remains enabled.
+
+
+
+
+ Type of value:
+
+
+ Time in seconds.
+
+
+
+
+ Default value:
+
+ 60
+
+
+
+ Notes:
+
+
+
+ This is an experimental feature. The syntax is likely to change
+ in future versions.
+
+
+
+ In case of some tags users may not want to enable them permanently,
+ but only for a short amount of time, for example to circumvent a block
+ that is the result of an overly-broad URL pattern.
+
+
+ The CGI interface http://config.privoxy.org/client-tags
+ therefore provides a "enable this tag temporarily" option.
+ If it is used, the tag will be set until the client-tag-lifetime
+ is over.
+
+
+
+
+ Examples:
+
+
+
+ # Increase the time to life for temporarily enabled tags to 3 minutes
+ client-tag-lifetime 180
+
+
+
+
+
+
+
+
+
+trust-x-forwarded-for
+
+
+ Specifies:
+
+
+ Whether or not Privoxy should use IP addresses specified with the X-Forwarded-For header
+
+
+
+
+ Type of value:
+
+
+ 0 or one
+
+
+
+
+ Default value:
+
+ 0
+
+
+
+ Notes:
+
+
+
+ This is an experimental feature. The syntax is likely to change
+ in future versions.
+
+
+
+ If clients reach Privoxy through another proxy, for example a load
+ balancer, Privoxy can't tell the client's IP address from the connection.
+ If multiple clients use the same proxy, they will share the same
+ client tag settings which is usually not desired.
+
+
+ This option lets Privoxy use the X-Forwarded-For header value as
+ client IP address. If the proxy sets the header, multiple clients
+ using the same proxy do not share the same client tag settings.
+
+
+ This option should only be enabled if Privoxy can only be reached
+ through a proxy and if the proxy can be trusted to set the header
+ correctly. It is recommended that ACL are used to make sure only
+ trusted systems can reach Privoxy.
+
+
+ If access to Privoxy isn't limited to trusted systems, this option
+ would allow malicious clients to change the client tags for other
+ clients or increase Privoxy's memory requirements by registering
+ lots of client tag settings for clients that don't exist.
+
+
+
+
+ Examples:
+
+
+
+ # Allow systems that can reach Privoxy to provide the client
+ # IP address with a X-Forwarded-For header.
+ trust-x-forwarded-for 1
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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 copies log messages to the console
+ window.
+ The log detail depends on the debug directive.
+
+
+@@#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).
@@ -2680,11 +3654,11 @@ forward-socks4, forward-socks4a and forward-socks5
-
+ log-buffer-size 1
-
+
]]>
@@ -2700,11 +3674,11 @@ forward-socks4, forward-socks4a and forward-socks5
-
+ log-max-lines 200
-
+
]]>
@@ -2721,11 +3695,11 @@ forward-socks4, forward-socks4a and forward-socks5
-
+ log-highlight-messages 1
-
+
]]>
@@ -2740,11 +3714,11 @@ forward-socks4, forward-socks4a and forward-socks5
-
+ log-font-name Comic Sans MS
-
+
]]>
@@ -2759,18 +3733,18 @@ forward-socks4, forward-socks4a and forward-socks5
-
+ log-font-size 8
-
+
]]>
@@]]>
-
+show-on-task-bar controls whether or not
Privoxy will appear as a button on the Task bar
when minimized:
@@ -2780,11 +3754,11 @@ forward-socks4, forward-socks4a and forward-socks5
-
+ show-on-task-bar 0
-
+
]]>
@@ -2801,11 +3775,11 @@ forward-socks4, forward-socks4a and forward-socks5
-
+ close-button-minimizes 1
-
+
]]>
@@ -2823,11 +3797,11 @@ forward-socks4, forward-socks4a and forward-socks5
-
+
#hide-console
-
+
]]>