From 529f359abd088b2a8e2c5e3631f688f2220f4e20 Mon Sep 17 00:00:00 2001 From: Fabian Keil Date: Thu, 17 Mar 2016 10:43:20 +0000 Subject: [PATCH] Document the client-specific-tag directive --- doc/source/p-config.sgml | 91 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 89 insertions(+), 2 deletions(-) diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml index b0b5f7af..da88c4ba 100644 --- a/doc/source/p-config.sgml +++ b/doc/source/p-config.sgml @@ -3,7 +3,7 @@ Purpose : Used with other docs and files only. - $Id: p-config.sgml,v 2.113 2015/01/24 16:42:13 fabiankeil Exp $ + $Id: p-config.sgml,v 2.114 2016/02/26 12:32:56 fabiankeil Exp $ Copyright (C) 2001-2016 Privoxy Developers http://www.privoxy.org/ See LICENSE. @@ -97,7 +97,7 @@ Sample Configuration File for Privoxy &p-version; - $Id: p-config.sgml,v 2.113 2015/01/24 16:42:13 fabiankeil Exp $ + $Id: p-config.sgml,v 2.114 2016/02/26 12:32:56 fabiankeil Exp $ Copyright (C) 2001-2016 Privoxy Developers http://www.privoxy.org/ @@ -3350,6 +3350,93 @@ 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/show-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 + + + + + + + -- 2.39.2