X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fp-config.sgml;h=6c5ab408af74004bc86d5e4593ecbc672c5310db;hb=e22a8cad1bac2c28925823b91fa7099a411390e6;hp=1990a5f001bff28c5f4447fb6134eb242e9658ad;hpb=47ae0f2c694024ba1fee89e137b526f7ec9a394e;p=privoxy.git
diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index 1990a5f0..6c5ab408 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.99 2013/03/07 14:10:34 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.124 2017/02/20 13:44:54 fabiankeil Exp $
- Copyright (C) 2001-2011 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.99 2013/03/07 14:10:34 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.124 2017/02/20 13:44:54 fabiankeil Exp $
-Copyright (C) 2001-2013 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/]]>
@@ -534,16 +534,6 @@ II. FORMAT OF THE CONFIGURATION FILE
No trailing /, please.
-
@@ -598,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
@@ -704,13 +743,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.
@@ -847,22 +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).
-
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.
+
@@ -1033,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
@@ -1084,13 +1110,13 @@ actionsfile
Type of value:
- None
+ 1 or 0Default value:
- Unset
+ 0
@@ -1113,7 +1139,7 @@ actionsfile
-@@#single-threaded]]>
+@@#single-threaded 1]]>
@@ -1932,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]]>
+
+
@@ -2195,11 +2297,16 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
- 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:
@@ -2436,6 +2543,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
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
@@ -2444,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.
+
@@ -3107,15 +3223,13 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
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.
@@ -3318,10 +3432,234 @@ 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
+
+
+
+
+
+
+
+
+
+