Rebuild config

[privoxy.git] / config

diff --git a/config b/config
index 2e3dee5..794ac3b 100644 (file)
--- a/config
+++ b/config
@@ -1,8 +1,8 @@
-#        Sample Configuration File for Privoxy v3.0.20
+#        Sample Configuration File for Privoxy 3.0.22
 #
-#  $Id: config,v 1.100 2013/01/09 15:07:39 fabiankeil Exp $
+#  $Id: p-config.sgml,v 2.104 2014/05/05 09:59:30 fabiankeil Exp $
 #
-#  Copyright (C) 2001-2013 Privoxy Developers http://www.privoxy.org/
+#  Copyright (C) 2001-2014 Privoxy Developers http://www.privoxy.org/
 #
 ####################################################################
 #                                                                  #
@@ -16,7 +16,8 @@
 #        3. DEBUGGING                                              #
 #        4. ACCESS CONTROL AND SECURITY                            #
 #        5. FORWARDING                                             #
-#        6. WINDOWS GUI OPTIONS                                    #
+#        6. MISCELLANEOUS                                          #
+#        7. WINDOWS GUI OPTIONS                                    #
 #                                                                  #
 ####################################################################
 #
@@ -68,7 +69,6 @@
 #  last character.
 #
 #
-#
 #  1. LOCAL SET-UP DOCUMENTATION
 #  ==============================
 #
@@ -77,7 +77,6 @@
 #  you, what you block and why you do that, your policies, etc.
 #
 #
-#
 #  1.1. user-manual
 #  =================
 #
@@ -131,7 +130,6 @@
 #
 #user-manual http://www.privoxy.org/user-manual/
 #
-#
 #  1.2. trust-info-url
 #  ====================
 #
@@ -168,7 +166,6 @@
 #trust-info-url  http://www.example.com/why_we_block.html
 #trust-info-url  http://www.example.com/what_we_allow.html
 #
-#
 #  1.3. admin-address
 #  ===================
 #
@@ -197,7 +194,6 @@
 #
 #admin-address privoxy-admin@example.com
 #
-#
 #  1.4. proxy-info-url
 #  ====================
 #
@@ -229,7 +225,6 @@
 #
 #proxy-info-url http://www.example.com/proxy-service.html
 #
-#
 #  2. CONFIGURATION AND LOG FILE LOCATIONS
 #  ========================================
 #
@@ -242,7 +237,6 @@
 #  be modified, such as log files and actions files.
 #
 #
-#
 #  2.1. confdir
 #  =============
 #
@@ -268,7 +262,6 @@
 #
 confdir .
 #
-#
 #  2.2. templdir
 #  ==============
 #
@@ -298,8 +291,37 @@ confdir .
 #
 #templdir .
 #
+#  2.3. 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.
 #
-#  2.3. logdir
+#  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 .
+#
+#  2.4. logdir
 #  ============
 #
 #  Specifies:
@@ -325,8 +347,7 @@ confdir .
 #
 logdir .
 #
-#
-#  2.4. actionsfile
+#  2.5. actionsfile
 #  =================
 #
 #  Specifies:
@@ -372,8 +393,7 @@ actionsfile match-all.action # Actions that are applied to all sites and maybe o
 actionsfile default.action   # Main actions file
 actionsfile user.action      # User customizations
 #
-#
-#  2.5. filterfile
+#  2.6. filterfile
 #  ================
 #
 #  Specifies:
@@ -418,8 +438,7 @@ actionsfile user.action      # User customizations
 filterfile default.filter
 filterfile user.filter      # User customizations
 #
-#
-#  2.6. logfile
+#  2.7. logfile
 #  =============
 #
 #  Specifies:
@@ -465,8 +484,7 @@ filterfile user.filter      # User customizations
 #
 logfile logfile
 #
-#
-#  2.7. trustfile
+#  2.8. trustfile
 #  ===============
 #
 #  Specifies:
