fD-testbed: conf/mgr.testbeddomain/squid/squid.conf annotate

annotate conf/mgr.testbeddomain/squid/squid.conf @ 0:9e5a3c884de6

Initial import of the virtual testbed.

author	Sebastien Decugis <sdecugis@nict.go.jp>
date	Thu, 17 Jun 2010 11:00:32 +0900
parents
children

rev	line source
0 9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2 # WELCOME TO SQUID 2.7.STABLE3
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3 # ----------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	5 # This is the default Squid configuration file. You may wish
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	6 # to look at the Squid home page (http://www.squid-cache.org/)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	7 # for the FAQ and other documentation.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	8 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	9 # The default Squid config file shows what the defaults for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	10 # various options happen to be. If you don't need to change the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	11 # default, you shouldn't uncomment the line. Doing so may cause
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	12 # run-time problems. In some cases "none" refers to no default
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	13 # setting at all, while in other cases it refers to a valid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	14 # option - the comments for that keyword indicate if this is the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	15 # case.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	16 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	17
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	18
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	19 # Configuration options can be included using the "include" directive.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	20 # Include takes a list of files to include. Quoting and wildcards is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	21 # supported.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	22 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	23 # For example,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	24 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	25 # include /path/to/included/file/squid.acl.config
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	26 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	27 # Includes can be nested up to a hard-coded depth of 16 levels.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	28 # This arbitrary restriction is to prevent recursive include references
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	29 # from causing Squid entering an infinite loop whilst trying to load
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	30 # configuration files.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	31
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	32
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	33 # OPTIONS FOR AUTHENTICATION
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	34 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	35
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	36 # TAG: auth_param
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	37 # This is used to define parameters for the various authentication
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	38 # schemes supported by Squid.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	39 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	40 # format: auth_param scheme parameter [setting]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	41 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	42 # The order in which authentication schemes are presented to the client is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	43 # dependent on the order the scheme first appears in config file. IE
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	44 # has a bug (it's not RFC 2617 compliant) in that it will use the basic
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	45 # scheme if basic is the first entry presented, even if more secure
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	46 # schemes are presented. For now use the order in the recommended
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	47 # settings section below. If other browsers have difficulties (don't
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	48 # recognize the schemes offered even if you are using basic) either
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	49 # put basic first, or disable the other schemes (by commenting out their
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	50 # program entry).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	51 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	52 # Once an authentication scheme is fully configured, it can only be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	53 # shutdown by shutting squid down and restarting. Changes can be made on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	54 # the fly and activated with a reconfigure. I.E. You can change to a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	55 # different helper, but not unconfigure the helper completely.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	56 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	57 # Please note that while this directive defines how Squid processes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	58 # authentication it does not automatically activate authentication.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	59 # To use authentication you must in addition make use of ACLs based
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	60 # on login name in http_access (proxy_auth, proxy_auth_regex or
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	61 # external with %LOGIN used in the format tag). The browser will be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	62 # challenged for authentication on the first such acl encountered
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	63 # in http_access processing and will also be re-challenged for new
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	64 # login credentials if the request is being denied by a proxy_auth
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	65 # type acl.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	66 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	67 # WARNING: authentication can't be used in a transparently intercepting
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	68 # proxy as the client then thinks it is talking to an origin server and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	69 # not the proxy. This is a limitation of bending the TCP/IP protocol to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	70 # transparently intercepting port 80, not a limitation in Squid.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	71 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	72 # === Parameters for the basic scheme follow. ===
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	73 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	74 # "program" cmdline
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	75 # Specify the command for the external authenticator. Such a program
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	76 # reads a line containing "username password" and replies "OK" or
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	77 # "ERR" in an endless loop. "ERR" responses may optionally be followed
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	78 # by a error description available as %m in the returned error page.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	79 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	80 # By default, the basic authentication scheme is not used unless a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	81 # program is specified.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	82 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	83 # If you want to use the traditional proxy authentication, jump over to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	84 # the helpers/basic_auth/NCSA directory and type:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	85 # % make
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	86 # % make install
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	87 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	88 # Then, set this line to something like
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	89 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	90 # auth_param basic program /usr/lib/squid/ncsa_auth /usr/etc/passwd
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	91 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	92 # "children" numberofchildren
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	93 # The number of authenticator processes to spawn. If you start too few
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	94 # squid will have to wait for them to process a backlog of credential
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	95 # verifications, slowing it down. When credential verifications are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	96 # done via a (slow) network you are likely to need lots of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	97 # authenticator processes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	98 # auth_param basic children 5
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	99 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	100 # "concurrency" numberofconcurrentrequests
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	101 # The number of concurrent requests/channels the helper supports.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	102 # Changes the protocol used to include a channel number first on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	103 # the request/response line, allowing multiple requests to be sent
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	104 # to the same helper in parallell without wating for the response.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	105 # Must not be set unless it's known the helper supports this.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	106 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	107 # "realm" realmstring
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	108 # Specifies the realm name which is to be reported to the client for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	109 # the basic proxy authentication scheme (part of the text the user
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	110 # will see when prompted their username and password).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	111 # auth_param basic realm Squid proxy-caching web server
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	112 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	113 # "credentialsttl" timetolive
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	114 # Specifies how long squid assumes an externally validated
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	115 # username:password pair is valid for - in other words how often the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	116 # helper program is called for that user. Set this low to force
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	117 # revalidation with short lived passwords. Note that setting this high
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	118 # does not impact your susceptibility to replay attacks unless you are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	119 # using an one-time password system (such as SecureID). If you are using
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	120 # such a system, you will be vulnerable to replay attacks unless you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	121 # also use the max_user_ip ACL in an http_access rule.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	122 # auth_param basic credentialsttl 2 hours
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	123 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	124 # "casesensitive" on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	125 # Specifies if usernames are case sensitive. Most user databases are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	126 # case insensitive allowing the same username to be spelled using both
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	127 # lower and upper case letters, but some are case sensitive. This
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	128 # makes a big difference for user_max_ip ACL processing and similar.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	129 # auth_param basic casesensitive off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	130 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	131 # "blankpassword" on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	132 # Specifies if blank passwords should be supported. Defaults to off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	133 # as there is multiple authentication backends which handles blank
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	134 # passwords as "guest" access.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	135 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	136 # === Parameters for the digest scheme follow ===
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	137 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	138 # "program" cmdline
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	139 # Specify the command for the external authenticator. Such a program
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	140 # reads a line containing "username":"realm" and replies with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	141 # appropriate H(A1) value hex encoded or ERR if the user (or his H(A1)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	142 # hash) does not exists. See RFC 2616 for the definition of H(A1).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	143 # "ERR" responses may optionally be followed by a error description
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	144 # available as %m in the returned error page.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	145 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	146 # By default, the digest authentication scheme is not used unless a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	147 # program is specified.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	148 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	149 # If you want to use a digest authenticator, jump over to the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	150 # helpers/digest_auth/ directory and choose the authenticator to use.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	151 # It it's directory type
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	152 # % make
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	153 # % make install
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	154 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	155 # Then, set this line to something like
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	156 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	157 # auth_param digest program /usr/lib/squid/digest_auth_pw /usr/etc/digpass
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	158 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	159 # "children" numberofchildren
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	160 # The number of authenticator processes to spawn. If you start too few
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	161 # squid will have to wait for them to process a backlog of credential
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	162 # verifications, slowing it down. When credential verifications are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	163 # done via a (slow) network you are likely to need lots of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	164 # authenticator processes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	165 # auth_param digest children 5
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	166 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	167 # "concurrency" numberofconcurrentrequests
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	168 # The number of concurrent requests/channels the helper supports.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	169 # Changes the protocol used to include a channel number first on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	170 # the request/response line, allowing multiple requests to be sent
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	171 # to the same helper in parallell without wating for the response.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	172 # Must not be set unless it's known the helper supports this.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	173 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	174 # "realm" realmstring
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	175 # Specifies the realm name which is to be reported to the client for the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	176 # digest proxy authentication scheme (part of the text the user will see
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	177 # when prompted their username and password).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	178 # auth_param digest realm Squid proxy-caching web server
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	179 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	180 # "nonce_garbage_interval" timeinterval
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	181 # Specifies the interval that nonces that have been issued to clients are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	182 # checked for validity.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	183 # auth_param digest nonce_garbage_interval 5 minutes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	184 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	185 # "nonce_max_duration" timeinterval
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	186 # Specifies the maximum length of time a given nonce will be valid for.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	187 # auth_param digest nonce_max_duration 30 minutes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	188 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	189 # "nonce_max_count" number
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	190 # Specifies the maximum number of times a given nonce can be used.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	191 # auth_param digest nonce_max_count 50
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	192 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	193 # "nonce_strictness" on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	194 # Determines if squid requires strict increment-by-1 behavior for nonce
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	195 # counts, or just incrementing (off - for use when useragents generate
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	196 # nonce counts that occasionally miss 1 (ie, 1,2,4,6)).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	197 # auth_param digest nonce_strictness off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	198 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	199 # "check_nonce_count" on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	200 # This directive if set to off can disable the nonce count check
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	201 # completely to work around buggy digest qop implementations in certain
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	202 # mainstream browser versions. Default on to check the nonce count to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	203 # protect from authentication replay attacks.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	204 # auth_param digest check_nonce_count on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	205 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	206 # "post_workaround" on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	207 # This is a workaround to certain buggy browsers who sends an incorrect
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	208 # request digest in POST requests when reusing the same nonce as acquired
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	209 # earlier in response to a GET request.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	210 # auth_param digest post_workaround off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	211 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	212 # === NTLM scheme options follow ===
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	213 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	214 # "program" cmdline
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	215 # Specify the command for the external NTLM authenticator. Such a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	216 # program participates in the NTLMSSP exchanges between Squid and the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	217 # client and reads commands according to the Squid NTLMSSP helper
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	218 # protocol. See helpers/ntlm_auth/ for details. Recommended ntlm
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	219 # authenticator is ntlm_auth from Samba-3.X, but a number of other
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	220 # ntlm authenticators is available.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	221 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	222 # By default, the ntlm authentication scheme is not used unless a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	223 # program is specified.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	224 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	225 # auth_param ntlm program /usr/bin/ntlm_auth --helper-protocol=squid-2.5-ntlmssp
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	226 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	227 # "children" numberofchildren
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	228 # The number of authenticator processes to spawn. If you start too few
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	229 # squid will have to wait for them to process a backlog of credential
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	230 # verifications, slowing it down. When credential verifications are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	231 # done via a (slow) network you are likely to need lots of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	232 # authenticator processes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	233 # auth_param ntlm children 5
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	234 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	235 # "keep_alive" on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	236 # This option enables the use of keep-alive on the initial
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	237 # authentication request. It has been reported some versions of MSIE
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	238 # have problems if this is enabled, but performance will be increased
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	239 # if enabled.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	240 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	241 # auth_param ntlm keep_alive on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	242 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	243 # === Negotiate scheme options follow ===
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	244 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	245 # "program" cmdline
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	246 # Specify the command for the external Negotiate authenticator. Such a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	247 # program participates in the SPNEGO exchanges between Squid and the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	248 # client and reads commands according to the Squid ntlmssp helper
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	249 # protocol. See helpers/ntlm_auth/ for details. Recommended SPNEGO
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	250 # authenticator is ntlm_auth from Samba-4.X.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	251 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	252 # By default, the Negotiate authentication scheme is not used unless a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	253 # program is specified.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	254 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	255 # auth_param negotiate program /path/to/samba/bin/ntlm_auth --helper-protocol=gss-spnego
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	256 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	257 # "children" numberofchildren
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	258 # The number of authenticator processes to spawn. If you start too few
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	259 # squid will have to wait for them to process a backlog of credential
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	260 # verifications, slowing it down. When credential verifications are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	261 # done via a (slow) network you are likely to need lots of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	262 # authenticator processes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	263 # auth_param negotiate children 5
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	264 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	265 # "keep_alive" on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	266 # If you experience problems with PUT/POST requests when using the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	267 # Negotiate authentication scheme then you can try setting this to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	268 # off. This will cause Squid to forcibly close the connection on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	269 # the initial requests where the browser asks which schemes are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	270 # supported by the proxy.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	271 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	272 # auth_param negotiate keep_alive on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	273 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	274 #Recommended minimum configuration per scheme:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	275 #auth_param negotiate program <uncomment and complete this line to activate>
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	276 #auth_param negotiate children 5
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	277 #auth_param negotiate keep_alive on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	278 #auth_param ntlm program <uncomment and complete this line to activate>
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	279 #auth_param ntlm children 5
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	280 #auth_param ntlm keep_alive on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	281 #auth_param digest program <uncomment and complete this line>
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	282 #auth_param digest children 5
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	283 #auth_param digest realm Squid proxy-caching web server
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	284 #auth_param digest nonce_garbage_interval 5 minutes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	285 #auth_param digest nonce_max_duration 30 minutes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	286 #auth_param digest nonce_max_count 50
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	287 #auth_param basic program <uncomment and complete this line>
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	288 #auth_param basic children 5
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	289 #auth_param basic realm Squid proxy-caching web server
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	290 #auth_param basic credentialsttl 2 hours
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	291 #auth_param basic casesensitive off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	292
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	293 # TAG: authenticate_cache_garbage_interval
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	294 # The time period between garbage collection across the username cache.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	295 # This is a tradeoff between memory utilization (long intervals - say
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	296 # 2 days) and CPU (short intervals - say 1 minute). Only change if you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	297 # have good reason to.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	298 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	299 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	300 # authenticate_cache_garbage_interval 1 hour
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	301
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	302 # TAG: authenticate_ttl
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	303 # The time a user & their credentials stay in the logged in user cache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	304 # since their last request. When the garbage interval passes, all user
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	305 # credentials that have passed their TTL are removed from memory.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	306 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	307 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	308 # authenticate_ttl 1 hour
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	309
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	310 # TAG: authenticate_ip_ttl
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	311 # If you use proxy authentication and the 'max_user_ip' ACL, this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	312 # directive controls how long Squid remembers the IP addresses
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	313 # associated with each user. Use a small value (e.g., 60 seconds) if
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	314 # your users might change addresses quickly, as is the case with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	315 # dialups. You might be safe using a larger value (e.g., 2 hours) in a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	316 # corporate LAN environment with relatively static address assignments.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	317 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	318 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	319 # authenticate_ip_ttl 0 seconds
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	320
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	321 # TAG: authenticate_ip_shortcircuit_ttl
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	322 # Cache authentication credentials per client IP address for this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	323 # long. Default is 0 seconds (disabled).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	324 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	325 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	326 # authenticate_ip_shortcircuit_ttl 0 seconds
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	327
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	328
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	329 # ACCESS CONTROLS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	330 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	331
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	332 # TAG: external_acl_type
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	333 # This option defines external acl classes using a helper program to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	334 # look up the status
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	335 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	336 # external_acl_type name [options] FORMAT.. /path/to/helper [helper arguments..]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	337 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	338 # Options:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	339 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	340 # ttl=n TTL in seconds for cached results (defaults to 3600
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	341 # for 1 hour)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	342 # negative_ttl=n
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	343 # TTL for cached negative lookups (default same
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	344 # as ttl)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	345 # children=n number of processes spawn to service external acl
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	346 # lookups of this type. (default 5).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	347 # concurrency=n concurrency level per process. Only used with helpers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	348 # capable of processing more than one query at a time.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	349 # Note: see compatibility note below
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	350 # cache=n result cache size, 0 is unbounded (default)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	351 # grace= Percentage remaining of TTL where a refresh of a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	352 # cached entry should be initiated without needing to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	353 # wait for a new reply. (default 0 for no grace period)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	354 # protocol=2.5 Compatibility mode for Squid-2.5 external acl helpers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	355 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	356 # FORMAT specifications
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	357 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	358 # %LOGIN Authenticated user login name
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	359 # %EXT_USER Username from external acl
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	360 # %IDENT Ident user name
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	361 # %SRC Client IP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	362 # %SRCPORT Client source port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	363 # %URI Requested URI
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	364 # %DST Requested host
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	365 # %PROTO Requested protocol
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	366 # %PORT Requested port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	367 # %METHOD Request method
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	368 # %MYADDR Squid interface address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	369 # %MYPORT Squid http_port number
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	370 # %PATH Requested URL-path (including query-string if any)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	371 # %USER_CERT SSL User certificate in PEM format
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	372 # %USER_CERTCHAIN SSL User certificate chain in PEM format
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	373 # %USER_CERT_xx SSL User certificate subject attribute xx
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	374 # %USER_CA_xx SSL User certificate issuer attribute xx
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	375 # %{Header} HTTP request header
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	376 # %{Hdr:member} HTTP request header list member
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	377 # %{Hdr:;member}
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	378 # HTTP request header list member using ; as
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	379 # list separator. ; can be any non-alphanumeric
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	380 # character.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	381 # %ACL The ACL name
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	382 # %DATA The ACL arguments. If not used then any arguments
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	383 # is automatically added at the end
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	384 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	385 # In addition to the above, any string specified in the referencing
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	386 # acl will also be included in the helper request line, after the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	387 # specified formats (see the "acl external" directive)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	388 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	389 # The helper receives lines per the above format specification,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	390 # and returns lines starting with OK or ERR indicating the validity
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	391 # of the request and optionally followed by additional keywords with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	392 # more details.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	393 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	394 # General result syntax:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	395 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	396 # OK/ERR keyword=value ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	397 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	398 # Defined keywords:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	399 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	400 # user= The users name (login also understood)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	401 # password= The users password (for PROXYPASS login= cache_peer)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	402 # message= Error message or similar used as %o in error messages
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	403 # (error also understood)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	404 # log= String to be logged in access.log. Available as
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	405 # %ea in logformat specifications
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	406 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	407 # If protocol=3.0 (the default) then URL escaping is used to protect
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	408 # each value in both requests and responses.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	409 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	410 # If using protocol=2.5 then all values need to be enclosed in quotes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	411 # if they may contain whitespace, or the whitespace escaped using \.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	412 # And quotes or \ characters within the keyword value must be \ escaped.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	413 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	414 # When using the concurrency= option the protocol is changed by
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	415 # introducing a query channel tag infront of the request/response.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	416 # The query channel tag is a number between 0 and concurrency-1.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	417 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	418 # Compatibility Note: The children= option was named concurrency= in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	419 # Squid-2.5.STABLE3 and earlier, and was accepted as an alias for the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	420 # duration of the Squid-2.5 releases to keep compatibility. However,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	421 # the meaning of concurrency= option has changed in Squid-2.6 to match
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	422 # that of Squid-3 and the old syntax no longer works.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	423 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	424 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	425 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	426
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	427 # TAG: acl
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	428 # Defining an Access List
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	429 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	430 # Every access list definition must begin with an aclname and acltype,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	431 # followed by either type-specific arguments or a quoted filename that
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	432 # they are read from.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	433 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	434 # acl aclname acltype argument ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	435 # acl aclname acltype "file" ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	436 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	437 # when using "file", the file should contain one item per line.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	438 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	439 # By default, regular expressions are CASE-SENSITIVE. To make
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	440 # them case-insensitive, use the -i option.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	441 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	442 # acl aclname src ip-address/netmask ... (clients IP address)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	443 # acl aclname src addr1-addr2/netmask ... (range of addresses)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	444 # acl aclname dst ip-address/netmask ... (URL host's IP address)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	445 # acl aclname myip ip-address/netmask ... (local socket IP address)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	446 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	447 # acl aclname arp mac-address ... (xx:xx:xx:xx:xx:xx notation)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	448 # # The arp ACL requires the special configure option --enable-arp-acl.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	449 # # Furthermore, the arp ACL code is not portable to all operating systems.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	450 # # It works on Linux, Solaris, FreeBSD and some other *BSD variants.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	451 # #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	452 # # NOTE: Squid can only determine the MAC address for clients that are on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	453 # # the same subnet. If the client is on a different subnet, then Squid cannot
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	454 # # find out its MAC address.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	455 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	456 # acl aclname srcdomain .foo.com ... # reverse lookup, client IP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	457 # acl aclname dstdomain .foo.com ... # Destination server from URL
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	458 # acl aclname srcdom_regex [-i] xxx ... # regex matching client name
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	459 # acl aclname dstdom_regex [-i] xxx ... # regex matching server
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	460 # # For dstdomain and dstdom_regex a reverse lookup is tried if a IP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	461 # # based URL is used and no match is found. The name "none" is used
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	462 # # if the reverse lookup fails.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	463 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	464 # acl aclname time [day-abbrevs] [h1:m1-h2:m2]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	465 # # day-abbrevs:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	466 # # S - Sunday
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	467 # # M - Monday
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	468 # # T - Tuesday
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	469 # # W - Wednesday
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	470 # # H - Thursday
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	471 # # F - Friday
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	472 # # A - Saturday
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	473 # # h1:m1 must be less than h2:m2
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	474 # acl aclname url_regex [-i] ^http:// ... # regex matching on whole URL
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	475 # acl aclname urlpath_regex [-i] \.gif$ ... # regex matching on URL path
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	476 # acl aclname urllogin [-i] [^a-zA-Z0-9] ... # regex matching on URL login field
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	477 # acl aclname port 80 70 21 ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	478 # acl aclname port 0-1024 ... # ranges allowed
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	479 # acl aclname myport 3128 ... # (local socket TCP port)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	480 # acl aclname myportname 3128 ... # http(s)_port name
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	481 # acl aclname proto HTTP FTP ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	482 # acl aclname method GET POST ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	483 # acl aclname browser [-i] regexp ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	484 # # pattern match on User-Agent header (see also req_header below)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	485 # acl aclname referer_regex [-i] regexp ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	486 # # pattern match on Referer header
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	487 # # Referer is highly unreliable, so use with care
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	488 # acl aclname ident username ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	489 # acl aclname ident_regex [-i] pattern ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	490 # # string match on ident output.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	491 # # use REQUIRED to accept any non-null ident.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	492 # acl aclname src_as number ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	493 # acl aclname dst_as number ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	494 # # Except for access control, AS numbers can be used for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	495 # # routing of requests to specific caches. Here's an
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	496 # # example for routing all requests for AS#1241 and only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	497 # # those to mycache.mydomain.net:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	498 # # acl asexample dst_as 1241
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	499 # # cache_peer_access mycache.mydomain.net allow asexample
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	500 # # cache_peer_access mycache_mydomain.net deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	501 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	502 # acl aclname proxy_auth [-i] username ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	503 # acl aclname proxy_auth_regex [-i] pattern ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	504 # # list of valid usernames
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	505 # # use REQUIRED to accept any valid username.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	506 # #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	507 # # NOTE: when a Proxy-Authentication header is sent but it is not
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	508 # # needed during ACL checking the username is NOT logged
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	509 # # in access.log.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	510 # #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	511 # # NOTE: proxy_auth requires a EXTERNAL authentication program
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	512 # # to check username/password combinations (see
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	513 # # auth_param directive).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	514 # #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	515 # # NOTE: proxy_auth can't be used in a transparent proxy as
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	516 # # the browser needs to be configured for using a proxy in order
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	517 # # to respond to proxy authentication.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	518 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	519 # acl aclname snmp_community string ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	520 # # A community string to limit access to your SNMP Agent
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	521 # # Example:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	522 # #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	523 # # acl snmppublic snmp_community public
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	524 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	525 # acl aclname maxconn number
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	526 # # This will be matched when the client's IP address has
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	527 # # more than <number> HTTP connections established.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	528 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	529 # acl aclname max_user_ip [-s] number
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	530 # # This will be matched when the user attempts to log in from more
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	531 # # than <number> different ip addresses. The authenticate_ip_ttl
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	532 # # parameter controls the timeout on the ip entries.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	533 # # If -s is specified the limit is strict, denying browsing
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	534 # # from any further IP addresses until the ttl has expired. Without
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	535 # # -s Squid will just annoy the user by "randomly" denying requests.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	536 # # (the counter is reset each time the limit is reached and a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	537 # # request is denied)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	538 # # NOTE: in acceleration mode or where there is mesh of child proxies,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	539 # # clients may appear to come from multiple addresses if they are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	540 # # going through proxy farms, so a limit of 1 may cause user problems.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	541 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	542 # acl aclname req_mime_type mime-type ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	543 # # regex match against the mime type of the request generated
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	544 # # by the client. Can be used to detect file upload or some
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	545 # # types HTTP tunneling requests.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	546 # # NOTE: This does NOT match the reply. You cannot use this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	547 # # to match the returned file type.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	548 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	549 # acl aclname req_header header-name [-i] any\.regex\.here
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	550 # # regex match against any of the known request headers. May be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	551 # # thought of as a superset of "browser", "referer" and "mime-type"
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	552 # # ACLs.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	553 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	554 # acl aclname rep_mime_type mime-type ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	555 # # regex match against the mime type of the reply received by
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	556 # # squid. Can be used to detect file download or some
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	557 # # types HTTP tunneling requests.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	558 # # NOTE: This has no effect in http_access rules. It only has
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	559 # # effect in rules that affect the reply data stream such as
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	560 # # http_reply_access.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	561 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	562 # acl aclname rep_header header-name [-i] any\.regex\.here
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	563 # # regex match against any of the known reply headers. May be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	564 # # thought of as a superset of "browser", "referer" and "mime-type"
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	565 # # ACLs.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	566 # #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	567 # # Example:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	568 # #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	569 # # acl many_spaces rep_header Content-Disposition -i [[:space:]]{3,}
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	570 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	571 # acl aclname external class_name [arguments...]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	572 # # external ACL lookup via a helper class defined by the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	573 # # external_acl_type directive.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	574 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	575 # acl aclname urlgroup group1 ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	576 # # match against the urlgroup as indicated by redirectors
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	577 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	578 # acl aclname user_cert attribute values...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	579 # # match against attributes in a user SSL certificate
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	580 # # attribute is one of DN/C/O/CN/L/ST
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	581 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	582 # acl aclname ca_cert attribute values...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	583 # # match against attributes a users issuing CA SSL certificate
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	584 # # attribute is one of DN/C/O/CN/L/ST
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	585 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	586 # acl aclname ext_user username ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	587 # acl aclname ext_user_regex [-i] pattern ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	588 # # string match on username returned by external acl helper
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	589 # # use REQUIRED to accept any non-null user name.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	590 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	591 #Examples:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	592 #acl macaddress arp 09:00:2b:23:45:67
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	593 #acl myexample dst_as 1241
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	594 #acl password proxy_auth REQUIRED
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	595 #acl fileupload req_mime_type -i ^multipart/form-data$
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	596 #acl javascript rep_mime_type -i ^application/x-javascript$
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	597 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	598 #Recommended minimum configuration:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	599 acl all src all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	600 acl manager proto cache_object
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	601 acl localhost src 127.0.0.1/32
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	602 acl to_localhost dst 127.0.0.0/8
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	603 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	604 # Example rule allowing access from your local networks.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	605 # Adapt to list your (internal) IP networks from where browsing
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	606 # should be allowed
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	607 acl localnet src 10.0.0.0/8 # RFC1918 possible internal network
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	608 acl localnet src 172.16.0.0/12 # RFC1918 possible internal network
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	609 acl localnet src 192.168.0.0/16 # RFC1918 possible internal network
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	610 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	611 acl SSL_ports port 443 # https
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	612 acl SSL_ports port 563 # snews
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	613 acl SSL_ports port 873 # rsync
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	614 acl Safe_ports port 80 # http
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	615 acl Safe_ports port 21 # ftp
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	616 acl Safe_ports port 443 # https
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	617 acl Safe_ports port 70 # gopher
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	618 acl Safe_ports port 210 # wais
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	619 acl Safe_ports port 1025-65535 # unregistered ports
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	620 acl Safe_ports port 280 # http-mgmt
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	621 acl Safe_ports port 488 # gss-http
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	622 acl Safe_ports port 591 # filemaker
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	623 acl Safe_ports port 777 # multiling http
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	624 acl Safe_ports port 631 # cups
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	625 acl Safe_ports port 873 # rsync
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	626 acl Safe_ports port 901 # SWAT
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	627 acl purge method PURGE
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	628 acl CONNECT method CONNECT
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	629
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	630 # TAG: http_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	631 # Allowing or Denying access based on defined access lists
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	632 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	633 # Access to the HTTP port:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	634 # http_access allow\|deny [!]aclname ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	635 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	636 # NOTE on default values:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	637 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	638 # If there are no "access" lines present, the default is to deny
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	639 # the request.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	640 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	641 # If none of the "access" lines cause a match, the default is the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	642 # opposite of the last line in the list. If the last line was
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	643 # deny, the default is allow. Conversely, if the last line
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	644 # is allow, the default will be deny. For these reasons, it is a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	645 # good idea to have an "deny all" or "allow all" entry at the end
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	646 # of your access lists to avoid potential confusion.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	647 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	648 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	649 # http_access deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	650 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	651 #Recommended minimum configuration:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	652 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	653 # Only allow cachemgr access from localhost
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	654 http_access allow manager localhost
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	655 http_access deny manager
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	656 # Only allow purge requests from localhost
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	657 http_access allow purge localhost
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	658 http_access deny purge
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	659 # Deny requests to unknown ports
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	660 http_access deny !Safe_ports
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	661 # Deny CONNECT to other than SSL ports
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	662 http_access deny CONNECT !SSL_ports
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	663 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	664 # We strongly recommend the following be uncommented to protect innocent
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	665 # web applications running on the proxy server who think the only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	666 # one who can access services on "localhost" is a local user
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	667 #http_access deny to_localhost
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	668 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	669 # INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	670
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	671 # Example rule allowing access from your local networks.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	672 # Adapt localnet in the ACL section to list your (internal) IP networks
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	673 # from where browsing should be allowed
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	674 http_access allow localnet
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	675 http_access allow localhost
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	676
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	677 # And finally deny all other access to this proxy
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	678 http_access deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	679
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	680 # TAG: http_access2
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	681 # Allowing or Denying access based on defined access lists
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	682 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	683 # Identical to http_access, but runs after redirectors. If not set
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	684 # then only http_access is used.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	685 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	686 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	687 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	688
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	689 # TAG: http_reply_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	690 # Allow replies to client requests. This is complementary to http_access.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	691 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	692 # http_reply_access allow\|deny [!] aclname ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	693 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	694 # NOTE: if there are no access lines present, the default is to allow
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	695 # all replies
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	696 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	697 # If none of the access lines cause a match the opposite of the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	698 # last line will apply. Thus it is good practice to end the rules
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	699 # with an "allow all" or "deny all" entry.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	700 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	701 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	702 # http_reply_access allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	703
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	704 # TAG: icp_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	705 # Allowing or Denying access to the ICP port based on defined
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	706 # access lists
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	707 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	708 # icp_access allow\|deny [!]aclname ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	709 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	710 # See http_access for details
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	711 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	712 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	713 # icp_access deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	714 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	715 #Allow ICP queries from local networks only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	716 icp_access allow localnet
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	717 icp_access deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	718
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	719 # TAG: htcp_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	720 # Allowing or Denying access to the HTCP port based on defined
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	721 # access lists
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	722 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	723 # htcp_access allow\|deny [!]aclname ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	724 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	725 # See http_access for details
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	726 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	727 # NOTE: The default if no htcp_access lines are present is to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	728 # deny all traffic. This default may cause problems with peers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	729 # using the htcp or htcp-oldsquid options.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	730 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	731 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	732 # htcp_access deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	733 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	734 #Allow HTCP queries from local networks only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	735 # htcp_access allow localnet
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	736 # htcp_access deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	737
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	738 # TAG: htcp_clr_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	739 # Allowing or Denying access to purge content using HTCP based
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	740 # on defined access lists
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	741 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	742 # htcp_clr_access allow\|deny [!]aclname ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	743 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	744 # See http_access for details
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	745 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	746 ##Allow HTCP CLR requests from trusted peers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	747 #acl htcp_clr_peer src 172.16.1.2
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	748 #htcp_clr_access allow htcp_clr_peer
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	749 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	750 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	751 # htcp_clr_access deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	752
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	753 # TAG: miss_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	754 # Use to force your neighbors to use you as a sibling instead of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	755 # a parent. For example:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	756 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	757 # acl localclients src 172.16.0.0/16
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	758 # miss_access allow localclients
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	759 # miss_access deny !localclients
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	760 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	761 # This means only your local clients are allowed to fetch
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	762 # MISSES and all other clients can only fetch HITS.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	763 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	764 # By default, allow all clients who passed the http_access rules
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	765 # to fetch MISSES from us.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	766 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	767 #Default setting:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	768 # miss_access allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	769
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	770 # TAG: ident_lookup_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	771 # A list of ACL elements which, if matched, cause an ident
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	772 # (RFC931) lookup to be performed for this request. For
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	773 # example, you might choose to always perform ident lookups
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	774 # for your main multi-user Unix boxes, but not for your Macs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	775 # and PCs. By default, ident lookups are not performed for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	776 # any requests.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	777 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	778 # To enable ident lookups for specific client addresses, you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	779 # can follow this example:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	780 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	781 # acl ident_aware_hosts src 198.168.1.0/255.255.255.0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	782 # ident_lookup_access allow ident_aware_hosts
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	783 # ident_lookup_access deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	784 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	785 # Only src type ACL checks are fully supported. A src_domain
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	786 # ACL might work at times, but it will not always provide
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	787 # the correct result.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	788 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	789 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	790 # ident_lookup_access deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	791
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	792 # TAG: reply_body_max_size bytes allow\|deny acl acl...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	793 # This option specifies the maximum size of a reply body in bytes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	794 # It can be used to prevent users from downloading very large files,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	795 # such as MP3's and movies. When the reply headers are received,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	796 # the reply_body_max_size lines are processed, and the first line with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	797 # a result of "allow" is used as the maximum body size for this reply.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	798 # This size is checked twice. First when we get the reply headers,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	799 # we check the content-length value. If the content length value exists
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	800 # and is larger than the allowed size, the request is denied and the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	801 # user receives an error message that says "the request or reply
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	802 # is too large." If there is no content-length, and the reply
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	803 # size exceeds this limit, the client's connection is just closed
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	804 # and they will receive a partial reply.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	805 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	806 # WARNING: downstream caches probably can not detect a partial reply
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	807 # if there is no content-length header, so they will cache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	808 # partial responses and give them out as hits. You should NOT
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	809 # use this option if you have downstream caches.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	810 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	811 # If you set this parameter to zero (the default), there will be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	812 # no limit imposed.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	813 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	814 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	815 # reply_body_max_size 0 allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	816
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	817 # TAG: authenticate_ip_shortcircuit_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	818 # Access list determining when shortcicuiting the authentication process
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	819 # based on source IP cached credentials is acceptable. Use this to deny
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	820 # using the ip auth cache on requests from child proxies or other source
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	821 # ip's having multiple users.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	822 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	823 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	824 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	825
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	826
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	827 # OPTIONS FOR X-Forwarded-For
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	828 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	829
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	830 # TAG: follow_x_forwarded_for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	831 # Allowing or Denying the X-Forwarded-For header to be followed to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	832 # find the original source of a request.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	833 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	834 # Requests may pass through a chain of several other proxies
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	835 # before reaching us. The X-Forwarded-For header will contain a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	836 # comma-separated list of the IP addresses in the chain, with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	837 # rightmost address being the most recent.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	838 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	839 # If a request reaches us from a source that is allowed by this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	840 # configuration item, then we consult the X-Forwarded-For header
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	841 # to see where that host received the request from. If the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	842 # X-Forwarded-For header contains multiple addresses, and if
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	843 # acl_uses_indirect_client is on, then we continue backtracking
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	844 # until we reach an address for which we are not allowed to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	845 # follow the X-Forwarded-For header, or until we reach the first
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	846 # address in the list. (If acl_uses_indirect_client is off, then
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	847 # it's impossible to backtrack through more than one level of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	848 # X-Forwarded-For addresses.)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	849 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	850 # The end result of this process is an IP address that we will
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	851 # refer to as the indirect client address. This address may
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	852 # be treated as the client address for access control, delay
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	853 # pools and logging, depending on the acl_uses_indirect_client,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	854 # delay_pool_uses_indirect_client and log_uses_indirect_client
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	855 # options.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	856 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	857 # SECURITY CONSIDERATIONS:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	858 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	859 # Any host for which we follow the X-Forwarded-For header
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	860 # can place incorrect information in the header, and Squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	861 # will use the incorrect information as if it were the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	862 # source address of the request. This may enable remote
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	863 # hosts to bypass any access control restrictions that are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	864 # based on the client's source addresses.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	865 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	866 # For example:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	867 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	868 # acl localhost src 127.0.0.1
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	869 # acl my_other_proxy srcdomain .proxy.example.com
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	870 # follow_x_forwarded_for allow localhost
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	871 # follow_x_forwarded_for allow my_other_proxy
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	872 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	873 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	874 # follow_x_forwarded_for deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	875
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	876 # TAG: acl_uses_indirect_client on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	877 # Controls whether the indirect client address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	878 # (see follow_x_forwarded_for) is used instead of the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	879 # direct client address in acl matching.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	880 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	881 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	882 # acl_uses_indirect_client on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	883
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	884 # TAG: delay_pool_uses_indirect_client on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	885 # Controls whether the indirect client address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	886 # (see follow_x_forwarded_for) is used instead of the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	887 # direct client address in delay pools.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	888 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	889 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	890 # delay_pool_uses_indirect_client on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	891
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	892 # TAG: log_uses_indirect_client on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	893 # Controls whether the indirect client address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	894 # (see follow_x_forwarded_for) is used instead of the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	895 # direct client address in the access log.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	896 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	897 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	898 # log_uses_indirect_client on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	899
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	900
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	901 # SSL OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	902 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	903
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	904 # TAG: ssl_unclean_shutdown
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	905 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	906 # --enable-ssl option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	907 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	908 # Some browsers (especially MSIE) bugs out on SSL shutdown
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	909 # messages.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	910 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	911 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	912 # ssl_unclean_shutdown off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	913
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	914 # TAG: ssl_engine
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	915 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	916 # --enable-ssl option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	917 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	918 # The OpenSSL engine to use. You will need to set this if you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	919 # would like to use hardware SSL acceleration for example.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	920 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	921 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	922 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	923
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	924 # TAG: sslproxy_client_certificate
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	925 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	926 # --enable-ssl option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	927 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	928 # Client SSL Certificate to use when proxying https:// URLs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	929 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	930 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	931 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	932
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	933 # TAG: sslproxy_client_key
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	934 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	935 # --enable-ssl option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	936 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	937 # Client SSL Key to use when proxying https:// URLs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	938 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	939 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	940 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	941
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	942 # TAG: sslproxy_version
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	943 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	944 # --enable-ssl option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	945 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	946 # SSL version level to use when proxying https:// URLs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	947 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	948 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	949 # sslproxy_version 1
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	950
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	951 # TAG: sslproxy_options
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	952 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	953 # --enable-ssl option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	954 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	955 # SSL engine options to use when proxying https:// URLs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	956 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	957 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	958 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	959
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	960 # TAG: sslproxy_cipher
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	961 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	962 # --enable-ssl option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	963 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	964 # SSL cipher list to use when proxying https:// URLs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	965 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	966 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	967 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	968
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	969 # TAG: sslproxy_cafile
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	970 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	971 # --enable-ssl option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	972 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	973 # file containing CA certificates to use when verifying server
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	974 # certificates while proxying https:// URLs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	975 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	976 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	977 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	978
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	979 # TAG: sslproxy_capath
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	980 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	981 # --enable-ssl option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	982 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	983 # directory containing CA certificates to use when verifying
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	984 # server certificates while proxying https:// URLs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	985 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	986 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	987 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	988
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	989 # TAG: sslproxy_flags
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	990 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	991 # --enable-ssl option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	992 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	993 # Various flags modifying the use of SSL while proxying https:// URLs:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	994 # DONT_VERIFY_PEER Accept certificates even if they fail to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	995 # verify.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	996 # NO_DEFAULT_CA Don't use the default CA list built in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	997 # to OpenSSL.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	998 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	999 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1000 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1001
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1002 # TAG: sslpassword_program
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1003 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1004 # --enable-ssl option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1005 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1006 # Specify a program used for entering SSL key passphrases
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1007 # when using encrypted SSL certificate keys. If not specified
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1008 # keys must either be unencrypted, or Squid started with the -N
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1009 # option to allow it to query interactively for the passphrase.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1010 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1011 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1012 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1013
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1014
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1015 # NETWORK OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1016 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1017
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1018 # TAG: http_port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1019 # Usage: port [options]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1020 # hostname:port [options]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1021 # 1.2.3.4:port [options]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1022 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1023 # The socket addresses where Squid will listen for HTTP client
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1024 # requests. You may specify multiple socket addresses.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1025 # There are three forms: port alone, hostname with port, and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1026 # IP address with port. If you specify a hostname or IP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1027 # address, Squid binds the socket to that specific
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1028 # address. This replaces the old 'tcp_incoming_address'
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1029 # option. Most likely, you do not need to bind to a specific
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1030 # address, so you can use the port number alone.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1031 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1032 # If you are running Squid in accelerator mode, you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1033 # probably want to listen on port 80 also, or instead.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1034 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1035 # The -I command line option will override the first port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1036 # specified here.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1037 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1038 # You may specify multiple socket addresses on multiple lines.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1039 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1040 # Options:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1041 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1042 # transparent Support for transparent interception of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1043 # outgoing requests without browser settings.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1044 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1045 # tproxy Support Linux TPROXY for spoofing outgoing
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1046 # connections using the client IP address.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1047 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1048 # accel Accelerator mode. See also the related vhost,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1049 # vport and defaultsite directives.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1050 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1051 # defaultsite=domainname
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1052 # What to use for the Host: header if it is not present
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1053 # in a request. Determines what site (not origin server)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1054 # accelerators should consider the default.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1055 # Defaults to visible_hostname:port if not set
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1056 # May be combined with vport=NN to override the port number.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1057 # Implies accel.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1058 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1059 # vhost Accelerator mode using Host header for virtual
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1060 # domain support. Implies accel.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1061 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1062 # vport Accelerator with IP based virtual host support.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1063 # Implies accel.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1064 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1065 # vport=NN As above, but uses specified port number rather
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1066 # than the http_port number. Implies accel.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1067 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1068 # allow-direct Allow direct forwarding in accelerator mode. Normally
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1069 # accelerated requests is denied direct forwarding as it
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1070 # never_direct was used.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1071 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1072 # urlgroup= Default urlgroup to mark requests with (see
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1073 # also acl urlgroup and url_rewrite_program)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1074 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1075 # protocol= Protocol to reconstruct accelerated requests with.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1076 # Defaults to http.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1077 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1078 # no-connection-auth
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1079 # Prevent forwarding of Microsoft connection oriented
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1080 # authentication (NTLM, Negotiate and Kerberos)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1081 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1082 # act-as-origin
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1083 # Act is if this Squid is the origin server.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1084 # This currently means generate own Date: and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1085 # Expires: headers. Implies accel.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1086 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1087 # http11 Enables HTTP/1.1 support to clients. The HTTP/1.1
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1088 # support is still incomplete with an internal HTTP/1.0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1089 # hop, but should work with most clients. The main
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1090 # HTTP/1.1 features missing due to this is forwarding
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1091 # of requests using chunked transfer encoding (results
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1092 # in 411) and forwarding of 1xx responses (silently
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1093 # dropped)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1094 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1095 # name= Specifies a internal name for the port. Defaults to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1096 # the port specification (port or addr:port)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1097 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1098 # keepalive[=idle,interval,timeout]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1099 # Enable TCP keepalive probes of idle connections
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1100 # idle is the initial time before TCP starts probing
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1101 # the connection, interval how often to probe, and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1102 # timeout the time before giving up.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1103 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1104 # If you run Squid on a dual-homed machine with an internal
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1105 # and an external interface we recommend you to specify the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1106 # internal address:port in http_port. This way Squid will only be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1107 # visible on the internal address.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1108 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1109 # Squid normally listens to port 3128
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1110 http_port 3128
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1111
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1112 # TAG: https_port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1113 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1114 # --enable-ssl option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1115 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1116 # Usage: [ip:]port cert=certificate.pem [key=key.pem] [options...]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1117 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1118 # The socket address where Squid will listen for HTTPS client
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1119 # requests.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1120 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1121 # This is really only useful for situations where you are running
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1122 # squid in accelerator mode and you want to do the SSL work at the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1123 # accelerator level.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1124 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1125 # You may specify multiple socket addresses on multiple lines,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1126 # each with their own SSL certificate and/or options.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1127 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1128 # Options:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1129 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1130 # In addition to the options specified for http_port the folling
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1131 # SSL related options is supported:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1132 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1133 # cert= Path to SSL certificate (PEM format).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1134 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1135 # key= Path to SSL private key file (PEM format)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1136 # if not specified, the certificate file is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1137 # assumed to be a combined certificate and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1138 # key file.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1139 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1140 # version= The version of SSL/TLS supported
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1141 # 1 automatic (default)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1142 # 2 SSLv2 only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1143 # 3 SSLv3 only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1144 # 4 TLSv1 only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1145 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1146 # cipher= Colon separated list of supported ciphers.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1147 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1148 # options= Various SSL engine options. The most important
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1149 # being:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1150 # NO_SSLv2 Disallow the use of SSLv2
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1151 # NO_SSLv3 Disallow the use of SSLv3
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1152 # NO_TLSv1 Disallow the use of TLSv1
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1153 # SINGLE_DH_USE Always create a new key when using
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1154 # temporary/ephemeral DH key exchanges
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1155 # See src/ssl_support.c or OpenSSL SSL_CTX_set_options
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1156 # documentation for a complete list of options.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1157 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1158 # clientca= File containing the list of CAs to use when
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1159 # requesting a client certificate.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1160 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1161 # cafile= File containing additional CA certificates to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1162 # use when verifying client certificates. If unset
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1163 # clientca will be used.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1164 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1165 # capath= Directory containing additional CA certificates
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1166 # and CRL lists to use when verifying client certificates.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1167 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1168 # crlfile= File of additional CRL lists to use when verifying
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1169 # the client certificate, in addition to CRLs stored in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1170 # the capath. Implies VERIFY_CRL flag below.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1171 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1172 # dhparams= File containing DH parameters for temporary/ephemeral
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1173 # DH key exchanges.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1174 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1175 # sslflags= Various flags modifying the use of SSL:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1176 # DELAYED_AUTH
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1177 # Don't request client certificates
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1178 # immediately, but wait until acl processing
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1179 # requires a certificate (not yet implemented).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1180 # NO_DEFAULT_CA
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1181 # Don't use the default CA lists built in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1182 # to OpenSSL.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1183 # NO_SESSION_REUSE
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1184 # Don't allow for session reuse. Each connection
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1185 # will result in a new SSL session.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1186 # VERIFY_CRL
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1187 # Verify CRL lists when accepting client
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1188 # certificates.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1189 # VERIFY_CRL_ALL
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1190 # Verify CRL lists for all certificates in the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1191 # client certificate chain.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1192 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1193 # sslcontext= SSL session ID context identifier.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1194 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1195 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1196 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1197 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1198
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1199 # TAG: tcp_outgoing_tos
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1200 # Allows you to select a TOS/Diffserv value to mark outgoing
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1201 # connections with, based on the username or source address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1202 # making the request.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1203 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1204 # tcp_outgoing_tos ds-field [!]aclname ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1205 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1206 # Example where normal_service_net uses the TOS value 0x00
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1207 # and good_service_net uses 0x20
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1208 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1209 # acl normal_service_net src 10.0.0.0/255.255.255.0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1210 # acl good_service_net src 10.0.1.0/255.255.255.0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1211 # tcp_outgoing_tos 0x00 normal_service_net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1212 # tcp_outgoing_tos 0x20 good_service_net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1213 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1214 # TOS/DSCP values really only have local significance - so you should
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1215 # know what you're specifying. For more information, see RFC2474 and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1216 # RFC3260.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1217 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1218 # The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1219 # "default" to use whatever default your host has. Note that in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1220 # practice often only values 0 - 63 is usable as the two highest bits
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1221 # have been redefined for use by ECN (RFC3168).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1222 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1223 # Processing proceeds in the order specified, and stops at first fully
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1224 # matching line.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1225 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1226 # Note: The use of this directive using client dependent ACLs is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1227 # incompatible with the use of server side persistent connections. To
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1228 # ensure correct results it is best to set server_persisten_connections
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1229 # to off when using this directive in such configurations.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1230 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1231 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1232 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1233
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1234 # TAG: tcp_outgoing_address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1235 # Allows you to map requests to different outgoing IP addresses
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1236 # based on the username or source address of the user making
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1237 # the request.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1238 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1239 # tcp_outgoing_address ipaddr [[!]aclname] ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1240 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1241 # Example where requests from 10.0.0.0/24 will be forwarded
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1242 # with source address 10.1.0.1, 10.0.2.0/24 forwarded with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1243 # source address 10.1.0.2 and the rest will be forwarded with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1244 # source address 10.1.0.3.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1245 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1246 # acl normal_service_net src 10.0.0.0/24
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1247 # acl good_service_net src 10.0.1.0/24 10.0.2.0/24
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1248 # tcp_outgoing_address 10.1.0.1 normal_service_net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1249 # tcp_outgoing_address 10.1.0.2 good_service_net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1250 # tcp_outgoing_address 10.1.0.3
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1251 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1252 # Processing proceeds in the order specified, and stops at first fully
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1253 # matching line.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1254 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1255 # Note: The use of this directive using client dependent ACLs is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1256 # incompatible with the use of server side persistent connections. To
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1257 # ensure correct results it is best to set server_persistent_connections
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1258 # to off when using this directive in such configurations.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1259 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1260 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1261 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1262
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1263 # TAG: zph_mode
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1264 # This option enables packet level marking of HIT/MISS responses,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1265 # either using IP TOS or socket priority.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1266 # off Feature disabled
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1267 # tos Set the IP TOS field
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1268 # priority Set the socket priority (may get mapped to TOS by OS,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1269 # otherwise only usable in local rulesets)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1270 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1271 # See also tcp_outgoing_tos for details/requirements about TOS usage.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1272 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1273 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1274 # zph_mode off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1275
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1276 # TAG: zph_local
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1277 # Allows you to select a TOS/Diffserv/Priority value to mark local hits.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1278 # Default: 0 (disabled).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1279 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1280 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1281 # zph_local 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1282
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1283 # TAG: zph_sibling
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1284 # Allows you to select a TOS/Diffserv/Priority value to mark sibling hits.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1285 # Default: 0 (disabled).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1286 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1287 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1288 # zph_sibling 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1289
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1290 # TAG: zph_parent
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1291 # Allows you to select a TOS/Diffserv/Priority value to mark parent hits.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1292 # Default: 0 (disabled).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1293 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1294 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1295 # zph_parent 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1296
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1297 # TAG: zph_option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1298 # The IP option to use when zph_mode is set to "option". Defaults to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1299 # 136 which is officially registered as "SATNET Stream ID".
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1300 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1301 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1302 # zph_option 136
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1303
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1304
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1305 # OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1306 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1307 cache_peer morbier parent 3128 3130 default
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1308
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1309 # TAG: cache_peer
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1310 # To specify other caches in a hierarchy, use the format:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1311 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1312 # cache_peer hostname type http-port icp-port [options]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1313 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1314 # For example,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1315 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1316 # # proxy icp
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1317 # # hostname type port port options
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1318 # # -------------------- -------- ----- ----- -----------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1319 # cache_peer parent.foo.net parent 3128 3130 proxy-only default
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1320 # cache_peer sib1.foo.net sibling 3128 3130 proxy-only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1321 # cache_peer sib2.foo.net sibling 3128 3130 proxy-only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1322 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1323 # type: either 'parent', 'sibling', or 'multicast'.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1324 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1325 # proxy-port: The port number where the cache listens for proxy
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1326 # requests.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1327 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1328 # icp-port: Used for querying neighbor caches about
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1329 # objects. To have a non-ICP neighbor
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1330 # specify '7' for the ICP port and make sure the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1331 # neighbor machine has the UDP echo port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1332 # enabled in its /etc/inetd.conf file.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1333 # NOTE: Also requires icp_port option enabled to send/receive
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1334 # requests via this method.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1335 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1336 # options: proxy-only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1337 # weight=n
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1338 # ttl=n
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1339 # no-query
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1340 # default
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1341 # round-robin
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1342 # carp
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1343 # multicast-responder
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1344 # multicast-siblings
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1345 # closest-only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1346 # no-digest
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1347 # no-netdb-exchange
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1348 # no-delay
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1349 # login=user:password \| PASS \| *:password
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1350 # connect-timeout=nn
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1351 # digest-url=url
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1352 # allow-miss
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1353 # max-conn=n
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1354 # htcp
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1355 # htcp-oldsquid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1356 # originserver
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1357 # userhash
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1358 # sourcehash
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1359 # name=xxx
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1360 # monitorurl=url
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1361 # monitorsize=sizespec
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1362 # monitorinterval=seconds
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1363 # monitortimeout=seconds
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1364 # forceddomain=name
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1365 # ssl
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1366 # sslcert=/path/to/ssl/certificate
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1367 # sslkey=/path/to/ssl/key
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1368 # sslversion=1\|2\|3\|4
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1369 # sslcipher=...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1370 # ssloptions=...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1371 # front-end-https[=on\|auto]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1372 # connection-auth[=on\|off\|auto]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1373 # idle=n
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1374 # http11
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1375 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1376 # use 'proxy-only' to specify objects fetched
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1377 # from this cache should not be saved locally.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1378 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1379 # use 'weight=n' to affect the selection of a peer
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1380 # during any weighted peer-selection mechanisms.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1381 # The weight must be an integer; default is 1,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1382 # larger weights are favored more.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1383 # This option does not affect parent selection if a peering
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1384 # protocol is not in use.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1385 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1386 # use 'ttl=n' to specify a IP multicast TTL to use
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1387 # when sending an ICP queries to this address.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1388 # Only useful when sending to a multicast group.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1389 # Because we don't accept ICP replies from random
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1390 # hosts, you must configure other group members as
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1391 # peers with the 'multicast-responder' option below.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1392 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1393 # use 'no-query' to NOT send ICP queries to this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1394 # neighbor.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1395 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1396 # use 'default' if this is a parent cache which can
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1397 # be used as a "last-resort" if a peer cannot be located
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1398 # by any of the peer-selection mechanisms.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1399 # If specified more than once, only the first is used.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1400 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1401 # use 'round-robin' to define a set of parents which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1402 # should be used in a round-robin fashion in the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1403 # absence of any ICP queries.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1404 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1405 # use 'carp' to define a set of parents which should
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1406 # be used as a CARP array. The requests will be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1407 # distributed among the parents based on the CARP load
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1408 # balancing hash function based on their weight.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1409 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1410 # 'multicast-responder' indicates the named peer
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1411 # is a member of a multicast group. ICP queries will
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1412 # not be sent directly to the peer, but ICP replies
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1413 # will be accepted from it.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1414 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1415 # the 'multicast-siblings' option is meant to be used
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1416 # only for cache peers of type "multicast". It instructs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1417 # Squid that ALL members of this multicast group have
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1418 # "sibling" relationship with it, not "parent". This is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1419 # an optimization that avoids useless multicast queries
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1420 # to a multicast group when the requested object would
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1421 # be fetched only from a "parent" cache, anyway. It's
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1422 # useful, e.g., when configuring a pool of redundant
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1423 # Squid proxies, being members of the same
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1424 # multicast group.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1425 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1426 # 'closest-only' indicates that, for ICP_OP_MISS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1427 # replies, we'll only forward CLOSEST_PARENT_MISSes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1428 # and never FIRST_PARENT_MISSes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1429 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1430 # use 'no-digest' to NOT request cache digests from
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1431 # this neighbor.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1432 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1433 # 'no-netdb-exchange' disables requesting ICMP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1434 # RTT database (NetDB) from the neighbor.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1435 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1436 # use 'no-delay' to prevent access to this neighbor
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1437 # from influencing the delay pools.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1438 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1439 # use 'login=user:password' if this is a personal/workgroup
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1440 # proxy and your parent requires proxy authentication.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1441 # Note: The string can include URL escapes (i.e. %20 for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1442 # spaces). This also means % must be written as %%.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1443 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1444 # use 'login=PASS' if users must authenticate against
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1445 # the upstream proxy or in the case of a reverse proxy
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1446 # configuration, the origin web server. This will pass
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1447 # the users credentials as they are to the peer.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1448 # Note: To combine this with local authentication the Basic
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1449 # authentication scheme must be used, and both servers must
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1450 # share the same user database as HTTP only allows for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1451 # a single login (one for proxy, one for origin server).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1452 # Also be warned this will expose your users proxy
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1453 # password to the peer. USE WITH CAUTION
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1454 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1455 # use 'login=*:password' to pass the username to the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1456 # upstream cache, but with a fixed password. This is meant
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1457 # to be used when the peer is in another administrative
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1458 # domain, but it is still needed to identify each user.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1459 # The star can optionally be followed by some extra
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1460 # information which is added to the username. This can
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1461 # be used to identify this proxy to the peer, similar to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1462 # the login=username:password option above.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1463 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1464 # use 'connect-timeout=nn' to specify a peer
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1465 # specific connect timeout (also see the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1466 # peer_connect_timeout directive)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1467 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1468 # use 'digest-url=url' to tell Squid to fetch the cache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1469 # digest (if digests are enabled) for this host from
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1470 # the specified URL rather than the Squid default
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1471 # location.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1472 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1473 # use 'allow-miss' to disable Squid's use of only-if-cached
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1474 # when forwarding requests to siblings. This is primarily
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1475 # useful when icp_hit_stale is used by the sibling. To
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1476 # extensive use of this option may result in forwarding
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1477 # loops, and you should avoid having two-way peerings
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1478 # with this option. (for example to deny peer usage on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1479 # requests from peer by denying cache_peer_access if the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1480 # source is a peer)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1481 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1482 # use 'max-conn=n' to limit the amount of connections Squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1483 # may open to this peer.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1484 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1485 # use 'htcp' to send HTCP, instead of ICP, queries
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1486 # to the neighbor. You probably also want to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1487 # set the "icp port" to 4827 instead of 3130.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1488 # You must also allow this Squid htcp_access and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1489 # http_access in the peer Squid configuration.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1490 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1491 # use 'htcp-oldsquid' to send HTCP to old Squid versions
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1492 # You must also allow this Squid htcp_access and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1493 # http_access in the peer Squid configuration.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1494 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1495 # 'originserver' causes this parent peer to be contacted as
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1496 # a origin server. Meant to be used in accelerator setups.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1497 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1498 # use 'userhash' to load-balance amongst a set of parents
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1499 # based on the client proxy_auth or ident username.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1500 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1501 # use 'sourcehash' to load-balance amongst a set of parents
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1502 # based on the client source ip.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1503 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1504 # use 'name=xxx' if you have multiple peers on the same
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1505 # host but different ports. This name can be used to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1506 # differentiate the peers in cache_peer_access and similar
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1507 # directives.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1508 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1509 # use 'monitorurl=url' to have periodically request a given
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1510 # URL from the peer, and only consider the peer as alive
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1511 # if this monitoring is successful (default none)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1512 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1513 # use 'monitorsize=min[-max]' to limit the size range of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1514 # 'monitorurl' replies considered valid. Defaults to 0 to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1515 # accept any size replies as valid.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1516 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1517 # use 'monitorinterval=seconds' to change frequency of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1518 # how often the peer is monitored with 'monitorurl'
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1519 # (default 300 for a 5 minute interval). If set to 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1520 # then monitoring is disabled even if a URL is defined.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1521 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1522 # use 'monitortimeout=seconds' to change the timeout of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1523 # 'monitorurl'. Defaults to 'monitorinterval'.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1524 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1525 # use 'forceddomain=name' to forcibly set the Host header
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1526 # of requests forwarded to this peer. Useful in accelerator
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1527 # setups where the server (peer) expects a certain domain
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1528 # name and using redirectors to feed this domain name
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1529 # is not feasible.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1530 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1531 # use 'ssl' to indicate connections to this peer should
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1532 # be SSL/TLS encrypted.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1533 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1534 # use 'sslcert=/path/to/ssl/certificate' to specify a client
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1535 # SSL certificate to use when connecting to this peer.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1536 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1537 # use 'sslkey=/path/to/ssl/key' to specify the private SSL
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1538 # key corresponding to sslcert above. If 'sslkey' is not
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1539 # specified 'sslcert' is assumed to reference a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1540 # combined file containing both the certificate and the key.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1541 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1542 # Notes:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1543 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1544 # On Debian/Ubuntu system a default snakeoil certificate is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1545 # available in /etc/ssl and users can set:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1546 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1547 # cert=/etc/ssl/certs/ssl-cert-snakeoil.pem
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1548 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1549 # and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1550 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1551 # key=/etc/ssl/private/ssl-cert-snakeoil.key
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1552 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1553 # for testing.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1554 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1555 # use sslversion=1\|2\|3\|4 to specify the SSL version to use
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1556 # when connecting to this peer
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1557 # 1 = automatic (default)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1558 # 2 = SSL v2 only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1559 # 3 = SSL v3 only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1560 # 4 = TLS v1 only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1561 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1562 # use sslcipher=... to specify the list of valid SSL ciphers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1563 # to use when connecting to this peer.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1564 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1565 # use ssloptions=... to specify various SSL engine options:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1566 # NO_SSLv2 Disallow the use of SSLv2
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1567 # NO_SSLv3 Disallow the use of SSLv3
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1568 # NO_TLSv1 Disallow the use of TLSv1
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1569 # See src/ssl_support.c or the OpenSSL documentation for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1570 # a more complete list.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1571 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1572 # use sslcafile=... to specify a file containing
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1573 # additional CA certificates to use when verifying the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1574 # peer certificate.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1575 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1576 # use sslcapath=... to specify a directory containing
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1577 # additional CA certificates to use when verifying the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1578 # peer certificate.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1579 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1580 # use sslcrlfile=... to specify a certificate revocation
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1581 # list file to use when verifying the peer certificate.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1582 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1583 # use sslflags=... to specify various flags modifying the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1584 # SSL implementation:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1585 # DONT_VERIFY_PEER
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1586 # Accept certificates even if they fail to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1587 # verify.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1588 # NO_DEFAULT_CA
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1589 # Don't use the default CA list built in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1590 # to OpenSSL.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1591 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1592 # use ssldomain= to specify the peer name as advertised
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1593 # in it's certificate. Used for verifying the correctness
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1594 # of the received peer certificate. If not specified the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1595 # peer hostname will be used.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1596 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1597 # use front-end-https to enable the "Front-End-Https: On"
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1598 # header needed when using Squid as a SSL frontend in front
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1599 # of Microsoft OWA. See MS KB document Q307347 for details
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1600 # on this header. If set to auto the header will
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1601 # only be added if the request is forwarded as a https://
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1602 # URL.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1603 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1604 # use connection-auth=off to tell Squid that this peer does
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1605 # not support Microsoft connection oriented authentication,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1606 # and any such challenges received from there should be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1607 # ignored. Default is auto to automatically determine the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1608 # status of the peer.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1609 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1610 # use idle=n to specify a minimum number of idle connections
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1611 # that should be kept open to this peer.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1612 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1613 # use http11 to send requests using HTTP/1.1 to this peer.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1614 # Note: The HTTP/1.1 support is still incomplete, with an
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1615 # internal HTTP/1.0 hop. As result 1xx responses will not
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1616 # be forwarded.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1617 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1618 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1619 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1620
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1621 # TAG: cache_peer_domain
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1622 # Use to limit the domains for which a neighbor cache will be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1623 # queried. Usage:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1624 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1625 # cache_peer_domain cache-host domain [domain ...]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1626 # cache_peer_domain cache-host !domain
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1627 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1628 # For example, specifying
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1629 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1630 # cache_peer_domain parent.foo.net .edu
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1631 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1632 # has the effect such that UDP query packets are sent to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1633 # 'bigserver' only when the requested object exists on a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1634 # server in the .edu domain. Prefixing the domain name
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1635 # with '!' means the cache will be queried for objects
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1636 # NOT in that domain.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1637 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1638 # NOTE: * Any number of domains may be given for a cache-host,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1639 # either on the same or separate lines.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1640 # * When multiple domains are given for a particular
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1641 # cache-host, the first matched domain is applied.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1642 # * Cache hosts with no domain restrictions are queried
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1643 # for all requests.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1644 # * There are no defaults.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1645 # * There is also a 'cache_peer_access' tag in the ACL
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1646 # section.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1647 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1648 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1649 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1650
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1651 # TAG: cache_peer_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1652 # Similar to 'cache_peer_domain' but provides more flexibility by
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1653 # using ACL elements.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1654 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1655 # cache_peer_access cache-host allow\|deny [!]aclname ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1656 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1657 # The syntax is identical to 'http_access' and the other lists of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1658 # ACL elements. See the comments for 'http_access' below, or
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1659 # the Squid FAQ (http://www.squid-cache.org/FAQ/FAQ-10.html).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1660 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1661 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1662 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1663
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1664 # TAG: neighbor_type_domain
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1665 # usage: neighbor_type_domain neighbor parent\|sibling domain domain ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1666 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1667 # Modifying the neighbor type for specific domains is now
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1668 # possible. You can treat some domains differently than the the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1669 # default neighbor type specified on the 'cache_peer' line.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1670 # Normally it should only be necessary to list domains which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1671 # should be treated differently because the default neighbor type
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1672 # applies for hostnames which do not match domains listed here.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1673 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1674 #EXAMPLE:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1675 # cache_peer cache.foo.org parent 3128 3130
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1676 # neighbor_type_domain cache.foo.org sibling .com .net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1677 # neighbor_type_domain cache.foo.org sibling .au .de
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1678 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1679 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1680 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1681
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1682 # TAG: dead_peer_timeout (seconds)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1683 # This controls how long Squid waits to declare a peer cache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1684 # as "dead." If there are no ICP replies received in this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1685 # amount of time, Squid will declare the peer dead and not
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1686 # expect to receive any further ICP replies. However, it
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1687 # continues to send ICP queries, and will mark the peer as
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1688 # alive upon receipt of the first subsequent ICP reply.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1689 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1690 # This timeout also affects when Squid expects to receive ICP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1691 # replies from peers. If more than 'dead_peer' seconds have
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1692 # passed since the last ICP reply was received, Squid will not
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1693 # expect to receive an ICP reply on the next query. Thus, if
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1694 # your time between requests is greater than this timeout, you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1695 # will see a lot of requests sent DIRECT to origin servers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1696 # instead of to your parents.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1697 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1698 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1699 # dead_peer_timeout 10 seconds
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1700
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1701 # TAG: hierarchy_stoplist
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1702 # A list of words which, if found in a URL, cause the object to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1703 # be handled directly by this cache. In other words, use this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1704 # to not query neighbor caches for certain objects. You may
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1705 # list this option multiple times. Note: never_direct overrides
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1706 # this option.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1707 #We recommend you to use at least the following line.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1708 hierarchy_stoplist cgi-bin ?
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1709
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1710
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1711 # MEMORY CACHE OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1712 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1713
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1714 # TAG: cache_mem (bytes)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1715 # NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS SIZE.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1716 # IT ONLY PLACES A LIMIT ON HOW MUCH ADDITIONAL MEMORY SQUID WILL
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1717 # USE AS A MEMORY CACHE OF OBJECTS. SQUID USES MEMORY FOR OTHER
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1718 # THINGS AS WELL. SEE THE SQUID FAQ SECTION 8 FOR DETAILS.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1719 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1720 # 'cache_mem' specifies the ideal amount of memory to be used
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1721 # for:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1722 # * In-Transit objects
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1723 # * Hot Objects
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1724 # * Negative-Cached objects
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1725 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1726 # Data for these objects are stored in 4 KB blocks. This
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1727 # parameter specifies the ideal upper limit on the total size of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1728 # 4 KB blocks allocated. In-Transit objects take the highest
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1729 # priority.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1730 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1731 # In-transit objects have priority over the others. When
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1732 # additional space is needed for incoming data, negative-cached
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1733 # and hot objects will be released. In other words, the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1734 # negative-cached and hot objects will fill up any unused space
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1735 # not needed for in-transit objects.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1736 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1737 # If circumstances require, this limit will be exceeded.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1738 # Specifically, if your incoming request rate requires more than
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1739 # 'cache_mem' of memory to hold in-transit objects, Squid will
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1740 # exceed this limit to satisfy the new requests. When the load
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1741 # decreases, blocks will be freed until the high-water mark is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1742 # reached. Thereafter, blocks will be used to store hot
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1743 # objects.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1744 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1745 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1746 # cache_mem 8 MB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1747
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1748 # TAG: maximum_object_size_in_memory (bytes)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1749 # Objects greater than this size will not be attempted to kept in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1750 # the memory cache. This should be set high enough to keep objects
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1751 # accessed frequently in memory to improve performance whilst low
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1752 # enough to keep larger objects from hoarding cache_mem.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1753 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1754 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1755 # maximum_object_size_in_memory 8 KB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1756
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1757 # TAG: memory_replacement_policy
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1758 # The memory replacement policy parameter determines which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1759 # objects are purged from memory when memory space is needed.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1760 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1761 # See cache_replacement_policy for details.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1762 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1763 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1764 # memory_replacement_policy lru
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1765
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1766
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1767 # DISK CACHE OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1768 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1769
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1770 # TAG: cache_replacement_policy
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1771 # The cache replacement policy parameter determines which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1772 # objects are evicted (replaced) when disk space is needed.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1773 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1774 # lru : Squid's original list based LRU policy
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1775 # heap GDSF : Greedy-Dual Size Frequency
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1776 # heap LFUDA: Least Frequently Used with Dynamic Aging
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1777 # heap LRU : LRU policy implemented using a heap
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1778 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1779 # Applies to any cache_dir lines listed below this.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1780 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1781 # The LRU policies keeps recently referenced objects.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1782 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1783 # The heap GDSF policy optimizes object hit rate by keeping smaller
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1784 # popular objects in cache so it has a better chance of getting a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1785 # hit. It achieves a lower byte hit rate than LFUDA though since
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1786 # it evicts larger (possibly popular) objects.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1787 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1788 # The heap LFUDA policy keeps popular objects in cache regardless of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1789 # their size and thus optimizes byte hit rate at the expense of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1790 # hit rate since one large, popular object will prevent many
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1791 # smaller, slightly less popular objects from being cached.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1792 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1793 # Both policies utilize a dynamic aging mechanism that prevents
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1794 # cache pollution that can otherwise occur with frequency-based
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1795 # replacement policies.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1796 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1797 # NOTE: if using the LFUDA replacement policy you should increase
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1798 # the value of maximum_object_size above its default of 4096 KB to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1799 # to maximize the potential byte hit rate improvement of LFUDA.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1800 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1801 # For more information about the GDSF and LFUDA cache replacement
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1802 # policies see http://www.hpl.hp.com/techreports/1999/HPL-1999-69.html
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1803 # and http://fog.hpl.external.hp.com/techreports/98/HPL-98-173.html.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1804 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1805 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1806 # cache_replacement_policy lru
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1807
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1808 # TAG: cache_dir
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1809 # Usage:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1810 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1811 # cache_dir Type Directory-Name Fs-specific-data [options]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1812 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1813 # You can specify multiple cache_dir lines to spread the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1814 # cache among different disk partitions.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1815 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1816 # Type specifies the kind of storage system to use. Only "ufs"
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1817 # is built by default. To enable any of the other storage systems
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1818 # see the --enable-storeio configure option.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1819 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1820 # 'Directory' is a top-level directory where cache swap
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1821 # files will be stored. If you want to use an entire disk
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1822 # for caching, this can be the mount-point directory.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1823 # The directory must exist and be writable by the Squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1824 # process. Squid will NOT create this directory for you.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1825 # Only using COSS, a raw disk device or a stripe file can
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1826 # be specified, but the configuration of the "cache_swap_log"
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1827 # tag is mandatory.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1828 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1829 # The ufs store type:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1830 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1831 # "ufs" is the old well-known Squid storage format that has always
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1832 # been there.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1833 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1834 # cache_dir ufs Directory-Name Mbytes L1 L2 [options]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1835 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1836 # 'Mbytes' is the amount of disk space (MB) to use under this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1837 # directory. The default is 100 MB. Change this to suit your
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1838 # configuration. Do NOT put the size of your disk drive here.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1839 # Instead, if you want Squid to use the entire disk drive,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1840 # subtract 20% and use that value.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1841 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1842 # 'Level-1' is the number of first-level subdirectories which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1843 # will be created under the 'Directory'. The default is 16.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1844 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1845 # 'Level-2' is the number of second-level subdirectories which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1846 # will be created under each first-level directory. The default
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1847 # is 256.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1848 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1849 # The aufs store type:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1850 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1851 # "aufs" uses the same storage format as "ufs", utilizing
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1852 # POSIX-threads to avoid blocking the main Squid process on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1853 # disk-I/O. This was formerly known in Squid as async-io.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1854 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1855 # cache_dir aufs Directory-Name Mbytes L1 L2 [options]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1856 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1857 # see argument descriptions under ufs above
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1858 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1859 # The diskd store type:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1860 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1861 # "diskd" uses the same storage format as "ufs", utilizing a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1862 # separate process to avoid blocking the main Squid process on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1863 # disk-I/O.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1864 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1865 # cache_dir diskd Directory-Name Mbytes L1 L2 [options] [Q1=n] [Q2=n]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1866 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1867 # see argument descriptions under ufs above
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1868 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1869 # Q1 specifies the number of unacknowledged I/O requests when Squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1870 # stops opening new files. If this many messages are in the queues,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1871 # Squid won't open new files. Default is 64
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1872 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1873 # Q2 specifies the number of unacknowledged messages when Squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1874 # starts blocking. If this many messages are in the queues,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1875 # Squid blocks until it receives some replies. Default is 72
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1876 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1877 # When Q1 < Q2 (the default), the cache directory is optimized
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1878 # for lower response time at the expense of a decrease in hit
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1879 # ratio. If Q1 > Q2, the cache directory is optimized for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1880 # higher hit ratio at the expense of an increase in response
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1881 # time.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1882 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1883 # The coss store type:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1884 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1885 # block-size=n defines the "block size" for COSS cache_dir's.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1886 # Squid uses file numbers as block numbers. Since file numbers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1887 # are limited to 24 bits, the block size determines the maximum
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1888 # size of the COSS partition. The default is 512 bytes, which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1889 # leads to a maximum cache_dir size of 512<<24, or 8 GB. Note
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1890 # you should not change the COSS block size after Squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1891 # has written some objects to the cache_dir.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1892 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1893 # overwrite-percent=n defines the percentage of disk that COSS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1894 # must write to before a given object will be moved to the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1895 # current stripe. A value of "n" closer to 100 will cause COSS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1896 # to waste less disk space by having multiple copies of an object
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1897 # on disk, but will increase the chances of overwriting a popular
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1898 # object as COSS overwrites stripes. A value of "n" close to 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1899 # will cause COSS to keep all current objects in the current COSS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1900 # stripe at the expense of the hit rate. The default value of 50
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1901 # will allow any given object to be stored on disk a maximum of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1902 # 2 times.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1903 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1904 # max-stripe-waste=n defines the maximum amount of space that COSS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1905 # will waste in a given stripe (in bytes). When COSS writes data
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1906 # to disk, it will potentially waste up to "max-size" worth of disk
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1907 # space for each 1MB of data written. If "max-size" is set to a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1908 # large value (ie >256k), this could potentially result in large
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1909 # amounts of wasted disk space. Setting this value to a lower value
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1910 # (ie 64k or 32k) will result in a COSS disk refusing to cache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1911 # larger objects until the COSS stripe has been filled to within
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1912 # "max-stripe-waste" of the maximum size (1MB).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1913 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1914 # membufs=n defines the number of "memory-only" stripes that COSS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1915 # will use. When an cache hit is performed on a COSS stripe before
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1916 # COSS has reached the overwrite-percent value for that object,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1917 # COSS will use a series of memory buffers to hold the object in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1918 # while the data is sent to the client. This will define the maximum
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1919 # number of memory-only buffers that COSS will use. The default value
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1920 # is 10, which will use a maximum of 10MB of memory for buffers.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1921 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1922 # maxfullbufs=n defines the maximum number of stripes a COSS partition
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1923 # will have in memory waiting to be freed (either because the disk is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1924 # under load and the stripe is unwritten, or because clients are still
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1925 # transferring data from objects using the memory). In order to try
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1926 # and maintain a good hit rate under load, COSS will reserve the last
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1927 # 2 full stripes for object hits. (ie a COSS cache_dir will reject
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1928 # new objects when the number of full stripes is 2 less than maxfullbufs)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1929 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1930 # The null store type:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1931 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1932 # no options are allowed or required
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1933 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1934 # Common options:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1935 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1936 # no-store, no new objects should be stored to this cache_dir
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1937 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1938 # min-size=n, refers to the min object size this storedir will accept.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1939 # It's used to restrict a storedir to only store large objects
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1940 # (e.g. aufs) while other storedirs are optimized for smaller objects
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1941 # (e.g. COSS). Defaults to 0.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1942 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1943 # max-size=n, refers to the max object size this storedir supports.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1944 # It is used to initially choose the storedir to dump the object.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1945 # Note: To make optimal use of the max-size limits you should order
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1946 # the cache_dir lines with the smallest max-size value first and the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1947 # ones with no max-size specification last.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1948 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1949 # Note that for coss, max-size must be less than COSS_MEMBUF_SZ
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1950 # (hard coded at 1 MB).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1951 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1952 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1953 # cache_dir ufs /var/spool/squid 100 16 256
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1954
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1955 # TAG: store_dir_select_algorithm
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1956 # Set this to 'round-robin' as an alternative.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1957 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1958 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1959 # store_dir_select_algorithm least-load
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1960
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1961 # TAG: max_open_disk_fds
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1962 # To avoid having disk as the I/O bottleneck Squid can optionally
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1963 # bypass the on-disk cache if more than this amount of disk file
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1964 # descriptors are open.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1965 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1966 # A value of 0 indicates no limit.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1967 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1968 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1969 # max_open_disk_fds 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1970
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1971 # TAG: minimum_object_size (bytes)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1972 # Objects smaller than this size will NOT be saved on disk. The
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1973 # value is specified in kilobytes, and the default is 0 KB, which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1974 # means there is no minimum.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1975 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1976 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1977 # minimum_object_size 0 KB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1978
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1979 # TAG: maximum_object_size (bytes)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1980 # Objects larger than this size will NOT be saved on disk. The
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1981 # value is specified in kilobytes, and the default is 4MB. If
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1982 # you wish to get a high BYTES hit ratio, you should probably
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1983 # increase this (one 32 MB object hit counts for 3200 10KB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1984 # hits). If you wish to increase speed more than your want to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1985 # save bandwidth you should leave this low.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1986 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1987 # NOTE: if using the LFUDA replacement policy you should increase
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1988 # this value to maximize the byte hit rate improvement of LFUDA!
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1989 # See replacement_policy below for a discussion of this policy.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1990 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1991 # NOTE 2: In Debian the default is raised to 20MB allowing cache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1992 # of Packages files in debian repositories. This makes squid a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1993 # proper proxy for APT.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1994 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1995 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1996 # maximum_object_size 20480 KB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1997
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1998 # TAG: cache_swap_low (percent, 0-100)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	1999 # TAG: cache_swap_high (percent, 0-100)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2000 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2001 # The low- and high-water marks for cache object replacement.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2002 # Replacement begins when the swap (disk) usage is above the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2003 # low-water mark and attempts to maintain utilization near the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2004 # low-water mark. As swap utilization gets close to high-water
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2005 # mark object eviction becomes more aggressive. If utilization is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2006 # close to the low-water mark less replacement is done each time.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2007 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2008 # Defaults are 90% and 95%. If you have a large cache, 5% could be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2009 # hundreds of MB. If this is the case you may wish to set these
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2010 # numbers closer together.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2011 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2012 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2013 # cache_swap_low 90
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2014 # cache_swap_high 95
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2015
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2016 # TAG: update_headers on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2017 # By default Squid updates stored HTTP headers when receiving
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2018 # a 304 response. Set this to off if you want to disable this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2019 # for disk I/O performance reasons. Disabling this VIOLATES the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2020 # HTTP standard, and could make you liable for problems which it
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2021 # causes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2022 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2023 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2024 # update_headers on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2025
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2026
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2027 # LOGFILE OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2028 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2029
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2030 # TAG: logformat
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2031 # Usage:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2032 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2033 # logformat <name> <format specification>
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2034 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2035 # Defines an access log format.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2036 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2037 # The <format specification> is a string with embedded % format codes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2038 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2039 # % format codes all follow the same basic structure where all but
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2040 # the formatcode is optional. Output strings are automatically escaped
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2041 # as required according to their context and the output format
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2042 # modifiers are usually not needed, but can be specified if an explicit
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2043 # output format is desired.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2044 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2045 # % ["\|[\|'\|#] [-] [[0]width] [{argument}] formatcode
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2046 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2047 # " output in quoted string format
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2048 # [ output in squid text log format as used by log_mime_hdrs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2049 # # output in URL quoted format
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2050 # ' output as-is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2051 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2052 # - left aligned
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2053 # width field width. If starting with 0 the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2054 # output is zero padded
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2055 # {arg} argument such as header name etc
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2056 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2057 # Format codes:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2058 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2059 # >a Client source IP address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2060 # >A Client FQDN
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2061 # >p Client source port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2062 # <A Server IP address or peer name
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2063 # la Local IP address (http_port)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2064 # lp Local port number (http_port)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2065 # oa Our outgoing IP address (tcp_outgoing_address)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2066 # ts Seconds since epoch
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2067 # tu subsecond time (milliseconds)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2068 # tl Local time. Optional strftime format argument
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2069 # default %d/%b/%Y:%H:%M:%S %z
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2070 # tg GMT time. Optional strftime format argument
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2071 # default %d/%b/%Y:%H:%M:%S %z
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2072 # tr Response time (milliseconds)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2073 # >h Request header. Optional header name argument
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2074 # on the format header[:[separator]element]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2075 # <h Reply header. Optional header name argument
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2076 # as for >h
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2077 # un User name
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2078 # ul User name from authentication
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2079 # ui User name from ident
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2080 # us User name from SSL
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2081 # ue User name from external acl helper
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2082 # Hs HTTP status code
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2083 # Ss Squid request status (TCP_MISS etc)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2084 # Sh Squid hierarchy status (DEFAULT_PARENT etc)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2085 # mt MIME content type
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2086 # rm Request method (GET/POST etc)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2087 # ru Request URL
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2088 # rp Request URL-Path excluding hostname
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2089 # rv Request protocol version
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2090 # ea Log string returned by external acl
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2091 # <st Reply size including HTTP headers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2092 # >st Request size including HTTP headers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2093 # st Request+Reply size including HTTP headers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2094 # sn Unique sequence number per log line entry
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2095 # % a literal % character
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2096 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2097 # The default formats available (which do not need re-defining) are:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2098 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2099 #logformat squid %ts.%03tu %6tr %>a %Ss/%03Hs %<st %rm %ru %un %Sh/%<A %mt
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2100 #logformat squidmime %ts.%03tu %6tr %>a %Ss/%03Hs %<st %rm %ru %un %Sh/%<A %mt [%>h] [%<h]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2101 #logformat common %>a %ui %un [%tl] "%rm %ru HTTP/%rv" %Hs %<st %Ss:%Sh
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2102 #logformat combined %>a %ui %un [%tl] "%rm %ru HTTP/%rv" %Hs %<st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2103 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2104 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2105 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2106
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2107 # TAG: access_log
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2108 # These files log client request activities. Has a line every HTTP or
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2109 # ICP request. The format is:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2110 # access_log <filepath> [<logformat name> [acl acl ...]]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2111 # access_log none [acl acl ...]]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2112 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2113 # Will log to the specified file using the specified format (which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2114 # must be defined in a logformat directive) those entries which match
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2115 # ALL the acl's specified (which must be defined in acl clauses).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2116 # If no acl is specified, all requests will be logged to this file.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2117 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2118 # To disable logging of a request use the filepath "none", in which case
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2119 # a logformat name should not be specified.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2120 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2121 # To log the request via syslog specify a filepath of "syslog":
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2122 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2123 # access_log syslog[:facility.priority] [format [acl1 [acl2 ....]]]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2124 # where facility could be any of:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2125 # authpriv, daemon, local0 .. local7 or user.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2126 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2127 # And priority could be any of:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2128 # err, warning, notice, info, debug.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2129 access_log /var/log/squid/access.log squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2130
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2131 # TAG: log_access allow\|deny acl acl...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2132 # This options allows you to control which requests gets logged
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2133 # to access.log (see access_log directive). Requests denied for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2134 # logging will also not be accounted for in performance counters.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2135 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2136 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2137 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2138
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2139 # TAG: logfile_daemon
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2140 # Specify the path to the logfile-writing daemon. This daemon is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2141 # used to write the access and store logs, if configured.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2142 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2143 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2144 # logfile_daemon /usr/lib/squid/logfile-daemon
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2145
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2146 # TAG: cache_log
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2147 # Cache logging file. This is where general information about
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2148 # your cache's behavior goes. You can increase the amount of data
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2149 # logged to this file with the "debug_options" tag below.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2150 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2151 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2152 # cache_log /var/log/squid/cache.log
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2153
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2154 # TAG: cache_store_log
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2155 # Logs the activities of the storage manager. Shows which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2156 # objects are ejected from the cache, and which objects are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2157 # saved and for how long. To disable, enter "none". There are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2158 # not really utilities to analyze this data, so you can safely
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2159 # disable it.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2160 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2161 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2162 # cache_store_log /var/log/squid/store.log
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2163
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2164 # TAG: cache_swap_state
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2165 # Location for the cache "swap.state" file. This index file holds
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2166 # the metadata of objects saved on disk. It is used to rebuild
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2167 # the cache during startup. Normally this file resides in each
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2168 # 'cache_dir' directory, but you may specify an alternate
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2169 # pathname here. Note you must give a full filename, not just
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2170 # a directory. Since this is the index for the whole object
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2171 # list you CANNOT periodically rotate it!
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2172 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2173 # If %s can be used in the file name it will be replaced with a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2174 # a representation of the cache_dir name where each / is replaced
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2175 # with '.'. This is needed to allow adding/removing cache_dir
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2176 # lines when cache_swap_log is being used.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2177 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2178 # If have more than one 'cache_dir', and %s is not used in the name
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2179 # these swap logs will have names such as:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2180 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2181 # cache_swap_log.00
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2182 # cache_swap_log.01
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2183 # cache_swap_log.02
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2184 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2185 # The numbered extension (which is added automatically)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2186 # corresponds to the order of the 'cache_dir' lines in this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2187 # configuration file. If you change the order of the 'cache_dir'
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2188 # lines in this file, these index files will NOT correspond to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2189 # the correct 'cache_dir' entry (unless you manually rename
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2190 # them). We recommend you do NOT use this option. It is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2191 # better to keep these index files in each 'cache_dir' directory.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2192 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2193 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2194 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2195
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2196 # TAG: logfile_rotate
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2197 # Specifies the number of logfile rotations to make when you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2198 # type 'squid -k rotate'. The default is 10, which will rotate
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2199 # with extensions 0 through 9. Setting logfile_rotate to 0 will
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2200 # disable the file name rotation, but the logfiles are still closed
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2201 # and re-opened. This will enable you to rename the logfiles
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2202 # yourself just before sending the rotate signal.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2203 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2204 # Note, the 'squid -k rotate' command normally sends a USR1
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2205 # signal to the running squid process. In certain situations
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2206 # (e.g. on Linux with Async I/O), USR1 is used for other
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2207 # purposes, so -k rotate uses another signal. It is best to get
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2208 # in the habit of using 'squid -k rotate' instead of 'kill -USR1
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2209 # <pid>'.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2210 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2211 # Note2, for Debian/Linux the default of logfile_rotate is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2212 # zero, since it includes external logfile-rotation methods.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2213 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2214 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2215 # logfile_rotate 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2216
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2217 # TAG: emulate_httpd_log on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2218 # The Cache can emulate the log file format which many 'httpd'
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2219 # programs use. To disable/enable this emulation, set
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2220 # emulate_httpd_log to 'off' or 'on'. The default
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2221 # is to use the native log format since it includes useful
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2222 # information Squid-specific log analyzers use.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2223 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2224 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2225 # emulate_httpd_log off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2226
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2227 # TAG: log_ip_on_direct on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2228 # Log the destination IP address in the hierarchy log tag when going
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2229 # direct. Earlier Squid versions logged the hostname here. If you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2230 # prefer the old way set this to off.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2231 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2232 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2233 # log_ip_on_direct on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2234
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2235 # TAG: mime_table
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2236 # Pathname to Squid's MIME table. You shouldn't need to change
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2237 # this, but the default file contains examples and formatting
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2238 # information if you do.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2239 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2240 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2241 # mime_table /usr/share/squid/mime.conf
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2242
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2243 # TAG: log_mime_hdrs on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2244 # The Cache can record both the request and the response MIME
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2245 # headers for each HTTP transaction. The headers are encoded
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2246 # safely and will appear as two bracketed fields at the end of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2247 # the access log (for either the native or httpd-emulated log
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2248 # formats). To enable this logging set log_mime_hdrs to 'on'.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2249 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2250 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2251 # log_mime_hdrs off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2252
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2253 # TAG: useragent_log
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2254 # Squid will write the User-Agent field from HTTP requests
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2255 # to the filename specified here. By default useragent_log
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2256 # is disabled.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2257 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2258 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2259 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2260
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2261 # TAG: referer_log
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2262 # Squid will write the Referer field from HTTP requests to the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2263 # filename specified here. By default referer_log is disabled.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2264 # Note that "referer" is actually a misspelling of "referrer"
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2265 # however the misspelt version has been accepted into the HTTP RFCs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2266 # and we accept both.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2267 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2268 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2269 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2270
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2271 # TAG: pid_filename
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2272 # A filename to write the process-id to. To disable, enter "none".
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2273 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2274 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2275 # pid_filename /var/run/squid.pid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2276
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2277 # TAG: debug_options
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2278 # Logging options are set as section,level where each source file
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2279 # is assigned a unique section. Lower levels result in less
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2280 # output, Full debugging (level 9) can result in a very large
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2281 # log file, so be careful. The magic word "ALL" sets debugging
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2282 # levels for all sections. We recommend normally running with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2283 # "ALL,1".
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2284 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2285 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2286 # debug_options ALL,1
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2287
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2288 # TAG: log_fqdn on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2289 # Turn this on if you wish to log fully qualified domain names
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2290 # in the access.log. To do this Squid does a DNS lookup of all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2291 # IP's connecting to it. This can (in some situations) increase
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2292 # latency, which makes your cache seem slower for interactive
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2293 # browsing.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2294 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2295 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2296 # log_fqdn off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2297
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2298 # TAG: client_netmask
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2299 # A netmask for client addresses in logfiles and cachemgr output.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2300 # Change this to protect the privacy of your cache clients.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2301 # A netmask of 255.255.255.0 will log all IP's in that range with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2302 # the last digit set to '0'.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2303 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2304 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2305 # client_netmask 255.255.255.255
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2306
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2307 # TAG: forward_log
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2308 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2309 # --enable-forward-log option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2310 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2311 # Logs the server-side requests.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2312 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2313 # This is currently work in progress.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2314 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2315 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2316 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2317
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2318 # TAG: strip_query_terms
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2319 # By default, Squid strips query terms from requested URLs before
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2320 # logging. This protects your user's privacy.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2321 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2322 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2323 # strip_query_terms on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2324
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2325 # TAG: buffered_logs on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2326 # cache.log log file is written with stdio functions, and as such
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2327 # it can be buffered or unbuffered. By default it will be unbuffered.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2328 # Buffering it can speed up the writing slightly (though you are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2329 # unlikely to need to worry unless you run with tons of debugging
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2330 # enabled in which case performance will suffer badly anyway..).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2331 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2332 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2333 # buffered_logs off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2334
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2335 # TAG: netdb_filename
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2336 # A filename where Squid stores it's netdb state between restarts.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2337 # To disable, enter "none".
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2338 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2339 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2340 # netdb_filename /var/spool/squid/logs/netdb.state
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2341
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2342
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2343 # OPTIONS FOR FTP GATEWAYING
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2344 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2345
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2346 # TAG: ftp_user
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2347 # If you want the anonymous login password to be more informative
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2348 # (and enable the use of picky ftp servers), set this to something
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2349 # reasonable for your domain, like wwwuser@somewhere.net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2350 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2351 # The reason why this is domainless by default is the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2352 # request can be made on the behalf of a user in any domain,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2353 # depending on how the cache is used.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2354 # Some ftp server also validate the email address is valid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2355 # (for example perl.com).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2356 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2357 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2358 # ftp_user Squid@
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2359
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2360 # TAG: ftp_list_width
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2361 # Sets the width of ftp listings. This should be set to fit in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2362 # the width of a standard browser. Setting this too small
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2363 # can cut off long filenames when browsing ftp sites.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2364 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2365 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2366 # ftp_list_width 32
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2367
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2368 # TAG: ftp_passive
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2369 # If your firewall does not allow Squid to use passive
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2370 # connections, turn off this option.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2371 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2372 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2373 # ftp_passive on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2374
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2375 # TAG: ftp_sanitycheck
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2376 # For security and data integrity reasons Squid by default performs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2377 # sanity checks of the addresses of FTP data connections ensure the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2378 # data connection is to the requested server. If you need to allow
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2379 # FTP connections to servers using another IP address for the data
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2380 # connection turn this off.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2381 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2382 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2383 # ftp_sanitycheck on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2384
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2385 # TAG: ftp_telnet_protocol
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2386 # The FTP protocol is officially defined to use the telnet protocol
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2387 # as transport channel for the control connection. However, many
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2388 # implementations are broken and does not respect this aspect of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2389 # the FTP protocol.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2390 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2391 # If you have trouble accessing files with ASCII code 255 in the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2392 # path or similar problems involving this ASCII code you can
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2393 # try setting this directive to off. If that helps, report to the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2394 # operator of the FTP server in question that their FTP server
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2395 # is broken and does not follow the FTP standard.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2396 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2397 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2398 # ftp_telnet_protocol on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2399
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2400
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2401 # OPTIONS FOR EXTERNAL SUPPORT PROGRAMS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2402 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2403
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2404 # TAG: diskd_program
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2405 # Specify the location of the diskd executable.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2406 # Note this is only useful if you have compiled in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2407 # diskd as one of the store io modules.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2408 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2409 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2410 # diskd_program /usr/lib/squid/diskd-daemon
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2411
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2412 # TAG: unlinkd_program
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2413 # Specify the location of the executable for file deletion process.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2414 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2415 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2416 # unlinkd_program /usr/lib/squid/unlinkd
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2417
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2418 # TAG: pinger_program
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2419 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2420 # --enable-icmp option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2421 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2422 # Specify the location of the executable for the pinger process.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2423 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2424 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2425 # pinger_program /usr/lib/squid/pinger
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2426
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2427
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2428 # OPTIONS FOR URL REWRITING
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2429 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2430
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2431 # TAG: storeurl_rewrite_program
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2432 # Specify the location of the executable for the Store URL rewriter.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2433 # The Store URL rewriter allows URLs to be "normalised" ; mapping
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2434 # multiple URLs to a single URL representation for cache operations.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2435 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2436 # For example, if you request an object at:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2437 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2438 # http://srv1.example.com/image.gif
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2439 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2440 # and a subsequent request for:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2441 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2442 # http://srv2.example.com/image.gif
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2443 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2444 # then Squid will treat these both as different URLs and cache them
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2445 # seperately.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2446 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2447 # This is almost the normal case, but an increasing number of sites
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2448 # distribute the same content between multiple frontend hosts.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2449 # The Store URL rewriter allows you to rewrite these URLs to one URL
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2450 # to use for cache operations, but not -fetches-. Fetches are still
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2451 # made from the original site, but stored with the store URL rewritten
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2452 # URL as the store key.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2453 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2454 # For each requested URL rewriter will receive on line with the format
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2455 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2456 # URL <SP> client_ip "/" fqdn <SP> user <SP> method <SP> urlgroup
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2457 # [<SP> kvpairs] <NL>
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2458 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2459 # In the future, the rewriter interface will be extended with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2460 # key=value pairs ("kvpairs" shown above). Rewriter programs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2461 # should be prepared to receive and possibly ignore additional
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2462 # whitespace-separated tokens on each input line.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2463 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2464 # And the rewriter may return a rewritten URL. The other components of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2465 # the request line does not need to be returned (ignored if they are).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2466 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2467 # By default, a Store URL rewriter is not used.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2468 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2469 # Please note - the normal URL rewriter rewrites Squid's _destination_
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2470 # URL - ie, what it fetches. The Store URL rewriter rewrites Squid's
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2471 # _store_ URL - ie, what it uses to store and retrieve objects.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2472 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2473 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2474 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2475
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2476 # TAG: storeurl_rewrite_children
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2477 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2478 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2479 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2480 # storeurl_rewrite_children 5
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2481
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2482 # TAG: storeurl_rewrite_concurrency
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2483 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2484 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2485 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2486 # storeurl_rewrite_concurrency 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2487
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2488 # TAG: url_rewrite_program
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2489 # Specify the location of the executable for the URL rewriter.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2490 # Since they can perform almost any function there isn't one included.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2491 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2492 # For each requested URL rewriter will receive on line with the format
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2493 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2494 # URL <SP> client_ip "/" fqdn <SP> user <SP> method <SP> urlgroup
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2495 # [<SP> kvpairs] <NL>
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2496 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2497 # In the future, the rewriter interface will be extended with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2498 # key=value pairs ("kvpairs" shown above). Rewriter programs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2499 # should be prepared to receive and possibly ignore additional
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2500 # whitespace-separated tokens on each input line.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2501 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2502 # And the rewriter may return a rewritten URL. The other components of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2503 # the request line does not need to be returned (ignored if they are).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2504 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2505 # The rewriter can also indicate that a client-side redirect should
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2506 # be performed to the new URL. This is done by prefixing the returned
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2507 # URL with "301:" (moved permanently) or 302: (moved temporarily).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2508 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2509 # It can also return a "urlgroup" that can subsequently be matched
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2510 # in cache_peer_access and similar ACL driven rules. An urlgroup is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2511 # returned by prefixing the returned URL with "!urlgroup!".
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2512 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2513 # By default, a URL rewriter is not used.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2514 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2515 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2516 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2517
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2518 # TAG: url_rewrite_children
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2519 # The number of redirector processes to spawn. If you start
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2520 # too few Squid will have to wait for them to process a backlog of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2521 # URLs, slowing it down. If you start too many they will use RAM
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2522 # and other system resources.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2523 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2524 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2525 # url_rewrite_children 5
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2526
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2527 # TAG: url_rewrite_concurrency
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2528 # The number of requests each redirector helper can handle in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2529 # parallel. Defaults to 0 which indicates the redirector
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2530 # is a old-style single threaded redirector.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2531 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2532 # When this directive is set to a value >= 1 then the protocol
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2533 # used to communicate with the helper is modified to include
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2534 # a request ID in front of the request/response. The request
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2535 # ID from the request must be echoed back with the response
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2536 # to that request.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2537 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2538 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2539 # url_rewrite_concurrency 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2540
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2541 # TAG: url_rewrite_host_header
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2542 # By default Squid rewrites any Host: header in redirected
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2543 # requests. If you are running an accelerator this may
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2544 # not be a wanted effect of a redirector.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2545 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2546 # WARNING: Entries are cached on the result of the URL rewriting
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2547 # process, so be careful if you have domain-virtual hosts.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2548 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2549 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2550 # url_rewrite_host_header on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2551
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2552 # TAG: url_rewrite_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2553 # If defined, this access list specifies which requests are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2554 # sent to the redirector processes. By default all requests
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2555 # are sent.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2556 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2557 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2558 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2559
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2560 # TAG: storeurl_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2561 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2562 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2563 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2564 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2565
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2566 # TAG: redirector_bypass
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2567 # When this is 'on', a request will not go through the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2568 # redirector if all redirectors are busy. If this is 'off'
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2569 # and the redirector queue grows too large, Squid will exit
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2570 # with a FATAL error and ask you to increase the number of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2571 # redirectors. You should only enable this if the redirectors
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2572 # are not critical to your caching system. If you use
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2573 # redirectors for access control, and you enable this option,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2574 # users may have access to pages they should not
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2575 # be allowed to request.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2576 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2577 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2578 # redirector_bypass off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2579
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2580 # TAG: location_rewrite_program
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2581 # Specify the location of the executable for the Location rewriter,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2582 # used to rewrite server generated redirects. Usually used in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2583 # conjunction with a url_rewrite_program
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2584 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2585 # For each Location header received the location rewriter will receive
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2586 # one line with the format:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2587 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2588 # location URL <SP> requested URL <SP> urlgroup <NL>
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2589 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2590 # And the rewriter may return a rewritten Location URL or a blank line.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2591 # The other components of the request line does not need to be returned
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2592 # (ignored if they are).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2593 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2594 # By default, a Location rewriter is not used.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2595 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2596 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2597 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2598
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2599 # TAG: location_rewrite_children
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2600 # The number of location rewriting processes to spawn. If you start
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2601 # too few Squid will have to wait for them to process a backlog of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2602 # URLs, slowing it down. If you start too many they will use RAM
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2603 # and other system resources.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2604 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2605 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2606 # location_rewrite_children 5
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2607
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2608 # TAG: location_rewrite_concurrency
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2609 # The number of requests each Location rewriter helper can handle in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2610 # parallel. Defaults to 0 which indicates that the helper
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2611 # is a old-style singlethreaded helper.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2612 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2613 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2614 # location_rewrite_concurrency 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2615
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2616 # TAG: location_rewrite_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2617 # If defined, this access list specifies which requests are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2618 # sent to the location rewriting processes. By default all Location
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2619 # headers are sent.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2620 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2621 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2622 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2623
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2624
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2625 # OPTIONS FOR TUNING THE CACHE
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2626 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2627
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2628 # TAG: cache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2629 # A list of ACL elements which, if matched, cause the request to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2630 # not be satisfied from the cache and the reply to not be cached.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2631 # In other words, use this to force certain objects to never be cached.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2632 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2633 # You must use the word 'DENY' to indicate the ACL names which should
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2634 # NOT be cached.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2635 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2636 # Default is to allow all to be cached.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2637 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2638 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2639 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2640
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2641 # TAG: max_stale time-units
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2642 # This option puts an upper limit on how stale content Squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2643 # will serve from the cache if cache validation fails.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2644 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2645 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2646 # max_stale 1 week
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2647
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2648 # TAG: refresh_pattern
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2649 # usage: refresh_pattern [-i] regex min percent max [options]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2650 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2651 # By default, regular expressions are CASE-SENSITIVE. To make
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2652 # them case-insensitive, use the -i option.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2653 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2654 # 'Min' is the time (in minutes) an object without an explicit
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2655 # expiry time should be considered fresh. The recommended
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2656 # value is 0, any higher values may cause dynamic applications
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2657 # to be erroneously cached unless the application designer
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2658 # has taken the appropriate actions.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2659 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2660 # 'Percent' is a percentage of the objects age (time since last
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2661 # modification age) an object without explicit expiry time
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2662 # will be considered fresh.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2663 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2664 # 'Max' is an upper limit on how long objects without an explicit
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2665 # expiry time will be considered fresh.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2666 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2667 # options: override-expire
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2668 # override-lastmod
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2669 # reload-into-ims
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2670 # ignore-reload
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2671 # ignore-no-cache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2672 # ignore-private
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2673 # ignore-auth
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2674 # stale-while-revalidate=NN
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2675 # ignore-stale-while-revalidate
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2676 # max-stale=NN
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2677 # negative-ttl=NN
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2678 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2679 # override-expire enforces min age even if the server
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2680 # sent an explicit expiry time (e.g., with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2681 # Expires: header or Cache-Control: max-age). Doing this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2682 # VIOLATES the HTTP standard. Enabling this feature
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2683 # could make you liable for problems which it causes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2684 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2685 # override-lastmod enforces min age even on objects
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2686 # that were modified recently.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2687 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2688 # reload-into-ims changes client no-cache or ``reload''
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2689 # to If-Modified-Since requests. Doing this VIOLATES the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2690 # HTTP standard. Enabling this feature could make you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2691 # liable for problems which it causes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2692 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2693 # ignore-reload ignores a client no-cache or ``reload''
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2694 # header. Doing this VIOLATES the HTTP standard. Enabling
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2695 # this feature could make you liable for problems which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2696 # it causes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2697 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2698 # ignore-no-cache ignores any ``Pragma: no-cache'' and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2699 # ``Cache-control: no-cache'' headers received from a server.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2700 # The HTTP RFC never allows the use of this (Pragma) header
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2701 # from a server, only a client, though plenty of servers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2702 # send it anyway.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2703 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2704 # ignore-private ignores any ``Cache-control: private''
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2705 # headers received from a server. Doing this VIOLATES
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2706 # the HTTP standard. Enabling this feature could make you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2707 # liable for problems which it causes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2708 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2709 # ignore-auth caches responses to requests with authorization,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2710 # as if the originserver had sent ``Cache-control: public''
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2711 # in the response header. Doing this VIOLATES the HTTP standard.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2712 # Enabling this feature could make you liable for problems which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2713 # it causes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2714 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2715 # stale-while-revalidate=NN makes Squid perform an asyncronous
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2716 # cache validation if the object isn't more stale than NN.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2717 # Doing this VIOLATES the HTTP standard. Enabling this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2718 # feature could make you liable for problems which it
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2719 # causes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2720 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2721 # ignore-stale-while-revalidate makes Squid ignore any 'Cache-Control:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2722 # stale-while-revalidate=NN' headers received from a server. Can be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2723 # combined with stale-while-revalidate=NN to override the server provided
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2724 # value.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2725 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2726 # max-stale=NN provided a maximum staleness factor. Squid won't
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2727 # serve objects more stale than this even if it failed to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2728 # validate the object.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2729 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2730 # negative-ttl=NN overrides the global negative_ttl parameter
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2731 # selectively for URLs matching this pattern (in seconds).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2732 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2733 # Basically a cached object is:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2734 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2735 # FRESH if expires < now, else STALE
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2736 # STALE if age > max
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2737 # FRESH if lm-factor < percent, else STALE
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2738 # FRESH if age < min
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2739 # else STALE
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2740 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2741 # The refresh_pattern lines are checked in the order listed here.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2742 # The first entry which matches is used. If none of the entries
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2743 # match the default will be used.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2744 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2745 # Note, you must uncomment all the default lines if you want
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2746 # to change one. The default setting is only active if none is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2747 # used.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2748 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2749 #Suggested default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2750 refresh_pattern ^ftp: 1440 20% 10080
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2751 refresh_pattern ^gopher: 1440 0% 1440
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2752 refresh_pattern -i (/cgi-bin/\|\?) 0 0% 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2753 refresh_pattern (Release\|Package(.gz)*)$ 0 20% 2880
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2754 refresh_pattern . 0 20% 4320
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2755
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2756 # TAG: quick_abort_min (KB)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2757 # TAG: quick_abort_max (KB)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2758 # TAG: quick_abort_pct (percent)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2759 # The cache by default continues downloading aborted requests
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2760 # which are almost completed (less than 16 KB remaining). This
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2761 # may be undesirable on slow (e.g. SLIP) links and/or very busy
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2762 # caches. Impatient users may tie up file descriptors and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2763 # bandwidth by repeatedly requesting and immediately aborting
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2764 # downloads.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2765 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2766 # When the user aborts a request, Squid will check the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2767 # quick_abort values to the amount of data transfered until
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2768 # then.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2769 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2770 # If the transfer has less than 'quick_abort_min' KB remaining,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2771 # it will finish the retrieval.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2772 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2773 # If the transfer has more than 'quick_abort_max' KB remaining,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2774 # it will abort the retrieval.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2775 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2776 # If more than 'quick_abort_pct' of the transfer has completed,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2777 # it will finish the retrieval.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2778 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2779 # If you do not want any retrieval to continue after the client
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2780 # has aborted, set both 'quick_abort_min' and 'quick_abort_max'
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2781 # to '0 KB'.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2782 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2783 # If you want retrievals to always continue if they are being
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2784 # cached set 'quick_abort_min' to '-1 KB'.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2785 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2786 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2787 # quick_abort_min 16 KB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2788 # quick_abort_max 16 KB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2789 # quick_abort_pct 95
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2790
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2791 # TAG: read_ahead_gap buffer-size
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2792 # The amount of data the cache will buffer ahead of what has been
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2793 # sent to the client when retrieving an object from another server.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2794 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2795 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2796 # read_ahead_gap 16 KB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2797
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2798 # TAG: negative_ttl time-units
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2799 # Time-to-Live (TTL) for failed requests. Certain types of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2800 # failures (such as "connection refused" and "404 Not Found") are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2801 # negatively-cached for a configurable amount of time. The
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2802 # default is 5 minutes. Note that this is different from
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2803 # negative caching of DNS lookups.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2804 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2805 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2806 # negative_ttl 5 minutes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2807
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2808 # TAG: positive_dns_ttl time-units
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2809 # Upper limit on how long Squid will cache positive DNS responses.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2810 # Default is 6 hours (360 minutes). This directive must be set
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2811 # larger than negative_dns_ttl.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2812 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2813 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2814 # positive_dns_ttl 6 hours
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2815
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2816 # TAG: negative_dns_ttl time-units
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2817 # Time-to-Live (TTL) for negative caching of failed DNS lookups.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2818 # This also sets the lower cache limit on positive lookups.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2819 # Minimum value is 1 second, and it is not recommendable to go
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2820 # much below 10 seconds.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2821 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2822 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2823 # negative_dns_ttl 1 minute
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2824
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2825 # TAG: range_offset_limit (bytes)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2826 # Sets a upper limit on how far into the the file a Range request
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2827 # may be to cause Squid to prefetch the whole file. If beyond this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2828 # limit Squid forwards the Range request as it is and the result
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2829 # is NOT cached.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2830 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2831 # This is to stop a far ahead range request (lets say start at 17MB)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2832 # from making Squid fetch the whole object up to that point before
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2833 # sending anything to the client.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2834 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2835 # A value of -1 causes Squid to always fetch the object from the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2836 # beginning so it may cache the result. (2.0 style)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2837 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2838 # A value of 0 causes Squid to never fetch more than the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2839 # client requested. (default)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2840 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2841 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2842 # range_offset_limit 0 KB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2843
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2844 # TAG: minimum_expiry_time (seconds)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2845 # The minimum caching time according to (Expires - Date)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2846 # Headers Squid honors if the object can't be revalidated
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2847 # defaults to 60 seconds. In reverse proxy enorinments it
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2848 # might be desirable to honor shorter object lifetimes. It
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2849 # is most likely better to make your server return a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2850 # meaningful Last-Modified header however.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2851 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2852 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2853 # minimum_expiry_time 60 seconds
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2854
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2855 # TAG: store_avg_object_size (kbytes)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2856 # Average object size, used to estimate number of objects your
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2857 # cache can hold. The default is 13 KB.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2858 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2859 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2860 # store_avg_object_size 13 KB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2861
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2862 # TAG: store_objects_per_bucket
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2863 # Target number of objects per bucket in the store hash table.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2864 # Lowering this value increases the total number of buckets and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2865 # also the storage maintenance rate. The default is 20.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2866 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2867 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2868 # store_objects_per_bucket 20
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2869
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2870
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2871 # HTTP OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2872 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2873
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2874 # TAG: request_header_max_size (KB)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2875 # This specifies the maximum size for HTTP headers in a request.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2876 # Request headers are usually relatively small (about 512 bytes).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2877 # Placing a limit on the request header size will catch certain
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2878 # bugs (for example with persistent connections) and possibly
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2879 # buffer-overflow or denial-of-service attacks.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2880 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2881 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2882 # request_header_max_size 20 KB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2883
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2884 # TAG: reply_header_max_size (KB)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2885 # This specifies the maximum size for HTTP headers in a reply.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2886 # Reply headers are usually relatively small (about 512 bytes).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2887 # Placing a limit on the reply header size will catch certain
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2888 # bugs (for example with persistent connections) and possibly
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2889 # buffer-overflow or denial-of-service attacks.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2890 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2891 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2892 # reply_header_max_size 20 KB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2893
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2894 # TAG: request_body_max_size (KB)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2895 # This specifies the maximum size for an HTTP request body.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2896 # In other words, the maximum size of a PUT/POST request.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2897 # A user who attempts to send a request with a body larger
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2898 # than this limit receives an "Invalid Request" error message.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2899 # If you set this parameter to a zero (the default), there will
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2900 # be no limit imposed.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2901 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2902 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2903 # request_body_max_size 0 KB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2904
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2905 # TAG: broken_posts
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2906 # A list of ACL elements which, if matched, causes Squid to send
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2907 # an extra CRLF pair after the body of a PUT/POST request.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2908 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2909 # Some HTTP servers has broken implementations of PUT/POST,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2910 # and rely on an extra CRLF pair sent by some WWW clients.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2911 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2912 # Quote from RFC2616 section 4.1 on this matter:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2913 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2914 # Note: certain buggy HTTP/1.0 client implementations generate an
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2915 # extra CRLF's after a POST request. To restate what is explicitly
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2916 # forbidden by the BNF, an HTTP/1.1 client must not preface or follow
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2917 # a request with an extra CRLF.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2918 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2919 #Example:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2920 # acl buggy_server url_regex ^http://....
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2921 # broken_posts allow buggy_server
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2922 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2923 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2924 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2925
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2926 # TAG: upgrade_http0.9
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2927 # This access list controls when HTTP/0.9 responses is upgraded
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2928 # to our current HTTP version. The default is to always upgrade.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2929 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2930 # Some applications expect to be able to respond with non-HTTP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2931 # responses and clients gets confused if the response is upgraded.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2932 # For example SHOUTcast servers used for mp3 streaming.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2933 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2934 # To enable some flexibility in detection of such applications
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2935 # the first line of the response is available in the internal header
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2936 # X-HTTP09-First-Line for use in the rep_header acl.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2937 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2938 # Don't upgrade ShoutCast responses to HTTP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2939 acl shoutcast rep_header X-HTTP09-First-Line ^ICY\s[0-9]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2940 upgrade_http0.9 deny shoutcast
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2941
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2942 # TAG: via on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2943 # If set (default), Squid will include a Via header in requests and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2944 # replies as required by RFC2616.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2945 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2946 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2947 # via on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2948
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2949 # TAG: cache_vary
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2950 # When 'cache_vary' is set to off, response that have a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2951 # Vary header will not be stored in the cache.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2952 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2953 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2954 # cache_vary on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2955
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2956 # TAG: broken_vary_encoding
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2957 # Many servers have broken support for on-the-fly Content-Encoding,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2958 # returning the same ETag on both plain and gzip:ed variants.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2959 # Vary replies matching this access list will have the cache split
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2960 # on the Accept-Encoding header of the request and not trusting the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2961 # ETag to be unique.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2962 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2963 # Apache mod_gzip and mod_deflate known to be broken so don't trust
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2964 # Apache to signal ETag correctly on such responses
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2965 acl apache rep_header Server ^Apache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2966 broken_vary_encoding allow apache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2967
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2968 # TAG: collapsed_forwarding (on\|off)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2969 # This option enables multiple requests for the same URI to be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2970 # processed as one request. Normally disabled to avoid increased
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2971 # latency on dynamic content, but there can be benefit from enabling
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2972 # this in accelerator setups where the web servers are the bottleneck
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2973 # and reliable and returns mostly cacheable information.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2974 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2975 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2976 # collapsed_forwarding off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2977
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2978 # TAG: refresh_stale_hit (time)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2979 # This option changes the refresh algorithm to allow concurrent
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2980 # requests while an object is being refreshed to be processed as
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2981 # cache hits if the object expired less than X seconds ago. Default
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2982 # is 0 to disable this feature. This option is mostly interesting
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2983 # in accelerator setups where a few objects is accessed very
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2984 # frequently.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2985 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2986 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2987 # refresh_stale_hit 0 seconds
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2988
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2989 # TAG: ie_refresh on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2990 # Microsoft Internet Explorer up until version 5.5 Service
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2991 # Pack 1 has an issue with transparent proxies, wherein it
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2992 # is impossible to force a refresh. Turning this on provides
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2993 # a partial fix to the problem, by causing all IMS-REFRESH
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2994 # requests from older IE versions to check the origin server
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2995 # for fresh content. This reduces hit ratio by some amount
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2996 # (~10% in my experience), but allows users to actually get
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2997 # fresh content when they want it. Note because Squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2998 # cannot tell if the user is using 5.5 or 5.5SP1, the behavior
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	2999 # of 5.5 is unchanged from old versions of Squid (i.e. a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3000 # forced refresh is impossible). Newer versions of IE will,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3001 # hopefully, continue to have the new behavior and will be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3002 # handled based on that assumption. This option defaults to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3003 # the old Squid behavior, which is better for hit ratios but
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3004 # worse for clients using IE, if they need to be able to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3005 # force fresh content.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3006 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3007 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3008 # ie_refresh off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3009
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3010 # TAG: vary_ignore_expire on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3011 # Many HTTP servers supporting Vary gives such objects
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3012 # immediate expiry time with no cache-control header
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3013 # when requested by a HTTP/1.0 client. This option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3014 # enables Squid to ignore such expiry times until
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3015 # HTTP/1.1 is fully implemented.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3016 # WARNING: This may eventually cause some varying
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3017 # objects not intended for caching to get cached.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3018 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3019 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3020 # vary_ignore_expire off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3021
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3022 # TAG: extension_methods
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3023 # Squid only knows about standardized HTTP request methods.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3024 # You can add up to 20 additional "extension" methods here.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3025 extension_methods REPORT MERGE MKACTIVITY CHECKOUT
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3026
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3027 # TAG: request_entities
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3028 # Squid defaults to deny GET and HEAD requests with request entities,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3029 # as the meaning of such requests are undefined in the HTTP standard
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3030 # even if not explicitly forbidden.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3031 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3032 # Set this directive to on if you have clients which insists
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3033 # on sending request entities in GET or HEAD requests. But be warned
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3034 # that there is server software (both proxies and web servers) which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3035 # can fail to properly process this kind of request which may make you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3036 # vulnerable to cache pollution attacks if enabled.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3037 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3038 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3039 # request_entities off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3040
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3041 # TAG: header_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3042 # Usage: header_access header_name allow\|deny [!]aclname ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3043 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3044 # WARNING: Doing this VIOLATES the HTTP standard. Enabling
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3045 # this feature could make you liable for problems which it
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3046 # causes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3047 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3048 # This option replaces the old 'anonymize_headers' and the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3049 # older 'http_anonymizer' option with something that is much
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3050 # more configurable. This new method creates a list of ACLs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3051 # for each header, allowing you very fine-tuned header
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3052 # mangling.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3053 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3054 # You can only specify known headers for the header name.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3055 # Other headers are reclassified as 'Other'. You can also
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3056 # refer to all the headers with 'All'.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3057 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3058 # For example, to achieve the same behavior as the old
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3059 # 'http_anonymizer standard' option, you should use:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3060 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3061 # header_access From deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3062 # header_access Referer deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3063 # header_access Server deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3064 # header_access User-Agent deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3065 # header_access WWW-Authenticate deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3066 # header_access Link deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3067 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3068 # Or, to reproduce the old 'http_anonymizer paranoid' feature
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3069 # you should use:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3070 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3071 # header_access Allow allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3072 # header_access Authorization allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3073 # header_access WWW-Authenticate allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3074 # header_access Proxy-Authorization allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3075 # header_access Proxy-Authenticate allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3076 # header_access Cache-Control allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3077 # header_access Content-Encoding allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3078 # header_access Content-Length allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3079 # header_access Content-Type allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3080 # header_access Date allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3081 # header_access Expires allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3082 # header_access Host allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3083 # header_access If-Modified-Since allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3084 # header_access Last-Modified allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3085 # header_access Location allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3086 # header_access Pragma allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3087 # header_access Accept allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3088 # header_access Accept-Charset allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3089 # header_access Accept-Encoding allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3090 # header_access Accept-Language allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3091 # header_access Content-Language allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3092 # header_access Mime-Version allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3093 # header_access Retry-After allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3094 # header_access Title allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3095 # header_access Connection allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3096 # header_access Proxy-Connection allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3097 # header_access All deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3098 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3099 # By default, all headers are allowed (no anonymizing is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3100 # performed).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3101 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3102 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3103 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3104
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3105 # TAG: header_replace
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3106 # Usage: header_replace header_name message
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3107 # Example: header_replace User-Agent Nutscrape/1.0 (CP/M; 8-bit)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3108 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3109 # This option allows you to change the contents of headers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3110 # denied with header_access above, by replacing them with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3111 # some fixed string. This replaces the old fake_user_agent
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3112 # option.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3113 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3114 # By default, headers are removed if denied.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3115 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3116 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3117 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3118
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3119 # TAG: relaxed_header_parser on\|off\|warn
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3120 # In the default "on" setting Squid accepts certain forms
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3121 # of non-compliant HTTP messages where it is unambiguous
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3122 # what the sending application intended even if the message
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3123 # is not correctly formatted. The messages is then normalized
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3124 # to the correct form when forwarded by Squid.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3125 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3126 # If set to "warn" then a warning will be emitted in cache.log
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3127 # each time such HTTP error is encountered.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3128 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3129 # If set to "off" then such HTTP errors will cause the request
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3130 # or response to be rejected.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3131 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3132 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3133 # relaxed_header_parser on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3134
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3135 # TAG: server_http11 on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3136 # This option enables the use ot HTTP/1.1 on outgoing "direct" requests.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3137 # See also the http11 cache_peer option.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3138 # Note: The HTTP/1.1 support is still incomplete, with an
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3139 # internal HTTP/1.0 hop. As result 1xx responses will not
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3140 # be forwarded.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3141 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3142 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3143 # server_http11 off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3144
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3145 # TAG: ignore_expect_100 on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3146 # This option makes Squid ignore any Expect: 100-continue header present
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3147 # in the request.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3148 # Note: Enabling this is a HTTP protocol violation, but some client may
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3149 # not handle it well..
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3150 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3151 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3152 # ignore_expect_100 off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3153
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3154 # TAG: external_refresh_check
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3155 # This option defines an external helper for determining whether to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3156 # refresh a stale response. It will be called when Squid receives a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3157 # request for a cached response that is stale; the helper can either
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3158 # confirm that the response is stale with a STALE response, or
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3159 # extend the freshness of the response (thereby avoiding a refresh
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3160 # check) with a FRESH response, along with a freshness=nnn keyword.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3161 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3162 # external_refresh_check [options] FORMAT.. /path/to/helper [helper_args]
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3163 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3164 # If present, helper_args will be passed to the helper on the command
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3165 # line verbatim.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3166 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3167 # Options:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3168 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3169 # children=n Number of processes to spawn to service external
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3170 # refresh checks (default 5).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3171 # concurrency=n Concurrency level per process. Only used with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3172 # helpers capable of processing more than one query
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3173 # at a time.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3174 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3175 # When using the concurrency option, the protocol is changed by introducing
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3176 # a query channel tag infront of the request/response. The query channel
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3177 # tag is a number between 0 and concurrency???1.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3178 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3179 # FORMAT specifications:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3180 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3181 # %CACHE_URI The URI of the cached response
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3182 # %RES{Header} HTTP response header value
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3183 # %AGE The age of the cached response
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3184 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3185 # The request sent to the helper consists of the data in the format
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3186 # specification in the order specified.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3187 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3188 # The helper receives lines per the above format specification, and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3189 # returns lines starting with OK or ERR indicating the validity of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3190 # the request and optionally followed by additional keywords with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3191 # more details. URL escaping is used to protect each value in both
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3192 # requests and responses.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3193 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3194 # General result syntax:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3195 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3196 # FRESH / STALE keyword=value ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3197 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3198 # Defined keywords:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3199 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3200 # freshness=nnn The number of seconds to extend the freshness of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3201 # the response by.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3202 # log=string String to be logged in access.log. Available as
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3203 # %ef in logformat specifications.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3204 # res{Header}=value
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3205 # Value to update response headers with. If already
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3206 # present, the supplied value completely replaces
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3207 # the cached value.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3208 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3209 # In the event of a helper???related error (e.g., overload), Squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3210 # will always default to STALE.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3211 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3212 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3213 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3214
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3215
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3216 # TIMEOUTS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3217 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3218
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3219 # TAG: forward_timeout time-units
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3220 # This parameter specifies how long Squid should at most attempt in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3221 # finding a forwarding path for the request before giving up.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3222 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3223 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3224 # forward_timeout 4 minutes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3225
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3226 # TAG: connect_timeout time-units
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3227 # This parameter specifies how long to wait for the TCP connect to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3228 # the requested server or peer to complete before Squid should
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3229 # attempt to find another path where to forward the request.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3230 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3231 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3232 # connect_timeout 1 minute
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3233
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3234 # TAG: peer_connect_timeout time-units
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3235 # This parameter specifies how long to wait for a pending TCP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3236 # connection to a peer cache. The default is 30 seconds. You
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3237 # may also set different timeout values for individual neighbors
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3238 # with the 'connect-timeout' option on a 'cache_peer' line.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3239 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3240 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3241 # peer_connect_timeout 30 seconds
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3242
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3243 # TAG: read_timeout time-units
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3244 # The read_timeout is applied on server-side connections. After
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3245 # each successful read(), the timeout will be extended by this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3246 # amount. If no data is read again after this amount of time,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3247 # the request is aborted and logged with ERR_READ_TIMEOUT. The
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3248 # default is 15 minutes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3249 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3250 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3251 # read_timeout 15 minutes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3252
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3253 # TAG: request_timeout
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3254 # How long to wait for an HTTP request after initial
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3255 # connection establishment.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3256 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3257 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3258 # request_timeout 5 minutes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3259
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3260 # TAG: persistent_request_timeout
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3261 # How long to wait for the next HTTP request on a persistent
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3262 # connection after the previous request completes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3263 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3264 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3265 # persistent_request_timeout 2 minutes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3266
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3267 # TAG: client_lifetime time-units
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3268 # The maximum amount of time a client (browser) is allowed to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3269 # remain connected to the cache process. This protects the Cache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3270 # from having a lot of sockets (and hence file descriptors) tied up
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3271 # in a CLOSE_WAIT state from remote clients that go away without
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3272 # properly shutting down (either because of a network failure or
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3273 # because of a poor client implementation). The default is one
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3274 # day, 1440 minutes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3275 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3276 # NOTE: The default value is intended to be much larger than any
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3277 # client would ever need to be connected to your cache. You
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3278 # should probably change client_lifetime only as a last resort.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3279 # If you seem to have many client connections tying up
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3280 # filedescriptors, we recommend first tuning the read_timeout,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3281 # request_timeout, persistent_request_timeout and quick_abort values.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3282 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3283 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3284 # client_lifetime 1 day
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3285
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3286 # TAG: half_closed_clients
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3287 # Some clients may shutdown the sending side of their TCP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3288 # connections, while leaving their receiving sides open. Sometimes,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3289 # Squid can not tell the difference between a half-closed and a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3290 # fully-closed TCP connection. By default, half-closed client
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3291 # connections are kept open until a read(2) or write(2) on the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3292 # socket returns an error. Change this option to 'off' and Squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3293 # will immediately close client connections when read(2) returns
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3294 # "no more data to read."
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3295 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3296 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3297 # half_closed_clients on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3298
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3299 # TAG: pconn_timeout
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3300 # Timeout for idle persistent connections to servers and other
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3301 # proxies.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3302 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3303 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3304 # pconn_timeout 1 minute
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3305
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3306 # TAG: ident_timeout
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3307 # Maximum time to wait for IDENT lookups to complete.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3308 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3309 # If this is too high, and you enabled IDENT lookups from untrusted
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3310 # users, you might be susceptible to denial-of-service by having
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3311 # many ident requests going at once.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3312 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3313 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3314 # ident_timeout 10 seconds
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3315
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3316 # TAG: shutdown_lifetime time-units
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3317 # When SIGTERM or SIGHUP is received, the cache is put into
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3318 # "shutdown pending" mode until all active sockets are closed.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3319 # This value is the lifetime to set for all open descriptors
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3320 # during shutdown mode. Any active clients after this many
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3321 # seconds will receive a 'timeout' message.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3322 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3323 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3324 # shutdown_lifetime 30 seconds
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3325
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3326
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3327 # ADMINISTRATIVE PARAMETERS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3328 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3329
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3330 # TAG: cache_mgr
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3331 # Email-address of local cache manager who will receive
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3332 # mail if the cache dies. The default is "webmaster".
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3333 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3334 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3335 # cache_mgr webmaster
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3336
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3337 # TAG: mail_from
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3338 # From: email-address for mail sent when the cache dies.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3339 # The default is to use 'appname@unique_hostname'.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3340 # Default appname value is "squid", can be changed into
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3341 # src/globals.h before building squid.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3342 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3343 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3344 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3345
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3346 # TAG: mail_program
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3347 # Email program used to send mail if the cache dies.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3348 # The default is "mail". The specified program must comply
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3349 # with the standard Unix mail syntax:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3350 # mail-program recipient < mailfile
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3351 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3352 # Optional command line options can be specified.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3353 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3354 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3355 # mail_program mail
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3356
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3357 # TAG: cache_effective_user
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3358 # If you start Squid as root, it will change its effective/real
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3359 # UID/GID to the user specified below. The default is to change
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3360 # to UID to proxy. If you define cache_effective_user, but not
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3361 # cache_effective_group, Squid sets the GID to the effective
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3362 # user's default group ID (taken from the password file) and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3363 # supplementary group list from the from groups membership of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3364 # cache_effective_user.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3365 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3366 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3367 # cache_effective_user proxy
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3368
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3369 # TAG: cache_effective_group
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3370 # If you want Squid to run with a specific GID regardless of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3371 # the group memberships of the effective user then set this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3372 # to the group (or GID) you want Squid to run as. When set
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3373 # all other group privileges of the effective user is ignored
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3374 # and only this GID is effective. If Squid is not started as
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3375 # root the user starting Squid must be member of the specified
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3376 # group.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3377 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3378 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3379 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3380
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3381 # TAG: httpd_suppress_version_string on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3382 # Suppress Squid version string info in HTTP headers and HTML error pages.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3383 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3384 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3385 # httpd_suppress_version_string off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3386
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3387 # TAG: visible_hostname
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3388 # If you want to present a special hostname in error messages, etc,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3389 # define this. Otherwise, the return value of gethostname()
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3390 # will be used. If you have multiple caches in a cluster and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3391 # get errors about IP-forwarding you must set them to have individual
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3392 # names with this setting.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3393 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3394 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3395 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3396
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3397 # TAG: unique_hostname
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3398 # If you want to have multiple machines with the same
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3399 # 'visible_hostname' you must give each machine a different
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3400 # 'unique_hostname' so forwarding loops can be detected.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3401 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3402 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3403 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3404
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3405 # TAG: hostname_aliases
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3406 # A list of other DNS names your cache has.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3407 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3408 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3409 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3410
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3411 # TAG: umask
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3412 # Minimum umask which should be enforced while the proxy
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3413 # is running, in addition to the umask set at startup.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3414 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3415 # Note: Should start with a 0 to indicate the normal octal
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3416 # representation of umasks
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3417 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3418 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3419 # umask 027
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3420
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3421
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3422 # OPTIONS FOR THE CACHE REGISTRATION SERVICE
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3423 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3424 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3425 # This section contains parameters for the (optional) cache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3426 # announcement service. This service is provided to help
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3427 # cache administrators locate one another in order to join or
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3428 # create cache hierarchies.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3429 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3430 # An 'announcement' message is sent (via UDP) to the registration
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3431 # service by Squid. By default, the announcement message is NOT
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3432 # SENT unless you enable it with 'announce_period' below.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3433 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3434 # The announcement message includes your hostname, plus the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3435 # following information from this configuration file:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3436 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3437 # http_port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3438 # icp_port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3439 # cache_mgr
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3440 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3441 # All current information is processed regularly and made
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3442 # available on the Web at http://www.ircache.net/Cache/Tracker/.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3443
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3444 # TAG: announce_period
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3445 # This is how frequently to send cache announcements. The
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3446 # default is `0' which disables sending the announcement
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3447 # messages.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3448 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3449 # To enable announcing your cache, just uncomment the line
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3450 # below.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3451 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3452 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3453 # announce_period 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3454 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3455 #To enable announcing your cache, just uncomment the line below.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3456 #announce_period 1 day
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3457
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3458 # TAG: announce_host
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3459 # TAG: announce_file
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3460 # TAG: announce_port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3461 # announce_host and announce_port set the hostname and port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3462 # number where the registration message will be sent.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3463 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3464 # Hostname will default to 'tracker.ircache.net' and port will
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3465 # default default to 3131. If the 'filename' argument is given,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3466 # the contents of that file will be included in the announce
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3467 # message.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3468 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3469 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3470 # announce_host tracker.ircache.net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3471 # announce_port 3131
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3472
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3473
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3474 # HTTPD-ACCELERATOR OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3475 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3476
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3477 # TAG: httpd_accel_no_pmtu_disc on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3478 # In many setups of transparently intercepting proxies Path-MTU
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3479 # discovery can not work on traffic towards the clients. This is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3480 # the case when the intercepting device does not fully track
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3481 # connections and fails to forward ICMP must fragment messages
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3482 # to the cache server.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3483 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3484 # If you have such setup and experience that certain clients
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3485 # sporadically hang or never complete requests set this to on.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3486 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3487 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3488 # httpd_accel_no_pmtu_disc off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3489
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3490
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3491 # DELAY POOL PARAMETERS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3492 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3493
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3494 # TAG: delay_pools
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3495 # This represents the number of delay pools to be used. For example,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3496 # if you have one class 2 delay pool and one class 3 delays pool, you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3497 # have a total of 2 delay pools.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3498 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3499 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3500 # delay_pools 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3501
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3502 # TAG: delay_class
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3503 # This defines the class of each delay pool. There must be exactly one
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3504 # delay_class line for each delay pool. For example, to define two
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3505 # delay pools, one of class 2 and one of class 3, the settings above
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3506 # and here would be:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3507 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3508 #Example:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3509 # delay_pools 2 # 2 delay pools
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3510 # delay_class 1 2 # pool 1 is a class 2 pool
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3511 # delay_class 2 3 # pool 2 is a class 3 pool
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3512 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3513 # The delay pool classes are:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3514 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3515 # class 1 Everything is limited by a single aggregate
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3516 # bucket.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3517 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3518 # class 2 Everything is limited by a single aggregate
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3519 # bucket as well as an "individual" bucket chosen
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3520 # from bits 25 through 32 of the IP address.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3521 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3522 # class 3 Everything is limited by a single aggregate
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3523 # bucket as well as a "network" bucket chosen
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3524 # from bits 17 through 24 of the IP address and a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3525 # "individual" bucket chosen from bits 17 through
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3526 # 32 of the IP address.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3527 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3528 # NOTE: If an IP address is a.b.c.d
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3529 # -> bits 25 through 32 are "d"
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3530 # -> bits 17 through 24 are "c"
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3531 # -> bits 17 through 32 are "c * 256 + d"
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3532 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3533 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3534 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3535
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3536 # TAG: delay_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3537 # This is used to determine which delay pool a request falls into.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3538 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3539 # delay_access is sorted per pool and the matching starts with pool 1,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3540 # then pool 2, ..., and finally pool N. The first delay pool where the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3541 # request is allowed is selected for the request. If it does not allow
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3542 # the request to any pool then the request is not delayed (default).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3543 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3544 # For example, if you want some_big_clients in delay
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3545 # pool 1 and lotsa_little_clients in delay pool 2:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3546 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3547 #Example:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3548 # delay_access 1 allow some_big_clients
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3549 # delay_access 1 deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3550 # delay_access 2 allow lotsa_little_clients
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3551 # delay_access 2 deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3552 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3553 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3554 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3555
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3556 # TAG: delay_parameters
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3557 # This defines the parameters for a delay pool. Each delay pool has
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3558 # a number of "buckets" associated with it, as explained in the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3559 # description of delay_class. For a class 1 delay pool, the syntax is:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3560 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3561 #delay_parameters pool aggregate
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3562 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3563 # For a class 2 delay pool:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3564 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3565 #delay_parameters pool aggregate individual
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3566 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3567 # For a class 3 delay pool:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3568 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3569 #delay_parameters pool aggregate network individual
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3570 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3571 # The variables here are:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3572 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3573 # pool a pool number - ie, a number between 1 and the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3574 # number specified in delay_pools as used in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3575 # delay_class lines.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3576 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3577 # aggregate the "delay parameters" for the aggregate bucket
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3578 # (class 1, 2, 3).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3579 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3580 # individual the "delay parameters" for the individual
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3581 # buckets (class 2, 3).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3582 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3583 # network the "delay parameters" for the network buckets
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3584 # (class 3).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3585 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3586 # A pair of delay parameters is written restore/maximum, where restore is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3587 # the number of bytes (not bits - modem and network speeds are usually
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3588 # quoted in bits) per second placed into the bucket, and maximum is the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3589 # maximum number of bytes which can be in the bucket at any time.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3590 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3591 # For example, if delay pool number 1 is a class 2 delay pool as in the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3592 # above example, and is being used to strictly limit each host to 64kbps
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3593 # (plus overheads), with no overall limit, the line is:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3594 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3595 #delay_parameters 1 -1/-1 8000/8000
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3596 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3597 # Note that the figure -1 is used to represent "unlimited".
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3598 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3599 # And, if delay pool number 2 is a class 3 delay pool as in the above
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3600 # example, and you want to limit it to a total of 256kbps (strict limit)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3601 # with each 8-bit network permitted 64kbps (strict limit) and each
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3602 # individual host permitted 4800bps with a bucket maximum size of 64kb
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3603 # to permit a decent web page to be downloaded at a decent speed
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3604 # (if the network is not being limited due to overuse) but slow down
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3605 # large downloads more significantly:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3606 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3607 #delay_parameters 2 32000/32000 8000/8000 600/8000
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3608 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3609 # There must be one delay_parameters line for each delay pool.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3610 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3611 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3612 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3613
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3614 # TAG: delay_initial_bucket_level (percent, 0-100)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3615 # The initial bucket percentage is used to determine how much is put
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3616 # in each bucket when squid starts, is reconfigured, or first notices
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3617 # a host accessing it (in class 2 and class 3, individual hosts and
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3618 # networks only have buckets associated with them once they have been
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3619 # "seen" by squid).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3620 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3621 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3622 # delay_initial_bucket_level 50
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3623
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3624
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3625 # WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3626 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3627
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3628 # TAG: wccp_router
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3629 # TAG: wccp2_router
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3630 # Use this option to define your WCCP ``home'' router for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3631 # Squid.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3632 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3633 # wccp_router supports a single WCCP(v1) router
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3634 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3635 # wccp2_router supports multiple WCCPv2 routers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3636 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3637 # only one of the two may be used at the same time and defines
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3638 # which version of WCCP to use.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3639 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3640 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3641 # wccp_router 0.0.0.0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3642
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3643 # TAG: wccp_version
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3644 # This directive is only relevant if you need to set up WCCP(v1)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3645 # to some very old and end-of-life Cisco routers. In all other
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3646 # setups it must be left unset or at the default setting.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3647 # It defines an internal version in the WCCP(v1) protocol,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3648 # with version 4 being the officially documented protocol.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3649 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3650 # According to some users, Cisco IOS 11.2 and earlier only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3651 # support WCCP version 3. If you're using that or an earlier
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3652 # version of IOS, you may need to change this value to 3, otherwise
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3653 # do not specify this parameter.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3654 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3655 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3656 # wccp_version 4
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3657
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3658 # TAG: wccp2_rebuild_wait
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3659 # If this is enabled Squid will wait for the cache dir rebuild to finish
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3660 # before sending the first wccp2 HereIAm packet
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3661 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3662 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3663 # wccp2_rebuild_wait on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3664
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3665 # TAG: wccp2_forwarding_method
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3666 # WCCP2 allows the setting of forwarding methods between the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3667 # router/switch and the cache. Valid values are as follows:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3668 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3669 # 1 - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3670 # 2 - L2 redirect (forward the packet using Layer 2/MAC rewriting)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3671 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3672 # Currently (as of IOS 12.4) cisco routers only support GRE.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3673 # Cisco switches only support the L2 redirect assignment method.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3674 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3675 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3676 # wccp2_forwarding_method 1
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3677
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3678 # TAG: wccp2_return_method
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3679 # WCCP2 allows the setting of return methods between the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3680 # router/switch and the cache for packets that the cache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3681 # decides not to handle. Valid values are as follows:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3682 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3683 # 1 - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3684 # 2 - L2 redirect (forward the packet using Layer 2/MAC rewriting)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3685 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3686 # Currently (as of IOS 12.4) cisco routers only support GRE.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3687 # Cisco switches only support the L2 redirect assignment.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3688 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3689 # If the "ip wccp redirect exclude in" command has been
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3690 # enabled on the cache interface, then it is still safe for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3691 # the proxy server to use a l2 redirect method even if this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3692 # option is set to GRE.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3693 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3694 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3695 # wccp2_return_method 1
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3696
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3697 # TAG: wccp2_assignment_method
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3698 # WCCP2 allows the setting of methods to assign the WCCP hash
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3699 # Valid values are as follows:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3700 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3701 # 1 - Hash assignment
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3702 # 2 - Mask assignment
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3703 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3704 # As a general rule, cisco routers support the hash assignment method
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3705 # and cisco switches support the mask assignment method.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3706 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3707 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3708 # wccp2_assignment_method 1
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3709
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3710 # TAG: wccp2_service
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3711 # WCCP2 allows for multiple traffic services. There are two
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3712 # types: "standard" and "dynamic". The standard type defines
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3713 # one service id - http (id 0). The dynamic service ids can be from
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3714 # 51 to 255 inclusive. In order to use a dynamic service id
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3715 # one must define the type of traffic to be redirected; this is done
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3716 # using the wccp2_service_info option.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3717 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3718 # The "standard" type does not require a wccp2_service_info option,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3719 # just specifying the service id will suffice.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3720 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3721 # MD5 service authentication can be enabled by adding
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3722 # "password=<password>" to the end of this service declaration.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3723 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3724 # Examples:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3725 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3726 # wccp2_service standard 0 # for the 'web-cache' standard service
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3727 # wccp2_service dynamic 80 # a dynamic service type which will be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3728 # # fleshed out with subsequent options.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3729 # wccp2_service standard 0 password=foo
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3730 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3731 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3732 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3733 # wccp2_service standard 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3734
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3735 # TAG: wccp2_service_info
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3736 # Dynamic WCCPv2 services require further information to define the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3737 # traffic you wish to have diverted.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3738 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3739 # The format is:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3740 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3741 # wccp2_service_info <id> protocol=<protocol> flags=<flag>,<flag>..
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3742 # priority=<priority> ports=<port>,<port>..
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3743 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3744 # The relevant WCCPv2 flags:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3745 # + src_ip_hash, dst_ip_hash
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3746 # + source_port_hash, dst_port_hash
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3747 # + src_ip_alt_hash, dst_ip_alt_hash
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3748 # + src_port_alt_hash, dst_port_alt_hash
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3749 # + ports_source
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3750 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3751 # The port list can be one to eight entries.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3752 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3753 # Example:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3754 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3755 # wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3756 # priority=240 ports=80
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3757 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3758 # Note: the service id must have been defined by a previous
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3759 # 'wccp2_service dynamic <id>' entry.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3760 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3761 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3762 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3763
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3764 # TAG: wccp2_weight
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3765 # Each cache server gets assigned a set of the destination
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3766 # hash proportional to their weight.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3767 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3768 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3769 # wccp2_weight 10000
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3770
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3771 # TAG: wccp_address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3772 # TAG: wccp2_address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3773 # Use this option if you require WCCP to use a specific
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3774 # interface address.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3775 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3776 # The default behavior is to not bind to any specific address.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3777 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3778 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3779 # wccp_address 0.0.0.0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3780 # wccp2_address 0.0.0.0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3781
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3782
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3783 # PERSISTENT CONNECTION HANDLING
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3784 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3785 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3786 # Also see "pconn_timeout" in the TIMEOUTS section
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3787
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3788 # TAG: client_persistent_connections
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3789 # TAG: server_persistent_connections
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3790 # Persistent connection support for clients and servers. By
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3791 # default, Squid uses persistent connections (when allowed)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3792 # with its clients and servers. You can use these options to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3793 # disable persistent connections with clients and/or servers.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3794 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3795 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3796 # client_persistent_connections on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3797 # server_persistent_connections on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3798
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3799 # TAG: persistent_connection_after_error
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3800 # With this directive the use of persistent connections after
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3801 # HTTP errors can be disabled. Useful if you have clients
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3802 # who fail to handle errors on persistent connections proper.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3803 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3804 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3805 # persistent_connection_after_error off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3806
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3807 # TAG: detect_broken_pconn
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3808 # Some servers have been found to incorrectly signal the use
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3809 # of HTTP/1.0 persistent connections even on replies not
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3810 # compatible, causing significant delays. This server problem
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3811 # has mostly been seen on redirects.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3812 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3813 # By enabling this directive Squid attempts to detect such
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3814 # broken replies and automatically assume the reply is finished
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3815 # after 10 seconds timeout.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3816 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3817 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3818 # detect_broken_pconn off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3819
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3820
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3821 # CACHE DIGEST OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3822 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3823
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3824 # TAG: digest_generation
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3825 # This controls whether the server will generate a Cache Digest
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3826 # of its contents.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3827 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3828 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3829 # digest_generation on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3830
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3831 # TAG: digest_bits_per_entry
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3832 # This is the number of bits of the server's Cache Digest which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3833 # will be associated with the Digest entry for a given HTTP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3834 # Method and URL (public key) combination. The default is 5.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3835 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3836 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3837 # digest_bits_per_entry 5
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3838
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3839 # TAG: digest_rebuild_period (seconds)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3840 # This is the wait time between Cache Digest rebuilds.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3841 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3842 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3843 # digest_rebuild_period 1 hour
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3844
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3845 # TAG: digest_rewrite_period (seconds)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3846 # This is the wait time between Cache Digest writes to disk.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3847 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3848 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3849 # digest_rewrite_period 1 hour
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3850
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3851 # TAG: digest_swapout_chunk_size (bytes)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3852 # This is the number of bytes of the Cache Digest to write to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3853 # disk at a time. It defaults to 4096 bytes (4KB), the Squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3854 # default swap page.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3855 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3856 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3857 # digest_swapout_chunk_size 4096 bytes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3858
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3859 # TAG: digest_rebuild_chunk_percentage (percent, 0-100)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3860 # This is the percentage of the Cache Digest to be scanned at a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3861 # time. By default it is set to 10% of the Cache Digest.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3862 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3863 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3864 # digest_rebuild_chunk_percentage 10
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3865
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3866
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3867 # SNMP OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3868 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3869
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3870 # TAG: snmp_port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3871 # Squid can now serve statistics and status information via SNMP.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3872 # By default it listens to port 3401 on the machine. If you don't
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3873 # wish to use SNMP, set this to "0".
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3874 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3875 # Note: on Debian/Linux, the default is zero - you need to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3876 # set it to 3401 to enable it.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3877 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3878 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3879 # snmp_port 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3880
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3881 # TAG: snmp_access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3882 # Allowing or denying access to the SNMP port.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3883 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3884 # All access to the agent is denied by default.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3885 # usage:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3886 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3887 # snmp_access allow\|deny [!]aclname ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3888 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3889 #Example:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3890 # snmp_access allow snmppublic localhost
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3891 # snmp_access deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3892 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3893 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3894 # snmp_access deny all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3895
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3896 # TAG: snmp_incoming_address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3897 # TAG: snmp_outgoing_address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3898 # Just like 'udp_incoming_address' above, but for the SNMP port.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3899 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3900 # snmp_incoming_address is used for the SNMP socket receiving
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3901 # messages from SNMP agents.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3902 # snmp_outgoing_address is used for SNMP packets returned to SNMP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3903 # agents.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3904 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3905 # The default snmp_incoming_address (0.0.0.0) is to listen on all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3906 # available network interfaces.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3907 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3908 # If snmp_outgoing_address is set to 255.255.255.255 (the default)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3909 # it will use the same socket as snmp_incoming_address. Only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3910 # change this if you want to have SNMP replies sent using another
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3911 # address than where this Squid listens for SNMP queries.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3912 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3913 # NOTE, snmp_incoming_address and snmp_outgoing_address can not have
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3914 # the same value since they both use port 3401.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3915 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3916 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3917 # snmp_incoming_address 0.0.0.0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3918 # snmp_outgoing_address 255.255.255.255
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3919
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3920
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3921 # ICP OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3922 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3923
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3924 # TAG: icp_port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3925 # The port number where Squid sends and receives ICP queries to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3926 # and from neighbor caches. Default is 3130. To disable use
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3927 # "0". May be overridden with -u on the command line.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3928 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3929 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3930 # icp_port 3130
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3931
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3932 # TAG: htcp_port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3933 # The port number where Squid sends and receives HTCP queries to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3934 # and from neighbor caches. To turn it on you want to set it 4827.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3935 # By default it is set to "0" (disabled).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3936 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3937 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3938 # htcp_port 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3939
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3940 # TAG: log_icp_queries on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3941 # If set, ICP queries are logged to access.log. You may wish
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3942 # do disable this if your ICP load is VERY high to speed things
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3943 # up or to simplify log analysis.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3944 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3945 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3946 # log_icp_queries on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3947
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3948 # TAG: udp_incoming_address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3949 # udp_incoming_address is used for UDP packets received from other
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3950 # caches.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3951 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3952 # The default behavior is to not bind to any specific address.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3953 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3954 # Only change this if you want to have all UDP queries received on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3955 # a specific interface/address.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3956 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3957 # NOTE: udp_incoming_address is used by the ICP, HTCP, and DNS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3958 # modules. Altering it will affect all of them in the same manner.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3959 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3960 # see also; udp_outgoing_address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3961 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3962 # NOTE, udp_incoming_address and udp_outgoing_address can not
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3963 # have the same value since they both use the same port.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3964 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3965 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3966 # udp_incoming_address 0.0.0.0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3967
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3968 # TAG: udp_outgoing_address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3969 # udp_outgoing_address is used for UDP packets sent out to other
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3970 # caches.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3971 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3972 # The default behavior is to not bind to any specific address.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3973 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3974 # Instead it will use the same socket as udp_incoming_address.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3975 # Only change this if you want to have UDP queries sent using another
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3976 # address than where this Squid listens for UDP queries from other
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3977 # caches.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3978 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3979 # NOTE: udp_outgoing_address is used by the ICP, HTCP, and DNS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3980 # modules. Altering it will affect all of them in the same manner.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3981 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3982 # see also; udp_incoming_address
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3983 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3984 # NOTE, udp_incoming_address and udp_outgoing_address can not
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3985 # have the same value since they both use the same port.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3986 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3987 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3988 # udp_outgoing_address 255.255.255.255
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3989
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3990 # TAG: icp_hit_stale on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3991 # If you want to return ICP_HIT for stale cache objects, set this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3992 # option to 'on'. If you have sibling relationships with caches
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3993 # in other administrative domains, this should be 'off'. If you only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3994 # have sibling relationships with caches under your control,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3995 # it is probably okay to set this to 'on'.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3996 # If set to 'on', your siblings should use the option "allow-miss"
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3997 # on their cache_peer lines for connecting to you.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3998 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	3999 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4000 # icp_hit_stale off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4001
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4002 # TAG: minimum_direct_hops
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4003 # If using the ICMP pinging stuff, do direct fetches for sites
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4004 # which are no more than this many hops away.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4005 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4006 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4007 # minimum_direct_hops 4
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4008
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4009 # TAG: minimum_direct_rtt
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4010 # If using the ICMP pinging stuff, do direct fetches for sites
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4011 # which are no more than this many rtt milliseconds away.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4012 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4013 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4014 # minimum_direct_rtt 400
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4015
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4016 # TAG: netdb_low
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4017 # TAG: netdb_high
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4018 # The low and high water marks for the ICMP measurement
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4019 # database. These are counts, not percents. The defaults are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4020 # 900 and 1000. When the high water mark is reached, database
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4021 # entries will be deleted until the low mark is reached.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4022 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4023 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4024 # netdb_low 900
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4025 # netdb_high 1000
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4026
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4027 # TAG: netdb_ping_period
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4028 # The minimum period for measuring a site. There will be at
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4029 # least this much delay between successive pings to the same
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4030 # network. The default is five minutes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4031 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4032 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4033 # netdb_ping_period 5 minutes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4034
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4035 # TAG: query_icmp on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4036 # If you want to ask your peers to include ICMP data in their ICP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4037 # replies, enable this option.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4038 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4039 # If your peer has configured Squid (during compilation) with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4040 # '--enable-icmp' that peer will send ICMP pings to origin server
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4041 # sites of the URLs it receives. If you enable this option the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4042 # ICP replies from that peer will include the ICMP data (if available).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4043 # Then, when choosing a parent cache, Squid will choose the parent with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4044 # the minimal RTT to the origin server. When this happens, the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4045 # hierarchy field of the access.log will be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4046 # "CLOSEST_PARENT_MISS". This option is off by default.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4047 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4048 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4049 # query_icmp off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4050
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4051 # TAG: test_reachability on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4052 # When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4053 # instead of ICP_MISS if the target host is NOT in the ICMP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4054 # database, or has a zero RTT.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4055 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4056 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4057 # test_reachability off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4058
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4059 # TAG: icp_query_timeout (msec)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4060 # Normally Squid will automatically determine an optimal ICP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4061 # query timeout value based on the round-trip-time of recent ICP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4062 # queries. If you want to override the value determined by
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4063 # Squid, set this 'icp_query_timeout' to a non-zero value. This
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4064 # value is specified in MILLISECONDS, so, to use a 2-second
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4065 # timeout (the old default), you would write:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4066 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4067 # icp_query_timeout 2000
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4068 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4069 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4070 # icp_query_timeout 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4071
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4072 # TAG: maximum_icp_query_timeout (msec)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4073 # Normally the ICP query timeout is determined dynamically. But
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4074 # sometimes it can lead to very large values (say 5 seconds).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4075 # Use this option to put an upper limit on the dynamic timeout
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4076 # value. Do NOT use this option to always use a fixed (instead
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4077 # of a dynamic) timeout value. To set a fixed timeout see the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4078 # 'icp_query_timeout' directive.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4079 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4080 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4081 # maximum_icp_query_timeout 2000
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4082
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4083 # TAG: minimum_icp_query_timeout (msec)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4084 # Normally the ICP query timeout is determined dynamically. But
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4085 # sometimes it can lead to very small timeouts, even lower than
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4086 # the normal latency variance on your link due to traffic.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4087 # Use this option to put an lower limit on the dynamic timeout
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4088 # value. Do NOT use this option to always use a fixed (instead
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4089 # of a dynamic) timeout value. To set a fixed timeout see the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4090 # 'icp_query_timeout' directive.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4091 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4092 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4093 # minimum_icp_query_timeout 5
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4094
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4095
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4096 # MULTICAST ICP OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4097 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4098
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4099 # TAG: mcast_groups
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4100 # This tag specifies a list of multicast groups which your server
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4101 # should join to receive multicasted ICP queries.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4102 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4103 # NOTE! Be very careful what you put here! Be sure you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4104 # understand the difference between an ICP _query_ and an ICP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4105 # _reply_. This option is to be set only if you want to RECEIVE
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4106 # multicast queries. Do NOT set this option to SEND multicast
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4107 # ICP (use cache_peer for that). ICP replies are always sent via
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4108 # unicast, so this option does not affect whether or not you will
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4109 # receive replies from multicast group members.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4110 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4111 # You must be very careful to NOT use a multicast address which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4112 # is already in use by another group of caches.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4113 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4114 # If you are unsure about multicast, please read the Multicast
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4115 # chapter in the Squid FAQ (http://www.squid-cache.org/FAQ/).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4116 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4117 # Usage: mcast_groups 239.128.16.128 224.0.1.20
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4118 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4119 # By default, Squid doesn't listen on any multicast groups.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4120 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4121 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4122 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4123
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4124 # TAG: mcast_miss_addr
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4125 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4126 # --enable-multicast-miss option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4127 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4128 # If you enable this option, every "cache miss" URL will
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4129 # be sent out on the specified multicast address.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4130 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4131 # Do not enable this option unless you are are absolutely
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4132 # certain you understand what you are doing.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4133 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4134 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4135 # mcast_miss_addr 255.255.255.255
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4136
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4137 # TAG: mcast_miss_ttl
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4138 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4139 # --enable-multicast-miss option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4140 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4141 # This is the time-to-live value for packets multicasted
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4142 # when multicasting off cache miss URLs is enabled. By
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4143 # default this is set to 'site scope', i.e. 16.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4144 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4145 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4146 # mcast_miss_ttl 16
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4147
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4148 # TAG: mcast_miss_port
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4149 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4150 # --enable-multicast-miss option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4151 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4152 # This is the port number to be used in conjunction with
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4153 # 'mcast_miss_addr'.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4154 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4155 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4156 # mcast_miss_port 3135
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4157
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4158 # TAG: mcast_miss_encode_key
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4159 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4160 # --enable-multicast-miss option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4161 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4162 # The URLs that are sent in the multicast miss stream are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4163 # encrypted. This is the encryption key.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4164 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4165 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4166 # mcast_miss_encode_key XXXXXXXXXXXXXXXX
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4167
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4168 # TAG: mcast_icp_query_timeout (msec)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4169 # For multicast peers, Squid regularly sends out ICP "probes" to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4170 # count how many other peers are listening on the given multicast
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4171 # address. This value specifies how long Squid should wait to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4172 # count all the replies. The default is 2000 msec, or 2
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4173 # seconds.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4174 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4175 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4176 # mcast_icp_query_timeout 2000
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4177
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4178
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4179 # INTERNAL ICON OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4180 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4181
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4182 # TAG: icon_directory
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4183 # Where the icons are stored. These are normally kept in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4184 # /usr/share/squid/icons
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4185 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4186 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4187 # icon_directory /usr/share/squid/icons
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4188
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4189 # TAG: global_internal_static
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4190 # This directive controls is Squid should intercept all requests for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4191 # /squid-internal-static/ no matter which host the URL is requesting
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4192 # (default on setting), or if nothing special should be done for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4193 # such URLs (off setting). The purpose of this directive is to make
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4194 # icons etc work better in complex cache hierarchies where it may
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4195 # not always be possible for all corners in the cache mesh to reach
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4196 # the server generating a directory listing.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4197 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4198 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4199 # global_internal_static on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4200
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4201 # TAG: short_icon_urls
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4202 # If this is enabled Squid will use short URLs for icons.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4203 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4204 # If off the URLs for icons will always be absolute URLs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4205 # including the proxy name and port.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4206 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4207 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4208 # short_icon_urls off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4209
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4210
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4211 # ERROR PAGE OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4212 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4213
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4214 # TAG: error_directory
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4215 # If you wish to create your own versions of the default
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4216 # (English) error files, either to customize them to suit your
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4217 # language or company copy the template English files to another
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4218 # directory and point this tag at them.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4219 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4220 # The squid developers are interested in making squid available in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4221 # a wide variety of languages. If you are making translations for a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4222 # langauge that Squid does not currently provide please consider
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4223 # contributing your translation back to the project.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4224 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4225 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4226 # error_directory /usr/share/squid/errors/English
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4227
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4228 # TAG: error_map
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4229 # Map errors to custom messages
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4230 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4231 # error_map message_url http_status ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4232 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4233 # http_status ... is a list of HTTP status codes or Squid error
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4234 # messages.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4235 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4236 # Use in accelerators to substitute the error messages returned
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4237 # by servers with other custom errors.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4238 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4239 # error_map http://your.server/error/404.shtml 404
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4240 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4241 # Requests for error messages is a GET request for the configured
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4242 # URL with the following special headers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4243 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4244 # X-Error-Status: The received HTTP status code (i.e. 404)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4245 # X-Request-URI: The requested URI where the error occurred
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4246 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4247 # In Addition the following headers are forwarded from the client
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4248 # request:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4249 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4250 # User-Agent, Cookie, X-Forwarded-For, Via, Authorization,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4251 # Accept, Referer
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4252 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4253 # And the following headers from the server reply:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4254 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4255 # Server, Via, Location, Content-Location
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4256 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4257 # The reply returned to the client will carry the original HTTP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4258 # headers from the real error message, but with the reply body
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4259 # of the configured error message.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4260 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4261 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4262 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4263 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4264
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4265 # TAG: err_html_text
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4266 # HTML text to include in error messages. Make this a "mailto"
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4267 # URL to your admin address, or maybe just a link to your
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4268 # organizations Web page.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4269 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4270 # To include this in your error messages, you must rewrite
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4271 # the error template files (found in the "errors" directory).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4272 # Wherever you want the 'err_html_text' line to appear,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4273 # insert a %L tag in the error template file.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4274 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4275 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4276 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4277
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4278 # TAG: deny_info
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4279 # Usage: deny_info err_page_name acl
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4280 # or deny_info http://... acl
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4281 # Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4282 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4283 # This can be used to return a ERR_ page for requests which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4284 # do not pass the 'http_access' rules. Squid remembers the last
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4285 # acl it evaluated in http_access, and if a 'deny_info' line exists
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4286 # for that ACL Squid returns a corresponding error page.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4287 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4288 # The acl is typically the last acl on the http_access deny line which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4289 # denied access. The exceptions to this rule are:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4290 # - When Squid needs to request authentication credentials. It's then
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4291 # the first authentication related acl encountered
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4292 # - When none of the http_access lines matches. It's then the last
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4293 # acl processed on the last http_access line.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4294 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4295 # You may use ERR_ pages that come with Squid or create your own pages
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4296 # and put them into the configured errors/ directory.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4297 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4298 # Alternatively you can specify an error URL. The browsers will
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4299 # get redirected (302) to the specified URL. %s in the redirection
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4300 # URL will be replaced by the requested URL.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4301 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4302 # Alternatively you can tell Squid to reset the TCP connection
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4303 # by specifying TCP_RESET.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4304 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4305 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4306 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4307
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4308
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4309 # OPTIONS INFLUENCING REQUEST FORWARDING
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4310 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4311
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4312 # TAG: nonhierarchical_direct
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4313 # By default, Squid will send any non-hierarchical requests
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4314 # (matching hierarchy_stoplist or not cacheable request type) direct
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4315 # to origin servers.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4316 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4317 # If you set this to off, Squid will prefer to send these
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4318 # requests to parents.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4319 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4320 # Note that in most configurations, by turning this off you will only
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4321 # add latency to these request without any improvement in global hit
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4322 # ratio.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4323 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4324 # If you are inside an firewall see never_direct instead of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4325 # this directive.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4326 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4327 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4328 # nonhierarchical_direct on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4329
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4330 # TAG: prefer_direct
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4331 # Normally Squid tries to use parents for most requests. If you for some
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4332 # reason like it to first try going direct and only use a parent if
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4333 # going direct fails set this to on.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4334 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4335 # By combining nonhierarchical_direct off and prefer_direct on you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4336 # can set up Squid to use a parent as a backup path if going direct
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4337 # fails.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4338 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4339 # Note: If you want Squid to use parents for all requests see
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4340 # the never_direct directive. prefer_direct only modifies how Squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4341 # acts on cacheable requests.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4342 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4343 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4344 # prefer_direct off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4345
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4346 # TAG: ignore_ims_on_miss on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4347 # This options makes Squid ignore If-Modified-Since on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4348 # cache misses. This is useful while the cache is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4349 # mostly empty to more quickly have the cache populated.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4350 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4351 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4352 # ignore_ims_on_miss off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4353
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4354 # TAG: always_direct
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4355 # Usage: always_direct allow\|deny [!]aclname ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4356 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4357 # Here you can use ACL elements to specify requests which should
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4358 # ALWAYS be forwarded by Squid to the origin servers without using
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4359 # any peers. For example, to always directly forward requests for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4360 # local servers ignoring any parents or siblings you may have use
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4361 # something like:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4362 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4363 # acl local-servers dstdomain my.domain.net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4364 # always_direct allow local-servers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4365 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4366 # To always forward FTP requests directly, use
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4367 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4368 # acl FTP proto FTP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4369 # always_direct allow FTP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4370 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4371 # NOTE: There is a similar, but opposite option named
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4372 # 'never_direct'. You need to be aware that "always_direct deny
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4373 # foo" is NOT the same thing as "never_direct allow foo". You
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4374 # may need to use a deny rule to exclude a more-specific case of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4375 # some other rule. Example:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4376 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4377 # acl local-external dstdomain external.foo.net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4378 # acl local-servers dstdomain .foo.net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4379 # always_direct deny local-external
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4380 # always_direct allow local-servers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4381 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4382 # NOTE: If your goal is to make the client forward the request
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4383 # directly to the origin server bypassing Squid then this needs
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4384 # to be done in the client configuration. Squid configuration
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4385 # can only tell Squid how Squid should fetch the object.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4386 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4387 # NOTE: This directive is not related to caching. The replies
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4388 # is cached as usual even if you use always_direct. To not cache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4389 # the replies see no_cache.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4390 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4391 # This option replaces some v1.1 options such as local_domain
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4392 # and local_ip.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4393 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4394 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4395 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4396
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4397 # TAG: never_direct
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4398 # Usage: never_direct allow\|deny [!]aclname ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4399 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4400 # never_direct is the opposite of always_direct. Please read
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4401 # the description for always_direct if you have not already.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4402 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4403 # With 'never_direct' you can use ACL elements to specify
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4404 # requests which should NEVER be forwarded directly to origin
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4405 # servers. For example, to force the use of a proxy for all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4406 # requests, except those in your local domain use something like:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4407 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4408 # acl local-servers dstdomain .foo.net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4409 # acl all src 0.0.0.0/0.0.0.0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4410 # never_direct deny local-servers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4411 # never_direct allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4412 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4413 # or if Squid is inside a firewall and there are local intranet
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4414 # servers inside the firewall use something like:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4415 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4416 # acl local-intranet dstdomain .foo.net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4417 # acl local-external dstdomain external.foo.net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4418 # always_direct deny local-external
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4419 # always_direct allow local-intranet
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4420 # never_direct allow all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4421 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4422 # This option replaces some v1.1 options such as inside_firewall
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4423 # and firewall_ip.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4424 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4425 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4426 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4427
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4428
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4429 # ADVANCED NETWORKING OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4430 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4431
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4432 # TAG: max_filedescriptors
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4433 # The maximum number of filedescriptors supported.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4434 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4435 # The default "0" means Squid inherits the current ulimit setting.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4436 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4437 # Note: Changing this requires a restart of Squid. Also
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4438 # not all comm loops supports values larger than --with-maxfd.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4439 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4440 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4441 # max_filedescriptors 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4442
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4443 # TAG: accept_filter
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4444 # FreeBSD:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4445 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4446 # The name of an accept(2) filter to install on Squid's
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4447 # listen socket(s). This feature is perhaps specific to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4448 # FreeBSD and requires support in the kernel.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4449 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4450 # The 'httpready' filter delays delivering new connections
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4451 # to Squid until a full HTTP request has been received.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4452 # See the accf_http(9) man page for details.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4453 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4454 # The 'dataready' filter delays delivering new connections
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4455 # to Squid until there is some data to process.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4456 # See the accf_dataready(9) man page for details.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4457 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4458 # Linux:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4459 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4460 # The 'data' filter delays delivering of new connections
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4461 # to Squid until there is some data to process by TCP_ACCEPT_DEFER.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4462 # You may optionally specify a number of seconds to wait by
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4463 # 'data=N' where N is the number of seconds. Defaults to 30
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4464 # if not specified. See the tcp(7) man page for details.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4465 #EXAMPLE:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4466 ## FreeBSD
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4467 #accept_filter httpready
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4468 ## Linux
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4469 #accept_filter data
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4470 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4471 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4472 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4473
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4474 # TAG: tcp_recv_bufsize (bytes)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4475 # Size of receive buffer to set for TCP sockets. Probably just
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4476 # as easy to change your kernel's default. Set to zero to use
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4477 # the default buffer size.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4478 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4479 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4480 # tcp_recv_bufsize 0 bytes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4481
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4482 # TAG: incoming_rate
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4483 # This directive controls how aggressive Squid should accept new
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4484 # connections compared to processing existing connections.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4485 # The lower number the more frequent Squid will look for new
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4486 # incoming requests.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4487 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4488 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4489 # incoming_rate 30
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4490
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4491
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4492 # DNS OPTIONS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4493 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4494
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4495 # TAG: check_hostnames
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4496 # For security and stability reasons Squid by default checks
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4497 # hostnames for Internet standard RFC compliance. If you do not want
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4498 # Squid to perform these checks then turn this directive off.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4499 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4500 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4501 # check_hostnames on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4502
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4503 # TAG: allow_underscore
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4504 # Underscore characters is not strictly allowed in Internet hostnames
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4505 # but nevertheless used by many sites. Set this to off if you want
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4506 # Squid to be strict about the standard.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4507 # This check is performed only when check_hostnames is set to on.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4508 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4509 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4510 # allow_underscore on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4511
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4512 # TAG: cache_dns_program
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4513 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4514 # --disable-internal-dns option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4515 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4516 # Specify the location of the executable for dnslookup process.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4517 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4518 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4519 # cache_dns_program /usr/lib/squid/dnsserver
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4520
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4521 # TAG: dns_children
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4522 # Note: This option is only available if Squid is rebuilt with the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4523 # --disable-internal-dns option
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4524 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4525 # The number of processes spawn to service DNS name lookups.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4526 # For heavily loaded caches on large servers, you should
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4527 # probably increase this value to at least 10. The maximum
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4528 # is 32. The default is 5.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4529 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4530 # You must have at least one dnsserver process.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4531 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4532 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4533 # dns_children 5
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4534
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4535 # TAG: dns_retransmit_interval
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4536 # Initial retransmit interval for DNS queries. The interval is
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4537 # doubled each time all configured DNS servers have been tried.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4538 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4539 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4540 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4541 # dns_retransmit_interval 5 seconds
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4542
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4543 # TAG: dns_timeout
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4544 # DNS Query timeout. If no response is received to a DNS query
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4545 # within this time all DNS servers for the queried domain
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4546 # are assumed to be unavailable.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4547 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4548 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4549 # dns_timeout 2 minutes
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4550
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4551 # TAG: dns_defnames on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4552 # Normally the RES_DEFNAMES resolver option is disabled
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4553 # (see res_init(3)). This prevents caches in a hierarchy
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4554 # from interpreting single-component hostnames locally. To allow
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4555 # Squid to handle single-component names, enable this option.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4556 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4557 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4558 # dns_defnames off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4559
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4560 # TAG: dns_nameservers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4561 # Use this if you want to specify a list of DNS name servers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4562 # (IP addresses) to use instead of those given in your
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4563 # /etc/resolv.conf file.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4564 # On Windows platforms, if no value is specified here or in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4565 # the /etc/resolv.conf file, the list of DNS name servers are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4566 # taken from the Windows registry, both static and dynamic DHCP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4567 # configurations are supported.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4568 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4569 # Example: dns_nameservers 10.0.0.1 192.172.0.4
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4570 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4571 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4572 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4573
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4574 # TAG: hosts_file
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4575 # Location of the host-local IP name-address associations
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4576 # database. Most Operating Systems have such a file on different
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4577 # default locations:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4578 # - Un*X & Linux: /etc/hosts
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4579 # - Windows NT/2000: %SystemRoot%\system32\drivers\etc\hosts
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4580 # (%SystemRoot% value install default is c:\winnt)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4581 # - Windows XP/2003: %SystemRoot%\system32\drivers\etc\hosts
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4582 # (%SystemRoot% value install default is c:\windows)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4583 # - Windows 9x/Me: %windir%\hosts
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4584 # (%windir% value is usually c:\windows)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4585 # - Cygwin: /etc/hosts
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4586 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4587 # The file contains newline-separated definitions, in the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4588 # form ip_address_in_dotted_form name [name ...] names are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4589 # whitespace-separated. Lines beginning with an hash (#)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4590 # character are comments.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4591 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4592 # The file is checked at startup and upon configuration.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4593 # If set to 'none', it won't be checked.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4594 # If append_domain is used, that domain will be added to
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4595 # domain-local (i.e. not containing any dot character) host
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4596 # definitions.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4597 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4598 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4599 # hosts_file /etc/hosts
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4600 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4601 hosts_file /etc/hosts
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4602
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4603 # TAG: dns_testnames
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4604 # The DNS tests exit as soon as the first site is successfully looked up
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4605 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4606 # This test can be disabled with the -D command line option.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4607 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4608 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4609 # dns_testnames netscape.com internic.net nlanr.net microsoft.com
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4610
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4611 # TAG: append_domain
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4612 # Appends local domain name to hostnames without any dots in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4613 # them. append_domain must begin with a period.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4614 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4615 # Be warned there are now Internet names with no dots in
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4616 # them using only top-domain names, so setting this may
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4617 # cause some Internet sites to become unavailable.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4618 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4619 #Example:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4620 # append_domain .yourdomain.com
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4621 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4622 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4623 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4624
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4625 # TAG: ignore_unknown_nameservers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4626 # By default Squid checks that DNS responses are received
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4627 # from the same IP addresses they are sent to. If they
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4628 # don't match, Squid ignores the response and writes a warning
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4629 # message to cache.log. You can allow responses from unknown
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4630 # nameservers by setting this option to 'off'.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4631 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4632 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4633 # ignore_unknown_nameservers on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4634
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4635 # TAG: ipcache_size (number of entries)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4636 # TAG: ipcache_low (percent)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4637 # TAG: ipcache_high (percent)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4638 # The size, low-, and high-water marks for the IP cache.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4639 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4640 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4641 # ipcache_size 1024
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4642 # ipcache_low 90
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4643 # ipcache_high 95
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4644
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4645 # TAG: fqdncache_size (number of entries)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4646 # Maximum number of FQDN cache entries.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4647 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4648 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4649 # fqdncache_size 1024
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4650
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4651
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4652 # MISCELLANEOUS
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4653 # -----------------------------------------------------------------------------
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4654
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4655 # TAG: memory_pools on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4656 # If set, Squid will keep pools of allocated (but unused) memory
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4657 # available for future use. If memory is a premium on your
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4658 # system and you believe your malloc library outperforms Squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4659 # routines, disable this.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4660 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4661 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4662 # memory_pools on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4663
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4664 # TAG: memory_pools_limit (bytes)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4665 # Used only with memory_pools on:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4666 # memory_pools_limit 50 MB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4667 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4668 # If set to a non-zero value, Squid will keep at most the specified
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4669 # limit of allocated (but unused) memory in memory pools. All free()
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4670 # requests that exceed this limit will be handled by your malloc
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4671 # library. Squid does not pre-allocate any memory, just safe-keeps
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4672 # objects that otherwise would be free()d. Thus, it is safe to set
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4673 # memory_pools_limit to a reasonably high value even if your
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4674 # configuration will use less memory.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4675 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4676 # If set to zero, Squid will keep all memory it can. That is, there
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4677 # will be no limit on the total amount of memory used for safe-keeping.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4678 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4679 # To disable memory allocation optimization, do not set
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4680 # memory_pools_limit to 0. Set memory_pools to "off" instead.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4681 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4682 # An overhead for maintaining memory pools is not taken into account
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4683 # when the limit is checked. This overhead is close to four bytes per
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4684 # object kept. However, pools may actually _save_ memory because of
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4685 # reduced memory thrashing in your malloc library.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4686 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4687 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4688 # memory_pools_limit 5 MB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4689
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4690 # TAG: forwarded_for on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4691 # If set, Squid will include your system's IP address or name
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4692 # in the HTTP requests it forwards. By default it looks like
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4693 # this:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4694 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4695 # X-Forwarded-For: 192.1.2.3
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4696 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4697 # If you disable this, it will appear as
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4698 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4699 # X-Forwarded-For: unknown
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4700 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4701 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4702 # forwarded_for on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4703
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4704 # TAG: cachemgr_passwd
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4705 # Specify passwords for cachemgr operations.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4706 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4707 # Usage: cachemgr_passwd password action action ...
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4708 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4709 # Some valid actions are (see cache manager menu for a full list):
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4710 # 5min
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4711 # 60min
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4712 # asndb
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4713 # authenticator
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4714 # cbdata
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4715 # client_list
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4716 # comm_incoming
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4717 # config *
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4718 # counters
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4719 # delay
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4720 # digest_stats
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4721 # dns
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4722 # events
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4723 # filedescriptors
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4724 # fqdncache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4725 # histograms
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4726 # http_headers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4727 # info
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4728 # io
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4729 # ipcache
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4730 # mem
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4731 # menu
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4732 # netdb
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4733 # non_peers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4734 # objects
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4735 # offline_toggle *
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4736 # pconn
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4737 # peer_select
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4738 # reconfigure *
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4739 # redirector
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4740 # refresh
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4741 # server_list
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4742 # shutdown *
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4743 # store_digest
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4744 # storedir
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4745 # utilization
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4746 # via_headers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4747 # vm_objects
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4748 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4749 # * Indicates actions which will not be performed without a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4750 # valid password, others can be performed if not listed here.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4751 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4752 # To disable an action, set the password to "disable".
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4753 # To allow performing an action without a password, set the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4754 # password to "none".
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4755 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4756 # Use the keyword "all" to set the same password for all actions.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4757 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4758 #Example:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4759 # cachemgr_passwd secret shutdown
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4760 # cachemgr_passwd lesssssssecret info stats/objects
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4761 # cachemgr_passwd disable all
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4762 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4763 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4764 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4765
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4766 # TAG: client_db on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4767 # If you want to disable collecting per-client statistics,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4768 # turn off client_db here.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4769 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4770 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4771 # client_db on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4772
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4773 # TAG: reload_into_ims on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4774 # When you enable this option, client no-cache or ``reload''
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4775 # requests will be changed to If-Modified-Since requests.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4776 # Doing this VIOLATES the HTTP standard. Enabling this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4777 # feature could make you liable for problems which it
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4778 # causes.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4779 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4780 # see also refresh_pattern for a more selective approach.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4781 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4782 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4783 # reload_into_ims off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4784
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4785 # TAG: maximum_single_addr_tries
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4786 # This sets the maximum number of connection attempts for a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4787 # host that only has one address (for multiple-address hosts,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4788 # each address is tried once).
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4789 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4790 # The default value is one attempt, the (not recommended)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4791 # maximum is 255 tries. A warning message will be generated
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4792 # if it is set to a value greater than ten.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4793 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4794 # Note: This is in addition to the request re-forwarding which
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4795 # takes place if Squid fails to get a satisfying response.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4796 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4797 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4798 # maximum_single_addr_tries 1
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4799
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4800 # TAG: retry_on_error
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4801 # If set to on Squid will automatically retry requests when
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4802 # receiving an error response. This is mainly useful if you
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4803 # are in a complex cache hierarchy to work around access
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4804 # control errors.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4805 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4806 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4807 # retry_on_error off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4808
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4809 # TAG: as_whois_server
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4810 # WHOIS server to query for AS numbers. NOTE: AS numbers are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4811 # queried only when Squid starts up, not for every request.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4812 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4813 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4814 # as_whois_server whois.ra.net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4815 # as_whois_server whois.ra.net
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4816
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4817 # TAG: offline_mode
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4818 # Enable this option and Squid will never try to validate cached
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4819 # objects.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4820 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4821 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4822 # offline_mode off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4823
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4824 # TAG: uri_whitespace
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4825 # What to do with requests that have whitespace characters in the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4826 # URI. Options:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4827 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4828 # strip: The whitespace characters are stripped out of the URL.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4829 # This is the behavior recommended by RFC2396.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4830 # deny: The request is denied. The user receives an "Invalid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4831 # Request" message.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4832 # allow: The request is allowed and the URI is not changed. The
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4833 # whitespace characters remain in the URI. Note the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4834 # whitespace is passed to redirector processes if they
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4835 # are in use.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4836 # encode: The request is allowed and the whitespace characters are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4837 # encoded according to RFC1738. This could be considered
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4838 # a violation of the HTTP/1.1
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4839 # RFC because proxies are not allowed to rewrite URI's.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4840 # chop: The request is allowed and the URI is chopped at the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4841 # first whitespace. This might also be considered a
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4842 # violation.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4843 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4844 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4845 # uri_whitespace strip
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4846
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4847 # TAG: coredump_dir
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4848 # By default Squid leaves core files in the directory from where
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4849 # it was started. If you set 'coredump_dir' to a directory
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4850 # that exists, Squid will chdir() to that directory at startup
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4851 # and coredump files will be left there.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4852 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4853 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4854 # coredump_dir none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4855 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4856 # Leave coredumps in the first cache dir
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4857 coredump_dir /var/spool/squid
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4858
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4859 # TAG: chroot
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4860 # Use this to have Squid do a chroot() while initializing. This
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4861 # also causes Squid to fully drop root privileges after
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4862 # initializing. This means, for example, if you use a HTTP
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4863 # port less than 1024 and try to reconfigure, you will may get an
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4864 # error saying that Squid can not open the port.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4865 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4866 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4867 # none
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4868
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4869 # TAG: balance_on_multiple_ip
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4870 # Some load balancing servers based on round robin DNS have been
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4871 # found not to preserve user session state across requests
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4872 # to different IP addresses.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4873 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4874 # By default Squid rotates IP's per request. By disabling
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4875 # this directive only connection failure triggers rotation.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4876 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4877 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4878 # balance_on_multiple_ip on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4879
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4880 # TAG: pipeline_prefetch
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4881 # To boost the performance of pipelined requests to closer
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4882 # match that of a non-proxied environment Squid can try to fetch
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4883 # up to two requests in parallel from a pipeline.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4884 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4885 # Defaults to off for bandwidth management and access logging
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4886 # reasons.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4887 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4888 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4889 # pipeline_prefetch off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4890
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4891 # TAG: high_response_time_warning (msec)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4892 # If the one-minute median response time exceeds this value,
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4893 # Squid prints a WARNING with debug level 0 to get the
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4894 # administrators attention. The value is in milliseconds.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4895 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4896 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4897 # high_response_time_warning 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4898
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4899 # TAG: high_page_fault_warning
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4900 # If the one-minute average page fault rate exceeds this
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4901 # value, Squid prints a WARNING with debug level 0 to get
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4902 # the administrators attention. The value is in page faults
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4903 # per second.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4904 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4905 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4906 # high_page_fault_warning 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4907
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4908 # TAG: high_memory_warning
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4909 # If the memory usage (as determined by mallinfo) exceeds
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4910 # this amount, Squid prints a WARNING with debug level 0 to get
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4911 # the administrators attention.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4912 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4913 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4914 # high_memory_warning 0 KB
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4915
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4916 # TAG: sleep_after_fork (microseconds)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4917 # When this is set to a non-zero value, the main Squid process
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4918 # sleeps the specified number of microseconds after a fork()
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4919 # system call. This sleep may help the situation where your
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4920 # system reports fork() failures due to lack of (virtual)
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4921 # memory. Note, however, if you have a lot of child
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4922 # processes, these sleep delays will add up and your
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4923 # Squid will not service requests for some amount of time
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4924 # until all the child processes have been started.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4925 # On Windows value less then 1000 (1 milliseconds) are
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4926 # rounded to 1000.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4927 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4928 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4929 # sleep_after_fork 0
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4930
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4931 # TAG: zero_buffers on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4932 # Squid by default will zero all buffers before using or reusing them.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4933 # Setting this to 'off' will result in fixed-sized temporary buffers
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4934 # not being zero'ed. This may give a performance boost on certain
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4935 # platforms but it may result in undefined behaviour at the present
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4936 # time.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4937 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4938 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4939 # zero_buffers on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4940
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4941 # TAG: windows_ipaddrchangemonitor on\|off
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4942 # On Windows Squid by default will monitor IP address changes and will
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4943 # reconfigure itself after any detected event. This is very useful for
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4944 # proxies connected to internet with dial-up interfaces.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4945 # In some cases (a Proxy server acting as VPN gateway is one) it could be
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4946 # desiderable to disable this behaviour setting this to 'off'.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4947 # Note: after changing this, Squid service must be restarted.
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4948 #
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4949 #Default:
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4950 # windows_ipaddrchangemonitor on
9e5a3c884de6 Initial import of the virtual testbed. Sebastien Decugis <sdecugis@nict.go.jp> parents: diff changeset	4951

Mercurial > hg > fD-testbed

annotate conf/mgr.testbeddomain/squid/squid.conf @ 0:9e5a3c884de6