X-Git-Url: http://www.privoxy.org/gitweb/%40user-manual%40%40actions-help-prefix%40HIDE_IF_MODIFIED_SINCE?a=blobdiff_plain;f=doc%2Fsource%2Fp-config.sgml;h=c622cf2cf50621ec2a326bb44a6f926eb9d1c5db;hb=029f27038bef2c80e99dde3359c0ad86cab29594;hp=fff23cd1b07bd0303112d2848d2d1ed5597ff188;hpb=e734bb1389aaa25ccc30da467aa439a9b00f9973;p=privoxy.git diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml index fff23cd1..c622cf2c 100644 --- a/doc/source/p-config.sgml +++ b/doc/source/p-config.sgml @@ -3,7 +3,7 @@ Purpose : Used with other docs and files only. - $Id: p-config.sgml,v 2.49 2009/04/19 17:39:55 fabiankeil Exp $ + $Id: p-config.sgml,v 2.50 2009/04/24 15:29:43 fabiankeil Exp $ Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/ See LICENSE. @@ -95,7 +95,7 @@ Sample Configuration File for Privoxy v&p-version; - $Id: p-config.sgml,v 2.49 2009/04/19 17:39:55 fabiankeil Exp $ + $Id: p-config.sgml,v 2.50 2009/04/24 15:29:43 fabiankeil Exp $ Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/ @@ -2512,19 +2512,87 @@ forward-socks4, forward-socks4a and forward-socks5 Effect if unset: - Connections are not reused. + Connections are not kept alive. Notes: + + This option allows clients to keep the connection to &my-app; + alive. If the server supports it, &my-app; will keep + the connection to the server alive as well. Under certain + circumstances this may result in speed-ups. + + + By default, &my-app; will close the connection to the server if + the client connection gets closed, or if the specified timeout + has been reached without a new request coming in. This behaviour + can be changed with the connection-sharing option. + This option has no effect if Privoxy has been compiled without keep-alive support. + + Examples: + + + keep-alive-timeout 300 + + + + +@@keep-alive-timeout 300]]> + + + +connection-sharing + + + Specifies: + + + Whether or not outgoing connections that have been kept alive + should be shared between different incoming connections. + + + + + Type of value: + + + 0 or 1 + + + + + Default value: + + None + + + + Effect if unset: + + + Connections are not shared. + + + + + Notes: + + + This option has no effect if Privoxy + has been compiled without keep-alive support, or if it's disabled. + + + Notes: @@ -2533,13 +2601,34 @@ forward-socks4, forward-socks4a and forward-socks5 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 &my-app; 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 &my-app; is still there. + If this option is effective, outgoing connections are shared between + clients (if there are more than one) and closing the client that initiated + the outgoing connection does no longer affect the connection between &my-app; + 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 &my-app; is still + there. + + + If there are more than one client (maybe even belonging to multiple users), + they will be able to reuse each others connections. This is potentially + dangerous in case of authentication schemes like NTLM where only the + connection is authenticated, instead of requiring authentication for + each request. + + + If there is only a single client, and if said client can keep connections + alive on its own, enabling this option has next to no effect. If the client + doesn't support connection keep-alive, enabling this option may make sense + as it allows &my-app; to keep outgoing connections alive even if the client + itself doesn't support it. + + + This option should only be used by experienced users who + understand the risks and can weight them against the benefits. @@ -2547,12 +2636,12 @@ forward-socks4, forward-socks4a and forward-socks5 Examples: - keep-alive-timeout 300 + connection-sharing 1 -@@keep-alive-timeout 300]]> +@@#connection-sharing 1]]> @@ -2689,7 +2778,7 @@ forward-socks4, forward-socks4a and forward-socks5 -@@max-client-connections 256]]> +@@#max-client-connections 256]]>