X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fp-config.sgml;h=84bde7e55c5bb24a3284728365cacfc284cdd6a3;hb=4c4af19863193dd2a1b504bcd627417e29d41b70;hp=b0b5f7af82ba9089f8c7136ce9c7149fef7e2c58;hpb=76854d3d47c7d1b050ed9c8a1f3bb429e1396e27;p=privoxy.git
diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index b0b5f7af..84bde7e5 100644
--- a/doc/source/p-config.sgml
+++ b/doc/source/p-config.sgml
@@ -1,11 +1,9 @@
+
+##################################################################
+ #
+ 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 #
+ #
+##################################################################
+
+
+I. INTRODUCTION
+ ===============
+
This file holds Privoxy's main configuration. Privoxy detects
@@ -229,7 +218,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.
@@ -251,30 +240,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
-
+ 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:
@@ -285,9 +266,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/
-
+ user-manual http://example.com/privoxy/user-manual/
@@ -316,7 +295,7 @@ II. FORMAT OF THE CONFIGURATION FILE
-@@#user-manual http://www.privoxy.org/user-manual/]]>
+@@#user-manual https://www.privoxy.org/user-manual/]]>
@@ -1035,7 +1014,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
@@ -1054,7 +1032,6 @@ actionsfile
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.
@@ -1329,21 +1306,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
-
@@ -1790,49 +1763,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
-
@@ -1958,6 +1921,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]]>
+
+
@@ -2062,40 +2101,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]:*> .
-
@@ -2200,30 +2231,24 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
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-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).
@@ -2235,13 +2260,11 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
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.*.*.*/ .
+ 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
@@ -2254,11 +2277,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
using their names, you will need additional exceptions that look like
this:
-
forward localhost/ .
-
@@ -2286,23 +2307,19 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
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
@@ -2321,7 +2338,6 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
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
@@ -2334,7 +2350,6 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
# 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.
@@ -2347,11 +2362,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
say, on antivir.example.com, port 8010:
-
forward / .
forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010
-
]]>
@@ -2478,6 +2491,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 +3113,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
@@ -3143,8 +3312,8 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
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),
+ (
+ 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.
@@ -3263,20 +3432,20 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
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
-
-
+
@@ -3350,10 +3519,300 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
-
+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
+
+
+
+
+
+
@@ -3374,15 +3833,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
@@#activity-animation 1]]>
-
- activity-animation 1
-
-
-
-
+
]]>
@@ -3396,15 +3849,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
@@#log-messages 1]]>
-
- log-messages 1
-
-
-
-
+
]]>
@@ -3422,15 +3869,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
@@#log-buffer-size 1]]>
-
- log-buffer-size 1
-
-
-
-
+
]]>
@@ -3442,15 +3883,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
@@#log-max-lines 200]]>
-
- log-max-lines 200
-
-
-
-
+
]]>
@@ -3463,15 +3898,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
@@#log-highlight-messages 1]]>
-
- log-highlight-messages 1
-
-
-
-
+
]]>
@@ -3482,15 +3911,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
@@#log-font-name Comic Sans MS]]>
-
- log-font-name Comic Sans MS
-
-
-
-
+
]]>
@@ -3501,15 +3924,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
@@#log-font-size 8]]>
-
- log-font-size 8
-
-
-
-
+
]]>
@@ -3522,15 +3939,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
@@#show-on-task-bar 0]]>
-
- show-on-task-bar 0
-
-
-
-
+
]]>
@@ -3543,15 +3954,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
@@#close-button-minimizes 1]]>
-
- close-button-minimizes 1
-
-
-
-
+
]]>
@@ -3565,15 +3970,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
@@#hide-console]]>
-
-
#hide-console
-
-
-
-
+
]]>