X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fsource%2Fp-config.sgml;h=208887e35a4b832bb6e5b1ffa1e51d1fa85e64e6;hb=ad82e1644de96f9dca72e62a544d7a6d8380a1c2;hp=c1ef4d7b42ce6a822020fb987bbeda9a1cf9f60d;hpb=1a9120c0c8330112fc0023892d7aea14467499de;p=privoxy.git diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml index c1ef4d7b..208887e3 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.103 2014/02/10 14:39:13 fabiankeil Exp $ + $Id: p-config.sgml,v 2.119 2016/03/30 11:14:46 fabiankeil Exp $ - Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/ + Copyright (C) 2001-2016 Privoxy Developers http://www.privoxy.org/ See LICENSE. ======================================================================== @@ -97,10 +97,10 @@ Sample Configuration File for Privoxy &p-version; - $Id: p-config.sgml,v 2.103 2014/02/10 14:39:13 fabiankeil Exp $ + $Id: p-config.sgml,v 2.119 2016/03/30 11:14:46 fabiankeil Exp $ -Copyright (C) 2001-2013 Privoxy Developers http://www.privoxy.org/ +Copyright (C) 2001-2016 Privoxy Developers http://www.privoxy.org/ @@ -588,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 @@ -694,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. @@ -837,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. + @@ -1023,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 @@ -2188,8 +2224,13 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t 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: @@ -2437,6 +2478,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. + @@ -3100,15 +3147,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. @@ -3311,6 +3356,156 @@ 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 + + + + + + +