The developer manual gives the users information on how to help the developer team. It provides guidance on coding, testing, documentation and other issues. @@ -151,7 +148,7 @@ CLASS="APPLICATION" >

Contacting the developers, Bug Reporting and Feature Requests

10.1. Get Support
10.2. Report bugs
10.3. Request new features
10.4. Report ads or other filter problems
10.5. Other

11.

11.1. Copyright
11.2. History

  {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
-

{+add-header{X-Actions-File-Version: A.B} -filter -no-popups}

Configuring Privoxy is not easy. To help you get -started, we provide you with three different default configurations. The -following table shows you, which features are enabled in each configuration. -

Feature	default.action	basic.action	intermediate.action	advanced.action
ad-filtering	?	x	x	x
blank image	?	x	x	x
de-animate GIFs	?	x	x	x
referer forging	?	x	x	x
jon's +no-cookies-keep (i.e. session cookies only)	?	x	x	x
no-popup windows	?		x	x
fast redirects	?		x	x
hide-referrer	?		x	x
hide-useragent	?		x	x
content-modification	?			x
feature-x	?
feature-y	?
feature-z	?

Copyright

is free software; you can redistribute it and/or modify it under the terms of the GNU General Public + License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details, which is available from the Free Software Foundation, Inc, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

History

9. Appendix11. Appendix

9.1. Regular Expressions11.1. Regular Expressions

"example\.com", makes sure the period is recognized only as a period (and not expanded to its - metacharacter meaning of any single character). + meta-character meaning of any single character).

9.2. 11.2. Privoxy's Internal Pages
- Show information about the current configuration: + Show information about the current configuration, including viewing and + editing of actions files:
- Show the client's request headers: + Show the browser's request headers:
Short cuts. Turn off, then on:
- Edit the actions list file: -
- http://config.privoxy.org/edit-actions -
9.2.1. Bookmarklets11.2.1. Bookmarklets

Below are some Enable PrivoxyPrivoxy - Enable

Disable PrivoxyPrivoxy - Disable

Toggle PrivoxyPrivoxy - Toggle Privoxy (Toggles between enabled and disabled)

View Privoxy StatusPrivoxy- View Status

Actions file feedback systemPrivoxy - Submit Filter Feedback

9.3. Chain of Events11.3. Chain of Events

Let's take a quick look at the basic sequence of events when a web page is @@ -1108,11 +1089,13 @@ CLASS="APPLICATION" >

First, the web browser requests a page, and this request is intercepted by - First, your web browser requests a web page. The browser knows to send + the request to Privoxy immediately. +>, which will in turn, + relay the request to the remote web server after passing the following + tests:
Privoxy traps any request for internal CGI - pages (e.g http://p.p/) and relays these back to the browser. +> traps any request for its own internal CGI + pages (e.g http://p.p/) and sends the CGI page back to the browser.
If the URL matches a Next, Privoxy checks to see if the URL + matches any "+block" pattern, then it is blocked - and the banner displayed. +> patterns. If + so, the URL is then blocked, and the remote web server will not be contacted. + "+handle-as-image" + is then checked and if it does not match, an + HTML "BLOCKED" page is sent back. Otherwise, if it does match, + an image is returned. The type of image depends on the setting of "+set-image-blocker" + (blank, checkerboard pattern, or an HTTP redirect to an image elsewhere).
If the URL pattern matches the "+fast-redirect" is processed, stripping unwanted parts - of the request web page URL. +>"+fast-redirects" action, + it is then processed. Unwanted parts of the requested URL are stripped.
At this point, Privoxy relays the request to the - web server, and requests the page (assuming nothing up to this point has - prevented getting us from this far). +> Now the rest of the client browser's request headers are processed. If any + of these match any of the relevant actions (e.g. "+hide-user-agent", + etc.), headers are suppressed or forged as determined by these actions and + their parameters.
The first few hundred bytes are read from the web server and - Now the web server starts sending its response back (i.e. typically a web page and related + data). +
First, the server headers are read and processed to determine, among other + things, the MIME type (document type) and encoding. The headers are then + filtered as deterimed by the + "+prevent-setting-cookies", + "+session-cookies-only", + and "+downgrade-http-version" + actions. +
If the "+kill-popups" is processed, if enabled. +> + action applies, and it is an HTML or JavaScript document, the popup-code in the + response is filtered on-the-fly as it is received.
If If a "+filter" applies, the rest of the page is read into - memory and then the filters are processed. Filters are applied in the order they - are specified in the + or "+deanimate-gifs" + action applies (and the document type fits the action), the rest of the page is + read into memory (up to a configurable limit). Then the filter rules (from + default.filter) are processed against the buffered + content. Filters are applied in the order they are specified in the + default.filter file. The entire - page, which is now filtered, is then sent by +> file. Animated GIFs, if present, are + reduced to either the first or last frame, depending on the action + setting.The entire page, which is now filtered, is then sent by Privoxy to your browser. +> back to your browser.
As the browser receives the filtered page content, it will read and request any - embedded URLs on the page, e.g. an ad image. As the browser requests these - secondary URLs from whatever server they may be on, - If neither "+filter" + or "+deanimate-gifs" + matches, then Privoxy handles these same as above, and the process - is repeated for each such URL. Note that a fancy web page may have many, many - such URLs for graphics, frames, etc. +> passes the raw data through + to the client browser as it becomes available. +
As the browser receives the now (probably filtered) page content, it + reads and then requests any URLs that may be embedded within the page + source, e.g. ad images, stylesheets, JavaScript, other HTML documents (e.g. + frames), sounds, etc. For each of these objects, the browser issues a new + request. And each such request is in turn processed as above. Note that a + complex web page may have many such embedded URLs.

9.4. Anatomy of an Action11.4. Anatomy of an Action The way Privoxy applies applies + "actions" - and "filters" to any given URL can be complex, and not always so +> + to any given URL can be complex, and not always so easy to understand what is happening. And sometimes we need to be able to the Bookmarklets section on a quick - and easy way to do this (be sure to flush caches afterwards!). Privoxy will tell us how the current configuration will handle it. This will not - help with filtering effects (i.e. the "+filter" action) from the - action) from + the default.filter file since this is handled very differently - and not so easy to trap! It also will not tell you about any other URLs that - may be embedded within the URL you are testing (i.e. a web page). For - instance, images such as ads are expressed as URLs within the raw page source - of HTML pages. So you will only get info for the actual URL that is pasted - into the prompt area -- not any sub-URLs. If you want to know about embedded - URLs like ads, you will have to dig those out of the HTML source. Use your - browser's "View Page Source" option for this. Or right click on - the ad, and grab the URL. Let's look at an example, file since this is handled very + differently and not so easy to trap! It also will not tell you about any other + URLs that may be embedded within the URL you are testing. For instance, images + such as ads are expressed as URLs within the raw page source of HTML pages. So + you will only get info for the actual URL that is pasted into the prompt area + -- not any sub-URLs. If you want to know about embedded URLs like ads, you + will have to dig those out of the HTML source. Use your browser's "View + Page Source" option for this. Or right click on the ad, and grab the + URL. Let's try an example, google.com, - one section at a time: System default actions: +> Matches for http://google.com: - { -add-header -block -deanimate-gifs -downgrade -fast-redirects -filter - -hide-forwarded -hide-from -hide-referer -hide-user-agent -image - -image-blocker -limit-connect -no-compression -no-cookies-keep - -no-cookies-read -no-cookies-set -no-popups -vanilla-wafer -wafer } - - This is the top section, and only tells us of the compiled in defaults. This - is basically what Privoxy would do if there - were not any "actions" defined, i.e. it does nothing. Every action - is disabled. This is not particularly informative for our purposes here. OK, - next section: Matches for http://google.com: +--- File standard --- +(no matches in this file) - { -add-header -block +deanimate-gifs -downgrade +fast-redirects - +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups} - +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal} - +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge} - -hide-user-agent -image +image-blocker{blank} +no-compression - +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups - -vanilla-wafer -wafer } - / +--- File default --- - { -no-cookies-keep -no-cookies-read -no-cookies-set } - .google.com +{ -add-header -block +deanimate-gifs{last} -downgrade-http-version +fast-redirects + -filter{popups} -filter{fun} -filter{shockwave-flash} -filter{crude-parental} + +filter{html-annoyances} +filter{js-annoyances} +filter{content-cookies} + +filter{webbugs} +filter{refresh-tags} +filter{nimda} +filter{banners-by-size} + +hide-forwarded-for-headers +hide-from-header{block} +hide-referer{forge} + -hide-user-agent -handle-as-image +set-image-blocker{pattern} -limit-connect + +prevent-compression +session-cookies-only -prevent-reading-cookies + -prevent-setting-cookies -kill-popups -send-vanilla-wafer -send-wafer } +/ + + { -session-cookies-only } + .google.com { -fast-redirects } - .google.com + .google.com - This is much more informative, and tells us how we have defined our - This tells us how we have defined our + "actions", and which ones match for our example, - , and + which ones match for our example, "google.com". The first grouping shows our default - settings, which would apply to all URLs. If you look at your . The first listing + is any matches for the standard.action file. No hits at + all here on "standard". Then next is "default", or + our default.action file. The large, multi-line listing, + is how the actions are set to match for all URLs, i.e. our default settings. + If you look at your "actions" - file, this would be the section just below the file, this would be the section + just below the "aliases" section - near the top. This applies to all URLs as signified by the single forward - slash -- section near the top. This will apply to + all URLs as signified by the single forward slash at the end of the listing + -- "/". - . These are the default actions we have enabled. But we can define additional - actions that would be exceptions to these general rules, and then list - specific URLs that these exceptions would apply to. Last match wins. - Just below this then are two explicit matches for But we can define additional actions that would be exceptions to these general + rules, and then list specific URLs (or patterns) that these exceptions would + apply to. Last match wins. Just below this then are two explicit matches for + ".google.com". - The first is negating our various cookie blocking actions (i.e. we will allow - cookies here). The second is allowing . The first is negating our previous cookie setting, + which was for "fast-redirects". Note - that there is a leading dot here -- "+session-cookies-only" + (i.e. not persistent). So we will allow persistent cookies for google. The + second turns off any + "+fast-redirects" + action, allowing this to take place unmolested. Note that there is a leading + dot here -- ".google.com". This will - match any hosts and sub-domains, in the google.com domain also, such as +>. This will match any hosts and + sub-domains, in the google.com domain also, such as "www.google.com". So, apparently, we have these actions defined - somewhere in the lower part of our actions file, and - . So, apparently, we have these two actions + defined somewhere in the lower part of our default.action + file, and "google.com" is referenced in these sections. is referenced somewhere in these latter + sections. Then, for our user.action file, we again have no hits. And now we pull it altogether in the bottom section and summarize how +> And finally we pull it all together in the bottom section and summarize how Privoxy Final results: - - -add-header -block -deanimate-gifs -downgrade -fast-redirects - +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups} - +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal} - +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge} - -hide-user-agent -image +image-blocker{blank} -limit-connect +no-compression - -no-cookies-keep -no-cookies-read -no-cookies-set +no-popups -vanilla-wafer - -wafer - - Notice the only difference here to the previous listing, is to + "fast-redirects" and "session-cookies-only". Now another example, "ad.doubleclick.net" { +block +image } +> { +block +handle-as-image } .ad.doubleclick.net - { +block +image } + { +block +handle-as-image } ad*. - { +block +image } - .doubleclick.net - - We'll just show the interesting part here, the explicit matches. It is matched three different times. Each as an "+block +image""+block +handle-as-image", which is the expanded form of one of our aliases that had been defined as: "+imageblock". (. ("Aliases" are defined in the - first section of the actions file and typically used to combine more +> are defined in + the first section of the actions file and typically used to combine more than one action.) Any one of these would have done the trick and blocked this as an unwanted @@ -1507,21 +1653,31 @@ CLASS="QUOTE" CLASS="QUOTE" >"ad.doubleclick.net" - is done here -- as both a "+block" + and an - an + "+image". The custom alias "+handle-as-image". + The custom alias "+imageblock" does this - for us. just simplifies the process and make + it more readable. One last example. Let's try Matches for http://www.rhapsodyk.net/adsl/HOWTO/: - { -add-header -block +deanimate-gifs -downgrade +fast-redirects - +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups} + { -add-header -block +deanimate-gifs -downgrade-http-version +fast-redirects + +filter{html-annoyances} +filter{js-annoyances} +filter{kill-popups} +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal} - +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge} - -hide-user-agent -image +image-blocker{blank} +no-compression - +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups - -vanilla-wafer -wafer } + +filter{fun} +hide-forwarded-for-headers +hide-from-header{block} + +hide-referer{forge} -hide-user-agent -handle-as-image +set-image-blocker{blank} + +prevent-compression +session-cookies-only -prevent-setting-cookies + -prevent-reading-cookies +kill-popups -send-vanilla-wafer -send-wafer } / - { +block +image } - /ads - - not - block (-block) pages with "{-block}") paths with "adsl". There are various ways to - handle such exceptions. Example:. There are + various ways to handle such exceptions. Example: { -block } - /adsl - - { -block } - /adsl - - { +block +handle-as-image } + /ads that expands to "{ -filter -no-cookies -no-cookies-keep }". Or you could do - your own exception to negate filtering: "{ -filter -session-cookies-only }". + Or you could do your own exception to negate filtering: {-filter} - .forbes.com - - This would probably be most appropriately put in user.action, + for local site exceptions. "{fragile}"Prev5. 7. Privoxy ConfigurationPrivoxy can also be controlled easily with a web browser. -

