X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fwebserver%2Fuser-manual%2Factions-file.html;h=2850f2754a3003b080afa19636db4c1dc8b2c7f7;hb=21e4d72fa6918226a74b9f034b230172bf2a570c;hp=58f50dec614142bcb784d110c6a37ac1b78e1580;hpb=e4446b36c844acb82cc754737b739fd0cdc402ed;p=privoxy.git diff --git a/doc/webserver/user-manual/actions-file.html b/doc/webserver/user-manual/actions-file.html index 58f50dec..2850f275 100644 --- a/doc/webserver/user-manual/actions-file.html +++ b/doc/webserver/user-manual/actions-file.html @@ -7,7 +7,7 @@ NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.79">
match-all.action - is used to define which + "actions" relating to banner-blocking, images, pop-ups, + content modification, cookie handling etc should be applied by default. + It should be the first actions file loaded +
default.action - is the primary action file - that sets the initial values for all actions. It is intended to - provide a base level of functionality for - Privoxy's array of features. So it is - a set of broad rules that should work reasonably well as-is for most users. - This is the file that the developers are keeping updated, and making available to users. - The user's preferences as set in - defines many exceptions (both + positive and negative) from the default set of actions that's configured + in standard.action, - e.g. either Cautious (the default), - Medium, or Advanced (see - below). -
match-all.action. It is a set of rules that should + work reasonably well as-is for most users. This file is only supposed to + be edited by the developers. It should be the second actions file loaded. +user.action - is intended to be for local site - preferences and exceptions. As an example, if your ISP or your bank - has specific requirements, and need special handling, this kind of - thing should go here. This file will not be upgraded. -
standard.action - is used only by the web based editor - at http://config.privoxy.org/edit-actions-list?f=default, - to set various pre-defined sets of rules for the default actions section - in default.action. -
Edit Set to Advanced -
These have increasing levels of aggressiveness These have increasing levels of aggressiveness and have no - influence on your browsing unless you select them explicitly in the - editor. A default installation should be pre-set to - Cautious (versions prior to 3.0.5 were set to - Medium). New users should try this for a while before - adjusting the settings to more aggressive levels. The more aggressive - the settings, then the more likelihood there is of problems such as sites - not working as they should. -
. New users should try this for a while before + adjusting the settings to more aggressive levels. The more aggressive + the settings, then the more likelihood there is of problems such as sites + not working as they should. +The The Edit button allows you to turn each - action on/off individually for fine-tuning. The Cautious - button changes the actions list to low/safe settings which will activate - ad blocking and a minimal set of Privoxy's features, and subsequently - there will be less of a chance for accidental problems. The - Medium button sets the list to a medium level of - other features and a low level set of privacy features. The - Advanced button sets the list to a high level of - ad blocking and medium level of privacy. See the chart below. The latter - three buttons over-ride any changes via with the - Edit button. More fine-tuning can be done in the - lower sections of this internal page. -
It is not recommend to edit the standard.action file - itself. -
While the actions file editor allows to enable these settings in all + actions files, they are only supposed to be enabled in the first one + to make sure you don't unintentionally overrule earlier rules. +The default profiles, and their associated actions, as pre-defined in - The default profiles, and their associated actions, as pre-defined in + standard.actiondefault.action are: -
The list of actions files to be used are defined in the main configuration file, and are processed in the order they are defined (e.g. @@ -1997,8 +1967,104 @@ CLASS="SECT3" >
Improve privacy by not forwarding the source of the request in the HTTP headers.
Deletes the "X-Forwarded-For:" HTTP header from the client request, + or adds a new one. +
Parameterized.
"block" to delete the header.
"add" to create the header (or append + the client's IP address to an already existing one). +
It is safe and recommended to use block. +
Forwarding the source address of the request may make + sense in some multi-user setups but is also a privacy risk. +
+change-x-forwarded-for{block} |
Improve privacy by not forwarding the source of the request in the HTTP headers.
Deletes any existing "X-Forwarded-for:" HTTP header from client requests. -
Boolean.
N/A -
It is safe and recommended to leave this on. -
+hide-forwarded-for-headers |
. Now, let's look at an example match-all.action, default.action and + and user.action - file and see how all these pieces come together:
file and see how all these pieces come together:Every config file should start with a short comment stating its purpose:
Remember all actions are disabled when matching starts, + so we have to explicitly enable the ones we want.While the match-all.action file only contains a + single section, it is probably the most important one. It has only one + pattern, "/", but this pattern + matches all URLs. Therefore, the set of + actions used in this "default" section will + be applied to all requests as a start. It can be partly or + wholly overridden by other actions files like default.action + and user.action, but it will still be largely responsible + for your overall browsing experience.
Again, at the start of matching, all actions are disabled, so there is + no need to disable any actions here. (Remember: a "+" + preceding the action name enables the action, a "-" disables!). + Also note how this long line has been made more readable by splitting it into + multiple lines with line continuation.
# Sample default.action file <ijbswa-developers@lists.sourceforge.net>{ \ + +change-x-forwarded-for{block} \ + +hide-from-header{block} \ + +set-image-blocker{pattern} \ +} +/ # Match all URLs + |
Then, since this is the The default behavior is now set.
If you aren't a developer, there's no need for you to edit the + default.action file. It is maintained by + the Privoxy developers and if you disagree with some of the + sections, you should overrule them in your user.action.
Understanding the default.action file, the -first section is a special section for internal use that you needn't -change or worry about:
file can + help you with your user.action, though.The first section in this file is a special section for internal use + that prevents older Privoxy versions from reading the file:
After that comes the (optional) alias section. We'll use the example -section from the above After that comes the (optional) alias section. We'll use the example + section from the above chapter on aliases, -that also explains why and how aliases are used:
Now come the regular sections, i.e. sets of actions, accompanied - by URL patterns to which they apply. Remember all actions - are disabled when matching starts, so we have to explicitly - enable the ones we want.
The first regular section is probably the most important. It has only - one pattern, "/", but this pattern - matches all URLs. Therefore, the - set of actions used in this "default" section will - be applied to all requests as a start. It can be partly or - wholly overridden by later matches further down this file, or in user.action, - but it will still be largely responsible for your overall browsing - experience.
Again, at the start of matching, all actions are disabled, so there is - no need to disable any actions here. (Remember: a "+" - preceding the action name enables the action, a "-" disables!). - Also note how this long line has been made more readable by splitting it into - multiple lines with line continuation.
########################################################################## -# "Defaults" section: -########################################################################## - { \ - +deanimate-gifs \ - +filter{html-annoyances} \ - +filter{refresh-tags} \ - +filter{webbugs} \ - +filter{ie-exploits} \ - +hide-forwarded-for-headers \ - +hide-from-header{block} \ - +hide-referrer{forge} \ - +prevent-compression \ - +session-cookies-only \ - +set-image-blocker{pattern} \ - } - / # forward slash will match *all* potential URL patterns. |
The default behavior is now set. -
The first of our specialized sections is concerned with "fragile"fast-redirects - action, which we enabled per default above, breaks some sites. So disable - it for popular sites where we know it misbehaves:
match-all.action, + breaks some sites. So disable it for popular sites where we know it misbehaves: