X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fwebserver%2Fuser-manual%2Fconfig.html;h=d0cd99a8d254faf05d331d1a8c3729c25123fdba;hp=35a12fb6557a697acddfd595f6977694e532bd4b;hb=40a495e3ffe8605f990003cd4f90390298c383b7;hpb=82c493b884fe1157749712c0bfbdd6e2a1455a97 diff --git a/doc/webserver/user-manual/config.html b/doc/webserver/user-manual/config.html index 35a12fb6..d0cd99a8 100644 --- a/doc/webserver/user-manual/config.html +++ b/doc/webserver/user-manual/config.html @@ -6,7 +6,7 @@ The Main Configuration File - + @@ -21,7 +21,7 @@ - + @@ -430,7 +430,55 @@
-

7.2.3. logdir

+

7.2.3. temporary-directory

+ +
+
+
Specifies:
+ +
+

A directory where Privoxy can create temporary files.

+
+ +
Type of value:
+ +
+

Path name

+
+ +
Default value:
+ +
+

unset

+
+ +
Effect if unset:
+ +
+

No temporary files are created, external filters don't + work.

+
+ +
Notes:
+ +
+

To execute external + filters, Privoxy has + to create temporary files. This directive specifies the + directory the temporary files should be written to.

+ +

It should be a directory only Privoxy (and trusted users) can + access.

+
+
+
+
+ +
+

7.2.4. logdir

@@ -473,7 +521,7 @@
-

7.2.4. +

7.2.5. actionsfile

@@ -544,22 +592,14 @@

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

- -

Note that since Privoxy 3.0.7, the complete filename, - including the ".action" extension - has to be specified. The syntax change was necessary to be - consistent with the other file options and to allow previously - forbidden characters.

+ considerations, etc.

-

7.2.5. +

7.2.6. filterfile

@@ -630,7 +670,7 @@
-

7.2.6. +

7.2.7. logfile

@@ -676,27 +716,28 @@

Depending on the debug options below, the logfile may be a privacy risk if third parties can get access to it. As most users will never look at it, Privoxy 3.0.7 and later only log fatal - errors by default.

+ "APPLICATION">Privoxy only logs fatal errors by + default.

For most troubleshooting purposes, you will have to change that, please refer to the debugging section for details.

-

Your logfile will grow indefinitely, and you will probably - want to periodically remove it. On Unix systems, you can do - this with a cron job (see "man - cron").

-

Any log files must be writable by whatever user Privoxy is being run as (on Unix, default user id is "privoxy").

+ +

To prevent the logfile from growing indefinitely, it is + recommended to periodically rotate or shorten it. Many + operating systems support log rotation out of the box, some + require additional software to do it. For details, please refer + to the documentation for your operating system.

-

7.2.7. +

7.2.8. trustfile

@@ -859,11 +900,6 @@ problem. They can produce a hell of an output (especially 16).

-

Privoxy used to ship with - the debug levels recommended above enabled by default, but due - to privacy concerns 3.0.7 and later are configured to only log - fatal errors.

-

If you are used to the more verbose settings, simply enable the debug lines below again.

@@ -901,15 +937,14 @@
Type of value:
-

None

+

1 or + 0

Default value:
-

Unset

+

0

Effect if unset:
@@ -1173,9 +1208,6 @@ mostly behave like a normal, content-neutral proxy with both ad blocking and content filtering disabled. See enable-remote-toggle below.

- -

The windows version will only display the toggle icon in the - system tray if this option is present.

@@ -1688,6 +1720,66 @@

+ +
+

7.4.9. + enable-proxy-authentication-forwarding

+ +
+
+
Specifies:
+ +
+

Whether or not proxy authentication through Privoxy should work.

+
+ +
Type of value:
+ +
+

0 or 1

+
+ +
Default value:
+ +
+

0

+
+ +
Effect if unset:
+ +
+

Proxy authentication headers are removed.

+
+ +
Notes:
+ +
+

Privoxy itself does not support proxy authentication, but + can allow clients to authenticate against Privoxy's parent + proxy.

+ +

By default Privoxy (3.0.21 and later) don't do that and + remove Proxy-Authorization headers in requests and + Proxy-Authenticate headers in responses to make it harder for + malicious sites to trick inexperienced users into providing + login information.

+ +

If this option is enabled the headers are forwarded.

+ +

Enabling this option is not recommended if there is no parent + proxy that requires authentication or if the local network + between Privoxy and the parent proxy isn't trustworthy. If + proxy authentication is only required for some requests, it is + recommended to use a client header filter to remove the + authentication headers for requests where they aren't + needed.

+
+
+
+
@@ -1974,12 +2066,18 @@
Privoxy 3.0.20 User ManualPrivoxy 3.0.25 User Manual
-  forward-socks5   /               127.0.0.1:9050 .
+  forward-socks5t   /               127.0.0.1:9050 .
 
+

