X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fp-config.sgml;h=d509c42ffd850b344bbd9cff7836dee92566a9f6;hb=7813de67763ae50a7dd40cce430d3f691a2be9de;hp=da88c4ba26ad1e1834d112c4caecfc39da09c9ae;hpb=529f359abd088b2a8e2c5e3631f688f2220f4e20;p=privoxy.git
diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index da88c4ba..d509c42f 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.114 2016/02/26 12:32:56 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.127 2017/06/26 12:14:38 fabiankeil Exp $
- Copyright (C) 2001-2016 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2017 Privoxy Developers https://www.privoxy.org/
See LICENSE.
========================================================================
@@ -97,30 +97,30 @@
Sample Configuration File for Privoxy &p-version;
- $Id: p-config.sgml,v 2.114 2016/02/26 12:32:56 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.127 2017/06/26 12:14:38 fabiankeil Exp $
-Copyright (C) 2001-2016 Privoxy Developers http://www.privoxy.org/
+Copyright (C) 2001-2017 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. MISCELLANEOUS #
- 7. 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 #
+ #
+##################################################################
@@ -229,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.
@@ -316,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/]]>
@@ -1958,6 +1958,82 @@ ACLs: permit-access and deny-access
@@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]]>
+
+
@@ -2478,6 +2554,12 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
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.
+
@@ -3094,6 +3176,156 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
+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
@@ -3401,7 +3633,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
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.
+ 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
@@ -3415,7 +3647,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
Clients can request tags to be set by using the CGI interface http://config.privoxy.org/show-client-tags.
+ url="http://config.privoxy.org/client-tags">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.
@@ -3437,10 +3669,221 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
-
+
+
+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
+
+
+
+
+
+
+
+
+
+