X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fp-config.sgml;h=e545a3afe12f180d04fb216f478ea325d6193bba;hp=e4416f72a5e24f6fbd1cbd97a1a701e8a84a97a6;hb=43980e5c0dbe1b2090fa04f69c3989960f1d8975;hpb=0428133610c525457cb16f7ac6a54203a2743d6c diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml index e4416f72..e545a3af 100644 --- a/doc/source/p-config.sgml +++ b/doc/source/p-config.sgml @@ -3,9 +3,9 @@ Purpose : Used with other docs and files only. - $Id: p-config.sgml,v 2.78 2011/08/18 11:42:50 fabiankeil Exp $ + $Id: p-config.sgml,v 2.105 2014/06/02 06:20:51 fabiankeil Exp $ - Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/ + Copyright (C) 2001-2014 Privoxy Developers http://www.privoxy.org/ See LICENSE. ======================================================================== @@ -94,13 +94,13 @@ @@TITLE<!-- between the @@ is stripped by Makefile -->@@ - Sample Configuration File for Privoxy v&p-version; + Sample Configuration File for Privoxy &p-version; - $Id: p-config.sgml,v 2.78 2011/08/18 11:42:50 fabiankeil Exp $ + $Id: p-config.sgml,v 2.105 2014/06/02 06:20:51 fabiankeil Exp $ -Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/ +Copyright (C) 2001-2014 Privoxy Developers http://www.privoxy.org/ @@ -117,7 +117,8 @@ Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/ 3. DEBUGGING # 4. ACCESS CONTROL AND SECURITY # 5. FORWARDING # - 6. WINDOWS GUI OPTIONS # + 6. MISCELLANEOUS # + 7. WINDOWS GUI OPTIONS # # ################################################################# @@ -533,16 +534,6 @@ II. FORMAT OF THE CONFIGURATION FILE No trailing /, please. - @@ -597,6 +588,55 @@ II. FORMAT OF THE CONFIGURATION FILE + +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. + + + + + +@@#temporary-directory .]]> + + + logdir @@ -856,8 +896,7 @@ actionsfile 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 based Linux distributions, a - logrotate script has been included. + (see man cron). Any log files must be writable by whatever user Privoxy @@ -1020,6 +1059,7 @@ actionsfile debug 4096 # Startup banner and warnings. debug 8192 # Non-fatal errors debug 32768 # log all data read from the network + debug 65536 # Log the applying actions @@ -1083,13 +1123,13 @@ actionsfile Type of value: - None + 1 or 0 Default value: - Unset + 0 @@ -1112,7 +1152,7 @@ actionsfile -@@#single-threaded]]> +@@#single-threaded 1]]> @@ -1278,10 +1318,10 @@ actionsfile IPv4 interfaces (addresses) on your machine and may become reachable from the Internet and/or the local network. Be aware that some GNU/Linux distributions modify that behaviour without updating the documentation. Check for non-standard - patches if your Privoxyversion behaves differently. + patches if your Privoxy version behaves differently. - If you configure Privoxyto be reachable from the + If you configure Privoxy to be reachable from the network, consider using access control lists (ACL's, see below), and/or a firewall. @@ -1291,12 +1331,6 @@ actionsfile linkend="enable-edit-actions">enable-edit-actions and enable-remote-toggle - - With the exception noted above, listening on multiple addresses is currently - not supported by Privoxy directly. - It can be done on most operating systems by letting a packet filter - redirect request for certain addresses to Privoxy, though. - @@ -1371,18 +1405,6 @@ actionsfile toggled off mode, i.e. 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. @@ -1888,6 +1910,67 @@ ACLs: permit-access and deny-access @@buffer-limit 4096]]> + +enable-proxy-authentication-forwarding + + + Specifies: + + + Whether or not proxy authentication through &my-app; 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. + + + + + +@@enable-proxy-authentication-forwarding 0]]> + + @@ -2034,7 +2117,7 @@ ACLs: permit-access and deny-access -forward-socks4, forward-socks4a and forward-socks5 +forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t @@ -2097,6 +2180,12 @@ forward-socks4, forward-socks4a and forward-socks5 With forward-socks5 the DNS resolution will happen on the remote server as well. + + forward-socks5t works like vanilla forward-socks5 but + lets &my-app; additionally use Tor-specific SOCKS extensions. Currently the only supported + SOCKS extension is optimistic data which can reduce the latency for the first request made + on a newly created connection. + socks_proxy and http_parent can be a @@ -2145,7 +2234,7 @@ forward-socks4, forward-socks4a and forward-socks5 - forward-socks5 / 127.0.0.1:9050 . + forward-socks5t / 127.0.0.1:9050 . @@ -2386,6 +2475,9 @@ forward-socks4, forward-socks4a and forward-socks5 option and configure your packet filter to redirect outgoing 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 @@ -2600,7 +2692,7 @@ forward-socks4, forward-socks4a and forward-socks5 Several users have reported this as a Privoxy bug, so the default value has been reduced. Consider increasing it to 300 seconds or even more if you think your browser can handle - it. If your browser appears to be hanging it can't. + it. If your browser appears to be hanging, it probably can't. @@ -2617,6 +2709,75 @@ forward-socks4, forward-socks4a and forward-socks5 +tolerate-pipelining + + + Specifies: + + + Whether or not pipelined requests should be served. + + + + + Type of value: + + + 0 or 1. + + + + + Default value: + + None + + + + Effect if unset: + + + If Privoxy receives more than one request at once, it terminates the + client connection after serving the first one. + + + + + Notes: + + + &my-app; currently doesn't pipeline outgoing requests, + thus allowing pipelining on the client connection is not + guaranteed to improve the performance. + + + By default &my-app; tries to discourage clients from pipelining + by discarding aggressively pipelined requests, which forces the + client to resend them through a new connection. + + + This option lets &my-app; tolerate pipelining. Whether or not + that improves performance mainly depends on the client configuration. + + + If you are seeing problems with pages not properly loading, + disabling this option could work around the problem. + + + + + Examples: + + + tolerate-pipelining 1 + + + + +@@tolerate-pipelining 1]]> + + + default-server-timeout @@ -2874,7 +3035,7 @@ forward-socks4, forward-socks4a and forward-socks5 Default value: - None + 128 @@ -2919,6 +3080,13 @@ forward-socks4, forward-socks4a and forward-socks5 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 &my-app; 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 &my-app; with a different FD_SETSIZE limit. + @@ -3126,6 +3294,72 @@ forward-socks4, forward-socks4a and forward-socks5 +client-header-order + + + Specifies: + + + The order in which client headers are sorted before forwarding them. + + + + + Type of value: + + + Client header names delimited by spaces or tabs + + + + + Default value: + + None + + + + Notes: + + + By default &my-app; leaves the client headers in the order they + were sent by the client. Headers are modified in-place, new headers + are added at the end of the already existing headers. + + + The header order can be used to fingerprint client requests + independently of other headers like the User-Agent. + + + This directive allows to sort the headers differently to better + mimic a different User-Agent. Client headers will be emitted + in the order given, headers whose name isn't explicitly specified + are added at the end. + + + Note that sorting headers in an uncommon way will make fingerprinting + actually easier. Encrypted headers are not affected by this directive. + + + + +@@#client-header-order Host \ + User-Agent \ + Accept \ + Accept-Language \ + Accept-Encoding \ + Proxy-Connection \ + Referer \ + Cookie \ + DNT \ + If-Modified-Since \ + Cache-Control \ + Content-Length \ + Content-Type +]]> + + + @@ -3165,8 +3399,9 @@ forward-socks4, forward-socks4a and forward-socks5 @@]]> If log-messages is set to 1, - Privoxy will log messages to the console - window: + Privoxy copies log messages to the console + window. + The log detail depends on the debug directive. @@#log-messages 1]]>