Note that if you got Tor through one of the bundles, you may + have to change the port from 9050 to 9150 (or even another + one). For details, please check the documentation on the + Tor + website.

+

The public Tor network can't be used to reach your local network, if you need to access local servers you therefore might want to make some @@ -2232,6 +2330,9 @@ HTTP connections into Privoxy.

+

Note that intercepting encrypted connections (HTTPS) isn't + supported.

+

Make sure that Privoxy's own requests aren't redirected as well. Additionally take care that Privoxy can't @@ -2491,8 +2592,8 @@ tolerate pipelining. Whether or not that improves performance mainly depends on the client configuration.

-

This options is new and should be considered - experimental.

+

If you are seeing problems with pages not properly loading, + disabling this option could work around the problem.

Examples:
@@ -2741,7 +2842,7 @@
Default value:
-

None

+

128

Effect if unset:
@@ -2787,6 +2888,14 @@

Obviously using this option only makes sense if you choose a limit below the one enforced by the operating system.

+ +

One most POSIX-compliant systems Privoxy can't properly deal with more than + FD_SETSIZE file descriptors at the same time and has to reject + connections if the limit is reached. This will likely change in + a future version, but currently this limit can't be increased + without recompiling Privoxy + with a different FD_SETSIZE limit.

Examples:
@@ -2844,15 +2953,15 @@
Notes:
-

This is a work-around for Firefox bug 492459: " Websites are no longer rendered if SSL requests for - JavaScripts are blocked by a proxy. " (https://bugzilla.mozilla.org/show_bug.cgi?id=492459) - As the bug has been fixed for quite some time this option - should no longer be needed and will be removed in a future - release. Please speak up if you have a reason why the option - should be kept around.

+

This directive was added as a work-around for Firefox bug + 492459: "Websites are no longer rendered if + SSL requests for JavaScripts are blocked by a proxy." + (https://bugzilla.mozilla.org/show_bug.cgi?id=492459), + the bug has been fixed for quite some time, but this directive + is also useful to make it harder for websites to detect whether + or not resources are being blocked.

@@ -3032,6 +3141,180 @@ + +
+

7.6.14. client-specific-tag

+ +
+
+
Specifies:
+ +
+

The name of a tag that will always be set for clients that + requested it through the webinterface.

+
+ +
Type of value:
+ +
+

Tag name followed by a + description that will be shown in the webinterface

+
+ +
Default value:
+ +
+

None

+
+ +
Notes:
+ +
+
+ + + + + + + + +
Warning
+

This is an experimental feature. The syntax is + likely to change in future versions.

+
+
+ +

Client-specific tags allow Privoxy admins to create + different profiles and let the users chose which one they want + without impacting other users.

+ +

One use case is allowing users to circumvent certain blocks + without having to allow them to circumvent all blocks. This is + not possible with the enable-remote-toggle + feature because it would bluntly disable all blocks for all + users and also affect other actions like filters. It also is + set globally which renders it useless in most multi-user + setups.

+ +

After a client-specific tag has been defined with the + client-specific-tag directive, action sections can be activated + based on the tag by using a CLIENT-TAG pattern. The CLIENT-TAG pattern is + evaluated at the same priority as URL patterns, as a result the + last matching pattern wins. Tags that are created based on + client or server headers are evaluated later on and can + overrule CLIENT-TAG and URL patterns!

+ +

The tag is set for all requests that come from clients that + requested it to be set. Note that "clients" are differentiated + by IP address, if the IP address changes the tag has to be + requested again.

+ +

Clients can request tags to be set by using the CGI + interface http://config.privoxy.org/show-client-tags. + The specific tag description is only used on the web page and + should be phrased in away that the user understand the effect + of the tag.

+
+ +
Examples:
+ +
+ + + + +
+
+    # Define a couple of tags, the described effect requires action sections
+    # that are enabled based on CLIENT-TAG patterns.
+    client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
+    disable-content-filters Disable content-filters but do not affect other actions
+
+
+
+
+
+
+
+ +
+

7.6.15. client-tag-lifetime

+ +
+
+
Specifies:
+ +
+

How long a temporarily enabled tag remains enabled.

+
+ +
Type of value:
+ +
+

Time in seconds.

+
+ +
Default value:
+ +
+

60

+
+ +
Notes:
+ +
+
+ + + + + + + + +
Warning
+

This is an experimental feature. The syntax is + likely to change in future versions.

+
+
+ +

In case of some tags users may not want to enable them + permanently, but only for a short amount of time, for example + to circumvent a block that is the result of an overly-broad URL + pattern.

+ +

The CGI interface http://config.privoxy.org/show-client-tags therefore + provides a "enable this tag temporarily" option. If it is used, + the tag will be set until the client-tag-lifetime is over.

+
+ +
Examples:
+ +
+ + + + +
+
+      # Increase the time to life for temporarily enabled tags to 3 minutes
+      client-tag-lifetime 180
+
+
+
+
+
+
+