From 00ff6723cacb0c08cbf3f1044e8639a89ebc23d7 Mon Sep 17 00:00:00 2001 From: hal9 Date: Fri, 8 Sep 2006 02:38:59 +0000 Subject: [PATCH] Various changes: -Fix a number of broken links. -Migrate the new Windows service command line options, and reference as needed. -Rebuild so that can be used with the new "user-manual" config capabilities. -Etc. --- doc/source/user-manual.sgml | 186 ++- doc/webserver/user-manual/actions-file.html | 24 +- doc/webserver/user-manual/appendix.html | 48 +- doc/webserver/user-manual/config.html | 1519 ++++++++++-------- doc/webserver/user-manual/configuration.html | 12 +- doc/webserver/user-manual/contact.html | 4 +- doc/webserver/user-manual/copyright.html | 6 +- doc/webserver/user-manual/filter-file.html | 12 +- doc/webserver/user-manual/index.html | 114 +- doc/webserver/user-manual/installation.html | 122 +- doc/webserver/user-manual/introduction.html | 4 +- doc/webserver/user-manual/quickstart.html | 32 +- doc/webserver/user-manual/seealso.html | 39 +- doc/webserver/user-manual/startup.html | 47 +- doc/webserver/user-manual/templates.html | 4 +- doc/webserver/user-manual/whatsnew.html | 62 +- 16 files changed, 1363 insertions(+), 872 deletions(-) diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 8e74d868..c9f6a94d 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -32,7 +32,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 2.16 2006/09/02 12:49:37 hal9 Exp $ + $Id: user-manual.sgml,v 2.17 2006/09/05 13:25:12 david__schmidt Exp $ Copyright (C) 2001- 2006 Privoxy Developers See LICENSE. @@ -58,7 +58,7 @@ -$Id: user-manual.sgml,v 2.16 2006/09/02 12:49:37 hal9 Exp $ +$Id: user-manual.sgml,v 2.17 2006/09/05 13:25:12 david__schmidt Exp $ @@ -204,7 +202,7 @@ automatically start Privoxy in the boot process. Also note that if you have a Junkbuster RPM installed on your system, you need to remove it first, because the packages conflict. Otherwise, RPM will try to remove Junkbuster - automatically, before installing Privoxy. + automatically if found, before installing Privoxy. @@ -223,8 +221,41 @@ automatically start Privoxy in the boot process. Just double-click the installer, which will guide you through the installation process. You will find the configuration files - in the same directory as you installed Privoxy in. + in the same directory as you installed Privoxy in. + + Version 3.0.4 introduces full Windows service + functionality. On Windows only, the Privoxy + program has two new command line arguments to install and uninstall + Privoxy as a service. + + + + Arguments: + + + --install[:service_name] + + + --uninstall[:service_name] + + + + + + After invoking Privoxy with + --install, you will need to bring up the + Windows service console to assign the user you + want Privoxy to run under, and whether or not you + want it to run whenever the system starts. You can start the + Windows services console with the following + command: services.msc If you do not take the manual step + of modifying Privoxy's service settings, it will + not start. Note too that you will need to give Privoxy a user account that + actually exists, or it will not be permitted to + write to its log and configuration files. + + @@ -503,16 +534,42 @@ automatically start Privoxy in the boot process. - MS-Windows versions can now be installed and - started as a service. + MS-Windows versions can now be + installed and + started as a Windows service. + + + config has two new options: + enable-remote-http-toggle, + and forwarded-connect-retries. + + + And there is improved handling of the user-manual + option, for placing documentation and help files on the local system. + + + + + + Actions files problems and suggestions are now being directed to: http://sourceforge.net/tracker/?group_id=11118&atid=460288. + Please use this to report such configuration related problems as missed + ads, sites that don't function properly due to one action or another, + innocent images being blocked, etc. + + + In addition, there are various bug fixes and significant enhancements, including - error pages are no longer cached, better DNS error handling, and various logging - improvements. + error pages should no longer be cached if the problem is fixed, better DNS + error handling, and various logging improvements. @@ -539,6 +596,16 @@ automatically start Privoxy in the boot process. configuration files. Save any important configuration files! + + + On the other hand, some installers may not overwrite any existing configuration + files, thinking you will want to do that. You may want to manually check + your saved files against the newer versions to see if the improvements have + merit, or whether there are new options that you may want to consider. + There are a number of new features, but most won't be available unless + these features are incorporated into your configuration somehow. + + See the full documentation on @@ -611,10 +678,8 @@ automatically start Privoxy in the boot process. Set your browser to use Privoxy as HTTP and HTTPS (SSL) proxy by setting the proxy configuration for address of 127.0.0.1 and port 8118. - (Junkbuster and earlier versions of - Privoxy used port 8000.) See the section Starting Privoxy below - for more details on this. + DO NOT activate proxying for FTP or + any protocols besides HTTP and HTTPS (SSL)! It won't work! @@ -669,7 +734,7 @@ automatically start Privoxy in the boot process. Please see the section Contacting the - Developers on how to report bugs or problems with websites or to get + Developers on how to report bugs, problems with websites or to get help. @@ -1083,44 +1148,18 @@ your PC. Windows -Click on the Privoxy Icon to start Privoxy. If no configuration file is +Click on the Privoxy Icon to start Privoxy. If no configuration file is specified on the command line, Privoxy will look for a file named config.txt. Note that Windows will automatically start Privoxy when the system starts if you chose that option when installing. - - Version 3.0.4 introduces full Windows service functionality. + Privoxy can run with full Windows service functionality. On Windows only, the Privoxy program has two new command line arguments - to install and uninstall Privoxy as a service. - - - Arguments: - - - --install[:service_name] - - - - - --uninstall[:service_name] - - - - - - - After invoking Privoxy with --install, - you will need to bring up the Windows service console to assign the user you - want Privoxy to run under, and whether or not you want it to run whenever the - system starts. You can start the Windows services console with the following command: - services.msc If you do not take the manual step of modifying - Privoxy's service settings, it will not start. Note too that you will need to - give Privoxy a user account that actually exists, or it will not be permitted to - write its log files. + to install and uninstall Privoxy as a service. See the + Windows Installation + instructions for details. @@ -1391,6 +1430,14 @@ must find a better place for this paragraph + + On MS Windows only there are two addition + options to allow Privoxy to install and + run as a service. See the +Window Installation section +for details. + + @@ -1557,6 +1604,12 @@ must find a better place for this paragraph + + The syntax of all configuration files has remained the same throughout the + 3.x series. There have been enhancements, but no changes that would preclude + the use of any configuration file from one version to the next. + + All files use the # character to denote a comment (the rest of the line will be ignored) and understand line continuation @@ -2091,7 +2144,7 @@ must find a better place for this paragraph at http://www.pcre.org/man.txt. You might also find the Perl man page on regular expressions (man perlre) useful, which is available on-line at http://www.perldoc.com/perl5.6/pod/perlre.html. + url="http://perldoc.perl.org/perlre.html">http://perldoc.perl.org/perlre.html. @@ -6205,11 +6258,11 @@ ar.atwola.com/ If you are new to regular expressions, you might want to take a look at the Appendix on regular expressions, and - see the Perl + see the Perl manual for - the + the s/// operator's syntax and Perl-style regular + url="http://perldoc.perl.org/perlre.html">Perl-style regular expressions in general. The below examples might also help to get you started. @@ -7038,7 +7091,7 @@ Requests - [] - Characters enclosed in brackets will be matched if + [ ] - Characters enclosed in brackets will be matched if any of the enclosed characters are encountered. For instance, [0-9] matches any numeric digit (zero through nine). As an example, we can combine this with + to match any digit one of more times: [0-9]+. @@ -7047,7 +7100,7 @@ Requests - () - parentheses are used to group a sub-expression, + ( ) - parentheses are used to group a sub-expression, or multiple sub-expressions. @@ -7089,7 +7142,7 @@ Requests - A now something a little more complex: + And now something a little more complex: @@ -7127,7 +7180,7 @@ Requests /.*/advert[0-9]+\.(gif|jpe?g) - Again another path statement with forward slashes. Anything in the square brackets - [] can be matched. This is using 0-9 as a + [ ] can be matched. This is using 0-9 as a shorthand expression to mean any digit one through nine. It is the same as saying 0123456789. So any digit matches. The + means one or more of the preceding expression must be included. The preceding @@ -7163,7 +7216,7 @@ Requests More reading on Perl Compatible Regular expressions: - http://www.perldoc.com/perl5.6/pod/perlre.html + http://perldoc.perl.org/perlre.html @@ -7394,7 +7447,7 @@ Requests Privoxy traps any request for its own internal CGI - pages (e.g http://p.p/) and sends the CGI page back to the browser. + pages (e.g http://p.p/) and sends the CGI page back to the browser. @@ -7481,7 +7534,7 @@ Requests - As the browser receives the now (probably filtered) page content, it + As the browser receives the now (possibly 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 @@ -7734,7 +7787,7 @@ In file: user.action [ View ] [ Edit ] Notice the only difference here to the previous listing, is to fast-redirects and session-cookies-only, - which are actived specifically for this site in our configuration, + which are activated specifically for this site in our configuration, and thus show in the Final Results. @@ -7782,14 +7835,14 @@ In file: user.action [ View ] [ Edit ] - One last example. Let's try http://www.rhapsodyk.net/adsl/HOWTO/. + One last example. Let's try http://www.example.net/adsl/HOWTO/. This one is giving us problems. We are getting a blank page. Hmmm ... - Matches for http://www.rhapsodyk.net/adsl/HOWTO/: + Matches for http://www.example.net/adsl/HOWTO/: In file: default.action [ View ] [ Edit ] @@ -7957,6 +8010,9 @@ In file: user.action [ View ] [ Edit ] + +

