#94: Add a config directive to let Privoxy prefer either IPv4 (or IPv6) addresses
[privoxy.git] / config
diff --git a/config b/config
index 9366b59..429a67f 100644 (file)
--- a/config
+++ b/config
@@ -1,8 +1,8 @@
-#        Sample Configuration File for Privoxy v3.0.13
+#        Sample Configuration File for Privoxy v3.0.17
 #
-#  $Id: config,v 1.79 2009/05/10 10:21:13 fabiankeil Exp $
+#  $Id: config,v 1.93 2010/11/13 12:48:18 fabiankeil Exp $
 #
-#  Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
+#  Copyright (C) 2001-2010 Privoxy Developers http://www.privoxy.org/
 #
 ####################################################################
 #                                                                  #
 #
 #        user-manual  /usr/share/doc/privoxy/user-manual
 #
-#
 #      The User Manual is then available to anyone with
 #      access to Privoxy, by following the built-in URL:
 #      http://config.privoxy.org/user-manual/ (or the shortcut:
 #
 #        user-manual  http://example.com/privoxy/user-manual/
 #
-#
 #      WARNING!!!
 #
 #          If set, this option should be the first option in the config
@@ -416,7 +414,7 @@ actionsfile user.action      # User customizations
 #      separate file, such as user.filter.
 #
 filterfile default.filter
-#filterfile user.filter      # User customizations
+filterfile user.filter      # User customizations
 #
 #
 #  2.6. logfile
@@ -560,7 +558,7 @@ logfile logfile
 #        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        16 # log all data written to the network
 #        debug        32 # debug force feature
 #        debug        64 # debug regular expression filters
 #        debug       128 # debug redirects
@@ -570,6 +568,7 @@ logfile logfile
 #        debug      2048 # CGI user interface
 #        debug      4096 # Startup banner and warnings.
 #        debug      8192 # Non-fatal errors
+#        debug     32768 # log all data read from the network
 #
 #
 #      To select multiple debug levels, you can either add them or
@@ -713,10 +712,7 @@ logfile logfile
 #      If you leave out the IP address, Privoxy will bind to all IPv4
 #      interfaces (addresses) on your machine and may become reachable
 #      from the Internet. In that case, consider using access control
-#      lists (ACL's, see below), and/or a firewall. If the hostname
-#      is localhost, Privoxy will explicitly try to bind to an IPv4
-#      address. For other hostnames it depends on the operating system
-#      which IP version will be used.
+#      lists (ACL's, see below), and/or a firewall.
 #
 #      If you open Privoxy to untrusted users, you will also
 #      want to make sure that the following actions are disabled:
@@ -731,13 +727,11 @@ logfile logfile
 #
 #        listen-address  192.168.0.1:8118
 #
-#
 #      Suppose you are running Privoxy on an IPv6-capable machine and
 #      you want it to listen on the IPv6 address of the loopback device:
 #
 #        listen-address [::1]:8118
 #
-#
 listen-address  127.0.0.1:8118
 #
 #
@@ -1010,10 +1004,10 @@ enforce-blocks 0
 #      names. If a DNS name resolves to multiple IP addresses, only
 #      the first one is used.
 #
-#      Some systems allows IPv4 client to connect to IPv6 server
-#      socket. Then the client's IPv4 address will be translated by
+#      Some systems allow IPv4 clients to connect to IPv6 server
+#      sockets. Then the client's IPv4 address will be translated by the
 #      system into IPv6 address space with special prefix ::ffff:0:0/96
-#      (so called IPv4 mapped IPv6 address).  Privoxy can handle it
+#      (so called IPv4 mapped IPv6 address). Privoxy can handle it
 #      and maps such ACL addresses automatically.
 #
 #      Denying access to particular sites by ACL may have undesired
@@ -1173,7 +1167,7 @@ buffer-limit 4096
 #
 #      Parent proxy specified by an IPv6 address:
 #
-#        foward   /                   [2001:DB8::1]:8000
+#        forward   /                   [2001:DB8::1]:8000
 #
 #
 #      Suppose your parent proxy doesn't support IPv6:
@@ -1280,7 +1274,6 @@ buffer-limit 4096
 #
 #
 #