5.1. Controlling 7.1. Controlling Privoxy with Your Web Browser), which is a built-in page and works without Internet access. You will see the following section: Privoxy Menu Please choose from the following options: - - * Privoxy main page - * Show information about the current configuration - * Show the source code version numbers - * Show the request headers. - * Show which actions apply to a URL and why - * Toggle Privoxy on or off - * Edit the actions list - - ▪ View & change the current configuration + ▪ View the source code version numbers + ▪ View the request headers. + ▪ Look up which actions apply to a URL and why + ▪ Toggle Privoxy on or off + This should be self-explanatory. Note the last item is an editor for the +> This should be self-explanatory. Note the first item leads to an editor for the "actions list", which is where much of the ad, banner, cookie, +>, which is where the ad, banner, cookie, and URL blocking magic is configured as well as other advanced features of 5.2. Configuration Files Overview7.2. Configuration Files Overview For Unix, *BSD and Linux, all configuration files are located in @@ -205,24 +249,24 @@ CLASS="APPLICATION" and number of configuration files has changed from previous versions, and is subject to change as development progresses. The installed defaults provide a reasonable starting point, though possibly - aggressive by some standards. For the time being, there are only three - default configuration files (this may change in time): The installed defaults provide a reasonable starting point, though + some settings may be aggressive by some standards. For the time being, the + principle configuration files are: The main configuration file is named config The main configuration file is named config on Linux, Unix, BSD, OS/2, and AmigaOS and config.txt - on Windows. + on Windows. This is a required file. default.action (the actions file) is used to define - which of a set of various (the main actions file) is used to define + the default settings for various "actions" relating to images, banners, - pop-ups, access restrictions, banners and cookies are to be applied, and where. - There is a web based editor for this file that can be accessed at Multiple actions files may be defined in config. These + are processed in the order they are defined. Local customizations and locally + preferred exceptions to the default policies as defined in + default.action are probably best applied in + user.action, which should be preserved across + upgrades. standard.action is also included. This is mostly + for Privoxy's internal use. + + There is also a web based editor that can be accessed from + http://config.privoxy.org/edit-actions/http://config.privoxy.org/show-status/ (Shortcut: http://p.p/edit-actions/). - (Other actions files are included as well with differing levels of filtering - and blocking, e.g. basic.action.) +>http://p.p/show-status/) for the + various actions files. default.filter (the filter file) can be used to re-write the raw - page content, including viewable text as well as embedded HTML and JavaScript, - and whatever else lurks on any given web page. The filtering jobs are only - pre-defined here; whether to apply them or not is up to the actions file. +> (the filter + file) can be used to re-write the raw page content, including + viewable text as well as embedded HTML and JavaScript, and whatever else + lurks on any given web page. The filtering jobs are only pre-defined here; + whether to apply them or not is up to the actions files. #" character to denote a - comment (the rest of the line will be ignored) and understand line continuation + comment (the rest of the line will be ignored) angd understand line continuation through placing a backslash ("\ default.action and The actions files and default.filter @@ -339,8 +411,8 @@ CLASS="SECT2" > 5.3. The Main Configuration File7.3. The Main Configuration File Again, the main configuration file is named 5.3.1. Configuration and Log File Locations7.3.1. Configuration and Log File Locations 5.3.1.1. confdir7.3.1.1. confdir 5.3.1.2. logdir7.3.1.2. logdir 5.3.1.3. actionsfile7.3.1.3. + + +actionsfile Specifies: The actions file to use +> The actions file(s) to use Default value: default.action (Unix) or default.action.txt (Windows) standard # Internal purposes, recommended not editing + default # Main actions file + user # User customizations + Effect if unset: No action is taken at all. Simple neutral proxying. +> No actions are taken at all. Simple neutral proxying. Notes: There is no point in using Privoxy without - an actions file. There are three different actions files included in the - distribution, with varying degrees of aggressiveness: - default.action, intermediate.action and +> Multiple actionsfile lines are OK and are in fact recommended! + + The default values include standard.action, which is used for internal + purposes and should be loaded, default.action, which is the + "main" actions file maintained by the developers, and advanced.action. +>user.action, where you can make your personal additions. + + There is no point in using Privoxy without an actions file. 5.3.1.4. filterfile7.3.1.4. filterfile Specifies: The filter file to use +> The filter file to use
} - actions in the actions file are turned off + actions in the actions files are turned off
5.3.1.5. logfile7.3.1.5. logfile
5.3.1.6. jarfile7.3.1.6. jarfile
5.3.1.7. trustfile7.3.1.7. trustfile
5.3.2. Local Set-up Documentation7.3.2. Local Set-up Documentation
If you intend to operate
5.3.2.1. trust-info-url7.3.2.1. trust-info-url
5.3.2.2. admin-address7.3.2.2. admin-address
5.3.2.3. proxy-info-url7.3.2.3. proxy-info-url
5.3.3. Debugging7.3.3. Debugging
These options are mainly useful when tracing a problem. @@ -1185,8 +1313,8 @@ CLASS="SECT4" >
5.3.3.1. debug7.3.3.1. debug
5.3.3.2. single-threaded7.3.3.2. single-threaded
5.3.4. Access Control and Security7.3.4. Access Control and Security
This section of the config file controls the security-relevant aspects @@ -1376,8 +1503,8 @@ CLASS="SECT4" >
5.3.4.1. listen-address7.3.4.1. listen-address
Privoxy will bind to all interfaces (addresses) on your machine and may become reachable - from the Internet. In that case, consider using access control lists (acl's) + from the Internet. In that case, consider using access control lists (ACL's) (see "ACLs"
listen-address 192.168.0.1:8118 -
listen-address 192.168.0.1:8118
5.3.4.2. toggle7.3.4.2. toggle
5.3.4.3. enable-remote-toggle7.3.4.3. enable-remote-toggle
5.3.4.4. enable-edit-actions7.3.4.4. enable-edit-actions

Whether or not the web-based actions file editor
5.3.4.5. ACLs: permit-access and deny-access7.3.4.5. + +ACLs: permit-access and deny-access
permit-access localhost -
permit-access localhost
permit-access www.privoxy.org/24 www.example.com/32 -
permit-access www.privoxy.org/24 www.example.com/32
permit-access 192.168.45.64/26 - deny-access 192.168.45.73 www.dirty-stuff.example.com -
5.3.4.6. buffer-limit7.3.4.6. buffer-limit
5.3.5. Forwarding7.3.5. Forwarding
This feature allows routing of HTTP requests through a chain of @@ -2118,8 +2249,8 @@ CLASS="SECT4" >
5.3.5.1. forward7.3.5.1. forward
target_domain is a domain name pattern (see the - chapter on domain matching in the actions file), + chapter on domain matching in the default.action file), forward .* anon-proxy.example.org:8080 - forward :443 . - forward .*. caching-proxy.example-isp.net:8000 - forward .example-isp.net . - 5.3.5.2. forward-socks4 and forward-socks4a7.3.5.2. + +forward-socks4 and forward-socks4a target_domain is a domain name pattern (see the - chapter on domain matching in the actions file), + chapter on domain matching in the default.action file), forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080 - forward .example.com . - forward-socks4 .*. socks-gw.example.com:1080 . - forward-socks4 .*. socks-gw.example.com:1080 .5.3.5.3. Advanced Forwarding Examples7.3.5.3. Advanced Forwarding Examples If you have links to multiple ISPs that provide various special content @@ -2509,8 +2650,7 @@ WIDTH="100%" > forward .*. . - forward .isp-b.net host-b:8118 - forward .*. . - forward .isp-a.net host-a:8118 - 5.3.6. Windows GUI Options7.3.6. Windows GUI Options Privoxy has a number of options specific to the Windows GUI interface:If
If
If