8.1. Finding the Right Mix

8.2. How to Edit

8.4.1. The Domain Pattern

8.4.2. The Path Pattern

man perlre) useful, which is available on-line at http://www.perldoc.com/perl5.6/pod/perlre.htmlhttp://perldoc.perl.org/perlre.html.

Note that the path pattern is automatically left-anchored at the

8.5.36. Summary

8.7.1. default.action

8.7.2. user.action

+ +[][ ] - Characters enclosed in brackets will be matched if any of the enclosed characters are encountered. For instance, ()( ) - parentheses are used to group a sub-expression, or multiple sub-expressions. @@ -478,7 +480,7 @@ CLASS="QUOTE" > in the path somewhere.

A now something a little more complex:

And now something a little more complex:

"[]""[ ]" can be matched. This is using "0-9"

More reading on Perl Compatible Regular expressions: http://www.perldoc.com/perl5.6/pod/perlre.htmlhttp://perldoc.perl.org/perlre.html

For information on regular expression based substitutions and their applications @@ -743,7 +745,7 @@ CLASS="SECT2" >

14.2.
Short cuts. Turn off, then on:

Privoxy traps any request for its own internal CGI - pages (e.g http://p.p/) and sends the CGI page back to the browser. + pages (e.g http://p.p/) and sends the CGI page back to the browser.

  • As the browser receives the now (probably filtered) page content, it +> As the browser receives the now (possibly 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 @@ -1690,7 +1696,7 @@ CLASS="QUOTE" CLASS="QUOTE" >"session-cookies-only", - which are actived specifically for this site in our configuration, + which are activated specifically for this site in our configuration, and thus show in the "Final Results"

    One last example. Let's try "http://www.rhapsodyk.net/adsl/HOWTO/""http://www.example.net/adsl/HOWTO/". This one is giving us problems. We are getting a blank page. Hmmm ...

    
 Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
    +>
 Matches for http://www.example.net/adsl/HOWTO/:
     
      In file: default.action 
    +
    +

    7.1. Configuration and Log File Locations

    Privoxy can (and normally does) use a number of - other files for additional configuration, help and logging. - This section of the configuration file tells Privoxy - where to find those other files.

    7.1. Local Set-up Documentation
  • The user running If you intend to operate Privoxy, must have read - permission for all configuration files, and write permission to any files - that would be modified, such as log files and actions files.

    for more users + than just yourself, it might be a good idea to let them know how to reach + you, what you block and why you do that, your policies, etc. +

    7.1.1. confdir

    7.1.1. user-manual

    Specifies:

    The directory where the other configuration files are located

    Location of the Privoxy User Manual. +

    Type of value:

    Path name

    A fully qualified URI

    Default value:

    /etc/privoxy (Unix) orUnset Privoxy installation dir (Windows)

    Effect if unset:

    http://www.privoxy.org/Mandatory

    version/user-manual/ + will be used, where version is the Privoxy version. +

    Notes:

    No trailing "/", please +> The User Manual URI is the single best source of information on + Privoxy, and is used for help links from some + of the internal CGI pages. The manual itself is normally packaged with the + binary distributions, so you probably want to set this to a locally + installed copy. For multi-user setups, you could provide a copy on a local + webserver for all your users and use the corresponding URL here.

    When development goes modular and multi-user, the blocker, filter, and - per-user config will be stored in subdirectories of "confdir". - For now, the configuration directory structure is flat, except for - confdir/templates, where the HTML templates for CGI - output reside (e.g. Privoxy's 404 error page). +> Examples: +

    The best all purpose solution is simply to put the full local + PATH to where the User Manual is + located: +

      user-manual  /usr/share/doc/privoxy/user-manual
    +

    The User Manual is then available to anyone with access to the proxy, by + following the built-in URL: http://config.privoxy.org/user-manual/ + (or the shortcut: http://p.p/user-manual/). +

    If the documentation is not on the local system, it can be accessed + from a remote server, as: +

      user-manual  http://example.com/privoxy/user-manual/
    +

    Warning

    If set, this option should be the first option in the config + file, because it is used while the config file is being read + on start-up.

    7.1.2. logdir

    7.1.2. trust-info-url

    Specifies:

    The directory where all logging takes place (i.e. where logfile and - jarfile are located) +> A URL to be displayed in the error page that users will see if access to an untrusted page is denied.

    Type of value:

    Path name

    URL

    Default value:

    /var/log/privoxy (Unix) or Privoxy installation dir (Windows)

    Two example URL are provided

    Effect if unset:

    No links are displayed on the "untrusted" error page. +

    Notes:

    The value of this option only matters if the experimental trust mechanism has been + activated. (See Mandatorytrustfile

    Notes:
    above.) +

    No trailing "/", please +> If you use the trust mechanism, it is a good idea to write up some on-line + documentation about your trust policy and to specify the URL(s) here. + Use multiple times for multiple URLs. +

    The URL(s) should be added to the trustfile as well, so users don't end up + locked out from the information on why they were locked out in the first place!

    7.1.3. actionsfile

    7.1.3. admin-address

    Specifies:

    The actions file(s) to use +> An email address to reach the proxy administrator.

    Type of value:

    File name, relative to confdir, without the .action suffix

    Email address

    Default values:
    Default value:

      standard     # Internal purposes, no editing recommended

    -

      default      # Main actions file

    -

      user         # User customizations

    -

    Unset

    Effect if unset:

    No actions are taken at all. Simple neutral proxying. +> No email address is displayed on error pages and the CGI user interface.

    Notes:

    Multiple If both actionsfile lines are permitted, 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 - user.action, where you can make your personal additions. -

    - Actions files are where all the per site and per URL configuration is done for - ad blocking, cookie management, privacy considerations, etc. - There is no point in using Privoxy without at - least one actions file. +>admin-address and proxy-info-url + are unset, the whole "Local Privoxy Support" box on all generated pages will + not be shown.

    7.1.4. filterfile

    7.1.4. proxy-info-url

    Specifies:

    The filter file(s) to use +> A URL to documentation about the local Privoxy setup, + configuration or policies.

    Type of value:

    File name, relative to confdir

    URL

    Default value:

    default.filter (Unix) orUnset default.filter.txt (Windows)

    Effect if unset:

    No textual content filtering takes place, i.e. all - +filter{name} - actions in the actions files are turned neutral. +> No link to local documentation is displayed on error pages and the CGI user interface.

    Notes:

    Multiple filterfiles lines are permitted. -

    The filter files contain content modification - rules that use regular expressions. These rules permit - powerful changes on the content of Web pages, and optionally the headers - as well, e.g., you could disable your favorite JavaScript annoyances, - re-write the actual displayed text, or just have some fun replacing - "Microsoft" with "MicroSuck" wherever it appears - on a Web page. -

    The - If both +filter{name} - actions rely on the relevant filter (name) - to be defined in a filter file! -

    A pre-defined filter file called default.filter that contains - a number of useful filters for common problems is included in the distribution. - See the section on the admin-address and filterproxy-info-url - action for a list. + are unset, the whole "Local Privoxy Support" box on all generated pages will + not be shown.

    It is recommended to place any locally adapted filters into a separate - file, such as user.filter. +> This URL shouldn't be blocked ;-)

    7.2. Configuration and Log File Locations

    Privoxy can (and normally does) use a number of + other files for additional configuration, help and logging. + This section of the configuration file tells Privoxy + where to find those other files.

    The user running Privoxy, must have read + permission for all configuration files, and write permission to any files + that would be modified, such as log files and actions files.

    7.1.5. logfile

    7.2.1. confdir

    Specifies:

    The log file to use -

    The directory where the other configuration files are located

    Type of value:

    File name, relative to logdir

    Path name

    Default value:

    logfile (Unix) /etc/privoxy (Unix) or privoxy.log (Windows)

    Privoxy installation dir (Windows)

    Effect if unset:

    No log file is used, all log messages go to the console (STDERR). -

    Mandatory

    Notes:

    The logfile is where all logging and error messages are written. The level - of detail and number of messages are set with the No trailing "debug - option (see below). The logfile can be useful for tracking down a problem with - Privoxy (e.g., it's not blocking an ad you - think it should block) but in most cases you probably will never look at it. +>/", please

    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 When development goes modular and multi-user, the blocker, filter, and + per-user config will be stored in subdirectories of "man cron"). For Red Hat, a logrotate - script has been included. +>"confdir". + For now, the configuration directory structure is flat, except for + confdir/templates, where the HTML templates for CGI + output reside (e.g. Privoxy's 404 error page).

    7.2.2. logdir

    On SuSE Linux systems, you can place a line like "/var/log/privoxy.* - +1024k 644 nobody.nogroup" in

    Specifies:

    The directory where all logging takes place (i.e. where /etc/logfiles, with - the effect that cron.daily will automatically archive, gzip, and empty the - log, when it exceeds 1M size. +>logfile and + jarfile are located)

    Type of value:

    Any log files must be writable by whatever user Path name

    Default value:

    /var/log/privoxy (Unix) or Privoxy - is being run as (default on UNIX, user id is installation dir (Windows)

    Effect if unset:

    Mandatory

    Notes:

    No trailing "privoxy"). +>"/", please

    7.2.3. actionsfile

    7.1.6. jarfile

    Specifies:

    The file to store intercepted cookies in +> The actions file(s) to use

    File name, relative to logdir

    confdir, without the .action suffix

    Default value:
    Default values:

    jarfile (Unix) or privoxy.jar (Windows)

      standard     # Internal purposes, no editing recommended

    +

      default      # Main actions file

    +

      user         # User customizations

    +

    Effect if unset:

    Intercepted cookies are not stored at all. +> No actions are taken at all. Simple neutral proxying.

    Notes:

    The jarfile may grow to ridiculous sizes over time. +> Multiple actionsfile lines are permitted, 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 + user.action, where you can make your personal additions. +

    + Actions files are where all the per site and per URL configuration is done for + ad blocking, cookie management, privacy considerations, etc. + There is no point in using Privoxy without at + least one actions file.

    7.2.4. filterfile

    7.1.7. trustfile

    Specifies:

    The trust file to use +> The filter file(s) to use

    Default value:

    Unset (commented out). When activated: trust (Unix) default.filter (Unix) or trust.txt (Windows)

    default.filter.txt (Windows)

    Effect if unset:

    The entire trust mechanism is turned off. +> No textual content filtering takes place, i.e. all + +filter{name} + actions in the actions files are turned neutral.

    Notes:

    The trust mechanism is an experimental feature for building white-lists and should - be used with care. It is NOT recommended for the casual user. +> Multiple filterfile lines are permitted.

    If you specify a trust file, Privoxy will only allow - access to sites that are specified in the trustfile. Sites can be listed - in one of two ways: +> The filter files contain content modification + rules that use regular expressions. These rules permit + powerful changes on the content of Web pages, and optionally the headers + as well, e.g., you could disable your favorite JavaScript annoyances, + re-write the actual displayed text, or just have some fun + playing buzzword bingo with web pages.

    Prepending a ~ character limits access to this site - only (and any sub-paths within this site), e.g. +> The ~www.example.com. -

    Or, you can designate sites as +filter{trusted referrers, by - prepending the name with a + character. The effect is that - access to untrusted sites will be granted -- but only if a link from this - trusted referrer was used. The link target will then be added to the - "trustfile" so that future, direct accesses will be granted. - Sites added via this mechanism do not become trusted referrers themselves - (i.e. they are added with a ~ designation). -

    If you use the + operator in the trust file, it may grow - considerably over time. +>name} + actions rely on the relevant filter (name) + to be defined in a filter file!

    It is recommended that Privoxy be compiled with - the --disable-force, --disable-toggle and - A pre-defined filter file called default.filter that contains + a number of useful filters for common problems is included in the distribution. + See the section on the --disable-editor options, if this feature is to be - used. +>filter + action for a list.

    Possible applications include limiting Internet access for children. +> It is recommended to place any locally adapted filters into a separate + file, such as user.filter.

    7.2. Local Set-up Documentation

    If you intend to operate Privoxy for more users - than just yourself, it might be a good idea to let them know how to reach - you, what you block and why you do that, your policies, etc. -

    7.2.1. user-manual

    7.2.5. logfile

    Specifies:

    Location of the Privoxy User Manual. +> The log file to use

    Type of value:

    A fully qualified URI

    File name, relative to logdir

    Default value:

    logfile (Unix) Unsetor

    privoxy.log (Windows)

    Effect if unset:

    http://www.privoxy.org/version/user-manual/ - will be used, where version is the Privoxy version. +> No log file is used, all log messages go to the console (STDERR).

    Notes:

    The User Manual URI is used for help links from some of the internal CGI pages. - The manual itself is normally packaged with the binary distributions, so you probably want - to set this to a locally installed copy. For multi-user setups, you could provide a copy on - a local webserver for all your users and use the corresponding URL here. +> The logfile is where all logging and error messages are written. The level + of detail and number of messages are set with the debug + option (see below). The logfile can be useful for tracking down a problem with + Privoxy (e.g., it's not blocking an ad you + think it should block) but in most cases you probably will never look at it.

    Examples: +> 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"). For Red Hat, a logrotate + script has been included.

    Unix, in local filesystem: -

      user-manual  file:///usr/share/doc/privoxy-3.0.4/user-manual/
    -

    Windows, in local filesystem, must use forward slash notation: -

      user-manual  file:/c:/some-dir/privoxy-3.0.4/user-manual/
    -

    Windows, UNC notation (with forward slashes): -

      user-manual  file://///some-server/some-path/privoxy-3.0.4/user-manual/
    -

    Any platform, on local webserver (called On SuSE Linux systems, you can place a line like "local-webserver"): -

    "/var/log/privoxy.* + +1024k 644 nobody.nogroup" in /etc/logfiles, with + the effect that cron.daily will automatically archive, gzip, and empty the + log, when it exceeds 1M size. +

      user-manual  http://local-webserver/privoxy-user-manual/
    Any log files must be writable by whatever user Privoxy -

    Warning

    If set, this option should be the first option in the config - file, because it is used while the config file is being read. + is being run as (default on UNIX, user id is "privoxy").

    7.2.2. trust-info-url

    7.2.6. jarfile

    Specifies:

    A URL to be displayed in the error page that users will see if access to an untrusted page is denied. +> The file to store intercepted cookies in

    Type of value:

    URL

    File name, relative to logdir

    Default value:

    Two example URL are provided

    Unset (commented out). When activated: jarfile (Unix) or privoxy.jar (Windows)

    Effect if unset:

    No links are displayed on the "untrusted" error page. +> Intercepted cookies are not stored in a dedicated log file.

    Notes:

    The value of this option only matters if the experimental trust mechanism has been - activated. (See trustfile above.) -

    If you use the trust mechanism, it is a good idea to write up some on-line - documentation about your trust policy and to specify the URL(s) here. - Use multiple times for multiple URLs. +> The jarfile may grow to ridiculous sizes over time.

    The URL(s) should be added to the trustfile as well, so users don't end up - locked out from the information on why they were locked out in the first place! +> If debug 8 (show header parsing) is enabled, cookies are + written to the logfile with the rest of the headers.

    7.2.3. admin-address

    7.2.7. trustfile

    Specifies:

    An email address to reach the proxy administrator. +> The trust file to use

    Type of value:

    Email address

    File name, relative to confdir

    Default value:
    UnsetUnset (commented out)

    . When activated: trust (Unix) or trust.txt (Windows)

    Effect if unset:

    No email address is displayed on error pages and the CGI user interface. +> The entire trust mechanism is turned off.

    Notes:

    If both admin-address and proxy-info-url - are unset, the whole "Local Privoxy Support" box on all generated pages will - not be shown. -

    7.2.4. proxy-info-url

    Specifies:
    The trust mechanism is an experimental feature for building white-lists and should + be used with care. It is NOT recommended for the casual user. +

    A URL to documentation about the local If you specify a trust file, Privoxy setup, - configuration or policies. +> will only allow + access to sites that are specified in the trustfile. Sites can be listed + in one of two ways:

    Type of value:

    URL

    Default value:
    Prepending a ~ character limits access to this site + only (and any sub-paths within this site), e.g. + ~www.example.com. +

    Or, you can designate sites as Unsettrusted referrers

    Effect if unset:
    , by + prepending the name with a + character. The effect is that + access to untrusted sites will be granted -- but only if a link from this + trusted referrer was used. The link target will then be added to the + "trustfile" so that future, direct accesses will be granted. + Sites added via this mechanism do not become trusted referrers themselves + (i.e. they are added with a ~ designation). +

    No link to local documentation is displayed on error pages and the CGI user interface. +> If you use the + operator in the trust file, it may grow + considerably over time.

    Notes:

    If both It is recommended that Privoxy be compiled with + the admin-address and --disable-force, proxy-info-url - are unset, the whole "Local Privoxy Support" box on all generated pages will - not be shown. +>--disable-toggle and + --disable-editor options, if this feature is to be + used.

    This URL shouldn't be blocked ;-) +> Possible applications include limiting Internet access for children.

    7.4.4. enable-remote-http-toggle

    Specifies:

    Whether or not Privoxy recognizes special HTTP headers to change its behaviour. +

    Type of value:

    0 or 1

    Default value:

    1

    Effect if unset:

    Privoxy ignores special HTTP headers. +

    Notes:

    When toggled on, the client can change Privoxy's + behaviour by setting special HTTP headers. Currently the only supported + special header is "X-Filter: No", to disable filtering for + the ongoing request, even if it is enabled in one of the action files. +

    If you are using Privoxy in a + multi-user environment or with untrustworthy clients and want to + enforce filtering, you will have to disable this option, + otherwise you can ignore it. +

    7.4.4. enable-edit-actions

    7.4.5. enable-edit-actions

    7.4.5. ACLs: permit-access and deny-access7.4.6. ACLs: permit-access and deny-access7.4.6. buffer-limit7.4.7. buffer-limit

    +

    To chain Privoxy and Tor, both running on the same system, you should use + the rule: +

      forward-socks4   /               127.0.0.1:9050 .
    +

    The public Tor network can't be used to reach your local network, + therefore it's a good idea to make some exceptions: +

      forward         192.168.*.*/     .
    +  forward            10.*.*.*/     .
    +  forward           127.*.*.*/     .
    +

    Unencrypted connections to systems in these address ranges will + be as (un)secure as the local network is, but the alternative is that you + can't reach the network at all. +

    If you also want to be able to reach servers in your local network by + using their names, you will need additional exceptions that look like + this: +

     forward           localhost/     .

    7.5.4. forwarded-connect-retries

    Specifies:

    How often Privoxy retries if a forwarded connection request fails. +

    Type of value:

    Number of retries. +

    Default value:

    0

    Effect if unset:

    Forwarded connections are treated like direct connections and no retry attempts are made. +

    Notes:

    forwarded-connect-retries is mainly interesting + for socks4a connections, where Privoxy can't detect why the connections failed. + The connection might have failed because of a DNS timeout in which case a retry makes sense, + but it might also have failed because the server doesn't exist or isn't reachable. In this + case the retry will just delay the appearance of Privoxy's error message. +

    Only use this option, if you are getting many forwarding related error messages, + that go away when you try again manually. Start with a small value and check Privoxy's + logfile from time to time, to see how many retries are usually needed. +

    Examples:

    forwarded-connect-retries 1 +

    + +

    6.1. Controlling

        Privoxy Menu

    The syntax of all configuration files has remained the same throughout the + 3.x series. There have been enhancements, but no changes that would preclude + the use of any configuration file from one version to the next.

    All files use the " + + + +

    12.1. License

    + +Appendix on regular expressions, and see the Perl manual for the s/// operator's syntax and Perl-style regular expressions

    9.1. Filter File Tutorial

    + + Copyright © 2001 - 2004 by +> © 2001 - 2006 by

    $Id: user-manual.sgml,v 2.15 2006/08/30 11:15:22 hal9 Exp $

    $Id: user-manual.sgml,v 2.17 2006/09/05 13:25:12 david__schmidt Exp $

    6.1. Controlling Privoxy
    7.1. Configuration and Log File LocationsLocal Set-up Documentation
    7.1.1. confdiruser-manual
    7.1.2. logdirtrust-info-url
    7.1.3. actionsfileadmin-address
    7.1.4. filterfile
    7.1.5. logfile
    7.1.6. jarfile
    7.1.7. trustfileproxy-info-url
    7.2. Local Set-up DocumentationConfiguration and Log File Locations
    7.2.1. user-manualconfdir
    7.2.2. trust-info-urllogdir
    7.2.3. admin-addressactionsfile
    7.2.4. proxy-info-urlfilterfile
    7.2.5. logfile
    7.2.6. jarfile
    7.2.7. trustfile
    7.4.4. enable-remote-http-toggle
    7.4.5. enable-edit-actions
    7.4.5. 7.4.6. ACLs: permit-access and deny-access
    7.4.6. 7.4.7. buffer-limit
    Advanced Forwarding Examples
    7.5.4. forwarded-connect-retries
    8.1. Finding the Right Mix
    8.2. How to Edit
    8.4.1. The Domain Pattern
    8.4.2. The Path Pattern
    8.5.36. Summary
    8.7.1. default.action
    8.7.2. user.action
    9.1. Filter File Tutorial
    12.1. License
    14.2. Privoxy + +.

    Note: If you have a previous Junkbuster or - Privoxy installation on your system, you - will need to remove it. On some platforms, this may be done for you as part - of their installation procedure. (See below for your platform). In any case - Note: + On some platforms, the installer may remove previously installed versions, if + found. (See below for your platform). In any case be sure to backup your old configuration if it is valuable to - you.be sure to backup + your old configuration if it is valuable to you. See the note to - upgradersnote to upgraders section below.

    Junkbuster - automatically, before installing Privoxy.

    Just double-click the installer, which will guide you through the installation process. You will find the configuration files - in the same directory as you installed Privoxy in.

    Privoxy in.

    Version 3.0.4 introduces full Windows service + functionality. On Windows only, the Privoxy + program has two new command line arguments to install and uninstall + Privoxy as a service.

    Arguments:

    --install[:service_name] +

    --uninstall[:service_name] +

    After invoking Privoxy with + --install, you will need to bring up the + Windows service console to assign the user you + want Privoxy to run under, and whether or not you + want it to run whenever the system starts. You can start the + Windows services console with the following + command: services.msc If you do not take the manual step + of modifying Privoxy's service settings, it will + not start. Note too that you will need to give Privoxy a user account that + actually exists, or it will not be permitted to + write to its log and configuration files.

    + + + +8118. - (Junkbuster and earlier versions of Privoxy used port 8000.) See the section Starting Privoxy below - for more details on this. +CLASS="emphasis" +>DO NOT activate proxying for FTP or + any protocols besides HTTP and HTTPS (SSL)! It won't work!

  • Contacting the Developers on how to report bugs or problems with websites or to get +> on how to report bugs, problems with websites or to get help.

  • + + http://www.privoxy.org/actions/http://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit "misses" to the developers. +> and other + configuration related suggestions to the developers. http://privacy.net/analyze/http://privacy.net/, a useful site to check what information about you is leaked while you browse the web. http://tor.eff.org/, + TOR can help anonymize web browsing, + web publishing, instant messaging, IRC, SSH, and other applications. +

    +

    http://www.privoxy.org/developer-manual/ + +

    5.4. Windows

    Click on the Privoxy Icon to start Privoxy. If no configuration file is +>Click on the Privoxy Icon to start Privoxy. If no configuration file is specified on the command line, Privoxyconfig.txt. Note that Windows will - automatically start Privoxy upon booting you PC.

    Privoxy can run with full Windows service functionality. + On Windows only, the Privoxy program has two new command line arguments + to install and uninstall Privoxy as a service. See the + Windows Installation + instructions for details.

    On MS Windows only there are two addition + options to allow Privoxy to install and + run as a service. See the +Window Installation section +for details.

    + + + + MS-Windows versions can now be installed and +> versions can now be + installed and started as a serviceWindows service.

  • config has two new options: + enable-remote-http-toggle, + and forwarded-connect-retries. +

    And there is improved handling of the user-manual + option, for placing documentation and help files on the local system. +

  • Actions files problems and suggestions are now being directed to: http://sourceforge.net/tracker/?group_id=11118&atid=460288. + Please use this to report such configuration related problems as missed + ads, sites that don't function properly due to one action or another, + innocent images being blocked, etc. +

  • In addition, there are various bug fixes and significant enhancements, including - error pages are no longer cached, better DNS error handling, and various logging - improvements. + error pages should no longer be cached if the problem is fixed, better DNS + error handling, and various logging improvements.

  • + On the other hand, some installers may not overwrite any existing configuration + files, thinking you will want to do that. You may want to manually check + your saved files against the newer versions to see if the improvements have + merit, or whether there are new options that you may want to consider. + There are a number of new features, but most won't be available unless + these features are incorporated into your configuration somehow. +

  • See the full documentation on