-#
 #  5.3. forwarded-connect-retries
 #  ===============================
 #
@@ -1321,6 +1314,9 @@ buffer-limit 4096
 #      manually. Start with a small value and check Privoxy's logfile
 #      from time to time, to see how many retries are usually needed.
 #
+#      Due to a bug, this option currently also causes Privoxy to
+#      retry in case of certain problems with direct connections.
+#
 #  Examples:
 #
 #      forwarded-connect-retries 1
@@ -1485,14 +1481,80 @@ split-large-forms 0
 #      This option has no effect if Privoxy has been compiled without
 #      keep-alive support.
 #
+#      Note that a timeout of five seconds as used in the default
+#      configuration file significantly decreases the number of
+#      connections that will be reused.  The value is used because some
+#      browsers limit the number of connections they open to a single
+#      host and apply the same limit to proxies. This can result in a
+#      single website "grabbing" all the connections the browser allows,
+#      which means connections to other websites can't be opened until
+#      the connections currently in use time out.
+#
+#      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.
+#
 #  Examples:
 #
 #      keep-alive-timeout 300
 #
-keep-alive-timeout 300
+keep-alive-timeout 5
+#
+#
+#  6.5. default-server-timeout
+#  ============================
+#
+#  Specifies:
+#
+#      Assumed server-side keep-alive timeout if not specified by
+#      the server.
+#
+#  Type of value:
+#
+#      Time in seconds.
+#
+#  Default value:
+#
+#      None
+#
+#  Effect if unset:
+#
+#      Connections for which the server didn't specify the keep-alive
+#      timeout are not reused.
+#
+#  Notes:
+#
+#      Enabling this option significantly increases the number of
+#      connections that are reused, provided the keep-alive-timeout
+#      option is also enabled.
+#
+#      While it also increases the number of connections problems when
+#      Privoxy tries to reuse a connection that already has been closed
+#      on the server side, or is closed while Privoxy is trying to
+#      reuse it, this should only be a problem if it happens for the
+#      first request sent by the client. If it happens for requests
+#      on reused client connections, Privoxy will simply close the
+#      connection and the client is supposed to retry the request
+#      without bothering the user.
+#
+#      Enabling this option is therefore only recommended if the
+#      connection-sharing option is disabled.
 #
+#      It is an error to specify a value larger than the
+#      keep-alive-timeout value.
 #
-#  6.5. connection-sharing
+#      This option has no effect if Privoxy has been compiled without
+#      keep-alive support.
+#
+#  Examples:
+#
+#      default-server-timeout 60
+#
+#default-server-timeout 60
+#
+#
+#  6.6. connection-sharing
 #  ========================
 #
 #  Specifies:
@@ -1563,7 +1625,7 @@ keep-alive-timeout 300
 #connection-sharing 1
 #
 #
-#  6.6. socket-timeout
+#  6.7. socket-timeout
 #  ====================
 #
 #  Specifies:
@@ -1596,7 +1658,7 @@ keep-alive-timeout 300
 socket-timeout 300
 #
 #
-#  6.7. max-client-connections
+#  6.8. max-client-connections
 #  ============================
 #
 #  Specifies:
@@ -1652,6 +1714,41 @@ socket-timeout 300
 #max-client-connections 256
 #
 #
+#  6.9. handle-as-empty-doc-returns-ok
+#  ====================================
+#
+#  Note:
+#
+#      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)
+#
+#  Specifies:
+#
+#      The status code Privoxy returns for pages blocked with
+#      +handle-as-empty-document.
+#
+#  Type of value:
+#
+#      0 or 1
+#
+#  Default value:
+#
+#      0
+#
+#  Effect if unset:
+#
+#      Privoxy returns a status 403(forbidden) for all blocked pages.
+#
+#  Effect if set:
+#
+#      Privoxy returns a status 200(OK) for pages blocked with
+#      +handle-as-empty-document and a status 403(Forbidden) for all
+#      other blocked pages.
+#
+handle-as-empty-doc-returns-ok 1
+#
+#
 #  7. WINDOWS GUI OPTIONS
 #  =======================
 #