If
The font used in the console window:

Font size used in the console window:

If
The
5.4. The Actions File7.4. Actions Files
The actions file (The actions files are used to define what actions + Privoxy takes for which URLs, and thus determines + how ad images, cookies and various other aspects of HTTP content and + transactions are handled, and on which sites (or even parts thereof). There + are three such files included with Privoxy, + with slightly different purposes. default.action, formerly: - actionsfile or sets + the default policies. ijb.action) is used - to define what actions standard.action is used by + Privoxy takes for which - URLs, and thus determines how ad images, cookies and various other aspects - of HTTP content and transactions are handled on which sites (or even parts - thereof).
and the web based editor to set + pre-defined values (and normally should not be edited). Local exceptions + are best done in user.action. The content of these + can all be viewed and edited from http://config.privoxy.org/show-status. + Anything you want can blocked, including ads, banners, or just some obnoxious - URL that you would rather not see. Cookies can be accepted or rejected, or + URL that you would rather not see is done here. Cookies can be accepted or rejected, or accepted only during the current browser session (i.e. not written to disk), content can be modified, JavaScripts tamed, user-tracking fooled, and much more. See below for a complete list of available actions. An actions file typically has sections. At the top, An actions file typically has sections. Near the top, "aliases" are - defined (discussed below), then the default set of rules which will apply - universally to all sites and pages. And then below that is generally a lengthy - set of exceptions to the defined universal policies.below), then the default set of rules + which will apply universally to all sites and pages. And then below that, + exceptions to the defined universal policies. 5.4.1. Finding the Right Mix7.4.1. Finding the Right Mix Note that some actions like cookie suppression or script disabling may - render some sites unusable, which rely on these techniques to work properly. - Finding the right mix of actions is not easy and certainly a matter of personal - taste. In general, it can be said that the more Note that some actions like cookie suppression + or script disabling may render some sites unusable, which rely on these + techniques to work properly. Finding the right mix of actions is not easy and + certainly a matter of personal taste. In general, it can be said that the more + "aggressive" - your default settings (in the top section of the actions file) are, - the more exceptions for your default settings (in the top section of the + actions file) are, the more exceptions for "trusted" sites you will have to - make later. If, for example, you want to kill popup windows per default, you'll - have to make exceptions from that rule for sites that you regularly use - and that require popups for actually useful content, like maybe your bank, - favorite shop, or newspaper. sites you + will have to make later. If, for example, you want to kill popup windows per + default, you'll have to make exceptions from that rule for sites that you + regularly use and that require popups for actually useful content, like maybe + your bank, favorite shop, or newspaper. We have tried to provide you with reasonable rules to start from in the - distribution actions file. But there is no general rule of thumb on these + distribution actions files. But there is no general rule of thumb on these things. There just are too many variables, and sites are constantly changing. - Sooner or later you will want to change the rules (and read this chapter). 5.4.2. How to Edit7.4.2. How to Edit The easiest way to edit the "actions" file is with a browser by - using our browser-based editor, which is available at files is with a browser by + using our browser-based editor, which can be reached from http://config.privoxy.org/edit-actionshttp://config.privoxy.org/show-status. If you prefer plain text editing to GUIs, you can of course also directly edit the - default.action file. 5.4.3. How Actions are Applied to URLs7.4.3. How Actions are Applied to URLs The actions file is divided into sections. There are special sections, +> Actions files are divided into sections. There are special sections, like the "alias""alias" sections which will be discussed later. For now let's concentrate on regular sections: They have a heading line (often split up to multiple lines for readability) which consist of a list of actions, @@ -2954,7 +3145,25 @@ CLASS="QUOTE" compared to all patterns in this file. Every time it matches, the list of applicable actions for the URL is incrementally updated, using the heading of the section in which the pattern is located. If multiple matches for - the same URL set the same action differently, the last match wins. "+handle-as-image" + and "+block" actions). + You can trace this process by visiting 5.4.4. Patterns7.4.4. Patterns Generally, a pattern has the form 5.4.4.1. The Domain Pattern7.4.4.1. The Domain Pattern The matching of the domain part offers some flexible options: if the @@ -3253,8 +3462,8 @@ CLASS="SECT4" > 5.4.4.2. The Path Pattern7.4.4.2. The Path Pattern "^". (regular expression speak + for the beginning of a line). Please also note that matching in the path is case 5.4.5. Actions7.4.5. Actions Actions are enabled if preceded with a All actions are disabled by default, until they are explicitly enabled + somewhere in an actions file. Actions are turned on if preceded with a + "+", and disabled if - preceded with a , and turned off if preceded with a "-". So a . So a + "+action" means - means "do that action", e.g. , e.g. + "+block" means please - means please "block the following URLs and/or patterns". All actions are - disabled by default, until they are explicitly enabled somewhere in an actions - file. "block the following URL + patterns". Actions are invoked by enclosing the action name in curly braces (e.g. @@ -3436,12 +3646,12 @@ CLASS="QUOTE" Multi-value, e.g. "{+/-add-header{Name: value}}" ot +> or "{+/-wafer{name=value}}""{+/-send-wafer{name=value}}"), where some value needs to be defined - in addition to simply enabling the actino. Examples: + in addition to simply enabling the action. Examples: If nothing is specified in this file, no If nothing is specified in any actions file, no "actions" are taken. - So in this case are + taken. So in this case Privoxy would just be a - normal, non-blocking, non-anonymizing proxy. You must specifically - enable the privacy and blocking features you need (although the - provided default default.action file will - give a good starting point). Later defined actions always over-ride earlier ones. So exceptions to any rules you make, should come in the latter part of the file. For multi-valued actions, the actions are applied in the order they are - specified. config (the default installation has three + actions files). It also quite possible for any given URL pattern to + match more than one action! The list of valid 5.4.5.1. 7.4.5.1. +add-header{Name: value}5.4.5.2. 7.4.5.2. +block .example.com.banners.example.com Notes:

If a URL matches one of the blocked patterns, Privoxy will display its - special + will intercept the URL and display its special "BLOCKED" page if a URL matches one of the - blocked patterns. If there is sufficient space, a large red - banner will appear with a friendly message about why the page - was blocked, and a way to go there anyway. If there is insufficient - space a smaller blocked page will appear without the red banner. - One exception is if the URL matches both page + instead. If there is sufficient space, a large red banner will appear with + a friendly message about why the page was blocked, and a way to go there + anyway. If there is insufficient space a smaller blocked page will appear + without the red banner. + Click here + to view the default blocked HTML page (Privoxy must be running + for this to work as intended!). +

+ A very important exception is if the URL matches both + "+block" - and and "+image", then it can be handled by - "+handle-as-image", + then it will be handled by + "+image-blocker" (see below). +>"+set-image-blocker" + (see below). It is important to understand this process, in order + to understand how Privoxy is able to deal with + ads and other objectionable content.

The The "+filter" action can also perform some of the +> + action can also perform some of the same functionality as "+block", but by virtue of very - different programming techniques, and is typically used for different + different programming techniques, and is most often used for different reasons.

5.4.5.3. 7.4.5.3. +deanimate-gifs5.4.5.4. 7.4.5.4. +downgrade+downgrade-http-version "+downgrade""+downgrade-http-version" will downgrade HTTP/1.1 client requests to HTTP/1.0 and downgrade the responses as well.      {+downgrade}{+downgrade-http-version}      Privoxy doesn't handle well yet. HTTP/1.1 is only partially implemented. Default is not to downgrade requests. This is - an infrequently needed action, and is used to help with problem sites only. + an infrequently needed action, and is used to help with rare problem sites only. 5.4.5.5. 7.4.5.5. +fast-redirectsPrivoxy can cut off - all but the last valid URL in redirect request and send a local redirect + all but the last valid URL in a redirect request and send a local redirect back to your browser without contacting the intermediate site(s). This is a normally on feature, and often requires exceptions for sites that - are sensitive to defeating this mechanism. +> This is a normally "on" feature, and often requires exceptions + for sites that are sensitive to defeating this mechanism. 5.4.5.6. 7.4.5.6. +filter"roll your own". - Filtering operates on a line by line basis. + Filtering operates on a line by line basis throughout the entire page. Filtering requires buffering the page content, which may appear to @@ -4213,16 +4464,25 @@ CLASS="QUOTE" noticeable on slower connections. Filtering can achieve some of the effects as the Filtering can achieve some of the effects as the + "+block" +> action, i.e. it can be used to block ads and banners. In the overall - scheme of things, filtering is one of the last things "Privoxy" - does with a web page. So other actions are applied first. + does with a web page. So other most other actions are applied to the + already "filtered" page. 5.4.5.7. 7.4.5.7. +hide-forwarded+hide-forwarded-for-headers     {+hide-forwarded}{+hide-forwarded-for-headers}       5.4.5.8. 7.4.5.8. +hide-from+hide-from-header      {+hide-from{block}}{+hide-from-header{block}}       The keyword "block" will completely remove the header. +> will completely remove the header + (not to be confused with the "+block" action). Alternately, you can specify any value you prefer to send to the web server. 5.4.5.9. 7.4.5.9. +hide-referer+hide-referer
5.4.5.10. 7.4.5.10. +hide-user-agent5.4.5.11. 7.4.5.11. +image+handle-as-image Privoxy should treat - automatically as an image. + automatically as an image, and is an important ingredient of how + ads are handled.      {+image}{+handle-as-image}      "+block"ed, in which case a ed, in which case a user definable image can + be sent rather than a HTML page. This is integral to the whole concept of + ad blocking: the URL must match both a "blocked" image can - be sent rather than a HTML page. (See "+block" rule, + and "+image-blocker{}" below - for the control over what is actually sent.) +>"+handle-as-image". + (See "+set-image-blocker" + below for control over what will actually be displayed by the browser.) There is little reason to change the default definition for this. +> There is little reason to change the default definition for this action. 5.4.5.12. 7.4.5.12. +image-blocker+set-image-blocker Typical uses: Decide what to do with URLs that end up tagged with both Decide what to do with URLs that end up tagged with both + "{+block}""+block" - and "{+image}", e.g an advertisement. +>"+handle-as-image", + e.g an advertisement. There are four available options: "-image-blocker""-set-image-blocker" will send a HTML "broken image" icon. icon. + "+image-blocker{blank}" will send a 1x1 - transparent GIF image. "+set-image-blocker{blank}" will send a + 1x1 transparent GIF image. + "+image-blocker{pattern}""+set-image-blocker{pattern}" will send a checkerboard type pattern (the default). And finally, "+image-blocker{http://xyz.com}" will send a HTTP temporary - redirect to the specified image. This has the advantage of the icon being - being cached by the browser, which will speed up the display. +>"+set-image-blocker{http://xyz.com}" will + send a HTTP temporary redirect to the specified image. This has the + advantage of the icon being being cached by the browser, which will speed + up the display.      {+image-blocker{blank}}{+set-image-blocker{blank}}       If you want invisible ads, they need to be both - defined as ads, they need to meet + criteria as matching both images and blocked. - And then, + actions. And then, "image-blocker" should be set to @@ -4718,12 +5032,13 @@ CLASS="QUOTE" CLASS="QUOTE" >"blank" for invisibility. Note you cannot treat HTML pages as - images in most cases. For instance, frames require an HTML page to display. - So a frame that is an ad, cannot be treated as an image. Forcing an - "image" in this situation just will not work. +> in this situation just will not work + reliably. 5.4.5.13. 7.4.5.13. +limit-connect     +limit-connect{443}                      # This is the default and need not be specified. +>                       # This is the default and need not be specified.      +limit-connect{80,443}                 # Ports 80 and 443 are OK. +>                  # Ports 80 and 443 are OK.      +limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100 and above 500 are OK. +>   # Port less than 3, 7, 20 to 100 and above 500 are OK.      5.4.5.14. 7.4.5.14. +no-compression+prevent-compression      {+no-compression}{+prevent-compression}      Privoxy, since , since + "+filter", - "+no-popup" and "+kill-popups" + and "+gif-deanimate" will not work - on compressed data. This will slow down connections to those websites, - though. Default typically is to turn + will not work on compressed data. This will slow down connections to those + websites, though. Default typically is to turn + "no-compression""prevent-compression" on. 5.4.5.15. 7.4.5.15. +no-cookies-keep+session-cookies-only Typical uses: Allow cookies for the current browser session only. +> Allow cookies for the current browser session only. Example usage: Example usage (disabling):     {+no-cookies-keep}{-session-cookies-only}       If websites set cookies, "no-cookies-keep""+session-cookies-only" will make sure they are erased when you exit and restart your web browser. This makes profiling cookies useless, but won't break sites which require cookies so that you can log in for transactions. This is generally turned on for all - sites. Sometimes referred to as "session cookies". +>"+prevent-*-cookies" actions should be turned off as well (see + below), for "+session-cookies-only" to work. Or, else no cookies + will get through at all. For, "persistent" cookies that survive + across browser sessions, see below as well. 5.4.5.16. 7.4.5.16. +no-cookies-read+prevent-reading-cookies      {+no-cookies-read}{+prevent-reading-cookies}       Often used in conjunction with "+no-cookies-set""+prevent-setting-cookies" to - disable persistant cookies completely. + disable cookies completely. Note that + "+session-cookies-only" + requires these to both be disabled (or else it never gets any cookies to cache). + For "persistent" cookies to work (i.e. they survive across browser + sessions and reboots), all three cookie settings should be "off" + for the specified sites. 5.4.5.17. 7.4.5.17. +no-cookies-set+prevent-setting-cookies Typical uses: Explicitly block the web server from sending cookies to your +> Explicitly block the web server from storing cookies on your system.      {+no-cookies-set}{+prevent-setting-cookies}       Often used in conjunction with "+no-cookies-read""+prevent-reading-cookies" to - disable persistant cookies completely. + disable cookies completely (see above). 5.4.5.18. 7.4.5.18. +no-popup+kill-popups      {+no-popup}{+kill-popups}       "+no-popup""+kill-popups" uses a built in filter to disable pop-ups that use the window.open() function, etc. - An alternate spelling is function, etc. This is + one of the first actions processed by Privoxy + as it contacts the remote web server. This action is not always 100% reliable, + and is supplemented by "+no-popups", which is - interchangeable. - "+filter{popups}". + 5.4.5.19. 7.4.5.19. +vanilla-wafer+send-vanilla-wafer     {+vanilla-wafer}{+send-vanilla-wafer}      jarfile for saving cookies. Of course, this is a (relatively) unique header and - could be used to track you. + could conceivably be used to track you. 5.4.5.20. 7.4.5.20. +wafer+send-wafer      {+wafer{name=value}}{+send-wafer{name=value}}      5.4.5.21. Actions Examples7.4.5.21. Actions Examples Note that the meaning of any of the above examples is reversed by preceding @@ -5334,39 +5704,54 @@ CLASS="QUOTE" CLASS="QUOTE" >"on". - Some actions that are turned on the default section do typically require - exceptions to be listed in the lower sections of actions file. do + typically require exceptions to be listed in the lower sections of + actions file. E.g. by default no URLs are "blocked" (i.e. in + the default definitions of default.action). We need + exceptions to this in order to enable ad blocking. Some examples: Turn off cookies by default, then allow a few through for specified sites: Turn off cookies by default, then allow a few through for specified sites + (showing an excerpt from the "default" section of an actions + file ONLY): # Turn off all persistent cookies - { +no-cookies-read } - { +no-cookies-set } - - # Allow cookies for this browser session ONLY - { +no-cookies-keep } +> # Excerpt only: + # Allow cookies to and from the server, but + # for this browser session ONLY + { +   # other actions normally listed here... +   -prevent-setting-cookies \ +   -prevent-reading-cookies \ +   +session-cookies-only   \   + } + / # match all URLs # Exceptions to the above, sites that benefit from persistent cookies - # that saved from one browser session to the next. - { -no-cookies-read } - { -no-cookies-set } - { -no-cookies-keep } - .javasoft.com - .sun.com - .yahoo.com - .msdn.microsoft.com - .redhat.com + # that are saved from one browser session to the next. + { -session-cookies-only } +  .javasoft.com +  .sun.com +  .yahoo.com +  .msdn.microsoft.com +  .redhat.com - # Alternative way of saying the same thing - {-no-cookies-set -no-cookies-read -no-cookies-keep} - .sourceforge.net - .sf.net     # Turn them off! - {+fast-redirects} +> # Turn them off (excerpt only)! + { +  # other actions normally listed here... +  +fast-redirects + } + / # match all URLs # Reverse it for these two sites, which don't work right without it. {-fast-redirects} - www.ukc.ac.uk/cgi-bin/wac\.cgi\? - login.yahoo.com +  www.ukc.ac.uk/cgi-bin/wac\.cgi\? +  login.yahoo.com
# Run everything through the filter file, using only the
+> # Run everything through the filter file, using only certain
# specified sections:
- +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}\
- +filter{webbugs} +filter{nimda} +filter{banners-by-size}
+ {
+  # other actions normally listed here...
+  +filter{html-annoyances} +filter{js-annoyances} +filter{kill-popups}\
+  +filter{webbugs} +filter{nimda} +filter{banners-by-size}
+ }
+ / #match all URLs