@@ -522,7 +540,6 @@ logfile logfile
 #
 #trustfile trust
 #
-#
 #  3. DEBUGGING
 #  =============
 #
@@ -531,7 +548,6 @@ logfile logfile
 #  line option when debugging.
 #
 #
-#
 #  3.1. debug
 #  ===========
 #
@@ -607,7 +623,6 @@ logfile logfile
 #debug  4096 # Startup banner and warnings
 #debug  8192 # Non-fatal errors
 #
-#
 #  3.2. single-threaded
 #  =====================
 #
@@ -617,11 +632,11 @@ logfile logfile
 #
 #  Type of value:
 #
-#      None
+#      1 or 0
 #
 #  Default value:
 #
-#      Unset
+#      0
 #
 #  Effect if unset:
 #
@@ -633,8 +648,7 @@ logfile logfile
 #      This option is only there for debugging purposes. It will
 #      drastically reduce performance.
 #
-#single-threaded
-#
+#single-threaded 1
 #
 #  3.3. hostname
 #  ==============
@@ -671,7 +685,6 @@ logfile logfile
 #
 #hostname hostname.example.org
 #
-#
 #  4. ACCESS CONTROL AND SECURITY
 #  ===============================
 #
@@ -679,7 +692,6 @@ logfile logfile
 #  aspects of Privoxy's configuration.
 #
 #
-#
 #  4.1. listen-address
 #  ====================
 #
@@ -778,7 +790,6 @@ logfile logfile
 #
 listen-address  127.0.0.1:8118
 #
-#
 #  4.2. toggle
 #  ============
 #
@@ -807,7 +818,6 @@ listen-address  127.0.0.1:8118
 #
 toggle  1
 #
-#
 #  4.3. enable-remote-toggle
 #  ==========================
 #
@@ -850,7 +860,6 @@ toggle  1
 #
 enable-remote-toggle  0
 #
-#
 #  4.4. enable-remote-http-toggle
 #  ===============================
 #
@@ -889,7 +898,6 @@ enable-remote-toggle  0
 #
 enable-remote-http-toggle  0
 #
-#
 #  4.5. enable-edit-actions
 #  =========================
 #
@@ -930,7 +938,6 @@ enable-remote-http-toggle  0
 #
 enable-edit-actions 0
 #
-#
 #  4.6. enforce-blocks
 #  ====================
 #
@@ -979,7 +986,6 @@ enable-edit-actions 0
 #
 enforce-blocks 0
 #
-#
 #  4.7. ACLs: permit-access and deny-access
 #  =========================================
 #
@@ -1091,7 +1097,6 @@ enforce-blocks 0
 #        permit-access  [::ffff:192.0.2.0]/120
 #
 #
-#
 #  4.8. buffer-limit
 #  ==================
 #
@@ -1129,6 +1134,46 @@ enforce-blocks 0
 #
 buffer-limit 4096
 #
+#  4.9. enable-proxy-authentication-forwarding
+#  ============================================
+#
+#  Specifies:
+#
+#      Whether or not proxy authentication through Privoxy 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
 #
 #  5. FORWARDING
 #  ==============
@@ -1153,7 +1198,6 @@ buffer-limit 4096
 #  4 and SOCKS 4A protocols.
 #
 #
-#
 #  5.1. forward
 #  =============
 #
@@ -1221,7 +1265,6 @@ buffer-limit 4096
 #        forward  <[2-3][0-9a-f][0-9a-f][0-9a-f]:*>   .
 #
 #
-#
 #  5.2. forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
 #  =========================================================================
 #
@@ -1298,7 +1341,7 @@ buffer-limit 4096
 #      To chain Privoxy and Tor, both running on the same system, you
 #      would use something like:
 #
-#        forward-socks5   /               127.0.0.1:9050 .
+#        forward-socks5t   /               127.0.0.1:9050 .
 #
 #      The public Tor network can't be used to reach your local
 #      network, if you need to access local servers you therefore
