Rebuild config file for 3.0.25

[privoxy.git] / config

diff --git a/config b/config
index 8d47eef..8403b70 100644 (file)
--- a/config
+++ b/config
@@ -1,25 +1,25 @@
 #        Sample Configuration File for Privoxy 3.0.25
 #
-#  $Id: config,v 1.109 2016/03/17 10:43:39 fabiankeil Exp $
-#
-#  Copyright (C) 2001-2016 Privoxy Developers http://www.privoxy.org/
-#
-####################################################################
-#                                                                  #
-#                      Table of Contents                           #
-#                                                                  #
-#        I. INTRODUCTION                                           #
-#       II. FORMAT OF THE CONFIGURATION FILE                       #
-#                                                                  #
-#        1. LOCAL SET-UP DOCUMENTATION                             #
-#        2. CONFIGURATION AND LOG FILE LOCATIONS                   #
-#        3. DEBUGGING                                              #
-#        4. ACCESS CONTROL AND SECURITY                            #
-#        5. FORWARDING                                             #
-#        6. MISCELLANEOUS                                          #
-#        7. WINDOWS GUI OPTIONS                                    #
-#                                                                  #
-####################################################################
+# $Id: p-config.sgml,v 2.121 2016/05/03 13:22:13 fabiankeil Exp $
+#
+# Copyright (C) 2001-2016 Privoxy Developers https://www.privoxy.org/
+#
+#####################################################################
+#                                                                   #
+#                      Table of Contents                            #
+#                                                                   #
+#        I. INTRODUCTION                                            #
+#       II. FORMAT OF THE CONFIGURATION FILE                        #
+#                                                                   #
+#        1. LOCAL SET-UP DOCUMENTATION                              #
+#        2. CONFIGURATION AND LOG FILE LOCATIONS                    #
+#        3. DEBUGGING                                               #
+#        4. ACCESS CONTROL AND SECURITY                             #
+#        5. FORWARDING                                              #
+#        6. MISCELLANEOUS                                           #
+#        7. WINDOWS GUI OPTIONS                                     #
+#                                                                   #
+#####################################################################
 #
 #
 #  I. INTRODUCTION
@@ -94,7 +94,7 @@
 #
 #  Effect if unset:
 #
-#      http://www.privoxy.org/version/user-manual/ will be used,
+#      https://www.privoxy.org/version/user-manual/ will be used,
 #      where version is the Privoxy version.
 #
 #  Notes:
@@ -128,7 +128,7 @@
 #          config file, because it is used while the config file is
 #          being read.
 #
-#user-manual http://www.privoxy.org/user-manual/
+#user-manual https://www.privoxy.org/user-manual/
 #
 #  1.2. trust-info-url
 #  ====================
@@ -1448,6 +1448,11 @@ forwarded-connect-retries  0
 #      loops if Privoxy's listening port is reachable by the outside
 #      or an attacker has access to the pages you visit.
 #
+#      If you are running Privoxy as intercepting proxy without being
+#      able to intercept all client requests you may want to adjust
+#      the CGI templates to make sure they don't reference content
+#      from config.privoxy.org.
+#
 #  Examples:
 #
 #      accept-intercepted-requests 1
@@ -2072,7 +2077,7 @@ socket-timeout 300
 #      requested again.
 #
 #      Clients can request tags to be set by using the CGI interface
-#      http://config.privoxy.org/show-client-tags. The specific tag
+#      http://config.privoxy.org/client-tags. The specific tag
 #      description is only used on the web page and should be phrased
 #      in away that the user understand the effect of the tag.
 #
@@ -2114,7 +2119,7 @@ socket-timeout 300
 #      to circumvent a block that is the result of an overly-broad
 #      URL pattern.
 #
-#      The CGI interface http://config.privoxy.org/show-client-tags
+#      The CGI interface http://config.privoxy.org/client-tags
 #      therefore provides a "enable this tag temporarily" option. If
 #      it is used, the tag will be set until the client-tag-lifetime
 #      is over.
@@ -2126,6 +2131,61 @@ socket-timeout 300
 #
 #
 #
+#  6.16. trust-x-forwarded-for
+#  ============================
+#
+#  Specifies:
+#
+#      Whether or not Privoxy should use IP addresses specified with
+#      the X-Forwarded-For header
+#
+#  Type of value:
+#
+#      0 or one
+#
+#  Default value:
+#
+#      0
+#
+#  Notes:
+#
+#      +-----------------------------------------------------+
+#      |                       Warning                       |
+#      |-----------------------------------------------------|
+#      |This is an experimental feature. The syntax is likely|
+#      |to change in future versions.                        |
+#      +-----------------------------------------------------+
+#
+#      If clients reach Privoxy through another proxy, for example a
+#      load balancer, Privoxy can't tell the client's IP address from
+#      the connection. If multiple clients use the same proxy, they
+#      will share the same client tag settings which is usually not
+#      desired.
+#
+#      This option lets Privoxy use the X-Forwarded-For header value
+#      as client IP address. If the proxy sets the header, multiple
+#      clients using the same proxy do not share the same client tag
+#      settings.
+#
+#      This option should only be enabled if Privoxy can only be
+#      reached through a proxy and if the proxy can be trusted to set
+#      the header correctly. It is recommended that ACL are used to
+#      make sure only trusted systems can reach Privoxy.
+#
+#      If access to Privoxy isn't limited to trusted systems, this
+#      option would allow malicious clients to change the client tags
+#      for other clients or increase Privoxy's memory requirements by
+#      registering lots of client tag settings for clients that don't
+#      exist.
+#
+#  Examples:
+#
+#            # Allow systems that can reach Privoxy to provide the client
+#            # IP address with a X-Forwarded-For header.
+#            trust-x-forwarded-for 1
+#
+#
+#
 #  7. WINDOWS GUI OPTIONS
 #  =======================
 #