- # Then disable filtering of code from sourceforge!
+ # Then disable filtering of code from all sourceforge domains!
{-filter}
- .cvs.sourceforge.net
+  .sourceforge.net

"blocked" banner). Many of these use - banner). Typically, the "block" + action is off by default in the upper section of an actions file, then enabled + against certain URLs and patterns in the lower part of the file. Many of these use regular expressions that will expand to match - multiple URLs:
that will expand to match multiple + URLs:
  # Blocklist:   {+block} -  /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g)) -  /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/]) +  ad*. +  .*ads. +  banner?. +  count*. +  /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?) +  /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|annonse|maino(kset|nta|s)?)/ +  .hitbox.com   /.*/(ng)?adclient\.cgi   /.*/(plain|live|rotate)[-_.]?ads?/ -  /.*/(sponsor)s?[0-9]?/ -  /.*/_?(plain|live)?ads?(-banners)?/   /.*/abanners/ -  /.*/ad(sdna_image|gifs?)/ -  /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe) -  /.*/adbanners/ -  /.*/adserver -  /.*/adstream\.cgi -  /.*/adv((er)?ts?|ertis(ing|ements?))?/ -  /.*/banner_?ads/ -  /.*/banners?/ -  /.*/banners?\.cgi/ -  /.*/cgi-bin/centralad/getimage -  /.*/images/addver\.gif -  /.*/images/marketing/.*\.(gif|jpe?g) -  /.*/popupads/ -  /.*/siteads/ -  /.*/sponsor.*\.gif -  /.*/sponsors?[0-9]?/ -  /.*/advert[0-9]+\.jpg -  /Media/Images/Adds/ -  /ad_images/ -  /adimages/ -  /.*/ads/ -  /bannerfarm/ -  /grafikk/annonse/ -  /graphics/defaultAd/ -  /image\.ng/AdType -  /image\.ng/transactionID -  /images/.*/.*_anim\.gif # alvin brattli -  /ip_img/.*\.(gif|jpe?g) -  /rotateads/ -  /rotations/ -  /worldnet/ad\.cgi -  /cgi-bin/nph-adclick.exe/ -  /.*/Image/BannerAdvertising/ -  /.*/ad-bin/ -  /.*/adlib/server\.cgi   /autoads/
@@ -5489,12 +5854,12 @@ CLASS="LITERALLAYOUT" > Note that many of these actions have the potential to cause a page to misbehave, possibly even not to display at all. There are many ways a site designer may choose to design his site, and what HTTP header - content he may depend on. There is no way to have hard and fast rules - for all sites. See the Appendix - for a brief example on troubleshooting actions. for a brief example on troubleshooting + actions.

`5.4.6. Aliases7.4.6. Aliases`

Custom . Alias names are not case sensitive, and must be defined before anything else in the - default.actionfile! And there can only be one set of - must be defined before other actionsin the + actions file! And there can only be one set of "aliases" defined.

+ defined per file. Each actions file may have its own aliases, but they are + only visible within that file. Now let's define a few aliases: # Useful custom aliases we can use later. These must come first! {{alias}} - +no-cookies = +no-cookies-set +no-cookies-read - -no-cookies = -no-cookies-set -no-cookies-read - fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups - shop = -no-cookies -filter -fast-redirects - +imageblock = +block +image + +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies + -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies + fragile = -block -prevent-cookies -filter -fast-redirects -hide-referer -kill-popups + shop = -prevent-cookies -filter -fast-redirects + +imageblock = +block +handle-as-image - #For people who don't like to type too much: ;-) - c0 = +no-cookies - c1 = -no-cookies - c2 = -no-cookies-set +no-cookies-read - c3 = +no-cookies-set -no-cookies-read + # Aliases defined from other aliases, for people who don't like to type + # too much: ;-) + c0 = +prevent-cookies + c1 = -prevent-cookies #... etc. Customize to your heart's content. @@ -5600,7 +5962,9 @@ CLASS="QUOTE" CLASS="QUOTE" >"fragile" - aliases from above: # These sites are very complex and require # minimal interference. {fragile} - .office.microsoft.com - .windowsupdate.microsoft.com - .nytimes.com + .office.microsoft.com + .windowsupdate.microsoft.com + .nytimes.com # Shopping sites - but we still want to block ads. {shop} - .quietpc.com - .worldpay.com # for quietpc.com - .jungle.com - .scan.co.uk + .quietpc.com + .worldpay.com # for quietpc.com + .scan.co.uk # These shops require pop-ups also - {shop -no-popups} - .dabs.com - .overclockers.co.uk + {shop -kill-popups} + .dabs.com + .overclockers.co.uk 5.5. The Filter File7.5. The Filter File Any web page can be dynamically modified with the filter file. This @@ -5767,8 +6130,8 @@ CLASS="SECT2" > 5.6. Templates7.6. Templates When PrevQuickstart to Using Starting Privoxy6. Contacting the Developers, Bug Reporting and Feature +>8. Contacting the Developers, Bug Reporting and Feature Requests We value your feedback. However, to provide you with the best support, please - note: - - 8.1. Get Support Use the Sourceforge Support Forum to get help: - +>To get support, use the Sourceforge Support Forum: + http://sourceforge.net/tracker/?group_id=11118&atid=211118 +

`8.2. Report bugs`

Submit bugs only through our Sourceforge Bug Forum: - +>To submit bugs, use the Sourceforge Bug Forum: + http://sourceforge.net/tracker/?group_id=11118&atid=111118.

