X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fwebserver%2Fuser-manual%2Fconfig.html;h=7967f84c9bb68cee1e119ef58306ce2781fc28d3;hb=b8b189fe71adc144bc77ea0126cd7bf4bbe07d69;hp=0a59a420b3f8c665ba9b7ca9e776a6f6bb160193;hpb=46174e1f222d671ce9aab072e6174499756911ed;p=privoxy.git diff --git a/doc/webserver/user-manual/config.html b/doc/webserver/user-manual/config.html index 0a59a420..7967f84c 100644 --- a/doc/webserver/user-manual/config.html +++ b/doc/webserver/user-manual/config.html @@ -7,7 +7,7 @@ NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.79"> +HREF="../p_doc.css"> Privoxy 3.0.7 User ManualPrivoxy 3.0.11 User ManualDefault value:

Two example URLs are provided

Unset

Effect if unset:

The directory where all logging takes place - (i.e. where logfile and - jarfile are located). +> is located).

  standard.action     # Internal purposes, no editing recommended

  match-all.action # Actions that are applied to all sites and maybe overruled later on.

  default.action      # Main actions file

  default.action   # Main actions file

  user.action         # User customizations

  user.action      # User customizations

- The default values include standard.action, which is used - for internal purposes and should be loaded, default.action, - which is the , which is the + "main" actions file maintained by the developers, and @@ -1088,10 +1089,7 @@ CLASS="EMPHASIS" >Effect if unset:

Logging is disabled unless --no-daemon mode is used. +> No logfile is written.

Many users will never look at it, however, and it's a privacy risk - if third parties can get access to it. It is therefore disabled by - default in 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. -

3.0.7 and later only log fatal + errors by default. +

For troubleshooting purposes, you will have to explicitly enable it. - Please don't file any support requests without trying to reproduce - the problem with logging enabled first. Once you read the log messages, - you may even be able to solve the problem on your own. +> 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 @@ -1156,79 +1153,8 @@ CLASS="SECT3" >

7.2.7. jarfile

Specifies:

The file to store intercepted cookies in -

Type of value:

File name, relative to logdir

Default value:

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

Effect if unset:

Intercepted cookies are not stored in a dedicated log file. -

Notes:

The jarfile may grow to ridiculous sizes over time. -

If debug 8 (show header parsing) is enabled, cookies are - also written to the logfile with the rest of the headers. - Therefore this option isn't very useful and may be removed - in future releases. Please report to the developers if you - are still using it. -

7.2.8. trustfile7.2.7. trustfile

Specifies:

Key values that determine what information gets logged to the - logfile. +> Key values that determine what information gets logged.

Default value:

12289 (i.e.: URLs plus informational and warning messages)

0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)

Effect if unset:

Nothing gets logged. +> Default value is used (see above). 

  debug         1 # show each GET/POST/CONNECT request
-  debug         2 # show each connection status
-  debug         4 # show I/O status
-  debug         8 # show header parsing
-  debug        16 # log all data written to the network into the logfile
-  debug        32 # debug force feature
-  debug        64 # debug regular expression filters
-  debug       128 # debug redirects
-  debug       256 # debug GIF de-animation
-  debug       512 # Common Log Format
-  debug      1024 # debug kill pop-ups
-  debug      2048 # CGI user interface
-  debug      4096 # Startup banner and warnings.
-  debug      8192 # Non-fatal errors
debug 1 # Log the destination for each request Privoxy let through. See also debug 1024. + debug 2 # show each connection status + debug 4 # show I/O status + debug 8 # show header parsing + debug 16 # log all data written to the network into the logfile + debug 32 # debug force feature + debug 64 # debug regular expression filters + debug 128 # debug redirects + debug 256 # debug GIF de-animation + debug 512 # Common Log Format + debug 1024 # Log the destination for requests Privoxy didn't let through, and the reason why. + debug 2048 # CGI user interface + debug 4096 # Startup banner and warnings. + debug 8192 # Non-fatal errors1, 4096 and 8192 are highly recommended1, 4096 and 8192 are recommended - so that you will notice when things go wrong. The other levels are probably - only of interest if you are hunting down a specific problem. They can produce - a hell of an output (especially 16). + so that you will notice when things go wrong. The other levels are + probably only of interest if you are hunting down a specific problem. + They can produce a hell of an output (especially 16).

If you want to use CLF (Common Log Format), you should set 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. +

If you want to use pure CLF (Common Log Format), you should set "debug 512""... [too long, truncated]".

Please don't file any support requests without trying to reproduce + the problem with increased debug level first. Once you read the log + messages, you may even be able to solve the problem on your own. +

7.3.3. hostname

Specifies:

The hostname shown on the CGI pages. +

Type of value:

Text

Default value:

Unset

Effect if unset:

The hostname provided by the operating system is used. +

Notes:

On some misconfigured systems resolving the hostname fails or + takes too much time and slows Privoxy down. Setting a fixed hostname + works around the problem. +

In other circumstances it might be desirable to show a hostname + other than the one returned by the operating system. For example + if the system has several different hostnames and you don't want + to use the first one. +

Note that Privoxy does not validate the specified hostname value. +

7.5.2. forward-socks4 and forward-socks4a7.5.2. forward-socks4, forward-socks4a and forward-socks5target_pattern is a is a + URL pattern - that specifies to which requests (i.e. URLs) this forward rule shall apply. Use that specifies to which + requests (i.e. URLs) this forward rule shall apply. Use / to denote "all URLs". - . http_parent and + and socks_proxy - are IP addresses in dotted decimal notation or valid DNS names (http_parentport parameters are TCP ports, i.e. integer values from 1 to 64535 +> parameters are TCP ports, + i.e. integer values from 1 to 65535

With forward-socks5 the DNS resolution will happen on the remote server as well. +

If CGI forms can lead to rather long URLs. This isn't a problem as far as the HTTP standard is concerned, but it can confuse clients with arbitrary - URL lenght limitations. + URL length limitations.

Enabling split-large-forms causes Privoxy - to devide big forms into smaller ones to keep the URL length down. + to divide big forms into smaller ones to keep the URL length down. It makes editing a lot less convenient and you can no longer submit all changes at once, but at least it works around this browser bug. @@ -3588,6 +3602,163 @@ CLASS="APPLICATION" >

7.5.8. keep-alive-timeout

Specifies:

Number of seconds after which an open connection will no longer be reused. +

Type of value:

Time in seconds. +

Default value:

None

Effect if unset:

Connections are not reused. +

Notes:

This option has no effect if Privoxy + has been compiled without keep-alive support. +

Notes:

Note that reusing connections doesn't necessary cause speedups. + There are also a few privacy implications you should be aware of. +

Outgoing connections are shared between clients (if there are more + than one) and closing the client that initiated the outgoing connection + does not affect the connection between Privoxy and the server unless + the client's request hasn't been completed yet. If the outgoing connection + is idle, it will not be closed until either Privoxy's + or the server's timeout is reached. While it's open, the server knows + that the system running Privoxy is still there. +

Examples:

keep-alive-timeout 300 +

7.5.9. socket-timeout

Specifies:

Number of seconds after which a socket times out if + no data is received. +

Type of value:

Time in seconds. +

Default value:

None

Effect if unset:

A default value of 300 seconds is used. +

Notes:

For SOCKS requests the timeout currently doesn't start until + the SOCKS server accepted the request. This will be fixed in + the next release. +

Examples:

socket-timeout 300 +