@@ -1322,7 +1365,6 @@ buffer-limit 4096
 #       forward           localhost/     .
 #
 #
-#
 #  5.3. forwarded-connect-retries
 #  ===============================
 #
@@ -1371,11 +1413,9 @@ buffer-limit 4096
 #
 forwarded-connect-retries  0
 #
-#
 #  6. MISCELLANEOUS
 #  =================
 #
-#
 #  6.1. accept-intercepted-requests
 #  =================================
 #
@@ -1402,6 +1442,9 @@ forwarded-connect-retries  0
 #      Privoxy, enable this 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 Privoxy can't intentionally
 #      connect to itself, otherwise you could run into redirection
@@ -1414,7 +1457,6 @@ forwarded-connect-retries  0
 #
 accept-intercepted-requests 0
 #
-#
 #  6.2. allow-cgi-request-crunching
 #  =================================
 #
@@ -1452,7 +1494,6 @@ accept-intercepted-requests 0
 #
 allow-cgi-request-crunching 0
 #
-#
 #  6.3. split-large-forms
 #  =======================
 #
@@ -1495,7 +1536,6 @@ allow-cgi-request-crunching 0
 #
 split-large-forms 0
 #
-#
 #  6.4. keep-alive-timeout
 #  ========================
 #
@@ -1552,7 +1592,6 @@ split-large-forms 0
 #
 keep-alive-timeout 5
 #
-#
 #  6.5. tolerate-pipelining
 #  =========================
 #
@@ -1596,7 +1635,6 @@ keep-alive-timeout 5
 #
 tolerate-pipelining 1
 #
-#
 #  6.6. default-server-timeout
 #  ============================
 #
@@ -1648,7 +1686,6 @@ tolerate-pipelining 1
 #
 #default-server-timeout 60
 #
-#
 #  6.7. connection-sharing
 #  ========================
 #
@@ -1719,7 +1756,6 @@ tolerate-pipelining 1
 #
 #connection-sharing 1
 #
-#
 #  6.8. socket-timeout
 #  ====================
 #
@@ -1752,7 +1788,6 @@ tolerate-pipelining 1
 #
 socket-timeout 300
 #
-#
 #  6.9. max-client-connections
 #  ============================
 #
@@ -1766,7 +1801,7 @@ socket-timeout 300
 #
 #  Default value:
 #
-#      None
+#      128
 #
 #  Effect if unset:
 #
@@ -1802,13 +1837,21 @@ socket-timeout 300
 #      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 Privoxy 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 Privoxy with a
+#      different FD_SETSIZE limit.
+#
 #  Examples:
 #
 #      max-client-connections 256
 #
 #max-client-connections 256
 #
-#  1.6.10. handle-as-empty-doc-returns-ok
+#  6.10. handle-as-empty-doc-returns-ok
+#  =====================================
 #
 #  Specifies:
 #
@@ -1845,7 +1888,8 @@ socket-timeout 300
 #
 #handle-as-empty-doc-returns-ok 1
 #
-#  1.6.11. enable-compression
+#  6.11. enable-compression
+#  =========================
 #
 #  Specifies:
 #
@@ -1885,7 +1929,8 @@ socket-timeout 300
 #
 #enable-compression 1
 #
-#  1.6.12. compression-level
+#  6.12. compression-level
+#  ========================
 #
 #  Specifies:
 #
@@ -1930,7 +1975,8 @@ socket-timeout 300
 #
 #compression-level 1
 #
-#  1.6.13. client-header-order
+#  6.13. client-header-order
+#  ==========================
 #
 #  Specifies:
 #
@@ -1970,13 +2016,13 @@ socket-timeout 300
 #   Proxy-Connection \
 #   Referer \
 #   Cookie \
+#   DNT \
 #   If-Modified-Since \
 #   Cache-Control \
 #   Content-Length \
 #   Content-Type
 #
 #
-#
 #  7. WINDOWS GUI OPTIONS
 #  =======================
 #