+ Make sure that the bug has not already been submitted. Please try to verify that it is a Privoxy/Junkbuster - version, platform, browser, any pertinent log data, any other relevant - details (please be specific) and, if possible, some way to reproduce the - bug. +> version, platform, browser, any + pertinent log data, any other relevant details (please be specific) and, + if possible, some way to reproduce the bug.

`8.3. Request new features`

Submit feature requests only through our Sourceforge feature request forum: - +>To submit ideas on new features, use the Sourceforge feature request forum: + http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.

+

`8.4. Report ads or other filter problems`

You can also send feedback on websites that Privoxy has problems with. Please bookmark -the following link: You can also send feedback on websites that Privoxy has problems with. Please bookmark +the following link: "Privoxy - Submit Filter Feedback". Once you surf to a page with problems, use the -bookmark to send us feedback. We will look into the issue as soon as possible. -

. Once you surf to a page with problems, use the +bookmark to send us feedback. We will look into the issue as soon as possible. + New, improved default.action files will occasionally be made + available based on your feedback. These will be announced on the ijbswa-announce + list.

`8.5. Other`

For any other issues, feel free to use the mailing lists: @@ -165,73 +212,13 @@ TARGET="_top" >http://sourceforge.net/mail/?group_id=11118.

+ Anyone interested in actively participating in development and related discussions can also join the appropriate mailing list. Archives are - available, too. + available, too. See the page on Sourceforge. 6.1. Submitting Ads and "Action" Problems Ads and banners that are not stopped by Privoxy - can be submitted to the developers by accessing a special page and filling - out the brief, required form. Conversely, you can also report pages, images, - etc. that Privoxy is blocking, but should not. - The form itself does require Internet access. To do this, point your browser to Privoxy - at http://config.privoxy.org/ - (shortcut: http://p.p/), and then select - Actions file feedback system, - near the bottom of the page. Paste in the URL that is the cause of the - unwanted behavior, and follow the prompts. The developers will - try to incorporate a fix for the problem you reported into future versions. New default.actions files will occasionally be made - available based on your feedback. These - will be announced on the - ijbswa-announce - list.

7. Copyright and History9. Copyright and History7.1. Copyright9.1. Copyright is free software; you can redistribute it and/or modify it under the terms of the GNU General Public + License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details, which is available from the Free Software Foundation, Inc, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 7.2. History9.2. History $Id: user-manual.sgml,v 1.91 2002/04/24 02:39:31 hal9 Exp $ $Id: user-manual.sgml,v 1.95 2002/04/26 17:23:29 swa Exp $ - The user manual gives users information on how to install, configure and use 1.1. New FeaturesFeatures 3.1. Binary Packages 3.1.1. Red Hat and SuSE RPMs 3.1.2. 3.2. Debian 3.1.3. 3.3. Windows 3.1.4. 3.4. Solaris, NetBSD, FreeBSD, HP-UX 3.1.5. 3.5. OS/2 3.1.6. 3.6. Max OSX 3.1.7. 3.7. AmigaOS 3.2. Building from Source4. Note to Upgraders 4. 5. Quickstart to Using Privoxy 4.1. Note to Upgraders 4.2. 6. Starting Privoxy 4.3. 6.1. Command Line Options 5. 7. 5.1. 7.1. Controlling Privoxy with Your Web Browser 5.2. 7.2. Configuration Files Overview 5.3. 7.3. The Main Configuration File 5.3.1. 7.3.1. Configuration and Log File Locations 5.3.2. 7.3.2. Local Set-up Documentation 5.3.3. 7.3.3. Debugging 5.3.4. 7.3.4. Access Control and Security 5.3.5. 7.3.5. Forwarding 5.3.6. 7.3.6. Windows GUI Options 5.4. The Actions File7.4. Actions Files 5.4.1. 7.4.1. Finding the Right Mix 5.4.2. 7.4.2. How to Edit 5.4.3. 7.4.3. How Actions are Applied to URLs 5.4.4. 7.4.4. Patterns 5.4.5. 7.4.5. Actions 5.4.6. 7.4.6. Aliases 5.5. 7.5. The Filter File 5.6. 7.6. Templates 6. 8. Contacting the Developers, Bug Reporting and Feature Requests 6.1. Submitting Ads and "Action" Problems8.1. Get Support 8.2. Report bugs 8.3. Request new features 8.4. Report ads or other filter problems 8.5. Other 7. 9. Copyright and History 7.1. 9.1. Copyright 7.2. 9.2. History 8. 10. See Also 9. 11. Appendix 9.1. 11.1. Regular Expressions 9.2. 11.2. Privoxy 9.2.1. 11.2.1. Bookmarklets 9.3. 11.3. Chain of Events 9.4. 11.4. Anatomy of an Action NextPrivoxy Project Page.Privoxy Project + Page. For installing and compiling the source code, please look + into our Developer Manual. If you like to live on the bleeding edge and are not afraid of using possibly unstable development versions, you can check out the up-to-the-minute @@ -98,22 +100,14 @@ HREF="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.gz" TARGET="_top" >the nightly CVS tarball. Again, we refer you to the Developer Manual. At present, Privoxy is known to run on Win32, Mac - OSX, OS/2, AmigaOS, Linux (RedHat, Suse, Debian), FreeBSD, NetBSD, BeOS, and - many flavors of Unix. 3.1. Binary Packages is known to run on + Windows(95, 98, ME, 2000, XP), Linux (RedHat, Suse, Debian), Mac OSX, + OS/2, AmigaOS, FreeBSD, NetBSD, BeOS, and many more flavors of Unix. Note: If you have a previous See the note to upgraders. How to install the binary packages depends on your operating system: section + below. 3.1.1. Red Hat and SuSE RPMs 3.1. Red Hat and SuSE RPMs RPMs can be installed with Note that on Red Hat, Privoxy will not be - automatically started on system boot. You will need to enable that using - will + not be automatically started on system boot. You will + need to enable that using chkconfig, , + ntsysv, or similar method. , or similar methods. Note that SuSE will +automatically start Privoxy in the boot process. If you have problems with failed dependencies, try rebuilding the SRC RPM: . 3.1.2. Debian 3.2. Debian FIXME. 3.1.3. Windows 3.3. Windows Just double-click the installer, which will guide you through - the installation process. 3.1.4. Solaris, NetBSD, FreeBSD, HP-UX 3.4. Solaris, NetBSD, FreeBSD, HP-UX Create a new directory, 3.1.5. OS/2 3.5. OS/2 First, make sure that no previous installations of 3.1.6. Max OSX 3.6. Max OSX Unzip the downloaded package (you can either double-click on the file in the finder, or on the desktop if you downloaded it there). Then, @@ -288,20 +288,20 @@ CLASS="LITERAL" CLASS="APPLICATION" >Privoxy will set itself up to start - automatically on system bringup via + automatically on system bring-up via /System/Library/StartupItems/Privoxy. 3.1.7. AmigaOS 3.7. AmigaOS Copy and then unpack the 3.2. Building from Source To build Privoxy from source, - autoheader, autoconf, GNU make - (gmake), and, of course, a C compiler are required. When building from a source tarball (either release version or - nightly CVS tarball), first unpack the source: tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz] - cd privoxy-2.9.14-beta - For retrieving the current CVS sources, you'll need CVS installed. - Note that sources from CVS are development quality, and may not be - stable, or well tested. To download CVS source: cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current - cd current - This will create a directory named current/, which will - contain the source tree. Then, in either case, to build from unpacked tarball or CVS source: autoheader - autoconf - ./configure # (--help to see options) - make # (the make from gnu, gmake for *BSD) - su - make -n install # (to see where all the files will go) - make install # (to really install) - If you have gnu make, you can have the first four steps - automatically done for you by just typing make - in the freshly downloaded or unpacked source directory. For more detailed instructions on how to build Redhat and SuSE RPMs, - Windows self-extracting installers, building on platforms with - special requirements etc, please consult the developer manual. NextQuickstart to Using PrivoxyNote to Upgraders 1.1. New Features1.1. Features In addition to FIXME: complete the list of features. change the order: most important + features to the top of the list. prefix new features with "NEW". + Integrated browser based configuration and control utility at Builds from source on most UNIX-like systems. Packages available for: Linux - (RedHat, SuSE, or Debian), Windows, Sun Solaris, Mac OSX, OS/2, HP-UX 11, - NetBSD and AmigaOS. - Every feature now controllable on a per-site or per-location basis, configuration more powerful and versatile over-all. PrevNext4. Quickstart to Using 5. Quickstart to Using Privoxy4.1. Note to Upgraders There are very significant changes from older versions of - Junkbuster to the current - Privoxy. Configuration is substantially - changed. Junkbuster 2.0.x and earlier - configuration files will not migrate. The functionality of the old - blockfile, cookiefile and - imagelist, are now combined into the - "actions file" (default.action - for most installations). A "filter file" (typically default.filter) - is new as of Privoxy 2.9.x, and provides some - of the new sophistication (explained below). config is - much the same as before. If upgrading from a 2.0.x version, you will have to use the new config - files, and possibly adapt any personal rules from your older files. - When porting personal rules over from the old blockfile - to the new actions file, please note that even the pattern syntax has - changed. If upgrading from 2.9.x development versions, it is still - recommended to use the new configuration files. A quick list of things to be aware of before upgrading: The default listening port is now 8118 due to a conflict with another - service (NAS). - - Some installers may remove earlier versions completely. Save any - important configuration files! - Privoxy is controllable with a web browser - at the special URL: http://config.privoxy.org/ - (Shortcut: http://p.p/). Many - aspects of configuration can be done here, including temporarily disabling - Install Privoxy. See the section Installing. The primary configuration file for cookie management, ad and banner - blocking, and many other aspects of Start Privoxy - configuration is default.action. It is strongly - recommended to become familiar with the new actions concept below, - before modifying this file. - - Some installers may not automatically start - Privoxy after installation. - 4.2. Starting . See the section Starting Privoxy Before launching Privoxy for the first time, you - will want to configure your browser(s) to use Privoxy - as a HTTP and HTTPS proxy. The default is localhost for the proxy address, - and port 8118 (earlier versions used port 8000). This is the one - configuration step that must be done! - With Netscape (and - Mozilla), this can be set under Edit - -> Preferences -> Advanced -> Proxies -> HTTP Proxy. - For Internet Explorer: Tools -> - Internet Properties -> Connections -> LAN Setting. Then, - check "Use Proxy" and fill in the appropriate info (Address: - localhost, Port: 8118). Include if HTTPS proxy support too. After doing this, flush your browser's disk and memory caches to force a - re-reading of all pages and to get rid of any ads that may be cached. You - are now ready to start enjoying the benefits of using - Privoxy! Privoxy is typically started by specifying the - main configuration file to be used on the command line. Example Unix startup - command: - # /usr/sbin/privoxy /etc/privoxy/config - - See below for other command line options. An init script is provided for SuSE and Red Hat. For for SuSE: rcprivoxy start For Red Hat and Debian: /etc/rc.d/init.d/privoxy start If no configuration file is specified on the command line, - Privoxy will look for a file named - config in the current directory. Except on Win32 where - it will try config.txt. If no file is specified on the - command line and no default configuration file can be found, - Privoxy will fail to start. The included default configuration files should give a reasonable starting - point. Most of the per site configuration is done in the - "actions" files. These are where various cookie actions are - defined, ad and banner blocking, and other aspects of - Privoxy configuration. There are several such - files included, with varying levels of aggressiveness. You will probably want to keep an eye out for sites that require persistent - cookies, and add these to default.action as needed. By - default, most of these will be accepted only during the current browser - session (aka "session cookies"), until you add them to the - configuration. If you want the browser to handle this instead, you will need - to edit default.action and disable this feature. If you - use more than one browser, it would make more sense to let - Privoxy handle this. In which case, the - browser(s) should be set to accept all cookies. Another feature where you will probably want to define exceptions for trusted - sites is the popup-killing (through the Change your browser's configuration to use the proxy +popup and - localhost on port + +filter{popups} actions), because your favorite shopping, - banking, or leisure site may need popups. 8118. See the section Starting Privoxy is HTTP/1.1 compliant, but not all of - the optional 1.1 features are as yet supported. In the unlikely event that - you experience inexplicable problems with browsers that use HTTP/1.1 per default - (like Mozilla or recent versions of I.E.), you might - try to force HTTP/1.0 compatibility. For Mozilla, look under Edit -> - Preferences -> Debug -> Networking. - Alternatively, set the "+downgrade" config option in - default.action which will downgrade your browser's HTTP - requests from HTTP/1.1 to HTTP/1.0 before processing them. After running Privoxy for a while, you can - start to fine tune the configuration to suit your personal, or site, - preferences and requirements. There are many, many aspects that can - be customized. "Actions" (as specified in default.action) - can be adjusted by pointing your browser to - http://config.privoxy.org/ - (shortcut: http://p.p/), - and then follow the link to "edit the actions list". - (This is an internal page and does not require Internet access.) In fact, various aspects of Privoxy - configuration can be viewed from this page, including - current configuration parameters, source code version numbers, - the browser's request headers, and "actions" that apply - to a given URL. In addition to the default.action file - editor mentioned above, Privoxy can also - be turned "on" and "off" (toggled) from this page. If you encounter problems, try loading the page without - Privoxy. If that helps, enter the URL where - you have the problems into the browser - based rule tracing utility. See which rules apply and why, and - then try turning them off for that site one after the other, until the problem - is gone. When you have found the culprit, you might want to turn the rest on - again. If the above paragraph sounds gibberish to you, you might want to read more about the actions concept - or even dive deep into the Appendix - on actions. If you can't get rid of the problem at all, think you've found a bug in - Privoxy, want to propose a new feature or smarter rules, please see the - chapter "Contacting the Developers, .." below. 4.3. Command Line Options Privoxy may be invoked with the following - command-line options: --version - Print version info and exit. Unix only. - --help - Print short usage info and exit. Unix only. - --no-daemon - Don't become a daemon, i.e. don't fork and become process group - leader, and don't detach from controlling tty. Unix only. - --pidfile FILE - - On startup, write the process ID to FILE. Delete the - FILE on exit. Failure to create or delete the - FILE is non-fatal. If no FILE - option is given, no PID file will be used. Unix only. - --user USER[.GROUP] - - After (optionally) writing the PID file, assume the user ID of - USER, and if included the GID of GROUP. Exit if the - privileges are not sufficient to do so. Unix only. configfile - If no configfile is included on the command line, - Privoxy will look for a file named - "config" in the current directory (except on Win32 - where it will look for "config.txt" instead). Specify - full path to avoid confusion. If no config file is found, - Privoxy will fail to start. +> Enjoy surfing with enhanced comfort and privacy. Please see the section + Contacting the Developers on how to report + bugs or problems with websites or to get help. You may want to change the + file user.action to further tweak your new browsing + experience.

