2 # WELCOME TO SQUID 3.0.STABLE13
3 # ----------------------------
5 # This is the default Squid configuration file. You may wish
6 # to look at the Squid home page (http://www.squid-cache.org/)
7 # for the FAQ and other documentation.
9 # The default Squid config file shows what the defaults for
10 # various options happen to be. If you don't need to change the
11 # default, you shouldn't uncomment the line. Doing so may cause
12 # run-time problems. In some cases "none" refers to no default
13 # setting at all, while in other cases it refers to a valid
14 # option - the comments for that keyword indicate if this is the
19 # Configuration options can be included using the "include" directive.
20 # Include takes a list of files to include. Quoting and wildcards is
25 # include /path/to/included/file/squid.acl.config
27 # Includes can be nested up to a hard-coded depth of 16 levels.
28 # This arbitrary restriction is to prevent recursive include references
29 # from causing Squid entering an infinite loop whilst trying to load
30 # configuration files.
33 # OPTIONS FOR AUTHENTICATION
34 # -----------------------------------------------------------------------------
37 # This is used to define parameters for the various authentication
38 # schemes supported by Squid.
40 # format: auth_param scheme parameter [setting]
42 # The order in which authentication schemes are presented to the client is
43 # dependent on the order the scheme first appears in config file. IE
44 # has a bug (it's not RFC 2617 compliant) in that it will use the basic
45 # scheme if basic is the first entry presented, even if more secure
46 # schemes are presented. For now use the order in the recommended
47 # settings section below. If other browsers have difficulties (don't
48 # recognize the schemes offered even if you are using basic) either
49 # put basic first, or disable the other schemes (by commenting out their
52 # Once an authentication scheme is fully configured, it can only be
53 # shutdown by shutting squid down and restarting. Changes can be made on
54 # the fly and activated with a reconfigure. I.E. You can change to a
55 # different helper, but not unconfigure the helper completely.
57 # Please note that while this directive defines how Squid processes
58 # authentication it does not automatically activate authentication.
59 # To use authentication you must in addition make use of ACLs based
60 # on login name in http_access (proxy_auth, proxy_auth_regex or
61 # external with %LOGIN used in the format tag). The browser will be
62 # challenged for authentication on the first such acl encountered
63 # in http_access processing and will also be re-challenged for new
64 # login credentials if the request is being denied by a proxy_auth
67 # WARNING: authentication can't be used in a transparently intercepting
68 # proxy as the client then thinks it is talking to an origin server and
69 # not the proxy. This is a limitation of bending the TCP/IP protocol to
70 # transparently intercepting port 80, not a limitation in Squid.
71 # Ports flagged 'transparent' or 'tproxy' have authentication disabled.
73 # === Parameters for the basic scheme follow. ===
76 # Specify the command for the external authenticator. Such a program
77 # reads a line containing "username password" and replies "OK" or
78 # "ERR" in an endless loop. "ERR" responses may optionally be followed
79 # by a error description available as %m in the returned error page.
80 # If you use an authenticator, make sure you have 1 acl of type proxy_auth.
82 # By default, the basic authentication scheme is not used unless a
83 # program is specified.
85 # If you want to use the traditional NCSA proxy authentication, set
86 # this line to something like
88 # auth_param basic program /usr/libexec/ncsa_auth /usr/etc/passwd
90 # "children" numberofchildren
91 # The number of authenticator processes to spawn. If you start too few
92 # Squid will have to wait for them to process a backlog of credential
93 # verifications, slowing it down. When password verifications are
94 # done via a (slow) network you are likely to need lots of
95 # authenticator processes.
96 # auth_param basic children 5
98 # "concurrency" concurrency
99 # The number of concurrent requests the helper can process.
100 # The default of 0 is used for helpers who only supports
101 # one request at a time. Setting this changes the protocol used to
102 # include a channel number first on the request/response line, allowing
103 # multiple requests to be sent to the same helper in parallel without
104 # wating for the response.
105 # Must not be set unless it's known the helper supports this.
106 # auth_param basic concurrency 0
108 # "realm" realmstring
109 # Specifies the realm name which is to be reported to the
110 # client for the basic proxy authentication scheme (part of
111 # the text the user will see when prompted their username and
112 # password). There is no default.
113 # auth_param basic realm Squid proxy-caching web server
115 # "credentialsttl" timetolive
116 # Specifies how long squid assumes an externally validated
117 # username:password pair is valid for - in other words how
118 # often the helper program is called for that user. Set this
119 # low to force revalidation with short lived passwords. Note
120 # setting this high does not impact your susceptibility
121 # to replay attacks unless you are using an one-time password
122 # system (such as SecureID). If you are using such a system,
123 # you will be vulnerable to replay attacks unless you also
124 # use the max_user_ip ACL in an http_access rule.
126 # "casesensitive" on|off
127 # Specifies if usernames are case sensitive. Most user databases are
128 # case insensitive allowing the same username to be spelled using both
129 # lower and upper case letters, but some are case sensitive. This
130 # makes a big difference for user_max_ip ACL processing and similar.
131 # auth_param basic casesensitive off
133 # === Parameters for the digest scheme follow ===
136 # Specify the command for the external authenticator. Such
137 # a program reads a line containing "username":"realm" and
138 # replies with the appropriate H(A1) value hex encoded or
139 # ERR if the user (or his H(A1) hash) does not exists.
140 # See rfc 2616 for the definition of H(A1).
141 # "ERR" responses may optionally be followed by a error description
142 # available as %m in the returned error page.
144 # By default, the digest authentication scheme is not used unless a
145 # program is specified.
147 # If you want to use a digest authenticator, set this line to
150 # auth_param digest program /usr/bin/digest_auth_pw /usr/etc/digpass
152 # "children" numberofchildren
153 # The number of authenticator processes to spawn (no default).
154 # If you start too few Squid will have to wait for them to
155 # process a backlog of H(A1) calculations, slowing it down.
156 # When the H(A1) calculations are done via a (slow) network
157 # you are likely to need lots of authenticator processes.
158 # auth_param digest children 5
160 # "realm" realmstring
161 # Specifies the realm name which is to be reported to the
162 # client for the digest proxy authentication scheme (part of
163 # the text the user will see when prompted their username and
164 # password). There is no default.
165 # auth_param digest realm Squid proxy-caching web server
167 # "nonce_garbage_interval" timeinterval
168 # Specifies the interval that nonces that have been issued
169 # to client_agent's are checked for validity.
171 # "nonce_max_duration" timeinterval
172 # Specifies the maximum length of time a given nonce will be
175 # "nonce_max_count" number
176 # Specifies the maximum number of times a given nonce can be
179 # "nonce_strictness" on|off
180 # Determines if squid requires strict increment-by-1 behavior
181 # for nonce counts, or just incrementing (off - for use when
182 # useragents generate nonce counts that occasionally miss 1
183 # (ie, 1,2,4,6)). Default off.
185 # "check_nonce_count" on|off
186 # This directive if set to off can disable the nonce count check
187 # completely to work around buggy digest qop implementations in
188 # certain mainstream browser versions. Default on to check the
189 # nonce count to protect from authentication replay attacks.
191 # "post_workaround" on|off
192 # This is a workaround to certain buggy browsers who sends
193 # an incorrect request digest in POST requests when reusing
194 # the same nonce as acquired earlier on a GET request.
196 # === NTLM scheme options follow ===
199 # Specify the command for the external NTLM authenticator.
200 # Such a program reads exchanged NTLMSSP packets with
201 # the browser via Squid until authentication is completed.
202 # If you use an NTLM authenticator, make sure you have 1 acl
203 # of type proxy_auth. By default, the NTLM authenticator_program
206 # auth_param ntlm program /usr/bin/ntlm_auth
208 # "children" numberofchildren
209 # The number of authenticator processes to spawn (no default).
210 # If you start too few Squid will have to wait for them to
211 # process a backlog of credential verifications, slowing it
212 # down. When credential verifications are done via a (slow)
213 # network you are likely to need lots of authenticator
216 # auth_param ntlm children 5
218 # "keep_alive" on|off
219 # If you experience problems with PUT/POST requests when using the
220 # Negotiate authentication scheme then you can try setting this to
221 # off. This will cause Squid to forcibly close the connection on
222 # the initial requests where the browser asks which schemes are
223 # supported by the proxy.
225 # auth_param ntlm keep_alive on
227 # === Options for configuring the NEGOTIATE auth-scheme follow ===
230 # Specify the command for the external Negotiate authenticator.
231 # This protocol is used in Microsoft Active-Directory enabled setups with
232 # the Microsoft Internet Explorer or Mozilla Firefox browsers.
233 # Its main purpose is to exchange credentials with the Squid proxy
234 # using the Kerberos mechanisms.
235 # If you use a Negotiate authenticator, make sure you have at least one acl
236 # of type proxy_auth active. By default, the negotiate authenticator_program
238 # The only supported program for this role is the ntlm_auth
239 # program distributed as part of Samba, version 4 or later.
241 # auth_param negotiate program /usr/bin/ntlm_auth --helper-protocol=gss-spnego
243 # "children" numberofchildren
244 # The number of authenticator processes to spawn (no default).
245 # If you start too few Squid will have to wait for them to
246 # process a backlog of credential verifications, slowing it
247 # down. When crendential verifications are done via a (slow)
248 # network you are likely to need lots of authenticator
250 # auth_param negotiate children 5
252 # "keep_alive" on|off
253 # If you experience problems with PUT/POST requests when using the
254 # Negotiate authentication scheme then you can try setting this to
255 # off. This will cause Squid to forcibly close the connection on
256 # the initial requests where the browser asks which schemes are
257 # supported by the proxy.
259 # auth_param negotiate keep_alive on
261 #Recommended minimum configuration per scheme:
262 #auth_param negotiate program <uncomment and complete this line to activate>
263 #auth_param negotiate children 5
264 #auth_param negotiate keep_alive on
265 #auth_param ntlm program <uncomment and complete this line to activate>
266 #auth_param ntlm children 5
267 #auth_param ntlm keep_alive on
268 #auth_param digest program <uncomment and complete this line>
269 #auth_param digest children 5
270 #auth_param digest realm Squid proxy-caching web server
271 #auth_param digest nonce_garbage_interval 5 minutes
272 #auth_param digest nonce_max_duration 30 minutes
273 #auth_param digest nonce_max_count 50
274 #auth_param basic program <uncomment and complete this line>
275 #auth_param basic children 5
276 #auth_param basic realm Squid proxy-caching web server
277 #auth_param basic credentialsttl 2 hours
279 # TAG: authenticate_cache_garbage_interval
280 # The time period between garbage collection across the username cache.
281 # This is a tradeoff between memory utilization (long intervals - say
282 # 2 days) and CPU (short intervals - say 1 minute). Only change if you
283 # have good reason to.
286 # authenticate_cache_garbage_interval 1 hour
288 # TAG: authenticate_ttl
289 # The time a user & their credentials stay in the logged in
290 # user cache since their last request. When the garbage
291 # interval passes, all user credentials that have passed their
292 # TTL are removed from memory.
295 # authenticate_ttl 1 hour
297 # TAG: authenticate_ip_ttl
298 # If you use proxy authentication and the 'max_user_ip' ACL,
299 # this directive controls how long Squid remembers the IP
300 # addresses associated with each user. Use a small value
301 # (e.g., 60 seconds) if your users might change addresses
302 # quickly, as is the case with dialups. You might be safe
303 # using a larger value (e.g., 2 hours) in a corporate LAN
304 # environment with relatively static address assignments.
307 # authenticate_ip_ttl 0 seconds
311 # -----------------------------------------------------------------------------
313 # TAG: external_acl_type
314 # This option defines external acl classes using a helper program
315 # to look up the status
317 # external_acl_type name [options] FORMAT.. /path/to/helper [helper arguments..]
321 # ttl=n TTL in seconds for cached results (defaults to 3600
324 # TTL for cached negative lookups (default same
326 # children=n Number of acl helper processes spawn to service
327 # external acl lookups of this type. (default 5)
328 # concurrency=n concurrency level per process. Only used with helpers
329 # capable of processing more than one query at a time.
330 # cache=n result cache size, 0 is unbounded (default)
331 # grace=n Percentage remaining of TTL where a refresh of a
332 # cached entry should be initiated without needing to
333 # wait for a new reply. (default 0 for no grace period)
334 # protocol=2.5 Compatibility mode for Squid-2.5 external acl helpers
336 # FORMAT specifications
338 # %LOGIN Authenticated user login name
339 # %EXT_USER Username from external acl
340 # %IDENT Ident user name
342 # %SRCPORT Client source port
344 # %DST Requested host
345 # %PROTO Requested protocol
346 # %PORT Requested port
347 # %PATH Requested URL path
348 # %METHOD Request method
349 # %MYADDR Squid interface address
350 # %MYPORT Squid http_port number
351 # %PATH Requested URL-path (including query-string if any)
352 # %USER_CERT SSL User certificate in PEM format
353 # %USER_CERTCHAIN SSL User certificate chain in PEM format
354 # %USER_CERT_xx SSL User certificate subject attribute xx
355 # %USER_CA_xx SSL User certificate issuer attribute xx
356 # %{Header} HTTP request header
357 # %{Hdr:member} HTTP request header list member
359 # HTTP request header list member using ; as
360 # list separator. ; can be any non-alphanumeric
363 # In addition to the above, any string specified in the referencing
364 # acl will also be included in the helper request line, after the
365 # specified formats (see the "acl external" directive)
367 # The helper receives lines per the above format specification,
368 # and returns lines starting with OK or ERR indicating the validity
369 # of the request and optionally followed by additional keywords with
372 # General result syntax:
374 # OK/ERR keyword=value ...
378 # user= The users name (login)
379 # password= The users password (for login= cache_peer option)
380 # message= Message describing the reason. Available as %o
382 # tag= Apply a tag to a request (for both ERR and OK results)
383 # Only sets a tag, does not alter existing tags.
384 # log= String to be logged in access.log. Available as
385 # %ea in logformat specifications
387 # If protocol=3.0 (the default) then URL escaping is used to protect
388 # each value in both requests and responses.
390 # If using protocol=2.5 then all values need to be enclosed in quotes
391 # if they may contain whitespace, or the whitespace escaped using \.
392 # And quotes or \ characters within the keyword value must be \ escaped.
394 # When using the concurrency= option the protocol is changed by
395 # introducing a query channel tag infront of the request/response.
396 # The query channel tag is a number between 0 and concurrency-1.
402 # Defining an Access List
404 # Every access list definition must begin with an aclname and acltype,
405 # followed by either type-specific arguments or a quoted filename that
406 # they are read from.
408 # acl aclname acltype argument ...
409 # acl aclname acltype "file" ...
411 # When using "file", the file should contain one item per line.
413 # By default, regular expressions are CASE-SENSITIVE. To make
414 # them case-insensitive, use the -i option.
417 # ***** ACL TYPES AVAILABLE *****
419 # acl aclname src ip-address/netmask ... # clients IP address
420 # acl aclname src addr1-addr2/netmask ... # range of addresses
421 # acl aclname dst ip-address/netmask ... # URL host's IP address
422 # acl aclname myip ip-address/netmask ... # local socket IP address
424 # acl aclname arp mac-address ... (xx:xx:xx:xx:xx:xx notation)
425 # # The arp ACL requires the special configure option --enable-arp-acl.
426 # # Furthermore, the ARP ACL code is not portable to all operating systems.
427 # # It works on Linux, Solaris, Windows, FreeBSD, and some other *BSD variants.
429 # # NOTE: Squid can only determine the MAC address for clients that are on
430 # # the same subnet. If the client is on a different subnet, then Squid cannot
431 # # find out its MAC address.
433 # acl aclname srcdomain .foo.com ... # reverse lookup, from client IP
434 # acl aclname dstdomain .foo.com ... # Destination server from URL
435 # acl aclname srcdom_regex [-i] \.foo\.com ... # regex matching client name
436 # acl aclname dstdom_regex [-i] \.foo\.com ... # regex matching server
437 # # For dstdomain and dstdom_regex a reverse lookup is tried if a IP
438 # # based URL is used and no match is found. The name "none" is used
439 # # if the reverse lookup fails.
441 # acl aclname src_as number ...
442 # acl aclname dst_as number ...
443 # # Except for access control, AS numbers can be used for
444 # # routing of requests to specific caches. Here's an
445 # # example for routing all requests for AS#1241 and only
446 # # those to mycache.mydomain.net:
447 # # acl asexample dst_as 1241
448 # # cache_peer_access mycache.mydomain.net allow asexample
449 # # cache_peer_access mycache_mydomain.net deny all
451 # acl aclname time [day-abbrevs] [h1:m1-h2:m2]
460 # # h1:m1 must be less than h2:m2
462 # acl aclname url_regex [-i] ^http:// ... # regex matching on whole URL
463 # acl aclname urlpath_regex [-i] \.gif$ ... # regex matching on URL path
465 # acl aclname port 80 70 21 ...
466 # acl aclname port 0-1024 ... # ranges allowed
467 # acl aclname myport 3128 ... # (local socket TCP port)
468 # acl aclname myportname 3128 ... # http(s)_port name
470 # acl aclname proto HTTP FTP ...
472 # acl aclname method GET POST ...
474 # acl aclname http_status 200 301 500- 400-403 ... # status code in reply
476 # acl aclname browser [-i] regexp ...
477 # # pattern match on User-Agent header (see also req_header below)
479 # acl aclname referer_regex [-i] regexp ...
480 # # pattern match on Referer header
481 # # Referer is highly unreliable, so use with care
483 # acl aclname ident username ...
484 # acl aclname ident_regex [-i] pattern ...
485 # # string match on ident output.
486 # # use REQUIRED to accept any non-null ident.
488 # acl aclname proxy_auth [-i] username ...
489 # acl aclname proxy_auth_regex [-i] pattern ...
490 # # list of valid usernames
491 # # use REQUIRED to accept any valid username.
493 # # NOTE: when a Proxy-Authentication header is sent but it is not
494 # # needed during ACL checking the username is NOT logged
497 # # NOTE: proxy_auth requires a EXTERNAL authentication program
498 # # to check username/password combinations (see
499 # # auth_param directive).
501 # # NOTE: proxy_auth can't be used in a transparent/intercepting proxy
502 # # as the browser needs to be configured for using a proxy in order
503 # # to respond to proxy authentication.
505 # acl aclname snmp_community string ...
506 # # A community string to limit access to your SNMP Agent
509 # # acl snmppublic snmp_community public
511 # acl aclname maxconn number
512 # # This will be matched when the client's IP address has
513 # # more than <number> HTTP connections established.
515 # acl aclname max_user_ip [-s] number
516 # # This will be matched when the user attempts to log in from more
517 # # than <number> different ip addresses. The authenticate_ip_ttl
518 # # parameter controls the timeout on the ip entries.
519 # # If -s is specified the limit is strict, denying browsing
520 # # from any further IP addresses until the ttl has expired. Without
521 # # -s Squid will just annoy the user by "randomly" denying requests.
522 # # (the counter is reset each time the limit is reached and a
523 # # request is denied)
524 # # NOTE: in acceleration mode or where there is mesh of child proxies,
525 # # clients may appear to come from multiple addresses if they are
526 # # going through proxy farms, so a limit of 1 may cause user problems.
528 # acl aclname req_mime_type [-i] mime-type ...
529 # # regex match against the mime type of the request generated
530 # # by the client. Can be used to detect file upload or some
531 # # types HTTP tunneling requests.
532 # # NOTE: This does NOT match the reply. You cannot use this
533 # # to match the returned file type.
535 # acl aclname req_header header-name [-i] any\.regex\.here
536 # # regex match against any of the known request headers. May be
537 # # thought of as a superset of "browser", "referer" and "mime-type"
540 # acl aclname rep_mime_type [-i] mime-type ...
541 # # regex match against the mime type of the reply received by
542 # # squid. Can be used to detect file download or some
543 # # types HTTP tunneling requests.
544 # # NOTE: This has no effect in http_access rules. It only has
545 # # effect in rules that affect the reply data stream such as
546 # # http_reply_access.
548 # acl aclname rep_header header-name [-i] any\.regex\.here
549 # # regex match against any of the known reply headers. May be
550 # # thought of as a superset of "browser", "referer" and "mime-type"
553 # acl aclname external class_name [arguments...]
554 # # external ACL lookup via a helper class defined by the
555 # # external_acl_type directive.
557 # acl aclname user_cert attribute values...
558 # # match against attributes in a user SSL certificate
559 # # attribute is one of DN/C/O/CN/L/ST
561 # acl aclname ca_cert attribute values...
562 # # match against attributes a users issuing CA SSL certificate
563 # # attribute is one of DN/C/O/CN/L/ST
565 # acl aclname ext_user username ...
566 # acl aclname ext_user_regex [-i] pattern ...
567 # # string match on username returned by external acl helper
568 # # use REQUIRED to accept any non-null user name.
571 #acl macaddress arp 09:00:2b:23:45:67
572 #acl myexample dst_as 1241
573 #acl password proxy_auth REQUIRED
574 #acl fileupload req_mime_type -i ^multipart/form-data$
575 #acl javascript rep_mime_type -i ^application/x-javascript$
580 #Recommended minimum configuration:
581 acl manager proto cache_object
582 acl localhost src 127.0.0.1/32
583 acl to_localhost dst 127.0.0.0/8
585 # Example rule allowing access from your local networks.
586 # Adapt to list your (internal) IP networks from where browsing
588 acl localnet src 10.0.0.0/8 # RFC1918 possible internal network
589 acl localnet src 172.16.0.0/12 # RFC1918 possible internal network
590 acl localnet src 192.168.0.0/16 # RFC1918 possible internal network
592 acl SSL_ports port 443
593 acl Safe_ports port 80 # http
594 acl Safe_ports port 21 # ftp
595 acl Safe_ports port 443 # https
596 acl Safe_ports port 70 # gopher
597 acl Safe_ports port 210 # wais
598 acl Safe_ports port 1025-65535 # unregistered ports
599 acl Safe_ports port 280 # http-mgmt
600 acl Safe_ports port 488 # gss-http
601 acl Safe_ports port 591 # filemaker
602 acl Safe_ports port 777 # multiling http
603 acl CONNECT method CONNECT
606 # Allowing or Denying access based on defined access lists
608 # Access to the HTTP port:
609 # http_access allow|deny [!]aclname ...
611 # NOTE on default values:
613 # If there are no "access" lines present, the default is to deny
616 # If none of the "access" lines cause a match, the default is the
617 # opposite of the last line in the list. If the last line was
618 # deny, the default is allow. Conversely, if the last line
619 # is allow, the default will be deny. For these reasons, it is a
620 # good idea to have an "deny all" or "allow all" entry at the end
621 # of your access lists to avoid potential confusion.
624 # http_access deny all
626 #Recommended minimum configuration:
628 # Only allow cachemgr access from localhost
629 http_access allow manager localhost
630 http_access deny manager
631 # Deny requests to unknown ports
632 http_access deny !Safe_ports
633 # Deny CONNECT to other than SSL ports
634 http_access deny CONNECT !SSL_ports
636 # We strongly recommend the following be uncommented to protect innocent
637 # web applications running on the proxy server who think the only
638 # one who can access services on "localhost" is a local user
639 #http_access deny to_localhost
641 # INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS
643 # Example rule allowing access from your local networks.
644 # Adapt localnet in the ACL section to list your (internal) IP networks
645 # from where browsing should be allowed
646 http_access allow localnet
648 # And finally deny all other access to this proxy
649 http_access allow localhost
652 # TAG: http_reply_access
653 # Allow replies to client requests. This is complementary to http_access.
655 # http_reply_access allow|deny [!] aclname ...
657 # NOTE: if there are no access lines present, the default is to allow
660 # If none of the access lines cause a match the opposite of the
661 # last line will apply. Thus it is good practice to end the rules
662 # with an "allow all" or "deny all" entry.
668 # Allowing or Denying access to the ICP port based on defined
671 # icp_access allow|deny [!]aclname ...
673 # See http_access for details
676 # icp_access deny all
678 #Allow ICP queries from local networks only
679 icp_access allow localnet
683 # Allowing or Denying access to the HTCP port based on defined
686 # htcp_access allow|deny [!]aclname ...
688 # See http_access for details
690 # NOTE: The default if no htcp_access lines are present is to
691 # deny all traffic. This default may cause problems with peers
692 # using the htcp or htcp-oldsquid options.
695 # htcp_access deny all
697 #Allow HTCP queries from local networks only
698 htcp_access allow localnet
701 # TAG: htcp_clr_access
702 # Allowing or Denying access to purge content using HTCP based
703 # on defined access lists
705 # htcp_clr_access allow|deny [!]aclname ...
707 # See http_access for details
709 ##Allow HTCP CLR requests from trusted peers
710 #acl htcp_clr_peer src 172.16.1.2
711 #htcp_clr_access allow htcp_clr_peer
714 # htcp_clr_access deny all
717 # Use to force your neighbors to use you as a sibling instead of
718 # a parent. For example:
720 # acl localclients src 172.16.0.0/16
721 # miss_access allow localclients
722 # miss_access deny !localclients
724 # This means only your local clients are allowed to fetch
725 # MISSES and all other clients can only fetch HITS.
727 # By default, allow all clients who passed the http_access rules
728 # to fetch MISSES from us.
731 # miss_access allow all
733 # TAG: ident_lookup_access
734 # A list of ACL elements which, if matched, cause an ident
735 # (RFC 931) lookup to be performed for this request. For
736 # example, you might choose to always perform ident lookups
737 # for your main multi-user Unix boxes, but not for your Macs
738 # and PCs. By default, ident lookups are not performed for
741 # To enable ident lookups for specific client addresses, you
742 # can follow this example:
744 # acl ident_aware_hosts src 198.168.1.0/255.255.255.0
745 # ident_lookup_access allow ident_aware_hosts
746 # ident_lookup_access deny all
748 # Only src type ACL checks are fully supported. A src_domain
749 # ACL might work at times, but it will not always provide
750 # the correct result.
753 # ident_lookup_access deny all
755 # TAG: reply_body_max_size size [acl acl...]
756 # This option specifies the maximum size of a reply body. It can be
757 # used to prevent users from downloading very large files, such as
758 # MP3's and movies. When the reply headers are received, the
759 # reply_body_max_size lines are processed, and the first line where
760 # all (if any) listed ACLs are true is used as the maximum body size
763 # This size is checked twice. First when we get the reply headers,
764 # we check the content-length value. If the content length value exists
765 # and is larger than the allowed size, the request is denied and the
766 # user receives an error message that says "the request or reply
767 # is too large." If there is no content-length, and the reply
768 # size exceeds this limit, the client's connection is just closed
769 # and they will receive a partial reply.
771 # WARNING: downstream caches probably can not detect a partial reply
772 # if there is no content-length header, so they will cache
773 # partial responses and give them out as hits. You should NOT
774 # use this option if you have downstream caches.
776 # WARNING: A maximum size smaller than the size of squid's error messages
777 # will cause an infinite loop and crash squid. Ensure that the smallest
778 # non-zero value you use is greater that the maximum header size plus
779 # the size of your largest error page.
781 # If you set this parameter none (the default), there will be
784 # Configuration Format is:
785 # reply_body_max_size SIZE UNITS [acl ...]
787 # reply_body_max_size 10 MB
795 # -----------------------------------------------------------------------------
798 # Usage: port [options]
799 # hostname:port [options]
800 # 1.2.3.4:port [options]
802 # The socket addresses where Squid will listen for HTTP client
803 # requests. You may specify multiple socket addresses.
804 # There are three forms: port alone, hostname with port, and
805 # IP address with port. If you specify a hostname or IP
806 # address, Squid binds the socket to that specific
807 # address. This replaces the old 'tcp_incoming_address'
808 # option. Most likely, you do not need to bind to a specific
809 # address, so you can use the port number alone.
811 # If you are running Squid in accelerator mode, you
812 # probably want to listen on port 80 also, or instead.
814 # The -a command line option may be used to specify additional
815 # port(s) where Squid listens for proxy request. Such ports will
816 # be plain proxy ports with no options.
818 # You may specify multiple socket addresses on multiple lines.
822 # transparent Support for transparent interception of
823 # outgoing requests without browser settings.
824 # NP: disables authentication on the port.
826 # tproxy Support Linux TPROXY for spoofing outgoing
827 # connections using the client IP address.
828 # NP: disables authentication on the port.
830 # accel Accelerator mode. Also needs at least one of
831 # vhost / vport / defaultsite.
833 # defaultsite=domainname
834 # What to use for the Host: header if it is not present
835 # in a request. Determines what site (not origin server)
836 # accelerators should consider the default.
839 # vhost Accelerator mode using Host header for virtual
840 # domain support. Implies accel.
842 # vport Accelerator with IP based virtual host support.
845 # vport=NN As above, but uses specified port number rather
846 # than the http_port number. Implies accel.
848 # protocol= Protocol to reconstruct accelerated requests with.
851 # disable-pmtu-discovery=
852 # Control Path-MTU discovery usage:
853 # off lets OS decide on what to do (default).
854 # transparent disable PMTU discovery when transparent
855 # support is enabled.
856 # always disable always PMTU discovery.
858 # In many setups of transparently intercepting proxies
859 # Path-MTU discovery can not work on traffic towards the
860 # clients. This is the case when the intercepting device
861 # does not fully track connections and fails to forward
862 # ICMP must fragment messages to the cache server. If you
863 # have such setup and experience that certain clients
864 # sporadically hang or never complete requests set
865 # disable-pmtu-discovery option to 'transparent'.
867 # name= Specifies a internal name for the port. Defaults to
868 # the port specification (port or addr:port)
870 # If you run Squid on a dual-homed machine with an internal
871 # and an external interface we recommend you to specify the
872 # internal address:port in http_port. This way Squid will only be
873 # visible on the internal address.
875 # Squid normally listens to port 3128
879 # Usage: [ip:]port cert=certificate.pem [key=key.pem] [options...]
881 # The socket address where Squid will listen for HTTPS client
884 # This is really only useful for situations where you are running
885 # squid in accelerator mode and you want to do the SSL work at the
888 # You may specify multiple socket addresses on multiple lines,
889 # each with their own SSL certificate and/or options.
893 # accel Accelerator mode. Also needs at least one of
894 # defaultsite or vhost.
896 # defaultsite= The name of the https site presented on
897 # this port. Implies accel.
899 # vhost Accelerator mode using Host header for virtual
900 # domain support. Requires a wildcard certificate
901 # or other certificate valid for more than one domain.
904 # protocol= Protocol to reconstruct accelerated requests with.
907 # cert= Path to SSL certificate (PEM format).
909 # key= Path to SSL private key file (PEM format)
910 # if not specified, the certificate file is
911 # assumed to be a combined certificate and
914 # version= The version of SSL/TLS supported
915 # 1 automatic (default)
920 # cipher= Colon separated list of supported ciphers.
922 # options= Various SSL engine options. The most important
924 # NO_SSLv2 Disallow the use of SSLv2
925 # NO_SSLv3 Disallow the use of SSLv3
926 # NO_TLSv1 Disallow the use of TLSv1
927 # SINGLE_DH_USE Always create a new key when using
928 # temporary/ephemeral DH key exchanges
929 # See src/ssl_support.c or OpenSSL SSL_CTX_set_options
930 # documentation for a complete list of options.
932 # clientca= File containing the list of CAs to use when
933 # requesting a client certificate.
935 # cafile= File containing additional CA certificates to
936 # use when verifying client certificates. If unset
937 # clientca will be used.
939 # capath= Directory containing additional CA certificates
940 # and CRL lists to use when verifying client certificates.
942 # crlfile= File of additional CRL lists to use when verifying
943 # the client certificate, in addition to CRLs stored in
944 # the capath. Implies VERIFY_CRL flag below.
946 # dhparams= File containing DH parameters for temporary/ephemeral
949 # sslflags= Various flags modifying the use of SSL:
951 # Don't request client certificates
952 # immediately, but wait until acl processing
953 # requires a certificate (not yet implemented).
955 # Don't use the default CA lists built in
958 # Don't allow for session reuse. Each connection
959 # will result in a new SSL session.
961 # Verify CRL lists when accepting client
964 # Verify CRL lists for all certificates in the
965 # client certificate chain.
967 # sslcontext= SSL session ID context identifier.
969 # vport Accelerator with IP based virtual host support.
971 # vport=NN As above, but uses specified port number rather
972 # than the https_port number. Implies accel.
974 # name= Specifies a internal name for the port. Defaults to
975 # the port specification (port or addr:port)
981 # TAG: tcp_outgoing_tos
982 # Allows you to select a TOS/Diffserv value to mark outgoing
983 # connections with, based on the username or source address
984 # making the request.
986 # tcp_outgoing_tos ds-field [!]aclname ...
988 # Example where normal_service_net uses the TOS value 0x00
989 # and normal_service_net uses 0x20
991 # acl normal_service_net src 10.0.0.0/255.255.255.0
992 # acl good_service_net src 10.0.1.0/255.255.255.0
993 # tcp_outgoing_tos 0x00 normal_service_net
994 # tcp_outgoing_tos 0x20 good_service_net
996 # TOS/DSCP values really only have local significance - so you should
997 # know what you're specifying. For more information, see RFC2474 and
1000 # The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or
1001 # "default" to use whatever default your host has. Note that in
1002 # practice often only values 0 - 63 is usable as the two highest bits
1003 # have been redefined for use by ECN (RFC3168).
1005 # Processing proceeds in the order specified, and stops at first fully
1008 # Note: The use of this directive using client dependent ACLs is
1009 # incompatible with the use of server side persistent connections. To
1010 # ensure correct results it is best to set server_persisten_connections
1011 # to off when using this directive in such configurations.
1016 # TAG: clientside_tos
1017 # Allows you to select a TOS/Diffserv value to mark client-side
1018 # connections with, based on the username or source address
1019 # making the request.
1024 # TAG: tcp_outgoing_address
1025 # Allows you to map requests to different outgoing IP addresses
1026 # based on the username or source address of the user making
1029 # tcp_outgoing_address ipaddr [[!]aclname] ...
1031 # Example where requests from 10.0.0.0/24 will be forwarded
1032 # with source address 10.1.0.1, 10.0.2.0/24 forwarded with
1033 # source address 10.1.0.2 and the rest will be forwarded with
1034 # source address 10.1.0.3.
1036 # acl normal_service_net src 10.0.0.0/24
1037 # acl good_service_net src 10.0.2.0/24
1038 # tcp_outgoing_address 10.1.0.1 normal_service_net
1039 # tcp_outgoing_address 10.1.0.2 good_service_net
1040 # tcp_outgoing_address 10.1.0.3
1042 # Processing proceeds in the order specified, and stops at first fully
1045 # Note: The use of this directive using client dependent ACLs is
1046 # incompatible with the use of server side persistent connections. To
1047 # ensure correct results it is best to set server_persistent_connections
1048 # to off when using this directive in such configurations.
1055 # -----------------------------------------------------------------------------
1057 # TAG: ssl_unclean_shutdown
1058 # Some browsers (especially MSIE) bugs out on SSL shutdown
1062 # ssl_unclean_shutdown off
1065 # The OpenSSL engine to use. You will need to set this if you
1066 # would like to use hardware SSL acceleration for example.
1071 # TAG: sslproxy_client_certificate
1072 # Client SSL Certificate to use when proxying https:// URLs
1077 # TAG: sslproxy_client_key
1078 # Client SSL Key to use when proxying https:// URLs
1083 # TAG: sslproxy_version
1084 # SSL version level to use when proxying https:// URLs
1087 # sslproxy_version 1
1089 # TAG: sslproxy_options
1090 # SSL engine options to use when proxying https:// URLs
1095 # TAG: sslproxy_cipher
1096 # SSL cipher list to use when proxying https:// URLs
1101 # TAG: sslproxy_cafile
1102 # file containing CA certificates to use when verifying server
1103 # certificates while proxying https:// URLs
1108 # TAG: sslproxy_capath
1109 # directory containing CA certificates to use when verifying
1110 # server certificates while proxying https:// URLs
1115 # TAG: sslproxy_flags
1116 # Various flags modifying the use of SSL while proxying https:// URLs:
1117 # DONT_VERIFY_PEER Accept certificates even if they fail to
1119 # NO_DEFAULT_CA Don't use the default CA list built in
1125 # TAG: sslpassword_program
1126 # Specify a program used for entering SSL key passphrases
1127 # when using encrypted SSL certificate keys. If not specified
1128 # keys must either be unencrypted, or Squid started with the -N
1129 # option to allow it to query interactively for the passphrase.
1135 # OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM
1136 # -----------------------------------------------------------------------------
1139 # To specify other caches in a hierarchy, use the format:
1141 # cache_peer hostname type http-port icp-port [options]
1146 # # hostname type port port options
1147 # # -------------------- -------- ----- ----- -----------
1148 # cache_peer parent.foo.net parent 3128 3130 proxy-only default
1149 # cache_peer sib1.foo.net sibling 3128 3130 proxy-only
1150 # cache_peer sib2.foo.net sibling 3128 3130 proxy-only
1152 # type: either 'parent', 'sibling', or 'multicast'.
1154 # proxy-port: The port number where the cache listens for proxy
1157 # icp-port: Used for querying neighbor caches about
1158 # objects. To have a non-ICP neighbor
1159 # specify '7' for the ICP port and make sure the
1160 # neighbor machine has the UDP echo port
1161 # enabled in its /etc/inetd.conf file.
1162 # NOTE: Also requires icp_port option enabled to send/receive
1163 # requests via this method.
1165 # options: proxy-only
1173 # weighted-round-robin
1177 # multicast-responder
1182 # login=user:password | PASS | *:password
1183 # connect-timeout=nn
1193 # sslcert=/path/to/ssl/certificate
1194 # sslkey=/path/to/ssl/key
1195 # sslversion=1|2|3|4
1198 # front-end-https[=on|auto]
1200 # use 'proxy-only' to specify objects fetched
1201 # from this cache should not be saved locally.
1203 # use 'weight=n' to affect the selection of a peer
1204 # during any weighted peer-selection mechanisms.
1205 # The weight must be an integer; default is 1,
1206 # larger weights are favored more.
1207 # This option does not affect parent selection if a peering
1208 # protocol is not in use.
1210 # use 'basetime=n' to specify a base amount to
1211 # be subtracted from round trip times of parents.
1212 # It is subtracted before division by weight in calculating
1213 # which parent to fectch from. If the rtt is less than the
1214 # base time the rtt is set to a minimal value.
1216 # use 'ttl=n' to specify a IP multicast TTL to use
1217 # when sending an ICP queries to this address.
1218 # Only useful when sending to a multicast group.
1219 # Because we don't accept ICP replies from random
1220 # hosts, you must configure other group members as
1221 # peers with the 'multicast-responder' option below.
1223 # use 'no-query' to NOT send ICP queries to this
1226 # use 'background-ping' to only send ICP queries to this
1227 # neighbor infrequently. This is used to keep the neighbor
1228 # round trip time updated and is usually used in
1229 # conjunction with weighted-round-robin.
1231 # use 'default' if this is a parent cache which can
1232 # be used as a "last-resort" if a peer cannot be located
1233 # by any of the peer-selection mechanisms.
1234 # If specified more than once, only the first is used.
1236 # use 'round-robin' to define a set of parents which
1237 # should be used in a round-robin fashion in the
1238 # absence of any ICP queries.
1240 # use 'weighted-round-robin' to define a set of parents
1241 # which should be used in a round-robin fashion with the
1242 # frequency of each parent being based on the round trip
1243 # time. Closer parents are used more often.
1244 # Usually used for background-ping parents.
1246 # use 'carp' to define a set of parents which should
1247 # be used as a CARP array. The requests will be
1248 # distributed among the parents based on the CARP load
1249 # balancing hash function based on their weight.
1251 # use 'userhash' to load-balance amongst a set of parents
1252 # based on the client proxy_auth or ident username.
1254 # use 'sourcehash' to load-balance amongst a set of parents
1255 # based on the client source ip.
1257 # 'multicast-responder' indicates the named peer
1258 # is a member of a multicast group. ICP queries will
1259 # not be sent directly to the peer, but ICP replies
1260 # will be accepted from it.
1262 # 'closest-only' indicates that, for ICP_OP_MISS
1263 # replies, we'll only forward CLOSEST_PARENT_MISSes
1264 # and never FIRST_PARENT_MISSes.
1266 # use 'no-digest' to NOT request cache digests from
1269 # 'no-netdb-exchange' disables requesting ICMP
1270 # RTT database (NetDB) from the neighbor.
1272 # use 'no-delay' to prevent access to this neighbor
1273 # from influencing the delay pools.
1275 # use 'login=user:password' if this is a personal/workgroup
1276 # proxy and your parent requires proxy authentication.
1277 # Note: The string can include URL escapes (i.e. %20 for
1278 # spaces). This also means % must be written as %%.
1280 # use 'login=PASS' if users must authenticate against
1281 # the upstream proxy or in the case of a reverse proxy
1282 # configuration, the origin web server. This will pass
1283 # the users credentials as they are to the peer.
1284 # This only works for the Basic HTTP authentication scheme.
1285 # Note: To combine this with proxy_auth both proxies must
1286 # share the same user database as HTTP only allows for
1287 # a single login (one for proxy, one for origin server).
1288 # Also be warned this will expose your users proxy
1289 # password to the peer. USE WITH CAUTION
1291 # use 'login=*:password' to pass the username to the
1292 # upstream cache, but with a fixed password. This is meant
1293 # to be used when the peer is in another administrative
1294 # domain, but it is still needed to identify each user.
1295 # The star can optionally be followed by some extra
1296 # information which is added to the username. This can
1297 # be used to identify this proxy to the peer, similar to
1298 # the login=username:password option above.
1300 # use 'connect-timeout=nn' to specify a peer
1301 # specific connect timeout (also see the
1302 # peer_connect_timeout directive)
1304 # use 'digest-url=url' to tell Squid to fetch the cache
1305 # digest (if digests are enabled) for this host from
1306 # the specified URL rather than the Squid default
1309 # use 'allow-miss' to disable Squid's use of only-if-cached
1310 # when forwarding requests to siblings. This is primarily
1311 # useful when icp_hit_stale is used by the sibling. To
1312 # extensive use of this option may result in forwarding
1313 # loops, and you should avoid having two-way peerings
1314 # with this option. (for example to deny peer usage on
1315 # requests from peer by denying cache_peer_access if the
1318 # use 'max-conn=n' to limit the amount of connections Squid
1319 # may open to this peer.
1321 # use 'htcp' to send HTCP, instead of ICP, queries
1322 # to the neighbor. You probably also want to
1323 # set the "icp port" to 4827 instead of 3130.
1324 # You MUST also set htcp_access expicitly. The default of
1325 # deny all will prevent peer traffic.
1327 # use 'htcp-oldsquid' to send HTCP to old Squid versions
1328 # You MUST also set htcp_access expicitly. The default of
1329 # deny all will prevent peer traffic.
1331 # 'originserver' causes this parent peer to be contacted as
1332 # a origin server. Meant to be used in accelerator setups.
1334 # use 'name=xxx' if you have multiple peers on the same
1335 # host but different ports. This name can be used to
1336 # differentiate the peers in cache_peer_access and similar
1339 # use 'forceddomain=name' to forcibly set the Host header
1340 # of requests forwarded to this peer. Useful in accelerator
1341 # setups where the server (peer) expects a certain domain
1342 # name and using redirectors to feed this domain name
1345 # use 'ssl' to indicate connections to this peer should
1346 # be SSL/TLS encrypted.
1348 # use 'sslcert=/path/to/ssl/certificate' to specify a client
1349 # SSL certificate to use when connecting to this peer.
1351 # use 'sslkey=/path/to/ssl/key' to specify the private SSL
1352 # key corresponding to sslcert above. If 'sslkey' is not
1353 # specified 'sslcert' is assumed to reference a
1354 # combined file containing both the certificate and the key.
1356 # use sslversion=1|2|3|4 to specify the SSL version to use
1357 # when connecting to this peer
1358 # 1 = automatic (default)
1363 # use sslcipher=... to specify the list of valid SSL ciphers
1364 # to use when connecting to this peer.
1366 # use ssloptions=... to specify various SSL engine options:
1367 # NO_SSLv2 Disallow the use of SSLv2
1368 # NO_SSLv3 Disallow the use of SSLv3
1369 # NO_TLSv1 Disallow the use of TLSv1
1370 # See src/ssl_support.c or the OpenSSL documentation for
1371 # a more complete list.
1373 # use sslcafile=... to specify a file containing
1374 # additional CA certificates to use when verifying the
1377 # use sslcapath=... to specify a directory containing
1378 # additional CA certificates to use when verifying the
1381 # use sslcrlfile=... to specify a certificate revocation
1382 # list file to use when verifying the peer certificate.
1384 # use sslflags=... to specify various flags modifying the
1385 # SSL implementation:
1387 # Accept certificates even if they fail to
1390 # Don't use the default CA list built in
1392 # DONT_VERIFY_DOMAIN
1393 # Don't verify the peer certificate
1394 # matches the server name
1396 # use ssldomain= to specify the peer name as advertised
1397 # in it's certificate. Used for verifying the correctness
1398 # of the received peer certificate. If not specified the
1399 # peer hostname will be used.
1401 # use front-end-https to enable the "Front-End-Https: On"
1402 # header needed when using Squid as a SSL frontend in front
1403 # of Microsoft OWA. See MS KB document Q307347 for details
1404 # on this header. If set to auto the header will
1405 # only be added if the request is forwarded as a https://
1411 # TAG: cache_peer_domain
1412 # Use to limit the domains for which a neighbor cache will be
1415 # cache_peer_domain cache-host domain [domain ...]
1416 # cache_peer_domain cache-host !domain
1418 # For example, specifying
1420 # cache_peer_domain parent.foo.net .edu
1422 # has the effect such that UDP query packets are sent to
1423 # 'bigserver' only when the requested object exists on a
1424 # server in the .edu domain. Prefixing the domainname
1425 # with '!' means the cache will be queried for objects
1426 # NOT in that domain.
1428 # NOTE: * Any number of domains may be given for a cache-host,
1429 # either on the same or separate lines.
1430 # * When multiple domains are given for a particular
1431 # cache-host, the first matched domain is applied.
1432 # * Cache hosts with no domain restrictions are queried
1434 # * There are no defaults.
1435 # * There is also a 'cache_peer_access' tag in the ACL
1441 # TAG: cache_peer_access
1442 # Similar to 'cache_peer_domain' but provides more flexibility by
1443 # using ACL elements.
1445 # cache_peer_access cache-host allow|deny [!]aclname ...
1447 # The syntax is identical to 'http_access' and the other lists of
1448 # ACL elements. See the comments for 'http_access' below, or
1449 # the Squid FAQ (http://www.squid-cache.org/FAQ/FAQ-10.html).
1454 # TAG: neighbor_type_domain
1455 # usage: neighbor_type_domain neighbor parent|sibling domain domain ...
1457 # Modifying the neighbor type for specific domains is now
1458 # possible. You can treat some domains differently than the the
1459 # default neighbor type specified on the 'cache_peer' line.
1460 # Normally it should only be necessary to list domains which
1461 # should be treated differently because the default neighbor type
1462 # applies for hostnames which do not match domains listed here.
1465 # cache_peer cache.foo.org parent 3128 3130
1466 # neighbor_type_domain cache.foo.org sibling .com .net
1467 # neighbor_type_domain cache.foo.org sibling .au .de
1472 # TAG: dead_peer_timeout (seconds)
1473 # This controls how long Squid waits to declare a peer cache
1474 # as "dead." If there are no ICP replies received in this
1475 # amount of time, Squid will declare the peer dead and not
1476 # expect to receive any further ICP replies. However, it
1477 # continues to send ICP queries, and will mark the peer as
1478 # alive upon receipt of the first subsequent ICP reply.
1480 # This timeout also affects when Squid expects to receive ICP
1481 # replies from peers. If more than 'dead_peer' seconds have
1482 # passed since the last ICP reply was received, Squid will not
1483 # expect to receive an ICP reply on the next query. Thus, if
1484 # your time between requests is greater than this timeout, you
1485 # will see a lot of requests sent DIRECT to origin servers
1486 # instead of to your parents.
1489 # dead_peer_timeout 10 seconds
1491 # TAG: hierarchy_stoplist
1492 # A list of words which, if found in a URL, cause the object to
1493 # be handled directly by this cache. In other words, use this
1494 # to not query neighbor caches for certain objects. You may
1495 # list this option multiple times.
1496 # Note: never_direct overrides this option.
1497 #We recommend you to use at least the following line.
1498 hierarchy_stoplist cgi-bin ?
1501 # MEMORY CACHE OPTIONS
1502 # -----------------------------------------------------------------------------
1504 # TAG: cache_mem (bytes)
1505 # NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS SIZE.
1506 # IT ONLY PLACES A LIMIT ON HOW MUCH ADDITIONAL MEMORY SQUID WILL
1507 # USE AS A MEMORY CACHE OF OBJECTS. SQUID USES MEMORY FOR OTHER
1508 # THINGS AS WELL. SEE THE SQUID FAQ SECTION 8 FOR DETAILS.
1510 # 'cache_mem' specifies the ideal amount of memory to be used
1512 # * In-Transit objects
1514 # * Negative-Cached objects
1516 # Data for these objects are stored in 4 KB blocks. This
1517 # parameter specifies the ideal upper limit on the total size of
1518 # 4 KB blocks allocated. In-Transit objects take the highest
1521 # In-transit objects have priority over the others. When
1522 # additional space is needed for incoming data, negative-cached
1523 # and hot objects will be released. In other words, the
1524 # negative-cached and hot objects will fill up any unused space
1525 # not needed for in-transit objects.
1527 # If circumstances require, this limit will be exceeded.
1528 # Specifically, if your incoming request rate requires more than
1529 # 'cache_mem' of memory to hold in-transit objects, Squid will
1530 # exceed this limit to satisfy the new requests. When the load
1531 # decreases, blocks will be freed until the high-water mark is
1532 # reached. Thereafter, blocks will be used to store hot
1538 # TAG: maximum_object_size_in_memory (bytes)
1539 # Objects greater than this size will not be attempted to kept in
1540 # the memory cache. This should be set high enough to keep objects
1541 # accessed frequently in memory to improve performance whilst low
1542 # enough to keep larger objects from hoarding cache_mem.
1545 # maximum_object_size_in_memory 8 KB
1547 # TAG: memory_replacement_policy
1548 # The memory replacement policy parameter determines which
1549 # objects are purged from memory when memory space is needed.
1551 # See cache_replacement_policy for details.
1554 # memory_replacement_policy lru
1557 # DISK CACHE OPTIONS
1558 # -----------------------------------------------------------------------------
1560 # TAG: cache_replacement_policy
1561 # The cache replacement policy parameter determines which
1562 # objects are evicted (replaced) when disk space is needed.
1564 # lru : Squid's original list based LRU policy
1565 # heap GDSF : Greedy-Dual Size Frequency
1566 # heap LFUDA: Least Frequently Used with Dynamic Aging
1567 # heap LRU : LRU policy implemented using a heap
1569 # Applies to any cache_dir lines listed below this.
1571 # The LRU policies keeps recently referenced objects.
1573 # The heap GDSF policy optimizes object hit rate by keeping smaller
1574 # popular objects in cache so it has a better chance of getting a
1575 # hit. It achieves a lower byte hit rate than LFUDA though since
1576 # it evicts larger (possibly popular) objects.
1578 # The heap LFUDA policy keeps popular objects in cache regardless of
1579 # their size and thus optimizes byte hit rate at the expense of
1580 # hit rate since one large, popular object will prevent many
1581 # smaller, slightly less popular objects from being cached.
1583 # Both policies utilize a dynamic aging mechanism that prevents
1584 # cache pollution that can otherwise occur with frequency-based
1585 # replacement policies.
1587 # NOTE: if using the LFUDA replacement policy you should increase
1588 # the value of maximum_object_size above its default of 4096 KB to
1589 # to maximize the potential byte hit rate improvement of LFUDA.
1591 # For more information about the GDSF and LFUDA cache replacement
1592 # policies see http://www.hpl.hp.com/techreports/1999/HPL-1999-69.html
1593 # and http://fog.hpl.external.hp.com/techreports/98/HPL-98-173.html.
1596 # cache_replacement_policy lru
1601 # cache_dir Type Directory-Name Fs-specific-data [options]
1603 # You can specify multiple cache_dir lines to spread the
1604 # cache among different disk partitions.
1606 # Type specifies the kind of storage system to use. Only "ufs"
1607 # is built by default. To enable any of the other storage systems
1608 # see the --enable-storeio configure option.
1610 # 'Directory' is a top-level directory where cache swap
1611 # files will be stored. If you want to use an entire disk
1612 # for caching, this can be the mount-point directory.
1613 # The directory must exist and be writable by the Squid
1614 # process. Squid will NOT create this directory for you.
1616 # The ufs store type:
1618 # "ufs" is the old well-known Squid storage format that has always
1621 # cache_dir ufs Directory-Name Mbytes L1 L2 [options]
1623 # 'Mbytes' is the amount of disk space (MB) to use under this
1624 # directory. The default is 100 MB. Change this to suit your
1625 # configuration. Do NOT put the size of your disk drive here.
1626 # Instead, if you want Squid to use the entire disk drive,
1627 # subtract 20% and use that value.
1629 # 'Level-1' is the number of first-level subdirectories which
1630 # will be created under the 'Directory'. The default is 16.
1632 # 'Level-2' is the number of second-level subdirectories which
1633 # will be created under each first-level directory. The default
1636 # The aufs store type:
1638 # "aufs" uses the same storage format as "ufs", utilizing
1639 # POSIX-threads to avoid blocking the main Squid process on
1640 # disk-I/O. This was formerly known in Squid as async-io.
1642 # cache_dir aufs Directory-Name Mbytes L1 L2 [options]
1644 # see argument descriptions under ufs above
1646 # The diskd store type:
1648 # "diskd" uses the same storage format as "ufs", utilizing a
1649 # separate process to avoid blocking the main Squid process on
1652 # cache_dir diskd Directory-Name Mbytes L1 L2 [options] [Q1=n] [Q2=n]
1654 # see argument descriptions under ufs above
1656 # Q1 specifies the number of unacknowledged I/O requests when Squid
1657 # stops opening new files. If this many messages are in the queues,
1658 # Squid won't open new files. Default is 64
1660 # Q2 specifies the number of unacknowledged messages when Squid
1661 # starts blocking. If this many messages are in the queues,
1662 # Squid blocks until it receives some replies. Default is 72
1664 # When Q1 < Q2 (the default), the cache directory is optimized
1665 # for lower response time at the expense of a decrease in hit
1666 # ratio. If Q1 > Q2, the cache directory is optimized for
1667 # higher hit ratio at the expense of an increase in response
1670 # The coss store type:
1672 # NP: COSS filesystem in 3.0 has been deemed too unstable for
1673 # production use and has thus been removed from this 3.0
1674 # STABLE release. We hope that it can be made usable again
1675 # in a future release.
1677 # block-size=n defines the "block size" for COSS cache_dir's.
1678 # Squid uses file numbers as block numbers. Since file numbers
1679 # are limited to 24 bits, the block size determines the maximum
1680 # size of the COSS partition. The default is 512 bytes, which
1681 # leads to a maximum cache_dir size of 512<<24, or 8 GB. Note
1682 # you should not change the coss block size after Squid
1683 # has written some objects to the cache_dir.
1685 # The coss file store has changed from 2.5. Now it uses a file
1686 # called 'stripe' in the directory names in the config - and
1687 # this will be created by squid -z.
1689 # The null store type:
1691 # no options are allowed or required
1695 # no-store, no new objects should be stored to this cache_dir
1697 # max-size=n, refers to the max object size this storedir supports.
1698 # It is used to initially choose the storedir to dump the object.
1699 # Note: To make optimal use of the max-size limits you should order
1700 # the cache_dir lines with the smallest max-size value first and the
1701 # ones with no max-size specification last.
1703 # Note for coss, max-size must be less than COSS_MEMBUF_SZ,
1704 # which can be changed with the --with-coss-membuf-size=N configure
1708 # cache_dir ufs /var/spool/squid 100 16 256
1710 # TAG: store_dir_select_algorithm
1711 # Set this to 'round-robin' as an alternative.
1714 # store_dir_select_algorithm least-load
1716 # TAG: max_open_disk_fds
1717 # To avoid having disk as the I/O bottleneck Squid can optionally
1718 # bypass the on-disk cache if more than this amount of disk file
1719 # descriptors are open.
1721 # A value of 0 indicates no limit.
1724 # max_open_disk_fds 0
1726 # TAG: minimum_object_size (bytes)
1727 # Objects smaller than this size will NOT be saved on disk. The
1728 # value is specified in kilobytes, and the default is 0 KB, which
1729 # means there is no minimum.
1732 # minimum_object_size 0 KB
1734 # TAG: maximum_object_size (bytes)
1735 # Objects larger than this size will NOT be saved on disk. The
1736 # value is specified in kilobytes, and the default is 4MB. If
1737 # you wish to get a high BYTES hit ratio, you should probably
1738 # increase this (one 32 MB object hit counts for 3200 10KB
1739 # hits). If you wish to increase speed more than your want to
1740 # save bandwidth you should leave this low.
1742 # NOTE: if using the LFUDA replacement policy you should increase
1743 # this value to maximize the byte hit rate improvement of LFUDA!
1744 # See replacement_policy below for a discussion of this policy.
1747 # maximum_object_size 4096 KB
1749 # TAG: cache_swap_low (percent, 0-100)
1750 # TAG: cache_swap_high (percent, 0-100)
1752 # The low- and high-water marks for cache object replacement.
1753 # Replacement begins when the swap (disk) usage is above the
1754 # low-water mark and attempts to maintain utilization near the
1755 # low-water mark. As swap utilization gets close to high-water
1756 # mark object eviction becomes more aggressive. If utilization is
1757 # close to the low-water mark less replacement is done each time.
1759 # Defaults are 90% and 95%. If you have a large cache, 5% could be
1760 # hundreds of MB. If this is the case you may wish to set these
1761 # numbers closer together.
1765 # cache_swap_high 95
1769 # -----------------------------------------------------------------------------
1774 # logformat <name> <format specification>
1776 # Defines an access log format.
1778 # The <format specification> is a string with embedded % format codes
1780 # % format codes all follow the same basic structure where all but
1781 # the formatcode is optional. Output strings are automatically escaped
1782 # as required according to their context and the output format
1783 # modifiers are usually not needed, but can be specified if an explicit
1784 # output format is desired.
1786 # % ["|[|'|#] [-] [[0]width] [{argument}] formatcode
1788 # " output in quoted string format
1789 # [ output in squid text log format as used by log_mime_hdrs
1790 # # output in URL quoted format
1794 # width field width. If starting with 0 the
1795 # output is zero padded
1796 # {arg} argument such as header name etc
1800 # >a Client source IP address
1802 # >p Client source port
1803 # <A Server IP address or peer name
1804 # la Local IP address (http_port)
1805 # lp Local port number (http_port)
1806 # ts Seconds since epoch
1807 # tu subsecond time (milliseconds)
1808 # tl Local time. Optional strftime format argument
1809 # default %d/%b/%Y:%H:%M:%S %z
1810 # tg GMT time. Optional strftime format argument
1811 # default %d/%b/%Y:%H:%M:%S %z
1812 # tr Response time (milliseconds)
1813 # >h Request header. Optional header name argument
1814 # on the format header[:[separator]element]
1815 # <h Reply header. Optional header name argument
1818 # ul User name from authentication
1819 # ui User name from ident
1820 # us User name from SSL
1821 # ue User name from external acl helper
1822 # Hs HTTP status code
1823 # Ss Squid request status (TCP_MISS etc)
1824 # Sh Squid hierarchy status (DEFAULT_PARENT etc)
1825 # mt MIME content type
1826 # rm Request method (GET/POST etc)
1828 # rp Request URL-Path excluding hostname
1829 # rv Request protocol version
1830 # et Tag returned by external acl
1831 # ea Log string returned by external acl
1832 # <st Reply size including HTTP headers
1833 # >st Request size including HTTP headers
1834 # st Request+Reply size including HTTP headers
1835 # <sH Reply high offset sent
1836 # <sS Upstream object size
1837 # % a literal % character
1839 # The default formats available (which do not need re-defining) are:
1841 #logformat squid %ts.%03tu %6tr %>a %Ss/%03Hs %<st %rm %ru %un %Sh/%<A %mt
1842 #logformat squidmime %ts.%03tu %6tr %>a %Ss/%03Hs %<st %rm %ru %un %Sh/%<A %mt [%>h] [%<h]
1843 #logformat common %>a %ui %un [%tl] "%rm %ru HTTP/%rv" %Hs %<st %Ss:%Sh
1844 #logformat combined %>a %ui %un [%tl] "%rm %ru HTTP/%rv" %Hs %<st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh
1850 # These files log client request activities. Has a line every HTTP or
1851 # ICP request. The format is:
1852 # access_log <filepath> [<logformat name> [acl acl ...]]
1853 # access_log none [acl acl ...]]
1855 # Will log to the specified file using the specified format (which
1856 # must be defined in a logformat directive) those entries which match
1857 # ALL the acl's specified (which must be defined in acl clauses).
1858 # If no acl is specified, all requests will be logged to this file.
1860 # To disable logging of a request use the filepath "none", in which case
1861 # a logformat name should not be specified.
1863 # To log the request via syslog specify a filepath of "syslog":
1865 # access_log syslog[:facility.priority] [format [acl1 [acl2 ....]]]
1866 # where facility could be any of:
1867 # authpriv, daemon, local0 .. local7 or user.
1869 # And priority could be any of:
1870 # err, warning, notice, info, debug.
1871 access_log /var/log/squid/access.log squid
1873 # TAG: log_access allow|deny acl acl...
1874 # This options allows you to control which requests gets logged
1875 # to access.log (see access_log directive). Requests denied for
1876 # logging will also not be accounted for in performance counters.
1882 # Cache logging file. This is where general information about
1883 # your cache's behavior goes. You can increase the amount of data
1884 # logged to this file with the "debug_options" tag below.
1887 # cache_log /var/log/squid/cache.log
1889 # TAG: cache_store_log
1890 # Logs the activities of the storage manager. Shows which
1891 # objects are ejected from the cache, and which objects are
1892 # saved and for how long. To disable, enter "none". There are
1893 # not really utilities to analyze this data, so you can safely
1897 # cache_store_log /var/log/squid/store.log
1899 # TAG: cache_swap_state
1900 # Location for the cache "swap.state" file. This index file holds
1901 # the metadata of objects saved on disk. It is used to rebuild
1902 # the cache during startup. Normally this file resides in each
1903 # 'cache_dir' directory, but you may specify an alternate
1904 # pathname here. Note you must give a full filename, not just
1905 # a directory. Since this is the index for the whole object
1906 # list you CANNOT periodically rotate it!
1908 # If %s can be used in the file name it will be replaced with a
1909 # a representation of the cache_dir name where each / is replaced
1910 # with '.'. This is needed to allow adding/removing cache_dir
1911 # lines when cache_swap_log is being used.
1913 # If have more than one 'cache_dir', and %s is not used in the name
1914 # these swap logs will have names such as:
1920 # The numbered extension (which is added automatically)
1921 # corresponds to the order of the 'cache_dir' lines in this
1922 # configuration file. If you change the order of the 'cache_dir'
1923 # lines in this file, these index files will NOT correspond to
1924 # the correct 'cache_dir' entry (unless you manually rename
1925 # them). We recommend you do NOT use this option. It is
1926 # better to keep these index files in each 'cache_dir' directory.
1931 # TAG: logfile_rotate
1932 # Specifies the number of logfile rotations to make when you
1933 # type 'squid -k rotate'. The default is 10, which will rotate
1934 # with extensions 0 through 9. Setting logfile_rotate to 0 will
1935 # disable the file name rotation, but the logfiles are still closed
1936 # and re-opened. This will enable you to rename the logfiles
1937 # yourself just before sending the rotate signal.
1939 # Note, the 'squid -k rotate' command normally sends a USR1
1940 # signal to the running squid process. In certain situations
1941 # (e.g. on Linux with Async I/O), USR1 is used for other
1942 # purposes, so -k rotate uses another signal. It is best to get
1943 # in the habit of using 'squid -k rotate' instead of 'kill -USR1
1950 # TAG: emulate_httpd_log on|off
1951 # The Cache can emulate the log file format which many 'httpd'
1952 # programs use. To disable/enable this emulation, set
1953 # emulate_httpd_log to 'off' or 'on'. The default
1954 # is to use the native log format since it includes useful
1955 # information Squid-specific log analyzers use.
1958 # emulate_httpd_log off
1960 # TAG: log_ip_on_direct on|off
1961 # Log the destination IP address in the hierarchy log tag when going
1962 # direct. Earlier Squid versions logged the hostname here. If you
1963 # prefer the old way set this to off.
1966 # log_ip_on_direct on
1969 # Pathname to Squid's MIME table. You shouldn't need to change
1970 # this, but the default file contains examples and formatting
1971 # information if you do.
1974 # mime_table /etc/squid/mime.conf
1976 # TAG: log_mime_hdrs on|off
1977 # The Cache can record both the request and the response MIME
1978 # headers for each HTTP transaction. The headers are encoded
1979 # safely and will appear as two bracketed fields at the end of
1980 # the access log (for either the native or httpd-emulated log
1981 # formats). To enable this logging set log_mime_hdrs to 'on'.
1986 # TAG: useragent_log
1987 # Squid will write the User-Agent field from HTTP requests
1988 # to the filename specified here. By default useragent_log
1995 # Squid will write the Referer field from HTTP requests to the
1996 # filename specified here. By default referer_log is disabled.
1997 # Note that "referer" is actually a misspelling of "referrer"
1998 # however the misspelt version has been accepted into the HTTP RFCs
1999 # and we accept both.
2005 # A filename to write the process-id to. To disable, enter "none".
2008 # pid_filename /var/run/squid.pid
2010 # TAG: debug_options
2011 # Logging options are set as section,level where each source file
2012 # is assigned a unique section. Lower levels result in less
2013 # output, Full debugging (level 9) can result in a very large
2014 # log file, so be careful. The magic word "ALL" sets debugging
2015 # levels for all sections. We recommend normally running with
2019 # debug_options ALL,1
2021 # TAG: log_fqdn on|off
2022 # Turn this on if you wish to log fully qualified domain names
2023 # in the access.log. To do this Squid does a DNS lookup of all
2024 # IP's connecting to it. This can (in some situations) increase
2025 # latency, which makes your cache seem slower for interactive
2031 # TAG: client_netmask
2032 # A netmask for client addresses in logfiles and cachemgr output.
2033 # Change this to protect the privacy of your cache clients.
2034 # A netmask of 255.255.255.0 will log all IP's in that range with
2035 # the last digit set to '0'.
2038 # client_netmask 255.255.255.255
2041 # Note: This option is only available if Squid is rebuilt with the
2042 # -DWIP_FWD_LOG define
2044 # Logs the server-side requests.
2046 # This is currently work in progress.
2051 # TAG: strip_query_terms
2052 # By default, Squid strips query terms from requested URLs before
2053 # logging. This protects your user's privacy.
2056 # strip_query_terms on
2058 # TAG: buffered_logs on|off
2059 # cache.log log file is written with stdio functions, and as such
2060 # it can be buffered or unbuffered. By default it will be unbuffered.
2061 # Buffering it can speed up the writing slightly (though you are
2062 # unlikely to need to worry unless you run with tons of debugging
2063 # enabled in which case performance will suffer badly anyway..).
2069 # OPTIONS FOR FTP GATEWAYING
2070 # -----------------------------------------------------------------------------
2073 # If you want the anonymous login password to be more informative
2074 # (and enable the use of picky ftp servers), set this to something
2075 # reasonable for your domain, like wwwuser@somewhere.net
2077 # The reason why this is domainless by default is the
2078 # request can be made on the behalf of a user in any domain,
2079 # depending on how the cache is used.
2080 # Some ftp server also validate the email address is valid
2081 # (for example perl.com).
2086 # TAG: ftp_list_width
2087 # Sets the width of ftp listings. This should be set to fit in
2088 # the width of a standard browser. Setting this too small
2089 # can cut off long filenames when browsing ftp sites.
2095 # If your firewall does not allow Squid to use passive
2096 # connections, turn off this option.
2101 # TAG: ftp_sanitycheck
2102 # For security and data integrity reasons Squid by default performs
2103 # sanity checks of the addresses of FTP data connections ensure the
2104 # data connection is to the requested server. If you need to allow
2105 # FTP connections to servers using another IP address for the data
2106 # connection turn this off.
2109 # ftp_sanitycheck on
2111 # TAG: ftp_telnet_protocol
2112 # The FTP protocol is officially defined to use the telnet protocol
2113 # as transport channel for the control connection. However, many
2114 # implementations are broken and does not respect this aspect of
2117 # If you have trouble accessing files with ASCII code 255 in the
2118 # path or similar problems involving this ASCII code you can
2119 # try setting this directive to off. If that helps, report to the
2120 # operator of the FTP server in question that their FTP server
2121 # is broken and does not follow the FTP standard.
2124 # ftp_telnet_protocol on
2127 # OPTIONS FOR EXTERNAL SUPPORT PROGRAMS
2128 # -----------------------------------------------------------------------------
2130 # TAG: diskd_program
2131 # Specify the location of the diskd executable.
2132 # Note this is only useful if you have compiled in
2133 # diskd as one of the store io modules.
2136 # diskd_program /usr/lib64/squid/diskd
2138 # TAG: unlinkd_program
2139 # Specify the location of the executable for file deletion process.
2142 # unlinkd_program /usr/lib64/squid/unlinkd
2144 # TAG: pinger_program
2145 # Note: This option is only available if Squid is rebuilt with the
2146 # --enable-icmp option
2148 # Specify the location of the executable for the pinger process.
2151 # pinger_program /usr/lib64/squid/pinger
2154 # OPTIONS FOR URL REWRITING
2155 # -----------------------------------------------------------------------------
2157 # TAG: url_rewrite_program
2158 # Specify the location of the executable for the URL rewriter.
2159 # Since they can perform almost any function there isn't one included.
2161 # For each requested URL rewriter will receive on line with the format
2163 # URL <SP> client_ip "/" fqdn <SP> user <SP> method [<SP> kvpairs]<NL>
2165 # In the future, the rewriter interface will be extended with
2166 # key=value pairs ("kvpairs" shown above). Rewriter programs
2167 # should be prepared to receive and possibly ignore additional
2168 # whitespace-separated tokens on each input line.
2170 # And the rewriter may return a rewritten URL. The other components of
2171 # the request line does not need to be returned (ignored if they are).
2173 # The rewriter can also indicate that a client-side redirect should
2174 # be performed to the new URL. This is done by prefixing the returned
2175 # URL with "301:" (moved permanently) or 302: (moved temporarily).
2177 # By default, a URL rewriter is not used.
2182 # TAG: url_rewrite_children
2183 # The number of redirector processes to spawn. If you start
2184 # too few Squid will have to wait for them to process a backlog of
2185 # URLs, slowing it down. If you start too many they will use RAM
2186 # and other system resources.
2189 # url_rewrite_children 5
2191 # TAG: url_rewrite_concurrency
2192 # The number of requests each redirector helper can handle in
2193 # parallel. Defaults to 0 which indicates the redirector
2194 # is a old-style single threaded redirector.
2197 # url_rewrite_concurrency 0
2199 # TAG: url_rewrite_host_header
2200 # By default Squid rewrites any Host: header in redirected
2201 # requests. If you are running an accelerator this may
2202 # not be a wanted effect of a redirector.
2204 # WARNING: Entries are cached on the result of the URL rewriting
2205 # process, so be careful if you have domain-virtual hosts.
2208 # url_rewrite_host_header on
2210 # TAG: url_rewrite_access
2211 # If defined, this access list specifies which requests are
2212 # sent to the redirector processes. By default all requests
2218 # TAG: url_rewrite_bypass
2219 # When this is 'on', a request will not go through the
2220 # redirector if all redirectors are busy. If this is 'off'
2221 # and the redirector queue grows too large, Squid will exit
2222 # with a FATAL error and ask you to increase the number of
2223 # redirectors. You should only enable this if the redirectors
2224 # are not critical to your caching system. If you use
2225 # redirectors for access control, and you enable this option,
2226 # users may have access to pages they should not
2227 # be allowed to request.
2230 # url_rewrite_bypass off
2233 # OPTIONS FOR TUNING THE CACHE
2234 # -----------------------------------------------------------------------------
2237 # A list of ACL elements which, if matched and denied, cause the request to
2238 # not be satisfied from the cache and the reply to not be cached.
2239 # In other words, use this to force certain objects to never be cached.
2241 # You must use the words 'allow' or 'deny' to indicate whether items
2242 # matching the ACL should be allowed or denied into the cache.
2244 # Default is to allow all to be cached
2249 # TAG: refresh_pattern
2250 # usage: refresh_pattern [-i] regex min percent max [options]
2252 # By default, regular expressions are CASE-SENSITIVE. To make
2253 # them case-insensitive, use the -i option.
2255 # 'Min' is the time (in minutes) an object without an explicit
2256 # expiry time should be considered fresh. The recommended
2257 # value is 0, any higher values may cause dynamic applications
2258 # to be erroneously cached unless the application designer
2259 # has taken the appropriate actions.
2261 # 'Percent' is a percentage of the objects age (time since last
2262 # modification age) an object without explicit expiry time
2263 # will be considered fresh.
2265 # 'Max' is an upper limit on how long objects without an explicit
2266 # expiry time will be considered fresh.
2268 # options: override-expire
2278 # override-expire enforces min age even if the server
2279 # sent an explicit expiry time (e.g., with the
2280 # Expires: header or Cache-Control: max-age). Doing this
2281 # VIOLATES the HTTP standard. Enabling this feature
2282 # could make you liable for problems which it causes.
2284 # override-lastmod enforces min age even on objects
2285 # that were modified recently.
2287 # reload-into-ims changes client no-cache or ``reload''
2288 # to If-Modified-Since requests. Doing this VIOLATES the
2289 # HTTP standard. Enabling this feature could make you
2290 # liable for problems which it causes.
2292 # ignore-reload ignores a client no-cache or ``reload''
2293 # header. Doing this VIOLATES the HTTP standard. Enabling
2294 # this feature could make you liable for problems which
2297 # ignore-no-cache ignores any ``Pragma: no-cache'' and
2298 # ``Cache-control: no-cache'' headers received from a server.
2299 # The HTTP RFC never allows the use of this (Pragma) header
2300 # from a server, only a client, though plenty of servers
2303 # ignore-no-store ignores any ``Cache-control: no-store''
2304 # headers received from a server. Doing this VIOLATES
2305 # the HTTP standard. Enabling this feature could make you
2306 # liable for problems which it causes.
2308 # ignore-private ignores any ``Cache-control: private''
2309 # headers received from a server. Doing this VIOLATES
2310 # the HTTP standard. Enabling this feature could make you
2311 # liable for problems which it causes.
2313 # ignore-auth caches responses to requests with authorization,
2314 # as if the originserver had sent ``Cache-control: public''
2315 # in the response header. Doing this VIOLATES the HTTP standard.
2316 # Enabling this feature could make you liable for problems which
2319 # refresh-ims causes squid to contact the origin server
2320 # when a client issues an If-Modified-Since request. This
2321 # ensures that the client will receive an updated version
2322 # if one is available.
2324 # Basically a cached object is:
2326 # FRESH if expires < now, else STALE
2327 # STALE if age > max
2328 # FRESH if lm-factor < percent, else STALE
2329 # FRESH if age < min
2332 # The refresh_pattern lines are checked in the order listed here.
2333 # The first entry which matches is used. If none of the entries
2334 # match the default will be used.
2336 # Note, you must uncomment all the default lines if you want
2337 # to change one. The default setting is only active if none is
2341 refresh_pattern ^ftp: 1440 20% 10080
2342 refresh_pattern ^gopher: 1440 0% 1440
2343 refresh_pattern (cgi-bin|\?) 0 0% 0
2344 refresh_pattern . 0 20% 4320
2346 # TAG: quick_abort_min (KB)
2347 # TAG: quick_abort_max (KB)
2348 # TAG: quick_abort_pct (percent)
2349 # The cache by default continues downloading aborted requests
2350 # which are almost completed (less than 16 KB remaining). This
2351 # may be undesirable on slow (e.g. SLIP) links and/or very busy
2352 # caches. Impatient users may tie up file descriptors and
2353 # bandwidth by repeatedly requesting and immediately aborting
2356 # When the user aborts a request, Squid will check the
2357 # quick_abort values to the amount of data transferred until
2360 # If the transfer has less than 'quick_abort_min' KB remaining,
2361 # it will finish the retrieval.
2363 # If the transfer has more than 'quick_abort_max' KB remaining,
2364 # it will abort the retrieval.
2366 # If more than 'quick_abort_pct' of the transfer has completed,
2367 # it will finish the retrieval.
2369 # If you do not want any retrieval to continue after the client
2370 # has aborted, set both 'quick_abort_min' and 'quick_abort_max'
2373 # If you want retrievals to always continue if they are being
2374 # cached set 'quick_abort_min' to '-1 KB'.
2377 # quick_abort_min 16 KB
2378 # quick_abort_max 16 KB
2379 # quick_abort_pct 95
2381 # TAG: read_ahead_gap buffer-size
2382 # The amount of data the cache will buffer ahead of what has been
2383 # sent to the client when retrieving an object from another server.
2386 # read_ahead_gap 16 KB
2388 # TAG: negative_ttl time-units
2389 # Time-to-Live (TTL) for failed requests. Certain types of
2390 # failures (such as "connection refused" and "404 Not Found") are
2391 # negatively-cached for a configurable amount of time. The
2392 # default is 5 minutes. Note that this is different from
2393 # negative caching of DNS lookups.
2395 # WARNING: This setting VIOLATES RFC 2616 when non-zero.
2396 # If you have problems with error pages caching, set to '0 seconds'
2399 # negative_ttl 5 minutes
2401 # TAG: positive_dns_ttl time-units
2402 # Upper limit on how long Squid will cache positive DNS responses.
2403 # Default is 6 hours (360 minutes). This directive must be set
2404 # larger than negative_dns_ttl.
2407 # positive_dns_ttl 6 hours
2409 # TAG: negative_dns_ttl time-units
2410 # Time-to-Live (TTL) for negative caching of failed DNS lookups.
2411 # This also sets the lower cache limit on positive lookups.
2412 # Minimum value is 1 second, and it is not recommendable to go
2413 # much below 10 seconds.
2416 # negative_dns_ttl 1 minutes
2418 # TAG: range_offset_limit (bytes)
2419 # Sets a upper limit on how far into the the file a Range request
2420 # may be to cause Squid to prefetch the whole file. If beyond this
2421 # limit Squid forwards the Range request as it is and the result
2424 # This is to stop a far ahead range request (lets say start at 17MB)
2425 # from making Squid fetch the whole object up to that point before
2426 # sending anything to the client.
2428 # A value of -1 causes Squid to always fetch the object from the
2429 # beginning so it may cache the result. (2.0 style)
2431 # A value of 0 causes Squid to never fetch more than the
2432 # client requested. (default)
2435 # range_offset_limit 0 KB
2437 # TAG: minimum_expiry_time (seconds)
2438 # The minimum caching time according to (Expires - Date)
2439 # Headers Squid honors if the object can't be revalidated
2440 # defaults to 60 seconds. In reverse proxy environments it
2441 # might be desirable to honor shorter object lifetimes. It
2442 # is most likely better to make your server return a
2443 # meaningful Last-Modified header however. In ESI environments
2444 # where page fragments often have short lifetimes, this will
2445 # often be best set to 0.
2448 # minimum_expiry_time 60 seconds
2450 # TAG: store_avg_object_size (kbytes)
2451 # Average object size, used to estimate number of objects your
2452 # cache can hold. The default is 13 KB.
2455 # store_avg_object_size 13 KB
2457 # TAG: store_objects_per_bucket
2458 # Target number of objects per bucket in the store hash table.
2459 # Lowering this value increases the total number of buckets and
2460 # also the storage maintenance rate. The default is 20.
2463 # store_objects_per_bucket 20
2467 # -----------------------------------------------------------------------------
2469 # TAG: request_header_max_size (KB)
2470 # This specifies the maximum size for HTTP headers in a request.
2471 # Request headers are usually relatively small (about 512 bytes).
2472 # Placing a limit on the request header size will catch certain
2473 # bugs (for example with persistent connections) and possibly
2474 # buffer-overflow or denial-of-service attacks.
2477 # request_header_max_size 20 KB
2479 # TAG: reply_header_max_size (KB)
2480 # This specifies the maximum size for HTTP headers in a reply.
2481 # Reply headers are usually relatively small (about 512 bytes).
2482 # Placing a limit on the reply header size will catch certain
2483 # bugs (for example with persistent connections) and possibly
2484 # buffer-overflow or denial-of-service attacks.
2487 # reply_header_max_size 20 KB
2489 # TAG: request_body_max_size (bytes)
2490 # This specifies the maximum size for an HTTP request body.
2491 # In other words, the maximum size of a PUT/POST request.
2492 # A user who attempts to send a request with a body larger
2493 # than this limit receives an "Invalid Request" error message.
2494 # If you set this parameter to a zero (the default), there will
2495 # be no limit imposed.
2498 # request_body_max_size 0 KB
2501 # A list of ACL elements which, if matched, causes Squid to send
2502 # an extra CRLF pair after the body of a PUT/POST request.
2504 # Some HTTP servers has broken implementations of PUT/POST,
2505 # and rely on an extra CRLF pair sent by some WWW clients.
2507 # Quote from RFC2616 section 4.1 on this matter:
2509 # Note: certain buggy HTTP/1.0 client implementations generate an
2510 # extra CRLF's after a POST request. To restate what is explicitly
2511 # forbidden by the BNF, an HTTP/1.1 client must not preface or follow
2512 # a request with an extra CRLF.
2515 # acl buggy_server url_regex ^http://....
2516 # broken_posts allow buggy_server
2522 # If set (default), Squid will include a Via header in requests and
2523 # replies as required by RFC2616.
2528 # TAG: ie_refresh on|off
2529 # Microsoft Internet Explorer up until version 5.5 Service
2530 # Pack 1 has an issue with transparent proxies, wherein it
2531 # is impossible to force a refresh. Turning this on provides
2532 # a partial fix to the problem, by causing all IMS-REFRESH
2533 # requests from older IE versions to check the origin server
2534 # for fresh content. This reduces hit ratio by some amount
2535 # (~10% in my experience), but allows users to actually get
2536 # fresh content when they want it. Note because Squid
2537 # cannot tell if the user is using 5.5 or 5.5SP1, the behavior
2538 # of 5.5 is unchanged from old versions of Squid (i.e. a
2539 # forced refresh is impossible). Newer versions of IE will,
2540 # hopefully, continue to have the new behavior and will be
2541 # handled based on that assumption. This option defaults to
2542 # the old Squid behavior, which is better for hit ratios but
2543 # worse for clients using IE, if they need to be able to
2544 # force fresh content.
2549 # TAG: vary_ignore_expire on|off
2550 # Many HTTP servers supporting Vary gives such objects
2551 # immediate expiry time with no cache-control header
2552 # when requested by a HTTP/1.0 client. This option
2553 # enables Squid to ignore such expiry times until
2554 # HTTP/1.1 is fully implemented.
2555 # WARNING: This may eventually cause some varying
2556 # objects not intended for caching to get cached.
2559 # vary_ignore_expire off
2561 # TAG: extension_methods
2562 # Squid only knows about standardized HTTP request methods.
2563 # You can add up to 20 additional "extension" methods here.
2568 # TAG: request_entities
2569 # Squid defaults to deny GET and HEAD requests with request entities,
2570 # as the meaning of such requests are undefined in the HTTP standard
2571 # even if not explicitly forbidden.
2573 # Set this directive to on if you have clients which insists
2574 # on sending request entities in GET or HEAD requests. But be warned
2575 # that there is server software (both proxies and web servers) which
2576 # can fail to properly process this kind of request which may make you
2577 # vulnerable to cache pollution attacks if enabled.
2580 # request_entities off
2582 # TAG: request_header_access
2583 # Usage: request_header_access header_name allow|deny [!]aclname ...
2585 # WARNING: Doing this VIOLATES the HTTP standard. Enabling
2586 # this feature could make you liable for problems which it
2589 # This option replaces the old 'anonymize_headers' and the
2590 # older 'http_anonymizer' option with something that is much
2591 # more configurable. This new method creates a list of ACLs
2592 # for each header, allowing you very fine-tuned header
2595 # This option only applies to request headers, i.e., from the
2596 # client to the server.
2598 # You can only specify known headers for the header name.
2599 # Other headers are reclassified as 'Other'. You can also
2600 # refer to all the headers with 'All'.
2602 # For example, to achieve the same behavior as the old
2603 # 'http_anonymizer standard' option, you should use:
2605 # request_header_access From deny all
2606 # request_header_access Referer deny all
2607 # request_header_access Server deny all
2608 # request_header_access User-Agent deny all
2609 # request_header_access WWW-Authenticate deny all
2610 # request_header_access Link deny all
2612 # Or, to reproduce the old 'http_anonymizer paranoid' feature
2615 # request_header_access Allow allow all
2616 # request_header_access Authorization allow all
2617 # request_header_access WWW-Authenticate allow all
2618 # request_header_access Proxy-Authorization allow all
2619 # request_header_access Proxy-Authenticate allow all
2620 # request_header_access Cache-Control allow all
2621 # request_header_access Content-Encoding allow all
2622 # request_header_access Content-Length allow all
2623 # request_header_access Content-Type allow all
2624 # request_header_access Date allow all
2625 # request_header_access Expires allow all
2626 # request_header_access Host allow all
2627 # request_header_access If-Modified-Since allow all
2628 # request_header_access Last-Modified allow all
2629 # request_header_access Location allow all
2630 # request_header_access Pragma allow all
2631 # request_header_access Accept allow all
2632 # request_header_access Accept-Charset allow all
2633 # request_header_access Accept-Encoding allow all
2634 # request_header_access Accept-Language allow all
2635 # request_header_access Content-Language allow all
2636 # request_header_access Mime-Version allow all
2637 # request_header_access Retry-After allow all
2638 # request_header_access Title allow all
2639 # request_header_access Connection allow all
2640 # request_header_access Proxy-Connection allow all
2641 # request_header_access All deny all
2643 # although many of those are HTTP reply headers, and so should be
2644 # controlled with the reply_header_access directive.
2646 # By default, all headers are allowed (no anonymizing is
2652 # TAG: reply_header_access
2653 # Usage: reply_header_access header_name allow|deny [!]aclname ...
2655 # WARNING: Doing this VIOLATES the HTTP standard. Enabling
2656 # this feature could make you liable for problems which it
2659 # This option only applies to reply headers, i.e., from the
2660 # server to the client.
2662 # This is the same as request_header_access, but in the other
2665 # This option replaces the old 'anonymize_headers' and the
2666 # older 'http_anonymizer' option with something that is much
2667 # more configurable. This new method creates a list of ACLs
2668 # for each header, allowing you very fine-tuned header
2671 # You can only specify known headers for the header name.
2672 # Other headers are reclassified as 'Other'. You can also
2673 # refer to all the headers with 'All'.
2675 # For example, to achieve the same behavior as the old
2676 # 'http_anonymizer standard' option, you should use:
2678 # reply_header_access From deny all
2679 # reply_header_access Referer deny all
2680 # reply_header_access Server deny all
2681 # reply_header_access User-Agent deny all
2682 # reply_header_access WWW-Authenticate deny all
2683 # reply_header_access Link deny all
2685 # Or, to reproduce the old 'http_anonymizer paranoid' feature
2688 # reply_header_access Allow allow all
2689 # reply_header_access Authorization allow all
2690 # reply_header_access WWW-Authenticate allow all
2691 # reply_header_access Proxy-Authorization allow all
2692 # reply_header_access Proxy-Authenticate allow all
2693 # reply_header_access Cache-Control allow all
2694 # reply_header_access Content-Encoding allow all
2695 # reply_header_access Content-Length allow all
2696 # reply_header_access Content-Type allow all
2697 # reply_header_access Date allow all
2698 # reply_header_access Expires allow all
2699 # reply_header_access Host allow all
2700 # reply_header_access If-Modified-Since allow all
2701 # reply_header_access Last-Modified allow all
2702 # reply_header_access Location allow all
2703 # reply_header_access Pragma allow all
2704 # reply_header_access Accept allow all
2705 # reply_header_access Accept-Charset allow all
2706 # reply_header_access Accept-Encoding allow all
2707 # reply_header_access Accept-Language allow all
2708 # reply_header_access Content-Language allow all
2709 # reply_header_access Mime-Version allow all
2710 # reply_header_access Retry-After allow all
2711 # reply_header_access Title allow all
2712 # reply_header_access Connection allow all
2713 # reply_header_access Proxy-Connection allow all
2714 # reply_header_access All deny all
2716 # although the HTTP request headers won't be usefully controlled
2717 # by this directive -- see request_header_access for details.
2719 # By default, all headers are allowed (no anonymizing is
2725 # TAG: header_replace
2726 # Usage: header_replace header_name message
2727 # Example: header_replace User-Agent Nutscrape/1.0 (CP/M; 8-bit)
2729 # This option allows you to change the contents of headers
2730 # denied with header_access above, by replacing them with
2731 # some fixed string. This replaces the old fake_user_agent
2734 # This only applies to request headers, not reply headers.
2736 # By default, headers are removed if denied.
2741 # TAG: relaxed_header_parser on|off|warn
2742 # In the default "on" setting Squid accepts certain forms
2743 # of non-compliant HTTP messages where it is unambiguous
2744 # what the sending application intended even if the message
2745 # is not correctly formatted. The messages is then normalized
2746 # to the correct form when forwarded by Squid.
2748 # If set to "warn" then a warning will be emitted in cache.log
2749 # each time such HTTP error is encountered.
2751 # If set to "off" then such HTTP errors will cause the request
2752 # or response to be rejected.
2755 # relaxed_header_parser on
2759 # -----------------------------------------------------------------------------
2761 # TAG: forward_timeout time-units
2762 # This parameter specifies how long Squid should at most attempt in
2763 # finding a forwarding path for the request before giving up.
2766 # forward_timeout 4 minutes
2768 # TAG: connect_timeout time-units
2769 # This parameter specifies how long to wait for the TCP connect to
2770 # the requested server or peer to complete before Squid should
2771 # attempt to find another path where to forward the request.
2774 # connect_timeout 1 minute
2776 # TAG: peer_connect_timeout time-units
2777 # This parameter specifies how long to wait for a pending TCP
2778 # connection to a peer cache. The default is 30 seconds. You
2779 # may also set different timeout values for individual neighbors
2780 # with the 'connect-timeout' option on a 'cache_peer' line.
2783 # peer_connect_timeout 30 seconds
2785 # TAG: read_timeout time-units
2786 # The read_timeout is applied on server-side connections. After
2787 # each successful read(), the timeout will be extended by this
2788 # amount. If no data is read again after this amount of time,
2789 # the request is aborted and logged with ERR_READ_TIMEOUT. The
2790 # default is 15 minutes.
2793 # read_timeout 15 minutes
2795 # TAG: request_timeout
2796 # How long to wait for an HTTP request after initial
2797 # connection establishment.
2800 # request_timeout 5 minutes
2802 # TAG: persistent_request_timeout
2803 # How long to wait for the next HTTP request on a persistent
2804 # connection after the previous request completes.
2807 # persistent_request_timeout 2 minutes
2809 # TAG: client_lifetime time-units
2810 # The maximum amount of time a client (browser) is allowed to
2811 # remain connected to the cache process. This protects the Cache
2812 # from having a lot of sockets (and hence file descriptors) tied up
2813 # in a CLOSE_WAIT state from remote clients that go away without
2814 # properly shutting down (either because of a network failure or
2815 # because of a poor client implementation). The default is one
2816 # day, 1440 minutes.
2818 # NOTE: The default value is intended to be much larger than any
2819 # client would ever need to be connected to your cache. You
2820 # should probably change client_lifetime only as a last resort.
2821 # If you seem to have many client connections tying up
2822 # filedescriptors, we recommend first tuning the read_timeout,
2823 # request_timeout, persistent_request_timeout and quick_abort values.
2826 # client_lifetime 1 day
2828 # TAG: half_closed_clients
2829 # Some clients may shutdown the sending side of their TCP
2830 # connections, while leaving their receiving sides open. Sometimes,
2831 # Squid can not tell the difference between a half-closed and a
2832 # fully-closed TCP connection.
2834 # By default, Squid will immediately close client connections when
2835 # read(2) returns "no more data to read."
2837 # Change this option to 'on' and Squid will keep open connections
2838 # until a read(2) or write(2) on the socket returns an error.
2839 # This may show some benefits for reverse proxies. But if not
2840 # it is recommended to leave OFF.
2843 # half_closed_clients off
2845 # TAG: pconn_timeout
2846 # Timeout for idle persistent connections to servers and other
2850 # pconn_timeout 1 minute
2852 # TAG: ident_timeout
2853 # Maximum time to wait for IDENT lookups to complete.
2855 # If this is too high, and you enabled IDENT lookups from untrusted
2856 # users, you might be susceptible to denial-of-service by having
2857 # many ident requests going at once.
2860 # ident_timeout 10 seconds
2862 # TAG: shutdown_lifetime time-units
2863 # When SIGTERM or SIGHUP is received, the cache is put into
2864 # "shutdown pending" mode until all active sockets are closed.
2865 # This value is the lifetime to set for all open descriptors
2866 # during shutdown mode. Any active clients after this many
2867 # seconds will receive a 'timeout' message.
2870 # shutdown_lifetime 30 seconds
2873 # ADMINISTRATIVE PARAMETERS
2874 # -----------------------------------------------------------------------------
2877 # Email-address of local cache manager who will receive
2878 # mail if the cache dies. The default is "root."
2884 # From: email-address for mail sent when the cache dies.
2885 # The default is to use 'appname@unique_hostname'.
2886 # Default appname value is "squid", can be changed into
2887 # src/globals.h before building squid.
2893 # Email program used to send mail if the cache dies.
2894 # The default is "mail". The specified program must comply
2895 # with the standard Unix mail syntax:
2896 # mail-program recipient < mailfile
2898 # Optional command line options can be specified.
2903 # TAG: cache_effective_user
2904 # If you start Squid as root, it will change its effective/real
2905 # UID/GID to the user specified below. The default is to change
2907 # see also; cache_effective_group
2910 # cache_effective_user squid
2912 # TAG: cache_effective_group
2913 # Squid sets the GID to the effective user's default group ID
2914 # (taken from the password file) and supplementary group list
2915 # from the groups membership.
2917 # If you want Squid to run with a specific GID regardless of
2918 # the group memberships of the effective user then set this
2919 # to the group (or GID) you want Squid to run as. When set
2920 # all other group privileges of the effective user are ignored
2921 # and only this GID is effective. If Squid is not started as
2922 # root the user starting Squid MUST be member of the specified
2925 # This option is not recommended by the Squid Team.
2926 # Our preference is for administrators to configure a secure
2927 # user account for squid with UID/GID matching system policies.
2932 # TAG: httpd_suppress_version_string on|off
2933 # Suppress Squid version string info in HTTP headers and HTML error pages.
2936 # httpd_suppress_version_string off
2938 # TAG: visible_hostname
2939 # If you want to present a special hostname in error messages, etc,
2940 # define this. Otherwise, the return value of gethostname()
2941 # will be used. If you have multiple caches in a cluster and
2942 # get errors about IP-forwarding you must set them to have individual
2943 # names with this setting.
2948 # TAG: unique_hostname
2949 # If you want to have multiple machines with the same
2950 # 'visible_hostname' you must give each machine a different
2951 # 'unique_hostname' so forwarding loops can be detected.
2956 # TAG: hostname_aliases
2957 # A list of other DNS names your cache has.
2963 # Minimum umask which should be enforced while the proxy
2964 # is running, in addition to the umask set at startup.
2966 # For a traditional octal representation of umasks, start
2967 # your value with 0.
2973 # OPTIONS FOR THE CACHE REGISTRATION SERVICE
2974 # -----------------------------------------------------------------------------
2976 # This section contains parameters for the (optional) cache
2977 # announcement service. This service is provided to help
2978 # cache administrators locate one another in order to join or
2979 # create cache hierarchies.
2981 # An 'announcement' message is sent (via UDP) to the registration
2982 # service by Squid. By default, the announcement message is NOT
2983 # SENT unless you enable it with 'announce_period' below.
2985 # The announcement message includes your hostname, plus the
2986 # following information from this configuration file:
2992 # All current information is processed regularly and made
2993 # available on the Web at http://www.ircache.net/Cache/Tracker/.
2995 # TAG: announce_period
2996 # This is how frequently to send cache announcements. The
2997 # default is `0' which disables sending the announcement
3000 # To enable announcing your cache, just uncomment the line
3006 #To enable announcing your cache, just uncomment the line below.
3007 #announce_period 1 day
3009 # TAG: announce_host
3010 # TAG: announce_file
3011 # TAG: announce_port
3012 # announce_host and announce_port set the hostname and port
3013 # number where the registration message will be sent.
3015 # Hostname will default to 'tracker.ircache.net' and port will
3016 # default default to 3131. If the 'filename' argument is given,
3017 # the contents of that file will be included in the announce
3021 # announce_host tracker.ircache.net
3022 # announce_port 3131
3025 # HTTPD-ACCELERATOR OPTIONS
3026 # -----------------------------------------------------------------------------
3028 # TAG: httpd_accel_surrogate_id
3029 # Note: This option is only available if Squid is rebuilt with the
3030 # -DUSE_SQUID_ESI define
3032 # Surrogates (http://www.esi.org/architecture_spec_1.0.html)
3033 # need an identification token to allow control targeting. Because
3034 # a farm of surrogates may all perform the same tasks, they may share
3035 # an identification token.
3038 # httpd_accel_surrogate_id unset-id
3040 # TAG: http_accel_surrogate_remote on|off
3041 # Note: This option is only available if Squid is rebuilt with the
3042 # -DUSE_SQUID_ESI define
3044 # Remote surrogates (such as those in a CDN) honour Surrogate-Control: no-store-remote.
3045 # Set this to on to have squid behave as a remote surrogate.
3048 # http_accel_surrogate_remote off
3050 # TAG: esi_parser libxml2|expat|custom
3051 # Note: This option is only available if Squid is rebuilt with the
3052 # -DUSE_SQUID_ESI define
3054 # ESI markup is not strictly XML compatible. The custom ESI parser
3055 # will give higher performance, but cannot handle non ASCII character
3062 # DELAY POOL PARAMETERS
3063 # -----------------------------------------------------------------------------
3066 # This represents the number of delay pools to be used. For example,
3067 # if you have one class 2 delay pool and one class 3 delays pool, you
3068 # have a total of 2 delay pools.
3074 # This defines the class of each delay pool. There must be exactly one
3075 # delay_class line for each delay pool. For example, to define two
3076 # delay pools, one of class 2 and one of class 3, the settings above
3077 # and here would be:
3080 # delay_pools 4 # 4 delay pools
3081 # delay_class 1 2 # pool 1 is a class 2 pool
3082 # delay_class 2 3 # pool 2 is a class 3 pool
3083 # delay_class 3 4 # pool 3 is a class 4 pool
3084 # delay_class 4 5 # pool 4 is a class 5 pool
3086 # The delay pool classes are:
3088 # class 1 Everything is limited by a single aggregate
3091 # class 2 Everything is limited by a single aggregate
3092 # bucket as well as an "individual" bucket chosen
3093 # from bits 25 through 32 of the IP address.
3095 # class 3 Everything is limited by a single aggregate
3096 # bucket as well as a "network" bucket chosen
3097 # from bits 17 through 24 of the IP address and a
3098 # "individual" bucket chosen from bits 17 through
3099 # 32 of the IP address.
3101 # class 4 Everything in a class 3 delay pool, with an
3102 # additional limit on a per user basis. This
3103 # only takes effect if the username is established
3104 # in advance - by forcing authentication in your
3105 # http_access rules.
3107 # class 5 Requests are grouped according their tag (see
3108 # external_acl's tag= reply).
3110 # NOTE: If an IP address is a.b.c.d
3111 # -> bits 25 through 32 are "d"
3112 # -> bits 17 through 24 are "c"
3113 # -> bits 17 through 32 are "c * 256 + d"
3119 # This is used to determine which delay pool a request falls into.
3121 # delay_access is sorted per pool and the matching starts with pool 1,
3122 # then pool 2, ..., and finally pool N. The first delay pool where the
3123 # request is allowed is selected for the request. If it does not allow
3124 # the request to any pool then the request is not delayed (default).
3126 # For example, if you want some_big_clients in delay
3127 # pool 1 and lotsa_little_clients in delay pool 2:
3130 # delay_access 1 allow some_big_clients
3131 # delay_access 1 deny all
3132 # delay_access 2 allow lotsa_little_clients
3133 # delay_access 2 deny all
3134 # delay_access 3 allow authenticated_clients
3139 # TAG: delay_parameters
3140 # This defines the parameters for a delay pool. Each delay pool has
3141 # a number of "buckets" associated with it, as explained in the
3142 # description of delay_class. For a class 1 delay pool, the syntax is:
3144 #delay_parameters pool aggregate
3146 # For a class 2 delay pool:
3148 #delay_parameters pool aggregate individual
3150 # For a class 3 delay pool:
3152 #delay_parameters pool aggregate network individual
3154 # For a class 4 delay pool:
3156 #delay_parameters pool aggregate network individual user
3158 # For a class 5 delay pool:
3160 #delay_parameters pool tag
3162 # The variables here are:
3164 # pool a pool number - ie, a number between 1 and the
3165 # number specified in delay_pools as used in
3166 # delay_class lines.
3168 # aggregate the "delay parameters" for the aggregate bucket
3171 # individual the "delay parameters" for the individual
3172 # buckets (class 2, 3).
3174 # network the "delay parameters" for the network buckets
3177 # user the delay parameters for the user buckets
3180 # tag the delay parameters for the tag buckets
3183 # A pair of delay parameters is written restore/maximum, where restore is
3184 # the number of bytes (not bits - modem and network speeds are usually
3185 # quoted in bits) per second placed into the bucket, and maximum is the
3186 # maximum number of bytes which can be in the bucket at any time.
3188 # For example, if delay pool number 1 is a class 2 delay pool as in the
3189 # above example, and is being used to strictly limit each host to 64kbps
3190 # (plus overheads), with no overall limit, the line is:
3192 #delay_parameters 1 -1/-1 8000/8000
3194 # Note that the figure -1 is used to represent "unlimited".
3196 # And, if delay pool number 2 is a class 3 delay pool as in the above
3197 # example, and you want to limit it to a total of 256kbps (strict limit)
3198 # with each 8-bit network permitted 64kbps (strict limit) and each
3199 # individual host permitted 4800bps with a bucket maximum size of 64kb
3200 # to permit a decent web page to be downloaded at a decent speed
3201 # (if the network is not being limited due to overuse) but slow down
3202 # large downloads more significantly:
3204 #delay_parameters 2 32000/32000 8000/8000 600/8000
3206 # There must be one delay_parameters line for each delay pool.
3208 # Finally, for a class 4 delay pool as in the example - each user will
3209 # be limited to 128Kb no matter how many workstations they are logged into.:
3211 #delay_parameters 4 32000/32000 8000/8000 600/64000 16000/16000
3216 # TAG: delay_initial_bucket_level (percent, 0-100)
3217 # The initial bucket percentage is used to determine how much is put
3218 # in each bucket when squid starts, is reconfigured, or first notices
3219 # a host accessing it (in class 2 and class 3, individual hosts and
3220 # networks only have buckets associated with them once they have been
3224 # delay_initial_bucket_level 50
3227 # WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS
3228 # -----------------------------------------------------------------------------
3232 # Use this option to define your WCCP ``home'' router for
3235 # wccp_router supports a single WCCP(v1) router
3237 # wccp2_router supports multiple WCCPv2 routers
3239 # only one of the two may be used at the same time and defines
3240 # which version of WCCP to use.
3243 # wccp_router 0.0.0.0
3246 # This directive is only relevant if you need to set up WCCP(v1)
3247 # to some very old and end-of-life Cisco routers. In all other
3248 # setups it must be left unset or at the default setting.
3249 # It defines an internal version in the WCCP(v1) protocol,
3250 # with version 4 being the officially documented protocol.
3252 # According to some users, Cisco IOS 11.2 and earlier only
3253 # support WCCP version 3. If you're using that or an earlier
3254 # version of IOS, you may need to change this value to 3, otherwise
3255 # do not specify this parameter.
3260 # TAG: wccp2_rebuild_wait
3261 # If this is enabled Squid will wait for the cache dir rebuild to finish
3262 # before sending the first wccp2 HereIAm packet
3265 # wccp2_rebuild_wait on
3267 # TAG: wccp2_forwarding_method
3268 # WCCP2 allows the setting of forwarding methods between the
3269 # router/switch and the cache. Valid values are as follows:
3271 # 1 - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
3272 # 2 - L2 redirect (forward the packet using Layer 2/MAC rewriting)
3274 # Currently (as of IOS 12.4) cisco routers only support GRE.
3275 # Cisco switches only support the L2 redirect assignment method.
3278 # wccp2_forwarding_method 1
3280 # TAG: wccp2_return_method
3281 # WCCP2 allows the setting of return methods between the
3282 # router/switch and the cache for packets that the cache
3283 # decides not to handle. Valid values are as follows:
3285 # 1 - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
3286 # 2 - L2 redirect (forward the packet using Layer 2/MAC rewriting)
3288 # Currently (as of IOS 12.4) cisco routers only support GRE.
3289 # Cisco switches only support the L2 redirect assignment.
3291 # If the "ip wccp redirect exclude in" command has been
3292 # enabled on the cache interface, then it is still safe for
3293 # the proxy server to use a l2 redirect method even if this
3294 # option is set to GRE.
3297 # wccp2_return_method 1
3299 # TAG: wccp2_assignment_method
3300 # WCCP2 allows the setting of methods to assign the WCCP hash
3301 # Valid values are as follows:
3303 # 1 - Hash assignment
3304 # 2 - Mask assignment
3306 # As a general rule, cisco routers support the hash assignment method
3307 # and cisco switches support the mask assignment method.
3310 # wccp2_assignment_method 1
3312 # TAG: wccp2_service
3313 # WCCP2 allows for multiple traffic services. There are two
3314 # types: "standard" and "dynamic". The standard type defines
3315 # one service id - http (id 0). The dynamic service ids can be from
3316 # 51 to 255 inclusive. In order to use a dynamic service id
3317 # one must define the type of traffic to be redirected; this is done
3318 # using the wccp2_service_info option.
3320 # The "standard" type does not require a wccp2_service_info option,
3321 # just specifying the service id will suffice.
3323 # MD5 service authentication can be enabled by adding
3324 # "password=<password>" to the end of this service declaration.
3328 # wccp2_service standard 0 # for the 'web-cache' standard service
3329 # wccp2_service dynamic 80 # a dynamic service type which will be
3330 # # fleshed out with subsequent options.
3331 # wccp2_service standard 0 password=foo
3335 # wccp2_service standard 0
3337 # TAG: wccp2_service_info
3338 # Dynamic WCCPv2 services require further information to define the
3339 # traffic you wish to have diverted.
3343 # wccp2_service_info <id> protocol=<protocol> flags=<flag>,<flag>..
3344 # priority=<priority> ports=<port>,<port>..
3346 # The relevant WCCPv2 flags:
3347 # + src_ip_hash, dst_ip_hash
3348 # + source_port_hash, dst_port_hash
3349 # + src_ip_alt_hash, dst_ip_alt_hash
3350 # + src_port_alt_hash, dst_port_alt_hash
3353 # The port list can be one to eight entries.
3357 # wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source
3358 # priority=240 ports=80
3360 # Note: the service id must have been defined by a previous
3361 # 'wccp2_service dynamic <id>' entry.
3367 # Each cache server gets assigned a set of the destination
3368 # hash proportional to their weight.
3371 # wccp2_weight 10000
3374 # TAG: wccp2_address
3375 # Use this option if you require WCCP to use a specific
3376 # interface address.
3378 # The default behavior is to not bind to any specific address.
3381 # wccp_address 0.0.0.0
3382 # wccp2_address 0.0.0.0
3385 # PERSISTENT CONNECTION HANDLING
3386 # -----------------------------------------------------------------------------
3388 # Also see "pconn_timeout" in the TIMEOUTS section
3390 # TAG: client_persistent_connections
3391 # TAG: server_persistent_connections
3392 # Persistent connection support for clients and servers. By
3393 # default, Squid uses persistent connections (when allowed)
3394 # with its clients and servers. You can use these options to
3395 # disable persistent connections with clients and/or servers.
3398 # client_persistent_connections on
3399 # server_persistent_connections on
3401 # TAG: persistent_connection_after_error
3402 # With this directive the use of persistent connections after
3403 # HTTP errors can be disabled. Useful if you have clients
3404 # who fail to handle errors on persistent connections proper.
3407 # persistent_connection_after_error off
3409 # TAG: detect_broken_pconn
3410 # Some servers have been found to incorrectly signal the use
3411 # of HTTP/1.0 persistent connections even on replies not
3412 # compatible, causing significant delays. This server problem
3413 # has mostly been seen on redirects.
3415 # By enabling this directive Squid attempts to detect such
3416 # broken replies and automatically assume the reply is finished
3417 # after 10 seconds timeout.
3420 # detect_broken_pconn off
3423 # CACHE DIGEST OPTIONS
3424 # -----------------------------------------------------------------------------
3426 # TAG: digest_generation
3427 # This controls whether the server will generate a Cache Digest
3428 # of its contents. By default, Cache Digest generation is
3429 # enabled if Squid is compiled with --enable-cache-digests defined.
3432 # digest_generation on
3434 # TAG: digest_bits_per_entry
3435 # This is the number of bits of the server's Cache Digest which
3436 # will be associated with the Digest entry for a given HTTP
3437 # Method and URL (public key) combination. The default is 5.
3440 # digest_bits_per_entry 5
3442 # TAG: digest_rebuild_period (seconds)
3443 # This is the wait time between Cache Digest rebuilds.
3446 # digest_rebuild_period 1 hour
3448 # TAG: digest_rewrite_period (seconds)
3449 # This is the wait time between Cache Digest writes to
3453 # digest_rewrite_period 1 hour
3455 # TAG: digest_swapout_chunk_size (bytes)
3456 # This is the number of bytes of the Cache Digest to write to
3457 # disk at a time. It defaults to 4096 bytes (4KB), the Squid
3458 # default swap page.
3461 # digest_swapout_chunk_size 4096 bytes
3463 # TAG: digest_rebuild_chunk_percentage (percent, 0-100)
3464 # This is the percentage of the Cache Digest to be scanned at a
3465 # time. By default it is set to 10% of the Cache Digest.
3468 # digest_rebuild_chunk_percentage 10
3472 # -----------------------------------------------------------------------------
3475 # The port number where Squid listens for SNMP requests. To enable
3476 # SNMP support set this to a suitable port number. Port number
3477 # 3401 is often used for the Squid SNMP agent. By default it's
3478 # set to "0" (disabled)
3485 # Allowing or denying access to the SNMP port.
3487 # All access to the agent is denied by default.
3490 # snmp_access allow|deny [!]aclname ...
3493 # snmp_access allow snmppublic localhost
3494 # snmp_access deny all
3497 # snmp_access deny all
3499 # TAG: snmp_incoming_address
3500 # TAG: snmp_outgoing_address
3501 # Just like 'udp_incoming_address' above, but for the SNMP port.
3503 # snmp_incoming_address is used for the SNMP socket receiving
3504 # messages from SNMP agents.
3505 # snmp_outgoing_address is used for SNMP packets returned to SNMP
3508 # The default snmp_incoming_address (0.0.0.0) is to listen on all
3509 # available network interfaces.
3511 # If snmp_outgoing_address is set to 255.255.255.255 (the default)
3512 # it will use the same socket as snmp_incoming_address. Only
3513 # change this if you want to have SNMP replies sent using another
3514 # address than where this Squid listens for SNMP queries.
3516 # NOTE, snmp_incoming_address and snmp_outgoing_address can not have
3517 # the same value since they both use port 3401.
3520 # snmp_incoming_address 0.0.0.0
3521 # snmp_outgoing_address 255.255.255.255
3525 # -----------------------------------------------------------------------------
3528 # The port number where Squid sends and receives ICP queries to
3529 # and from neighbor caches. The standard UDP port for ICP is 3130.
3530 # Default is disabled (0).
3537 # The port number where Squid sends and receives HTCP queries to
3538 # and from neighbor caches. To turn it on you want to set it to
3539 # 4827. By default it is set to "0" (disabled).
3545 # TAG: log_icp_queries on|off
3546 # If set, ICP queries are logged to access.log. You may wish
3547 # do disable this if your ICP load is VERY high to speed things
3548 # up or to simplify log analysis.
3551 # log_icp_queries on
3553 # TAG: udp_incoming_address
3554 # udp_incoming_address is used for UDP packets received from other
3557 # The default behavior is to not bind to any specific address.
3559 # Only change this if you want to have all UDP queries received on
3560 # a specific interface/address.
3562 # NOTE: udp_incoming_address is used by the ICP, HTCP, and DNS
3563 # modules. Altering it will affect all of them in the same manner.
3565 # see also; udp_outgoing_address
3567 # NOTE, udp_incoming_address and udp_outgoing_address can not
3568 # have the same value since they both use the same port.
3571 # udp_incoming_address 0.0.0.0
3573 # TAG: udp_outgoing_address
3574 # udp_outgoing_address is used for UDP packets sent out to other
3577 # The default behavior is to not bind to any specific address.
3579 # Instead it will use the same socket as udp_incoming_address.
3580 # Only change this if you want to have UDP queries sent using another
3581 # address than where this Squid listens for UDP queries from other
3584 # NOTE: udp_outgoing_address is used by the ICP, HTCP, and DNS
3585 # modules. Altering it will affect all of them in the same manner.
3587 # see also; udp_incoming_address
3589 # NOTE, udp_incoming_address and udp_outgoing_address can not
3590 # have the same value since they both use the same port.
3593 # udp_outgoing_address 255.255.255.255
3595 # TAG: icp_hit_stale on|off
3596 # If you want to return ICP_HIT for stale cache objects, set this
3597 # option to 'on'. If you have sibling relationships with caches
3598 # in other administrative domains, this should be 'off'. If you only
3599 # have sibling relationships with caches under your control,
3600 # it is probably okay to set this to 'on'.
3601 # If set to 'on', your siblings should use the option "allow-miss"
3602 # on their cache_peer lines for connecting to you.
3607 # TAG: minimum_direct_hops
3608 # If using the ICMP pinging stuff, do direct fetches for sites
3609 # which are no more than this many hops away.
3612 # minimum_direct_hops 4
3614 # TAG: minimum_direct_rtt
3615 # If using the ICMP pinging stuff, do direct fetches for sites
3616 # which are no more than this many rtt milliseconds away.
3619 # minimum_direct_rtt 400
3623 # The low and high water marks for the ICMP measurement
3624 # database. These are counts, not percents. The defaults are
3625 # 900 and 1000. When the high water mark is reached, database
3626 # entries will be deleted until the low mark is reached.
3632 # TAG: netdb_ping_period
3633 # The minimum period for measuring a site. There will be at
3634 # least this much delay between successive pings to the same
3635 # network. The default is five minutes.
3638 # netdb_ping_period 5 minutes
3640 # TAG: query_icmp on|off
3641 # If you want to ask your peers to include ICMP data in their ICP
3642 # replies, enable this option.
3644 # If your peer has configured Squid (during compilation) with
3645 # '--enable-icmp' that peer will send ICMP pings to origin server
3646 # sites of the URLs it receives. If you enable this option the
3647 # ICP replies from that peer will include the ICMP data (if available).
3648 # Then, when choosing a parent cache, Squid will choose the parent with
3649 # the minimal RTT to the origin server. When this happens, the
3650 # hierarchy field of the access.log will be
3651 # "CLOSEST_PARENT_MISS". This option is off by default.
3656 # TAG: test_reachability on|off
3657 # When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH
3658 # instead of ICP_MISS if the target host is NOT in the ICMP
3659 # database, or has a zero RTT.
3662 # test_reachability off
3664 # TAG: icp_query_timeout (msec)
3665 # Normally Squid will automatically determine an optimal ICP
3666 # query timeout value based on the round-trip-time of recent ICP
3667 # queries. If you want to override the value determined by
3668 # Squid, set this 'icp_query_timeout' to a non-zero value. This
3669 # value is specified in MILLISECONDS, so, to use a 2-second
3670 # timeout (the old default), you would write:
3672 # icp_query_timeout 2000
3675 # icp_query_timeout 0
3677 # TAG: maximum_icp_query_timeout (msec)
3678 # Normally the ICP query timeout is determined dynamically. But
3679 # sometimes it can lead to very large values (say 5 seconds).
3680 # Use this option to put an upper limit on the dynamic timeout
3681 # value. Do NOT use this option to always use a fixed (instead
3682 # of a dynamic) timeout value. To set a fixed timeout see the
3683 # 'icp_query_timeout' directive.
3686 # maximum_icp_query_timeout 2000
3688 # TAG: minimum_icp_query_timeout (msec)
3689 # Normally the ICP query timeout is determined dynamically. But
3690 # sometimes it can lead to very small timeouts, even lower than
3691 # the normal latency variance on your link due to traffic.
3692 # Use this option to put an lower limit on the dynamic timeout
3693 # value. Do NOT use this option to always use a fixed (instead
3694 # of a dynamic) timeout value. To set a fixed timeout see the
3695 # 'icp_query_timeout' directive.
3698 # minimum_icp_query_timeout 5
3700 # TAG: background_ping_rate time-units
3701 # Controls how often the ICP pings are sent to siblings that
3702 # have background-ping set.
3705 # background_ping_rate 10 seconds
3708 # MULTICAST ICP OPTIONS
3709 # -----------------------------------------------------------------------------
3712 # This tag specifies a list of multicast groups which your server
3713 # should join to receive multicasted ICP queries.
3715 # NOTE! Be very careful what you put here! Be sure you
3716 # understand the difference between an ICP _query_ and an ICP
3717 # _reply_. This option is to be set only if you want to RECEIVE
3718 # multicast queries. Do NOT set this option to SEND multicast
3719 # ICP (use cache_peer for that). ICP replies are always sent via
3720 # unicast, so this option does not affect whether or not you will
3721 # receive replies from multicast group members.
3723 # You must be very careful to NOT use a multicast address which
3724 # is already in use by another group of caches.
3726 # If you are unsure about multicast, please read the Multicast
3727 # chapter in the Squid FAQ (http://www.squid-cache.org/FAQ/).
3729 # Usage: mcast_groups 239.128.16.128 224.0.1.20
3731 # By default, Squid doesn't listen on any multicast groups.
3736 # TAG: mcast_miss_addr
3737 # Note: This option is only available if Squid is rebuilt with the
3738 # -DMULTICAST_MISS_STREAM define
3740 # If you enable this option, every "cache miss" URL will
3741 # be sent out on the specified multicast address.
3743 # Do not enable this option unless you are are absolutely
3744 # certain you understand what you are doing.
3747 # mcast_miss_addr 255.255.255.255
3749 # TAG: mcast_miss_ttl
3750 # Note: This option is only available if Squid is rebuilt with the
3751 # -DMULTICAST_MISS_STREAM define
3753 # This is the time-to-live value for packets multicasted
3754 # when multicasting off cache miss URLs is enabled. By
3755 # default this is set to 'site scope', i.e. 16.
3760 # TAG: mcast_miss_port
3761 # Note: This option is only available if Squid is rebuilt with the
3762 # -DMULTICAST_MISS_STREAM define
3764 # This is the port number to be used in conjunction with
3765 # 'mcast_miss_addr'.
3768 # mcast_miss_port 3135
3770 # TAG: mcast_miss_encode_key
3771 # Note: This option is only available if Squid is rebuilt with the
3772 # -DMULTICAST_MISS_STREAM define
3774 # The URLs that are sent in the multicast miss stream are
3775 # encrypted. This is the encryption key.
3778 # mcast_miss_encode_key XXXXXXXXXXXXXXXX
3780 # TAG: mcast_icp_query_timeout (msec)
3781 # For multicast peers, Squid regularly sends out ICP "probes" to
3782 # count how many other peers are listening on the given multicast
3783 # address. This value specifies how long Squid should wait to
3784 # count all the replies. The default is 2000 msec, or 2
3788 # mcast_icp_query_timeout 2000
3791 # INTERNAL ICON OPTIONS
3792 # -----------------------------------------------------------------------------
3794 # TAG: icon_directory
3795 # Where the icons are stored. These are normally kept in
3796 # /usr/share/squid/icons
3799 # icon_directory /usr/share/squid/icons
3801 # TAG: global_internal_static
3802 # This directive controls is Squid should intercept all requests for
3803 # /squid-internal-static/ no matter which host the URL is requesting
3804 # (default on setting), or if nothing special should be done for
3805 # such URLs (off setting). The purpose of this directive is to make
3806 # icons etc work better in complex cache hierarchies where it may
3807 # not always be possible for all corners in the cache mesh to reach
3808 # the server generating a directory listing.
3811 # global_internal_static on
3813 # TAG: short_icon_urls
3814 # If this is enabled Squid will use short URLs for icons.
3815 # If disabled it will revert to the old behavior of including
3816 # it's own name and port in the URL.
3818 # If you run a complex cache hierarchy with a mix of Squid and
3819 # other proxies you may need to disable this directive.
3822 # short_icon_urls on
3825 # ERROR PAGE OPTIONS
3826 # -----------------------------------------------------------------------------
3828 # TAG: error_directory
3829 # Directory where the error files are read from.
3830 # /usr/lib/squid/errors contains sets of error files
3831 # in different languages. The default error directory
3832 # is /etc/squid/errors, which is a link to one of these
3835 # If you wish to create your own versions of the error files,
3836 # either to customize them to suit your language or company,
3837 # copy the template English files to another directory and
3838 # point this tag at them.
3840 # Current Language updates can be downloaded from:
3841 # http://www.squid-cache.org/Versions/langpack/
3843 # The squid developers are interested in making squid available in
3844 # a wide variety of languages. If you are making translations for a
3845 # language that Squid does not currently provide please consider
3846 # contributing your translation back to the project.
3847 # see http://wiki.squid-cache.org/Translations
3850 # error_directory /usr/share/squid/errors/templates
3852 # TAG: err_html_text
3853 # HTML text to include in error messages. Make this a "mailto"
3854 # URL to your admin address, or maybe just a link to your
3855 # organizations Web page.
3857 # To include this in your error messages, you must rewrite
3858 # the error template files (found in the "errors" directory).
3859 # Wherever you want the 'err_html_text' line to appear,
3860 # insert a %L tag in the error template file.
3865 # TAG: email_err_data on|off
3866 # If enabled, information about the occurred error will be
3867 # included in the mailto links of the ERR pages (if %W is set)
3868 # so that the email body contains the data.
3869 # Syntax is <A HREF="mailto:%w%W">%w</A>
3875 # Usage: deny_info err_page_name acl
3876 # or deny_info http://... acl
3877 # Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys
3879 # This can be used to return a ERR_ page for requests which
3880 # do not pass the 'http_access' rules. Squid remembers the last
3881 # acl it evaluated in http_access, and if a 'deny_info' line exists
3882 # for that ACL Squid returns a corresponding error page.
3884 # The acl is typically the last acl on the http_access deny line which
3885 # denied access. The exceptions to this rule are:
3886 # - When Squid needs to request authentication credentials. It's then
3887 # the first authentication related acl encountered
3888 # - When none of the http_access lines matches. It's then the last
3889 # acl processed on the last http_access line.
3891 # You may use ERR_ pages that come with Squid or create your own pages
3892 # and put them into the configured errors/ directory.
3894 # Alternatively you can specify an error URL. The browsers will
3895 # get redirected (302) to the specified URL. %s in the redirection
3896 # URL will be replaced by the requested URL.
3898 # Alternatively you can tell Squid to reset the TCP connection
3899 # by specifying TCP_RESET.
3905 # OPTIONS INFLUENCING REQUEST FORWARDING
3906 # -----------------------------------------------------------------------------
3908 # TAG: nonhierarchical_direct
3909 # By default, Squid will send any non-hierarchical requests
3910 # (matching hierarchy_stoplist or not cacheable request type) direct
3911 # to origin servers.
3913 # If you set this to off, Squid will prefer to send these
3914 # requests to parents.
3916 # Note that in most configurations, by turning this off you will only
3917 # add latency to these request without any improvement in global hit
3920 # If you are inside an firewall see never_direct instead of
3924 # nonhierarchical_direct on
3926 # TAG: prefer_direct
3927 # Normally Squid tries to use parents for most requests. If you for some
3928 # reason like it to first try going direct and only use a parent if
3929 # going direct fails set this to on.
3931 # By combining nonhierarchical_direct off and prefer_direct on you
3932 # can set up Squid to use a parent as a backup path if going direct
3935 # Note: If you want Squid to use parents for all requests see
3936 # the never_direct directive. prefer_direct only modifies how Squid
3937 # acts on cacheable requests.
3942 # TAG: always_direct
3943 # Usage: always_direct allow|deny [!]aclname ...
3945 # Here you can use ACL elements to specify requests which should
3946 # ALWAYS be forwarded by Squid to the origin servers without using
3947 # any peers. For example, to always directly forward requests for
3948 # local servers ignoring any parents or siblings you may have use
3951 # acl local-servers dstdomain my.domain.net
3952 # always_direct allow local-servers
3954 # To always forward FTP requests directly, use
3957 # always_direct allow FTP
3959 # NOTE: There is a similar, but opposite option named
3960 # 'never_direct'. You need to be aware that "always_direct deny
3961 # foo" is NOT the same thing as "never_direct allow foo". You
3962 # may need to use a deny rule to exclude a more-specific case of
3963 # some other rule. Example:
3965 # acl local-external dstdomain external.foo.net
3966 # acl local-servers dstdomain .foo.net
3967 # always_direct deny local-external
3968 # always_direct allow local-servers
3970 # NOTE: If your goal is to make the client forward the request
3971 # directly to the origin server bypassing Squid then this needs
3972 # to be done in the client configuration. Squid configuration
3973 # can only tell Squid how Squid should fetch the object.
3975 # NOTE: This directive is not related to caching. The replies
3976 # is cached as usual even if you use always_direct. To not cache
3977 # the replies see no_cache.
3979 # This option replaces some v1.1 options such as local_domain
3986 # Usage: never_direct allow|deny [!]aclname ...
3988 # never_direct is the opposite of always_direct. Please read
3989 # the description for always_direct if you have not already.
3991 # With 'never_direct' you can use ACL elements to specify
3992 # requests which should NEVER be forwarded directly to origin
3993 # servers. For example, to force the use of a proxy for all
3994 # requests, except those in your local domain use something like:
3996 # acl local-servers dstdomain .foo.net
3997 # never_direct deny local-servers
3998 # never_direct allow all
4000 # or if Squid is inside a firewall and there are local intranet
4001 # servers inside the firewall use something like:
4003 # acl local-intranet dstdomain .foo.net
4004 # acl local-external dstdomain external.foo.net
4005 # always_direct deny local-external
4006 # always_direct allow local-intranet
4007 # never_direct allow all
4009 # This option replaces some v1.1 options such as inside_firewall
4016 # ADVANCED NETWORKING OPTIONS
4017 # -----------------------------------------------------------------------------
4019 # TAG: incoming_icp_average
4020 # TAG: incoming_http_average
4021 # TAG: incoming_dns_average
4022 # TAG: min_icp_poll_cnt
4023 # TAG: min_dns_poll_cnt
4024 # TAG: min_http_poll_cnt
4025 # Heavy voodoo here. I can't even believe you are reading this.
4026 # Are you crazy? Don't even think about adjusting these unless
4027 # you understand the algorithms in comm_select.c first!
4030 # incoming_icp_average 6
4031 # incoming_http_average 4
4032 # incoming_dns_average 4
4033 # min_icp_poll_cnt 8
4034 # min_dns_poll_cnt 8
4035 # min_http_poll_cnt 8
4037 # TAG: accept_filter
4040 # The name of an accept(2) filter to install on Squid's
4041 # listen socket(s). This feature is perhaps specific to
4042 # FreeBSD and requires support in the kernel.
4044 # The 'httpready' filter delays delivering new connections
4045 # to Squid until a full HTTP request has been received.
4046 # See the accf_http(9) man page for details.
4048 # The 'dataready' filter delays delivering new connections
4049 # to Squid until there is some data to process.
4050 # See the accf_dataready(9) man page for details.
4054 # The 'data' filter delays delivering of new connections
4055 # to Squid until there is some data to process by TCP_ACCEPT_DEFER.
4056 # You may optionally specify a number of seconds to wait by
4057 # 'data=N' where N is the number of seconds. Defaults to 30
4058 # if not specified. See the tcp(7) man page for details.
4061 #accept_filter httpready
4068 # TAG: tcp_recv_bufsize (bytes)
4069 # Size of receive buffer to set for TCP sockets. Probably just
4070 # as easy to change your kernel's default. Set to zero to use
4071 # the default buffer size.
4074 # tcp_recv_bufsize 0 bytes
4078 # -----------------------------------------------------------------------------
4080 # TAG: icap_enable on|off
4081 # If you want to enable the ICAP module support, set this to on.
4086 # TAG: icap_connect_timeout
4087 # This parameter specifies how long to wait for the TCP connect to
4088 # the requested ICAP server to complete before giving up and either
4089 # terminating the HTTP transaction or bypassing the failure.
4091 # The default for optional services is peer_connect_timeout.
4092 # The default for essential services is connect_timeout.
4093 # If this option is explicitly set, its value applies to all services.
4098 # TAG: icap_io_timeout time-units
4099 # This parameter specifies how long to wait for an I/O activity on
4100 # an established, active ICAP connection before giving up and
4101 # either terminating the HTTP transaction or bypassing the
4104 # The default is read_timeout.
4109 # TAG: icap_service_failure_limit
4110 # The limit specifies the number of failures that Squid tolerates
4111 # when establishing a new TCP connection with an ICAP service. If
4112 # the number of failures exceeds the limit, the ICAP service is
4113 # not used for new ICAP requests until it is time to refresh its
4114 # OPTIONS. The per-service failure counter is reset to zero each
4115 # time Squid fetches new service OPTIONS.
4117 # A negative value disables the limit. Without the limit, an ICAP
4118 # service will not be considered down due to connectivity failures
4119 # between ICAP OPTIONS requests.
4122 # icap_service_failure_limit 10
4124 # TAG: icap_service_revival_delay
4125 # The delay specifies the number of seconds to wait after an ICAP
4126 # OPTIONS request failure before requesting the options again. The
4127 # failed ICAP service is considered "down" until fresh OPTIONS are
4130 # The actual delay cannot be smaller than the hardcoded minimum
4131 # delay of 30 seconds.
4134 # icap_service_revival_delay 180
4136 # TAG: icap_preview_enable on|off
4137 # The ICAP Preview feature allows the ICAP server to handle the
4138 # HTTP message by looking only at the beginning of the message body
4139 # or even without receiving the body at all. In some environments,
4140 # previews greatly speedup ICAP processing.
4142 # During an ICAP OPTIONS transaction, the server may tell Squid what
4143 # HTTP messages should be previewed and how big the preview should be.
4144 # Squid will not use Preview if the server did not request one.
4146 # To disable ICAP Preview for all ICAP services, regardless of
4147 # individual ICAP server OPTIONS responses, set this option to "off".
4149 #icap_preview_enable off
4152 # icap_preview_enable on
4154 # TAG: icap_preview_size
4155 # The default size of preview data to be sent to the ICAP server.
4156 # -1 means no preview. This value might be overwritten on a per server
4157 # basis by OPTIONS requests.
4160 # icap_preview_size -1
4162 # TAG: icap_default_options_ttl
4163 # The default TTL value for ICAP OPTIONS responses that don't have
4164 # an Options-TTL header.
4167 # icap_default_options_ttl 60
4169 # TAG: icap_persistent_connections on|off
4170 # Whether or not Squid should use persistent connections to
4174 # icap_persistent_connections on
4176 # TAG: icap_send_client_ip on|off
4177 # This adds the header "X-Client-IP" to ICAP requests.
4180 # icap_send_client_ip off
4182 # TAG: icap_send_client_username on|off
4183 # This sends authenticated HTTP client username (if available) to
4184 # the ICAP service. The username value is encoded based on the
4185 # icap_client_username_encode option and is sent using the header
4186 # specified by the icap_client_username_header option.
4189 # icap_send_client_username off
4191 # TAG: icap_client_username_header
4192 # ICAP request header name to use for send_client_username.
4195 # icap_client_username_header X-Client-Username
4197 # TAG: icap_client_username_encode on|off
4198 # Whether to base64 encode the authenticated client username.
4201 # icap_client_username_encode off
4204 # Defines a single ICAP service
4206 # icap_service servicename vectoring_point bypass service_url
4208 # vectoring_point = reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
4209 # This specifies at which point of transaction processing the
4210 # ICAP service should be activated. *_postcache vectoring points
4211 # are not yet supported.
4213 # If set to 1, the ICAP service is treated as optional. If the
4214 # service cannot be reached or malfunctions, Squid will try to
4215 # ignore any errors and process the message as if the service
4216 # was not enabled. No all ICAP errors can be bypassed.
4217 # If set to 0, the ICAP service is treated as essential and all
4218 # ICAP errors will result in an error page returned to the
4220 # service_url = icap://servername:port/service
4223 #icap_service service_1 reqmod_precache 0 icap://icap1.mydomain.net:1344/reqmod
4224 #icap_service service_2 respmod_precache 0 icap://icap2.mydomain.net:1344/respmod
4230 # Defines an ICAP service chain. Eventually, multiple services per
4231 # vectoring point will be supported. For now, please specify a single
4232 # service per class:
4234 # icap_class classname servicename
4237 #icap_class class_1 service_1
4238 #icap class class_2 service_1
4239 #icap class class_3 service_3
4245 # Redirects a request through an ICAP service class, depending
4248 # icap_access classname allow|deny [!]aclname...
4250 # The icap_access statements are processed in the order they appear in
4251 # this configuration file. If an access list matches, the processing stops.
4252 # For an "allow" rule, the specified class is used for the request. A "deny"
4253 # rule simply stops processing without using the class. You can also use the
4254 # special classname "None".
4256 # For backward compatibility, it is also possible to use services
4259 #icap_access class_1 allow all
4266 # -----------------------------------------------------------------------------
4268 # TAG: check_hostnames
4269 # For security and stability reasons Squid can check
4270 # hostnames for Internet standard RFC compliance. If you want
4271 # Squid to perform these checks turn this directive on.
4274 # check_hostnames off
4276 # TAG: allow_underscore
4277 # Underscore characters is not strictly allowed in Internet hostnames
4278 # but nevertheless used by many sites. Set this to off if you want
4279 # Squid to be strict about the standard.
4280 # This check is performed only when check_hostnames is set to on.
4283 # allow_underscore on
4285 # TAG: cache_dns_program
4286 # Note: This option is only available if Squid is rebuilt with the
4287 # --disable-internal-dns option
4289 # Specify the location of the executable for dnslookup process.
4292 # cache_dns_program /usr/lib64/squid/dnsserver
4295 # Note: This option is only available if Squid is rebuilt with the
4296 # --disable-internal-dns option
4298 # The number of processes spawn to service DNS name lookups.
4299 # For heavily loaded caches on large servers, you should
4300 # probably increase this value to at least 10. The maximum
4301 # is 32. The default is 5.
4303 # You must have at least one dnsserver process.
4308 # TAG: dns_retransmit_interval
4309 # Initial retransmit interval for DNS queries. The interval is
4310 # doubled each time all configured DNS servers have been tried.
4314 # dns_retransmit_interval 5 seconds
4317 # DNS Query timeout. If no response is received to a DNS query
4318 # within this time all DNS servers for the queried domain
4319 # are assumed to be unavailable.
4322 # dns_timeout 2 minutes
4324 # TAG: dns_defnames on|off
4325 # Normally the RES_DEFNAMES resolver option is disabled
4326 # (see res_init(3)). This prevents caches in a hierarchy
4327 # from interpreting single-component hostnames locally. To allow
4328 # Squid to handle single-component names, enable this option.
4333 # TAG: dns_nameservers
4334 # Use this if you want to specify a list of DNS name servers
4335 # (IP addresses) to use instead of those given in your
4336 # /etc/resolv.conf file.
4337 # On Windows platforms, if no value is specified here or in
4338 # the /etc/resolv.conf file, the list of DNS name servers are
4339 # taken from the Windows registry, both static and dynamic DHCP
4340 # configurations are supported.
4342 # Example: dns_nameservers 10.0.0.1 192.172.0.4
4348 # Location of the host-local IP name-address associations
4349 # database. Most Operating Systems have such a file on different
4350 # default locations:
4351 # - Un*X & Linux: /etc/hosts
4352 # - Windows NT/2000: %SystemRoot%\system32\drivers\etc\hosts
4353 # (%SystemRoot% value install default is c:\winnt)
4354 # - Windows XP/2003: %SystemRoot%\system32\drivers\etc\hosts
4355 # (%SystemRoot% value install default is c:\windows)
4356 # - Windows 9x/Me: %windir%\hosts
4357 # (%windir% value is usually c:\windows)
4358 # - Cygwin: /etc/hosts
4360 # The file contains newline-separated definitions, in the
4361 # form ip_address_in_dotted_form name [name ...] names are
4362 # whitespace-separated. Lines beginning with an hash (#)
4363 # character are comments.
4365 # The file is checked at startup and upon configuration.
4366 # If set to 'none', it won't be checked.
4367 # If append_domain is used, that domain will be added to
4368 # domain-local (i.e. not containing any dot character) host
4372 # hosts_file /etc/hosts
4374 # TAG: dns_testnames
4375 # The DNS tests exit as soon as the first site is successfully looked up
4377 # This test can be disabled with the -D command line option.
4380 # dns_testnames netscape.com internic.net nlanr.net microsoft.com
4382 # TAG: append_domain
4383 # Appends local domain name to hostnames without any dots in
4384 # them. append_domain must begin with a period.
4386 # Be warned there are now Internet names with no dots in
4387 # them using only top-domain names, so setting this may
4388 # cause some Internet sites to become unavailable.
4391 # append_domain .yourdomain.com
4396 # TAG: ignore_unknown_nameservers
4397 # By default Squid checks that DNS responses are received
4398 # from the same IP addresses they are sent to. If they
4399 # don't match, Squid ignores the response and writes a warning
4400 # message to cache.log. You can allow responses from unknown
4401 # nameservers by setting this option to 'off'.
4404 # ignore_unknown_nameservers on
4406 # TAG: ipcache_size (number of entries)
4407 # TAG: ipcache_low (percent)
4408 # TAG: ipcache_high (percent)
4409 # The size, low-, and high-water marks for the IP cache.
4416 # TAG: fqdncache_size (number of entries)
4417 # Maximum number of FQDN cache entries.
4420 # fqdncache_size 1024
4424 # -----------------------------------------------------------------------------
4426 # TAG: memory_pools on|off
4427 # If set, Squid will keep pools of allocated (but unused) memory
4428 # available for future use. If memory is a premium on your
4429 # system and you believe your malloc library outperforms Squid
4430 # routines, disable this.
4435 # TAG: memory_pools_limit (bytes)
4436 # Used only with memory_pools on:
4437 # memory_pools_limit 50 MB
4439 # If set to a non-zero value, Squid will keep at most the specified
4440 # limit of allocated (but unused) memory in memory pools. All free()
4441 # requests that exceed this limit will be handled by your malloc
4442 # library. Squid does not pre-allocate any memory, just safe-keeps
4443 # objects that otherwise would be free()d. Thus, it is safe to set
4444 # memory_pools_limit to a reasonably high value even if your
4445 # configuration will use less memory.
4447 # If set to zero, Squid will keep all memory it can. That is, there
4448 # will be no limit on the total amount of memory used for safe-keeping.
4450 # To disable memory allocation optimization, do not set
4451 # memory_pools_limit to 0. Set memory_pools to "off" instead.
4453 # An overhead for maintaining memory pools is not taken into account
4454 # when the limit is checked. This overhead is close to four bytes per
4455 # object kept. However, pools may actually _save_ memory because of
4456 # reduced memory thrashing in your malloc library.
4459 # memory_pools_limit 5 MB
4461 # TAG: forwarded_for on|off
4462 # If set, Squid will include your system's IP address or name
4463 # in the HTTP requests it forwards. By default it looks like
4466 # X-Forwarded-For: 192.1.2.3
4468 # If you disable this, it will appear as
4470 # X-Forwarded-For: unknown
4475 # TAG: cachemgr_passwd
4476 # Specify passwords for cachemgr operations.
4478 # Usage: cachemgr_passwd password action action ...
4480 # Some valid actions are (see cache manager menu for a full list):
4520 # * Indicates actions which will not be performed without a
4521 # valid password, others can be performed if not listed here.
4523 # To disable an action, set the password to "disable".
4524 # To allow performing an action without a password, set the
4525 # password to "none".
4527 # Use the keyword "all" to set the same password for all actions.
4530 # cachemgr_passwd secret shutdown
4531 # cachemgr_passwd lesssssssecret info stats/objects
4532 # cachemgr_passwd disable all
4537 # TAG: client_db on|off
4538 # If you want to disable collecting per-client statistics,
4539 # turn off client_db here.
4544 # TAG: refresh_all_ims on|off
4545 # When you enable this option, squid will always check
4546 # the origin server for an update when a client sends an
4547 # If-Modified-Since request. Many browsers use IMS
4548 # requests when the user requests a reload, and this
4549 # ensures those clients receive the latest version.
4551 # By default (off), squid may return a Not Modified response
4552 # based on the age of the cached version.
4555 # refresh_all_ims off
4557 # TAG: reload_into_ims on|off
4558 # When you enable this option, client no-cache or ``reload''
4559 # requests will be changed to If-Modified-Since requests.
4560 # Doing this VIOLATES the HTTP standard. Enabling this
4561 # feature could make you liable for problems which it
4564 # see also refresh_pattern for a more selective approach.
4567 # reload_into_ims off
4569 # TAG: maximum_single_addr_tries
4570 # This sets the maximum number of connection attempts for a
4571 # host that only has one address (for multiple-address hosts,
4572 # each address is tried once).
4574 # The default value is one attempt, the (not recommended)
4575 # maximum is 255 tries. A warning message will be generated
4576 # if it is set to a value greater than ten.
4578 # Note: This is in addition to the request re-forwarding which
4579 # takes place if Squid fails to get a satisfying response.
4582 # maximum_single_addr_tries 1
4584 # TAG: retry_on_error
4585 # If set to on Squid will automatically retry requests when
4586 # receiving an error response. This is mainly useful if you
4587 # are in a complex cache hierarchy to work around access
4591 # retry_on_error off
4593 # TAG: as_whois_server
4594 # WHOIS server to query for AS numbers. NOTE: AS numbers are
4595 # queried only when Squid starts up, not for every request.
4598 # as_whois_server whois.ra.net
4599 # as_whois_server whois.ra.net
4602 # Enable this option and Squid will never try to validate cached
4608 # TAG: uri_whitespace
4609 # What to do with requests that have whitespace characters in the
4612 # strip: The whitespace characters are stripped out of the URL.
4613 # This is the behavior recommended by RFC2396.
4614 # deny: The request is denied. The user receives an "Invalid
4616 # allow: The request is allowed and the URI is not changed. The
4617 # whitespace characters remain in the URI. Note the
4618 # whitespace is passed to redirector processes if they
4620 # encode: The request is allowed and the whitespace characters are
4621 # encoded according to RFC1738. This could be considered
4622 # a violation of the HTTP/1.1
4623 # RFC because proxies are not allowed to rewrite URI's.
4624 # chop: The request is allowed and the URI is chopped at the
4625 # first whitespace. This might also be considered a
4629 # uri_whitespace strip
4632 # By default Squid leaves core files in the directory from where
4633 # it was started. If you set 'coredump_dir' to a directory
4634 # that exists, Squid will chdir() to that directory at startup
4635 # and coredump files will be left there.
4640 # Leave coredumps in the first cache dir
4641 coredump_dir /var/spool/squid
4644 # Use this to have Squid do a chroot() while initializing. This
4645 # also causes Squid to fully drop root privileges after
4646 # initializing. This means, for example, if you use a HTTP
4647 # port less than 1024 and try to reconfigure, you will may get an
4648 # error saying that Squid can not open the port.
4653 # TAG: balance_on_multiple_ip
4654 # Some load balancing servers based on round robin DNS have been
4655 # found not to preserve user session state across requests
4656 # to different IP addresses.
4658 # By default Squid rotates IP's per request. By disabling
4659 # this directive only connection failure triggers rotation.
4662 # balance_on_multiple_ip on
4664 # TAG: pipeline_prefetch
4665 # To boost the performance of pipelined requests to closer
4666 # match that of a non-proxied environment Squid can try to fetch
4667 # up to two requests in parallel from a pipeline.
4669 # Defaults to off for bandwidth management and access logging
4673 # pipeline_prefetch off
4675 # TAG: high_response_time_warning (msec)
4676 # If the one-minute median response time exceeds this value,
4677 # Squid prints a WARNING with debug level 0 to get the
4678 # administrators attention. The value is in milliseconds.
4681 # high_response_time_warning 0
4683 # TAG: high_page_fault_warning
4684 # If the one-minute average page fault rate exceeds this
4685 # value, Squid prints a WARNING with debug level 0 to get
4686 # the administrators attention. The value is in page faults
4690 # high_page_fault_warning 0
4692 # TAG: high_memory_warning
4693 # If the memory usage (as determined by mallinfo) exceeds
4694 # this amount, Squid prints a WARNING with debug level 0 to get
4695 # the administrators attention.
4698 # high_memory_warning 0 KB
4700 # TAG: sleep_after_fork (microseconds)
4701 # When this is set to a non-zero value, the main Squid process
4702 # sleeps the specified number of microseconds after a fork()
4703 # system call. This sleep may help the situation where your
4704 # system reports fork() failures due to lack of (virtual)
4705 # memory. Note, however, if you have a lot of child
4706 # processes, these sleep delays will add up and your
4707 # Squid will not service requests for some amount of time
4708 # until all the child processes have been started.
4709 # On Windows value less then 1000 (1 milliseconds) are
4713 # sleep_after_fork 0
4715 # TAG: windows_ipaddrchangemonitor on|off
4716 # On Windows Squid by default will monitor IP address changes and will
4717 # reconfigure itself after any detected event. This is very useful for
4718 # proxies connected to internet with dial-up interfaces.
4719 # In some cases (a Proxy server acting as VPN gateway is one) it could be
4720 # desiderable to disable this behaviour setting this to 'off'.
4721 # Note: after changing this, Squid service must be restarted.
4724 # windows_ipaddrchangemonitor on