X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fp-config.sgml;h=6bf7fbe1279fc7da01d842c672d0fb02f5ab1d53;hp=8e171f1a853943f06c787dc2b6f5387850e721ff;hb=7ecdaff4e6e989eaa70d1ffec88c0e5dfbeb19bb;hpb=2522c86ee646a3ec3a1bcd04f25563b1516fa393
diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index 8e171f1a..6bf7fbe1 100644
--- a/doc/source/p-config.sgml
+++ b/doc/source/p-config.sgml
@@ -1,11 +1,9 @@
@@
- Sample Configuration File for Privoxy v&p-version;
+ Sample Configuration File for Privoxy &p-version;
- $Id: p-config.sgml,v 2.80 2012/03/19 12:56:26 fabiankeil Exp $
-
-
-Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/
+Copyright (C) 2001-2018 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 #
+ #
+##################################################################
@@ -228,7 +224,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.
@@ -250,30 +246,22 @@ II. FORMAT OF THE CONFIGURATION FILE
Unix, in local filesystem (may not work with all browsers):
- user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/
-
Windows, in local filesystem, must use forward slash notation:
- user-manual file:/c:/some-dir/privoxy-&p-version;/user-manual/
-
Windows, UNC notation (with forward slashes):
- 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
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:
@@ -284,9 +272,7 @@ II. FORMAT OF THE CONFIGURATION FILE
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/
-
@@ -315,7 +301,7 @@ II. FORMAT OF THE CONFIGURATION FILE
-@@#user-manual http://www.privoxy.org/user-manual/]]>
+@@#user-manual https://www.privoxy.org/user-manual/]]>
@@ -533,16 +519,6 @@ II. FORMAT OF THE CONFIGURATION FILE
No trailing /, please.
-
@@ -597,6 +573,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
@@ -703,13 +728,6 @@ actionsfile
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.
@@ -846,23 +864,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.
+
@@ -1003,7 +1020,6 @@ actionsfile
The available debug levels are:
-
debug 1 # Log the destination for each request &my-app; let through. See also debug 1024.
debug 2 # show each connection status
@@ -1020,8 +1036,8 @@ actionsfile
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
-
To select multiple debug levels, you can either add them or use
multiple debug lines.
@@ -1032,12 +1048,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
@@ -1083,13 +1093,13 @@ actionsfile
Type of value:
- None
+ 1 or 0Default value:
- Unset
+ 0
@@ -1112,7 +1122,7 @@ actionsfile
-@@#single-threaded]]>
+@@#single-threaded 1]]>
@@ -1302,21 +1312,17 @@ actionsfile
(192.168.0.0) and has another outside connection with a different address.
You want it to serve requests from inside only:
-
listen-address 192.168.0.1:8118
-
Suppose you are running Privoxy on an
IPv6-capable machine and you want it to listen on the IPv6 address
of the loopback device:
-
listen-address [::1]:8118
-
@@ -1365,18 +1371,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.
@@ -1775,49 +1769,39 @@ ACLs: permit-access and deny-access
is OK. The absence of a dst_addr implies that
all destination addresses are OK:
-
permit-access localhost
-
Allow any host on the same class C subnet as www.privoxy.org access to
nothing but www.example.com (or other domains hosted on the same system):
-
permit-access www.privoxy.org/24 www.example.com/32
-
Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
with the exception that 192.168.45.73 may not access the IP address behind
www.dirty-stuff.example.com:
-
permit-access 192.168.45.64/26
deny-access 192.168.45.73 www.dirty-stuff.example.com
-
Allow access from the IPv4 network 192.0.2.0/24 even if listening on
an IPv6 wild card address (not supported on all platforms):
-
permit-access 192.0.2.0/24
-
This is equivalent to the following line even if listening on an
IPv4 address (not supported on all platforms):
-
permit-access [::ffff:192.0.2.0]/120
-
@@ -1882,6 +1866,143 @@ 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]]>
+
+
+
+trusted-cgi-referer
+
+
+ Specifies:
+
+
+ A trusted website or webpage whose links can be followed to reach sensitive CGI pages
+
+
+
+
+ Type of value:
+
+ URL or URL prefix
+
+
+
+ Default value:
+
+ Unset
+
+
+
+ Effect if unset:
+
+
+ No external pages are considered trusted referers.
+
+
+
+
+ Notes:
+
+
+ Before &my-app; accepts configuration changes through CGI pages like
+ client-tags or the
+ remote toggle, it checks
+ the Referer header to see if the request comes from a trusted source.
+
+
+ By default only the webinterface domains
+ config.privoxy.org
+ and
+ p.p
+ are considered trustworthy.
+ Requests originating from other domains are rejected to prevent
+ third-parties from modifiying Privoxy's state by e.g. embedding
+ images that result in CGI requests.
+
+
+ In some environments it may be desirable to embed links to CGI pages
+ on external pages, for example on an Intranet homepage the Privoxy admin
+ controls.
+
+
+ The trusted-cgi-referer option can be used to add that page,
+ or the whole domain, as trusted source so the resulting requests aren't
+ rejected.
+ Requests are accepted if the specified trusted-cgi-refer is the prefix
+ of the Referer.
+
+
+
+ Declaring pages the admin doesn't control trustworthy may allow
+ malicious third parties to modify Privoxy's internal state against
+ the user's wishes and without the user's knowledge.
+
+
+
+
+
+
+@@trusted-cgi-referer http://www.example.org/local-privoxy-control-page]]>
+
+
@@ -1986,40 +2107,32 @@ ACLs: permit-access and deny-access
Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
-
forward / parent-proxy.example.org:8080
forward :443 .
-
Everything goes to our example ISP's caching proxy, except for requests
to that ISP's sites:
-
forward / caching-proxy.isp.example.net:8000
forward .isp.example.net .
-
Parent proxy specified by an IPv6 address:
-
forward / [2001:DB8::1]:8000
-
Suppose your parent proxy doesn't support IPv6:
-
forward / parent-proxy.example.org:8000
forward ipv6-server.example.org .
forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
-
@@ -2028,7 +2141,7 @@ ACLs: permit-access and deny-access
-forward-socks4, forward-socks4a and forward-socks5
+forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
@@ -2091,6 +2204,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
@@ -2118,43 +2237,40 @@ forward-socks4, forward-socks4a and forward-socks5
their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
the Internet.
-
forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
forward .example.com .
-
A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
-
forward-socks4 / socks-gw.example.com:1080 .
-
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:
-
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
@@ -2167,11 +2283,9 @@ forward-socks4, forward-socks4a and forward-socks5
using their names, you will need additional exceptions that look like
this:
-
forward localhost/ .
-
@@ -2199,23 +2313,19 @@ forward-socks4, forward-socks4a and forward-socks5
host-a:
-
forward / .
forward .isp-b.example.net host-b:8118
-
host-b:
-
forward / .
forward .isp-a.example.org host-a:8118
-
Now, your users can set their browser's proxy to use either
@@ -2234,7 +2344,6 @@ forward-socks4, forward-socks4a and forward-socks5
run on the same box, your squid configuration could then look like this:
-
# Define Privoxy as parent proxy (without ICP)
cache_peer 127.0.0.1 parent 8118 7 no-query
@@ -2247,7 +2356,6 @@ forward-socks4, forward-socks4a and forward-socks5
# Forward all the rest to Privoxy
never_direct allow all
-
You would then need to change your browser's proxy settings to squid's address and port.
@@ -2260,11 +2368,9 @@ forward-socks4, forward-socks4a and forward-socks5
say, on antivir.example.com, port 8010:
-
forward / .
forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010
-
]]>
@@ -2380,6 +2486,9 @@ forward-socks4, forward-socks4a and forward-socks5
option and configure your packet filter to redirect outgoing
HTTP connections into Privoxy.
+
+ Note that intercepting encrypted connections (HTTPS) isn't supported.
+
Make sure that Privoxy's own requests
aren't redirected as well. Additionally take care that
@@ -2388,6 +2497,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.
+
@@ -2594,7 +2709,7 @@ forward-socks4, forward-socks4a and forward-socks5
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 can't.
+ it. If your browser appears to be hanging, it probably can't.
@@ -2611,13 +2726,13 @@ forward-socks4, forward-socks4a and forward-socks5
-default-server-timeout
+tolerate-pipeliningSpecifies:
- Assumed server-side keep-alive timeout if not specified by the server.
+ Whether or not pipelined requests should be served.
@@ -2625,7 +2740,7 @@ forward-socks4, forward-socks4a and forward-socks5
Type of value:
- Time in seconds.
+ 0 or 1.
@@ -2639,8 +2754,8 @@ forward-socks4, forward-socks4a and forward-socks5
Effect if unset:
- Connections for which the server didn't specify the keep-alive
- timeout are not reused.
+ If Privoxy receives more than one request at once, it terminates the
+ client connection after serving the first one.
@@ -2648,34 +2763,22 @@ forward-socks4, forward-socks4a and forward-socks5
Notes:
- 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.
+ &my-app; currently doesn't pipeline outgoing requests,
+ thus allowing pipelining on the client connection is not
+ guaranteed to improve the performance.
- Enabling this option is therefore only recommended if the
- connection-sharing option
- is disabled.
+ 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.
- It is an error to specify a value larger than the keep-alive-timeout value.
+ This option lets &my-app; tolerate pipelining. Whether or not
+ that improves performance mainly depends on the client configuration.
- This option has no effect if Privoxy
- has been compiled without keep-alive support.
+ If you are seeing problems with pages not properly loading,
+ disabling this option could work around the problem.
@@ -2683,23 +2786,22 @@ forward-socks4, forward-socks4a and forward-socks5
Examples:
- default-server-timeout 60
+ tolerate-pipelining 1
-@@#default-server-timeout 60]]>
+@@tolerate-pipelining 1]]>
-connection-sharing
+default-server-timeoutSpecifies:
- Whether or not outgoing connections that have been kept alive
- should be shared between different incoming connections.
+ Assumed server-side keep-alive timeout if not specified by the server.
@@ -2707,7 +2809,7 @@ forward-socks4, forward-socks4a and forward-socks5
Type of value:
- 0 or 1
+ Time in seconds.
@@ -2721,7 +2823,8 @@ forward-socks4, forward-socks4a and forward-socks5
Effect if unset:
- Connections are not shared.
+ Connections for which the server didn't specify the keep-alive
+ timeout are not reused.
@@ -2729,8 +2832,89 @@ forward-socks4, forward-socks4a and forward-socks5
Notes:
- This option has no effect if Privoxy
- has been compiled without keep-alive support, or if it's disabled.
+ 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.
+
+
+
+
+ Examples:
+
+
+ default-server-timeout 60
+
+
+
+
+@@#default-server-timeout 60]]>
+
+
+
+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.
@@ -2868,7 +3052,7 @@ forward-socks4, forward-socks4a and forward-socks5
Default value:
- None
+ 128
@@ -2913,6 +3097,13 @@ forward-socks4, forward-socks4a and forward-socks5
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.
+
@@ -2928,6 +3119,156 @@ forward-socks4, forward-socks4a and forward-socks5
+listen-backlog
+
+
+ Specifies:
+
+
+ Connection queue length requested from the operating system.
+
+
+
+
+ Type of value:
+
+
+ Number.
+
+
+
+
+ Default value:
+
+ 128
+
+
+
+ Effect if unset:
+
+
+ A connection queue length of 128 is requested from the operating system.
+
+
+
+
+ Notes:
+
+
+ Under high load incoming connection may queue up before Privoxy
+ gets around to serve them. The queue length is limitted by the
+ operating system. Once the queue is full, additional connections
+ are dropped before Privoxy can accept and serve them.
+
+
+ Increasing the queue length allows Privoxy to accept more
+ incomming connections that arrive roughly at the same time.
+
+
+ Note that Privoxy can only request a certain queue length,
+ whether or not the requested length is actually used depends
+ on the operating system which may use a different length instead.
+
+
+ On many operating systems a limit of -1 can be specified to
+ instruct the operating system to use the maximum queue length
+ allowed. Check the listen man page to see if your platform allows this.
+
+
+ On some platforms you can use "netstat -Lan -p tcp" to see the effective
+ queue length.
+
+
+ Effectively using a value above 128 usually requires changing
+ the system configuration as well. On FreeBSD-based system the
+ limit is controlled by the kern.ipc.soacceptqueue sysctl.
+
+
+
+
+ Examples:
+
+
+ listen-backlog 4096
+
+
+
+
+@@#listen-backlog -1]]>
+
+
+
+enable-accept-filter
+
+
+ Specifies:
+
+
+ Whether or not Privoxy should use an accept filter
+
+
+
+
+ Type of value:
+
+
+ 0 or 1
+
+
+
+
+ Default value:
+
+ 0
+
+
+
+ Effect if unset:
+
+
+ No accept filter is enabled.
+
+
+
+
+ Notes:
+
+
+ Accept filters reduce the number of context switches by not
+ passing sockets for new connections to Privoxy until a complete
+ HTTP request is available.
+
+
+ As a result, Privoxy can process the whole request right away
+ without having to wait for additional data first.
+
+
+ For this option to work, Privoxy has to be compiled with
+ FEATURE_ACCEPT_FILTER and the operating system has to support
+ it (which may require loading a kernel module).
+
+
+ Currently accept filters are only supported on FreeBSD-based
+ systems. Check the
+ accf_http(9)
+ man page
+ to learn how to enable the support in the operating system.
+
+
+
+
+ Examples:
+
+
+ enable-accept-filter 1
+
+
+
+
+@@#enable-accept-filter 1]]>
+
+
+
handle-as-empty-doc-returns-ok
@@ -2975,15 +3316,13 @@ forward-socks4, forward-socks4a and forward-socks5
Notes:
- This is a work-around for Firefox bug 492459:
-
- Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.
-
+ 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)
- As the bug has been fixed for quite some time this option should no longer
- be needed and will be removed in a future release. Please speak up if you
- have a reason why the option should be kept around.
+ >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.
@@ -3099,7 +3438,6 @@ forward-socks4, forward-socks4a and forward-socks5
Examples:
-
# Best speed (compared to the other levels)
compression-level 1
@@ -3112,7 +3450,6 @@ forward-socks4, forward-socks4a and forward-socks5
# is likely to be flawed.
compression-level 0
-
@@ -3120,10 +3457,366 @@ forward-socks4, forward-socks4a and forward-socks5
-
+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
+
+
+
+
+
+
+
+
+
+
+receive-buffer-size
+
+
+ Specifies:
+
+
+ The size of the buffer Privoxy uses to receive data from the server.
+
+
+
+
+ Type of value:
+
+
+ Size in bytes
+
+
+
+
+ Default value:
+
+ 5000
+
+
+
+ Notes:
+
+
+ Increasing the receive-buffer-size increases Privoxy's memory usage but
+ can lower the number of context switches and thereby reduce the
+ cpu usage and potentially increase the throughput.
+
+
+ This is mostly relevant for fast network connections and
+ large downloads that don't require filtering.
+
+
+ Reducing the buffer size reduces the amount of memory Privoxy
+ needs to handle the request but increases the number of systemcalls
+ and may reduce the throughput.
+
+
+ A dtrace command like:
+ sudo dtrace -n 'syscall::read:return /execname == "privoxy"/ { @[execname] = llquantize(arg0, 10, 0, 5, 20); @m = max(arg0)}'
+ can be used to properly tune the receive-buffer-size.
+ On systems without dtrace, strace or truss may be used as
+ less convenient alternatives.
+
+
+ If the buffer is too large it will increase Privoxy's memory
+ footprint without any benefit. As the memory is (currently)
+ cleared before using it, a buffer that is too large can
+ actually reduce the throughput.
+
+
+
+
+ Examples:
+
+
+ # Increase the receive buffer size
+ receive-buffer-size 32768
+
+
+
+
+
+
+
+
+
@@ -3159,8 +3852,9 @@ forward-socks4, forward-socks4a and forward-socks5
@@]]>
If log-messages is set to 1,
- Privoxy will log messages to the console
- window:
+ Privoxy copies log messages to the console
+ window.
+ The log detail depends on the debug directive.
@@#log-messages 1]]>