PrevNextInstallationNote to UpgradersStarting Privoxy Configuration

8. See Also10. See Also Other references and sites of interest to Starting Privoxy Privoxy User Manual Prev Next 6. Starting Privoxy Before launching Privoxy for the first time, you + will want to configure your browser(s) to use Privoxy + as a HTTP and HTTPS proxy. The default is localhost for the proxy address, + and port 8118 (earlier versions used port 8000). This is the one + configuration step that must be done! + With Netscape (and + Mozilla), this can be set under Edit + -> Preferences -> Advanced -> Proxies -> HTTP Proxy. + For Internet Explorer: Tools -> + Internet Properties -> Connections -> LAN Setting. Then, + check "Use Proxy" and fill in the appropriate info (Address: + localhost, Port: 8118). Include if HTTPS proxy support too. After doing this, flush your browser's disk and memory caches to force a + re-reading of all pages and to get rid of any ads that may be cached. You + are now ready to start enjoying the benefits of using + Privoxy! Privoxy is typically started by specifying the + main configuration file to be used on the command line. Example Unix startup + command: + # /usr/sbin/privoxy /etc/privoxy/config See below for other command line options. An init script is provided for SuSE and Red Hat. For for SuSE: rcprivoxy start For Red Hat and Debian: /etc/rc.d/init.d/privoxy start If no configuration file is specified on the command line, + Privoxy will look for a file named + config in the current directory. Except on Win32 where + it will try config.txt. If no file is specified on the + command line and no default configuration file can be found, + Privoxy will fail to start. The included default configuration files should give a reasonable starting + point. Most of the per site configuration is done in the + "actions" files. These are where various cookie actions are + defined, ad and banner blocking, and other aspects of + Privoxy configuration. There are several such + files included, with varying levels of aggressiveness. You will probably want to keep an eye out for sites for which you may prefer + persistent cookies, and add these to your actions configuration as needed. By + default, most of these will be accepted only during the current browser + session (aka "session cookies"), unless you add them to the + configuration. If you want the browser to handle this instead, you will need + to edit user.action (or through the web based interface) + and disable this feature. If you use more than one browser, it would make + more sense to let Privoxy handle this. In which + case, the browser(s) should be set to accept all cookies. Another feature where you will probably want to define exceptions for trusted + sites is the popup-killing (through the +popup and + +filter{popups} actions), because your favorite shopping, + banking, or leisure site may need popups (explained below). Privoxy is HTTP/1.1 compliant, but not all of + the optional 1.1 features are as yet supported. In the unlikely event that + you experience inexplicable problems with browsers that use HTTP/1.1 per default + (like Mozilla or recent versions of I.E.), you might + try to force HTTP/1.0 compatibility. For Mozilla, look under Edit -> + Preferences -> Debug -> Networking. + Alternatively, set the "+downgrade-http-version" config option in + default.action which will downgrade your browser's HTTP + requests from HTTP/1.1 to HTTP/1.0 before processing them. After running Privoxy for a while, you can + start to fine tune the configuration to suit your personal, or site, + preferences and requirements. There are many, many aspects that can + be customized. "Actions" + can be adjusted by pointing your browser to + http://config.privoxy.org/ + (shortcut: http://p.p/), + and then follow the link to "View & Change the Current Configuration". + (This is an internal page and does not require Internet access.) In fact, various aspects of Privoxy + configuration can be viewed from this page, including + current configuration parameters, source code version numbers, + the browser's request headers, and "actions" that apply + to a given URL. In addition to the actions file + editor mentioned above, Privoxy can also + be turned "on" and "off" (toggled) from this page. If you encounter problems, try loading the page without + Privoxy. If that helps, enter the URL where + you have the problems into the browser + based rule tracing utility. See which rules apply and why, and + then try turning them off for that site one after the other, until the problem + is gone. When you have found the culprit, you might want to turn the rest on + again. If the above paragraph sounds gibberish to you, you might want to read more about the actions concept + or even dive deep into the Appendix + on actions. If you can't get rid of the problem at all, think you've found a bug in + Privoxy, want to propose a new feature or smarter rules, please see the + section "Contacting the + Developers" below. 6.1. Command Line Options Privoxy may be invoked with the following + command-line options: --version + Print version info and exit. Unix only. + --help + Print short usage info and exit. Unix only. + --no-daemon + Don't become a daemon, i.e. don't fork and become process group + leader, and don't detach from controlling tty. Unix only. + --pidfile FILE + + On startup, write the process ID to FILE. Delete the + FILE on exit. Failure to create or delete the + FILE is non-fatal. If no FILE + option is given, no PID file will be used. Unix only. + --user USER[.GROUP] + + After (optionally) writing the PID file, assume the user ID of + USER, and if included the GID of GROUP. Exit if the + privileges are not sufficient to do so. Unix only. + configfile + If no configfile is included on the command line, + Privoxy will look for a file named + "config" in the current directory (except on Win32 + where it will look for "config.txt" instead). Specify + full path to avoid confusion. If no config file is found, + Privoxy will fail to start. + Prev Home Next Quickstart to Using Privoxy Privoxy Configuration \ No newline at end of file diff --git a/doc/webserver/user-manual/upgradersnote.html b/doc/webserver/user-manual/upgradersnote.html new file mode 100644 index 00000000..087a7b77 --- /dev/null +++ b/doc/webserver/user-manual/upgradersnote.html @@ -0,0 +1,274 @@ +Note to UpgradersPrivoxy User Manual Prev Next 4. Note to Upgraders There are very significant changes from older versions of + Junkbuster to the current + Privoxy. Configuration is substantially + changed. Junkbuster 2.0.x and earlier + configuration files will not migrate. The functionality of the old + blockfile, cookiefile and + imagelist, are now combined into the + "actions files". default.action, + is the main actions file. Local exceptions should best be put into + user.action. A "filter file" (typically default.filter) + is new as of Privoxy 2.9.x, and provides some + of the new sophistication (explained below). config is + much the same as before. If upgrading from a 2.0.x version, you will have to use the new config + files, and possibly adapt any personal rules from your older files. + When porting personal rules over from the old blockfile + to the new actions files, please note that even the pattern syntax has + changed. If upgrading from 2.9.x development versions, it is still + recommended to use the new configuration files. A quick list of things to be aware of before upgrading: The default listening port is now 8118 due to a conflict with another + service (NAS). + + Some installers may remove earlier versions completely. Save any + important configuration files! + Privoxy is controllable with a web browser + at the special URL: http://config.privoxy.org/ + (Shortcut: http://p.p/). Many + aspects of configuration can be done here, including temporarily disabling + Privoxy. + The primary configuration file for cookie management, ad and banner + blocking, and many other aspects of Privoxy + configuration is in the "actions" files. It is strongly + recommended to become familiar with the new actions concept below, + before modifying these files. Locally defined rules + should go into user.action. + + Some installers may not automatically start + Privoxy after installation. + Prev Home Next Installation Quickstart to Using Privoxy \ No newline at end of file

