Rebuild config with the recently added compression directives
authorFabian Keil <fk@fabiankeil.de>
Wed, 17 Aug 2011 10:31:40 +0000 (10:31 +0000)
committerFabian Keil <fk@fabiankeil.de>
Wed, 17 Aug 2011 10:31:40 +0000 (10:31 +0000)
config

diff --git a/config b/config
index 429a67f..a1ba08c 100644 (file)
--- a/config
+++ b/config
@@ -1,6 +1,6 @@
 #        Sample Configuration File for Privoxy v3.0.17
 #
-#  $Id: config,v 1.93 2010/11/13 12:48:18 fabiankeil Exp $
+#  $Id: config,v 1.94 2011/04/19 13:18:46 fabiankeil Exp $
 #
 #  Copyright (C) 2001-2010 Privoxy Developers http://www.privoxy.org/
 #
@@ -681,13 +681,15 @@ logfile logfile
 #
 #  Specifies:
 #
-#      The IP address and TCP port on which Privoxy will listen for
+#      The address and TCP port on which Privoxy will listen for
 #      client requests.
 #
 #  Type of value:
 #
 #      [IP-Address]:Port
 #
+#      [Hostname]:Port
+#
 #  Default value:
 #
 #      127.0.0.1:8118
@@ -707,17 +709,56 @@ logfile logfile
 #      if you want to serve requests from other machines (e.g. on your
 #      local network) as well, you will need to override the default.
 #
-#      IPv6 addresses containing colons have to be quoted by brackets.
+#      You can use this statement multiple times to make Privoxy listen
+#      on more ports or more IP addresses. Suitable if your operating
+#      system does not support sharing IPv6 and IPv4 protocols on the
+#      same socket.
+#
+#      If a hostname is used instead of an IP address, Privoxy will
+#      try to resolve it to an IP address and if there are multiple,
+#      use the first one returned.
+#
+#      If the address for the hostname isn't already known on the
+#      system (for example because it's in /etc/hostname), this may
+#      result in DNS traffic.
+#
+#      If the specified address isn't available on the system, or if
+#      the hostname can't be resolved, Privoxy will fail to start.
 #
-#      If you leave out the IP address, Privoxy will bind to all IPv4
+#      IPv6 addresses containing colons have to be quoted by
+#      brackets. They can only be used if Privoxy has been compiled
+#      with IPv6 support. If you aren't sure if your version supports
+#      it, have a look at http://config.privoxy.org/ show-status.
+#
+#      Some operating systems will prefer IPv6 to IPv4 addresses even if
+#      the system has no IPv6 connectivity which is usually not expected
+#      by the user.  Some even rely on DNS to resolve localhost which
+#      mean the "localhost" address used may not actually be local.
+#
+#      It is therefore recommended to explicitly configure the intended
+#      IP address instead of relying on the operating system, unless
+#      there's a strong reason not to.
+#
+#      If you leave out the 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.
+#      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.
+#
+#      If you configure Privoxyto be reachable from the network,
+#      consider using access control 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:
 #      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.
+#
 #  Example:
 #
 #      Suppose you are running Privoxy on a machine which has the
@@ -1712,17 +1753,11 @@ socket-timeout 300
 #      max-client-connections 256
 #
 #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
@@ -1746,7 +1781,97 @@ socket-timeout 300
 #      +handle-as-empty-document and a status 403(Forbidden) for all
 #      other blocked pages.
 #
-handle-as-empty-doc-returns-ok 1
+#  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.
+#
+#handle-as-empty-doc-returns-ok 1
+#
+#
+#  1.6.10. enable-compression
+#
+#  Specifies:
+#
+#      Whether or not buffered content is compressed before delivery.
+#
+#  Type of value:
+#
+#      0 or 1
+#
+#  Default value:
+#
+#      0
+#
+#  Effect if unset:
+#
+#      Privoxy does not compress buffered content.
+#
+#  Effect if set:
+#
+#      Privoxy compresses buffered content before delivering it to
+#      the client, provided the client supports it.
+#
+#  Notes:
+#
+#      This directive is only supported if Privoxy has been compiled
+#      with FEATURE_COMPRESSION, which should not to be confused
+#      with FEATURE_ZLIB.
+#
+#      Compressing buffered content is mainly useful if Privoxy and the
+#      client are running on different systems. If they are running on
+#      the same system, enabling compression is likely to slow things
+#      down. If you didn't measure otherwise, you should assume that
+#      it does and keep this option disabled.
+#
+#      Privoxy will not compress buffered content below a certain
+#      length.
+#
+#enable-compression 1
+#
+#
+#  1.6.11. compression-level
+#
+#  Specifies:
+#
+#      The compression level that is passed to the zlib library when
+#      compressing buffered content.
+#
+#  Type of value:
+#
+#      Positive number ranging from 0 to 9.
+#
+#  Default value:
+#
+#      1
+#
+#  Notes:
+#
+#      Compressing the data more takes usually longer than compressing
+#      it less or not compressing it at all. Which level is best
+#      depends on the connection between Privoxy and the client. If
+#      you can't be bothered to benchmark it for yourself, you should
+#      stick with the default and keep compression disabled.
+#
+#      If compression is disabled, the compression level is irrelevant.
+#
+#  Examples:
+#
+#          # Best speed (compared to the other levels)
+#          compression-level 1 # Best compression compression-level 9 #
+#          No compression. Only useful for testing as the added header #
+#          slightly increases the amount of data that has to be sent.
+#          # If your benchmark shows that using this compression level #
+#          is superior to using no compression at all, the benchmark #
+#          is likely to be flawed.  compression-level 0
+#
+#
+#compression-level 1
 #
 #
 #  7. WINDOWS GUI OPTIONS