Prev	Home	Next
Quickstart to Using Privoxy		Privoxy Configuration

3.2. What is an "actions" These are all explained in the user-manual. @@ -176,7 +176,7 @@ CLASS="SECT2" >

3.9. Instead of ads, now I get a checkerboard pattern. I don't want to see anything.3.8. Instead of ads, now I get a checkerboard pattern. I don't want to see anything.

3.10. Why would anybody want to see a checkerboard pattern?3.9. Why would anybody want to see a checkerboard pattern?

1.6. How does Privoxy1.7. Can PrivoxySee the Troubleshooting section below.)

1.7. Can PrivoxySee the Troubleshooting section below.)

5.3. One of my favorite sites does not work with Privoxy5.4. Where can I get help? Report bugs? Feature Requests? Etc? Feedback is encouraged, whether good, bad or ugly. Please see the contact - page in the user-manual for - details.

5.5. What time is it?5.4. What time is it?

Privoxy Menu

5.2. Configuration Files Overview7.2. Configuration Files Overview

5.3. The Main Configuration File7.3. The Main Configuration File

5.3.1. Configuration and Log File Locations7.3.1. Configuration and Log File Locations

5.3.1.1. confdir7.3.1.1. confdir

5.3.1.2. logdir7.3.1.2. logdir

5.3.1.3. actionsfile7.3.1.3. + + +actionsfile

5.3.1.4. filterfile7.3.1.4. filterfile

5.3.1.5. logfile7.3.1.5. logfile

5.3.1.6. jarfile7.3.1.6. jarfile

5.3.1.7. trustfile7.3.1.7. trustfile

5.3.2. Local Set-up Documentation7.3.2. Local Set-up Documentation

5.3.2.1. trust-info-url7.3.2.1. trust-info-url

5.3.2.2. admin-address7.3.2.2. admin-address

5.3.2.3. proxy-info-url7.3.2.3. proxy-info-url

5.3.3. Debugging7.3.3. Debugging

5.3.3.1. debug7.3.3.1. debug

5.3.3.2. single-threaded7.3.3.2. single-threaded

5.3.4. Access Control and Security7.3.4. Access Control and Security

5.3.4.1. listen-address7.3.4.1. listen-address

5.3.4.2. toggle7.3.4.2. toggle

5.3.4.3. enable-remote-toggle7.3.4.3. enable-remote-toggle

5.3.4.4. enable-edit-actions7.3.4.4. enable-edit-actions

5.3.4.5. ACLs: permit-access and deny-access7.3.4.5. + +ACLs: permit-access and deny-access

5.3.4.6. buffer-limit7.3.4.6. buffer-limit

5.3.5.1. forward7.3.5.1. forward

5.3.5.2. forward-socks4 and forward-socks4a7.3.5.2. + +forward-socks4 and forward-socks4a

5.3.5.3. Advanced Forwarding Examples7.3.5.3. Advanced Forwarding Examples

5.3.6. Windows GUI Options7.3.6. Windows GUI Options

5.4. The Actions File7.4. Actions Files

5.4.1. Finding the Right Mix7.4.1. Finding the Right Mix

5.4.2. How to Edit7.4.2. How to Edit

5.4.3. How Actions are Applied to URLs7.4.3. How Actions are Applied to URLs

5.4.4. Patterns7.4.4. Patterns

5.4.4.1. The Domain Pattern7.4.4.1. The Domain Pattern

5.4.4.2. The Path Pattern7.4.4.2. The Path Pattern

5.4.6. Aliases7.4.6. Aliases

5.5. The Filter File7.5. The Filter File

5.6. Templates7.6. Templates

7.1. Copyright9.1. Copyright

1.1. New Features1.1. Features

3.2. What is an "actions"
These are all explained in the user-manual. @@ -176,7 +176,7 @@ CLASS="SECT2" >

1.6. How does Privoxy
1.7. Can PrivoxySee the Troubleshooting section below.)

5.3. One of my favorite sites does not work with Privoxy
5.4. Where can I get help? Report bugs? Feature Requests? Etc?
Feedback is encouraged, whether good, bad or ugly. Please see the contact - page in the user-manual for - details.

`5.3. The Main Configuration File7.3. The Main Configuration File`

`5.3.1. Configuration and Log File Locations7.3.1. Configuration and Log File Locations`

`5.3.1.1. confdir7.3.1.1. confdir`

`5.3.1.2. logdir7.3.1.2. logdir`

`5.3.1.3. actionsfile7.3.1.3. + + +actionsfile`

`5.4.4.1. The Domain Pattern7.4.4.1. The Domain Pattern`

`5.4.4.2. The Path Pattern7.4.4.2. The Path Pattern`

`5.4.6. Aliases7.4.6. Aliases`

`1.1. New Features1.1. Features`