2 # SQUID Web Proxy Cache http://www.squid-cache.org/
3 # ----------------------------------------------------------
5 # Squid is the result of efforts by numerous individuals from
6 # the Internet community; see the CONTRIBUTORS file for full
7 # details. Many organizations have provided support for Squid's
8 # development; see the SPONSORS file for full details. Squid is
9 # Copyrighted (C) 2000 by the Regents of the University of
10 # California; see the COPYRIGHT file for full details. Squid
11 # incorporates software developed and/or copyrighted by other
12 # sources; see the CREDITS file for full details.
14 # This program is free software; you can redistribute it and/or modify
15 # it under the terms of the GNU General Public License as published by
16 # the Free Software Foundation; either version 2 of the License, or
17 # (at your option) any later version.
19 # This program is distributed in the hope that it will be useful,
20 # but WITHOUT ANY WARRANTY; without even the implied warranty of
21 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 # GNU General Public License for more details.
24 # You should have received a copy of the GNU General Public License
25 # along with this program; if not, write to the Free Software
26 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
31 ----------------------------
33 This is the documentation for the Squid configuration file.
34 This documentation can also be found online at:
35 http://www.squid-cache.org/Doc/config/
37 You may wish to look at the Squid home page and wiki for the
38 FAQ and other documentation:
39 http://www.squid-cache.org/
40 http://wiki.squid-cache.org/SquidFaq
41 http://wiki.squid-cache.org/ConfigExamples
43 This documentation shows what the defaults for various directives
44 happen to be. If you don't need to change the default, you should
45 leave the line out of your squid.conf in most cases.
47 In some cases "none" refers to no default setting at all,
48 while in other cases it refers to the value of the option
49 - the comments for that keyword indicate if this is the case.
54 Configuration options can be included using the "include" directive.
55 Include takes a list of files to include. Quoting and wildcards are
60 include /path/to/included/file/squid.acl.config
62 Includes can be nested up to a hard-coded depth of 16 levels.
63 This arbitrary restriction is to prevent recursive include references
64 from causing Squid entering an infinite loop whilst trying to load
67 Values with byte units
69 Squid accepts size units on some size related directives. All
70 such directives are documented with a default value displaying
73 Units accepted by Squid are:
75 KB - Kilobyte (1024 bytes)
79 Values with spaces, quotes, and other special characters
81 Squid supports directive parameters with spaces, quotes, and other
82 special characters. Surround such parameters with "double quotes". Use
83 the configuration_includes_quoted_values directive to enable or
86 Squid supports reading configuration option parameters from external
87 files using the syntax:
88 parameters("/path/filename")
90 acl whitelist dstdomain parameters("/etc/squid/whitelist.txt")
92 Conditional configuration
94 If-statements can be used to make configuration directives
98 ... regular configuration directives ...
100 ... regular configuration directives ...]
103 The else part is optional. The keywords "if", "else", and "endif"
104 must be typed on their own lines, as if they were regular
105 configuration directives.
107 NOTE: An else-if condition is not supported.
109 These individual conditions types are supported:
112 Always evaluates to true.
114 Always evaluates to false.
115 <integer> = <integer>
116 Equality comparison of two integer numbers.
121 The following SMP-related preprocessor macros can be used.
123 ${process_name} expands to the current Squid process "name"
124 (e.g., squid1, squid2, or cache1).
126 ${process_number} expands to the current Squid process
127 identifier, which is an integer number (e.g., 1, 2, 3) unique
128 across all Squid processes of the current service instance.
130 ${service_name} expands into the current Squid service instance
131 name identifier which is provided by -n on the command line.
135 # options still not yet ported from 2.7 to 3.x
136 NAME: broken_vary_encoding
139 This option is not yet supported by Squid-3.
145 This option is not yet supported by Squid-3.
151 This option is not yet supported by Squid-3.
154 NAME: external_refresh_check
157 This option is not yet supported by Squid-3.
160 NAME: location_rewrite_program location_rewrite_access location_rewrite_children location_rewrite_concurrency
163 This option is not yet supported by Squid-3.
166 NAME: refresh_stale_hit
169 This option is not yet supported by Squid-3.
172 # Options Removed in 3.3
173 NAME: ignore_ims_on_miss
176 Remove this line. The HTTP/1.1 feature is now fully supported by default.
179 # Options Removed in 3.2
180 NAME: ignore_expect_100
183 Remove this line. The HTTP/1.1 feature is now fully supported by default.
186 NAME: dns_v4_fallback
189 Remove this line. Squid performs a 'Happy Eyeballs' algorithm, the 'fallback' algorithm is no longer relevant.
195 Remove this line. Configure FTP page display using the CSS controls in errorpages.css instead.
198 NAME: maximum_single_addr_tries
201 Replaced by connect_retries. The behaviour has changed, please read the documentation before altering.
207 Remove this line. The feature is supported by default in storage types where update is implemented.
210 NAME: url_rewrite_concurrency
213 Remove this line. Set the 'concurrency=' option of url_rewrite_children instead.
216 # Options Removed in 3.1
220 Remove this line. DNS is no longer tested on startup.
223 NAME: extension_methods
226 Remove this line. All valid methods for HTTP are accepted by default.
229 # 2.7 Options Removed/Replaced in 3.2
234 # 2.7 Options Removed/Replaced in 3.1
242 Remove this line. HTTP/1.1 is supported by default.
245 NAME: upgrade_http0.9
248 Remove this line. ICY/1.0 streaming protocol is supported by default.
251 NAME: zph_local zph_mode zph_option zph_parent zph_sibling
254 Alter these entries. Use the qos_flows directive instead.
257 # Options Removed in 3.0
261 Since squid-3.0 replace with request_header_access or reply_header_access
262 depending on whether you wish to match client requests or server replies.
265 NAME: httpd_accel_no_pmtu_disc
268 Since squid-3.0 use the 'disable-pmtu-discovery' flag on http_port instead.
271 NAME: wais_relay_host
274 Replace this line with 'cache_peer' configuration.
277 NAME: wais_relay_port
280 Replace this line with 'cache_peer' configuration.
284 OPTIONS FOR AUTHENTICATION
285 -----------------------------------------------------------------------------
294 This is used to define parameters for the various authentication
295 schemes supported by Squid.
297 format: auth_param scheme parameter [setting]
299 The order in which authentication schemes are presented to the client is
300 dependent on the order the scheme first appears in config file. IE
301 has a bug (it's not RFC 2617 compliant) in that it will use the basic
302 scheme if basic is the first entry presented, even if more secure
303 schemes are presented. For now use the order in the recommended
304 settings section below. If other browsers have difficulties (don't
305 recognize the schemes offered even if you are using basic) either
306 put basic first, or disable the other schemes (by commenting out their
309 Once an authentication scheme is fully configured, it can only be
310 shutdown by shutting squid down and restarting. Changes can be made on
311 the fly and activated with a reconfigure. I.E. You can change to a
312 different helper, but not unconfigure the helper completely.
314 Please note that while this directive defines how Squid processes
315 authentication it does not automatically activate authentication.
316 To use authentication you must in addition make use of ACLs based
317 on login name in http_access (proxy_auth, proxy_auth_regex or
318 external with %LOGIN used in the format tag). The browser will be
319 challenged for authentication on the first such acl encountered
320 in http_access processing and will also be re-challenged for new
321 login credentials if the request is being denied by a proxy_auth
324 WARNING: authentication can't be used in a transparently intercepting
325 proxy as the client then thinks it is talking to an origin server and
326 not the proxy. This is a limitation of bending the TCP/IP protocol to
327 transparently intercepting port 80, not a limitation in Squid.
328 Ports flagged 'transparent', 'intercept', or 'tproxy' have
329 authentication disabled.
331 === Parameters common to all schemes. ===
334 Specifies the command for the external authenticator. Such a program
335 runs a loop that, on every iteration, reads a request line from
336 the standard and responds with a scheme-specific answer. The loop
337 stops when all input is exchausted (EOF). See scheme-specific
338 "program" descriptions below for details.
341 Specifies a string to be append to request line format for the
342 authentication helper. "Quoted" format values may contain spaces and
343 logformat %macros. In theory, any logformat %macro can be used.
344 In practice, a %macro expands as a dash (-) if the helper request is
345 sent before the required macro information is available to Squid.
346 By default, Squid uses request formats provided in scheme-specific
347 examples below (search for %credentials).
348 The expanded key_extras value is added to the Squid credentials
349 cache and, hence, will affect authentication. It can be used to
350 autenticate different users with identical user names (e.g., when user
351 authentication depends on http_port).
352 Avoid adding frequently changing information to key_extras. For
353 example, if you add user source IP, and it changes frequently
354 in your environment, then max_user_ip ACL is going to treat every
355 user+IP combination as a unique "user", breaking the ACL and
356 wasting a lot of memory on those user records. It will also force
357 users to authenticate from scratch whenever their IP changes.
359 === Parameters for the basic scheme follow. ===
362 Specify the command for the external authenticator. Such a program
363 reads a request_format line ("username password" by default) and
364 replies with one of three results:
370 the user does not exist.
373 An internal error occurred in the helper, preventing
374 a result being identified.
376 "ERR" and "BH" results may optionally be followed by message="..."
377 containing a description available as %m in the returned error page.
379 If you use an authenticator, make sure you have 1 acl of type
382 By default, the basic authentication scheme is not used unless a
383 program is specified.
385 If you want to use the traditional NCSA proxy authentication, set
386 this line to something like
388 auth_param basic program @DEFAULT_PREFIX@/libexec/basic_ncsa_auth @DEFAULT_PREFIX@/etc/passwd
391 HTTP uses iso-latin-1 as character set, while some authentication
392 backends such as LDAP expects UTF-8. If this is set to on Squid will
393 translate the HTTP iso-latin-1 charset to UTF-8 before sending the
394 username & password to the helper.
396 "children" numberofchildren [startup=N] [idle=N] [concurrency=N]
397 The maximum number of authenticator processes to spawn. If you start too few
398 Squid will have to wait for them to process a backlog of credential
399 verifications, slowing it down. When password verifications are
400 done via a (slow) network you are likely to need lots of
401 authenticator processes.
403 The startup= and idle= options permit some skew in the exact amount
404 run. A minimum of startup=N will begin during startup and reconfigure.
405 Squid will start more in groups of up to idle=N in an attempt to meet
406 traffic needs and to keep idle=N free above those traffic needs up to
409 The concurrency= option sets the number of concurrent requests the
410 helper can process. The default of 0 is used for helpers who only
411 supports one request at a time. Setting this to a number greater than
412 0 changes the protocol used to include a channel number first on the
413 request/response line, allowing multiple requests to be sent to the
414 same helper in parallel without waiting for the response.
415 Must not be set unless it's known the helper supports this.
417 auth_param basic children 20 startup=0 idle=1
420 Specifies the realm name which is to be reported to the
421 client for the basic proxy authentication scheme (part of
422 the text the user will see when prompted their username and
423 password). There is no default.
424 auth_param basic realm Squid proxy-caching web server
426 "credentialsttl" timetolive
427 Specifies how long squid assumes an externally validated
428 username:password pair is valid for - in other words how
429 often the helper program is called for that user. Set this
430 low to force revalidation with short lived passwords. Note
431 setting this high does not impact your susceptibility
432 to replay attacks unless you are using an one-time password
433 system (such as SecureID). If you are using such a system,
434 you will be vulnerable to replay attacks unless you also
435 use the max_user_ip ACL in an http_access rule.
437 "casesensitive" on|off
438 Specifies if usernames are case sensitive. Most user databases are
439 case insensitive allowing the same username to be spelled using both
440 lower and upper case letters, but some are case sensitive. This
441 makes a big difference for user_max_ip ACL processing and similar.
442 auth_param basic casesensitive off
444 === Parameters for the digest scheme follow ===
447 Specify the command for the external authenticator. Such a program
448 reads a request_format line ("username":"realm" by default) and
449 replies with one of three results:
452 the user exists. The ha1= key is mandatory and
453 contains the appropriate H(A1) value, hex encoded.
454 See rfc 2616 for the definition of H(A1).
457 the user does not exist.
460 An internal error occurred in the helper, preventing
461 a result being identified.
463 "ERR" and "BH" results may optionally be followed by message="..."
464 containing a description available as %m in the returned error page.
466 By default, the digest authentication scheme is not used unless a
467 program is specified.
469 If you want to use a digest authenticator, set this line to
472 auth_param digest program @DEFAULT_PREFIX@/bin/digest_pw_auth @DEFAULT_PREFIX@/etc/digpass
475 HTTP uses iso-latin-1 as character set, while some authentication
476 backends such as LDAP expects UTF-8. If this is set to on Squid will
477 translate the HTTP iso-latin-1 charset to UTF-8 before sending the
478 username & password to the helper.
480 "children" numberofchildren [startup=N] [idle=N] [concurrency=N]
481 The maximum number of authenticator processes to spawn (default 5).
482 If you start too few Squid will have to wait for them to
483 process a backlog of H(A1) calculations, slowing it down.
484 When the H(A1) calculations are done via a (slow) network
485 you are likely to need lots of authenticator processes.
487 The startup= and idle= options permit some skew in the exact amount
488 run. A minimum of startup=N will begin during startup and reconfigure.
489 Squid will start more in groups of up to idle=N in an attempt to meet
490 traffic needs and to keep idle=N free above those traffic needs up to
493 The concurrency= option sets the number of concurrent requests the
494 helper can process. The default of 0 is used for helpers who only
495 supports one request at a time. Setting this to a number greater than
496 0 changes the protocol used to include a channel number first on the
497 request/response line, allowing multiple requests to be sent to the
498 same helper in parallel without waiting for the response.
499 Must not be set unless it's known the helper supports this.
501 auth_param digest children 20 startup=0 idle=1
504 Specifies the realm name which is to be reported to the
505 client for the digest proxy authentication scheme (part of
506 the text the user will see when prompted their username and
507 password). There is no default.
508 auth_param digest realm Squid proxy-caching web server
510 "nonce_garbage_interval" timeinterval
511 Specifies the interval that nonces that have been issued
512 to client_agent's are checked for validity.
514 "nonce_max_duration" timeinterval
515 Specifies the maximum length of time a given nonce will be
518 "nonce_max_count" number
519 Specifies the maximum number of times a given nonce can be
522 "nonce_strictness" on|off
523 Determines if squid requires strict increment-by-1 behavior
524 for nonce counts, or just incrementing (off - for use when
525 user agents generate nonce counts that occasionally miss 1
526 (ie, 1,2,4,6)). Default off.
528 "check_nonce_count" on|off
529 This directive if set to off can disable the nonce count check
530 completely to work around buggy digest qop implementations in
531 certain mainstream browser versions. Default on to check the
532 nonce count to protect from authentication replay attacks.
534 "post_workaround" on|off
535 This is a workaround to certain buggy browsers who sends
536 an incorrect request digest in POST requests when reusing
537 the same nonce as acquired earlier on a GET request.
539 === NTLM scheme options follow ===
542 Specify the command for the external NTLM authenticator.
543 Such a program reads exchanged NTLMSSP packets with
544 the browser via Squid until authentication is completed.
545 If you use an NTLM authenticator, make sure you have 1 acl
546 of type proxy_auth. By default, the NTLM authenticator program
549 auth_param ntlm program /usr/bin/ntlm_auth
551 "children" numberofchildren [startup=N] [idle=N]
552 The maximum number of authenticator processes to spawn (default 5).
553 If you start too few Squid will have to wait for them to
554 process a backlog of credential verifications, slowing it
555 down. When credential verifications are done via a (slow)
556 network you are likely to need lots of authenticator
559 The startup= and idle= options permit some skew in the exact amount
560 run. A minimum of startup=N will begin during startup and reconfigure.
561 Squid will start more in groups of up to idle=N in an attempt to meet
562 traffic needs and to keep idle=N free above those traffic needs up to
565 auth_param ntlm children 20 startup=0 idle=1
568 If you experience problems with PUT/POST requests when using the
569 Negotiate authentication scheme then you can try setting this to
570 off. This will cause Squid to forcibly close the connection on
571 the initial requests where the browser asks which schemes are
572 supported by the proxy.
574 auth_param ntlm keep_alive on
576 === Options for configuring the NEGOTIATE auth-scheme follow ===
579 Specify the command for the external Negotiate authenticator.
580 This protocol is used in Microsoft Active-Directory enabled setups with
581 the Microsoft Internet Explorer or Mozilla Firefox browsers.
582 Its main purpose is to exchange credentials with the Squid proxy
583 using the Kerberos mechanisms.
584 If you use a Negotiate authenticator, make sure you have at least
585 one acl of type proxy_auth active. By default, the negotiate
586 authenticator program is not used.
587 The only supported program for this role is the ntlm_auth
588 program distributed as part of Samba, version 4 or later.
590 auth_param negotiate program /usr/bin/ntlm_auth --helper-protocol=gss-spnego
592 "children" numberofchildren [startup=N] [idle=N]
593 The maximum number of authenticator processes to spawn (default 5).
594 If you start too few Squid will have to wait for them to
595 process a backlog of credential verifications, slowing it
596 down. When credential verifications are done via a (slow)
597 network you are likely to need lots of authenticator
600 The startup= and idle= options permit some skew in the exact amount
601 run. A minimum of startup=N will begin during startup and reconfigure.
602 Squid will start more in groups of up to idle=N in an attempt to meet
603 traffic needs and to keep idle=N free above those traffic needs up to
606 auth_param negotiate children 20 startup=0 idle=1
609 If you experience problems with PUT/POST requests when using the
610 Negotiate authentication scheme then you can try setting this to
611 off. This will cause Squid to forcibly close the connection on
612 the initial requests where the browser asks which schemes are
613 supported by the proxy.
615 auth_param negotiate keep_alive on
619 #Recommended minimum configuration per scheme:
620 #auth_param negotiate program <uncomment and complete this line to activate>
621 #auth_param negotiate children 20 startup=0 idle=1
622 #auth_param negotiate keep_alive on
624 #auth_param ntlm program <uncomment and complete this line to activate>
625 #auth_param ntlm children 20 startup=0 idle=1
626 #auth_param ntlm keep_alive on
628 #auth_param digest program <uncomment and complete this line>
629 #auth_param digest children 20 startup=0 idle=1
630 #auth_param digest realm Squid proxy-caching web server
631 #auth_param digest nonce_garbage_interval 5 minutes
632 #auth_param digest nonce_max_duration 30 minutes
633 #auth_param digest nonce_max_count 50
635 #auth_param basic program <uncomment and complete this line>
636 #auth_param basic children 5 startup=5 idle=1
637 #auth_param basic realm Squid proxy-caching web server
638 #auth_param basic credentialsttl 2 hours
641 NAME: authenticate_cache_garbage_interval
644 LOC: Config.authenticateGCInterval
646 The time period between garbage collection across the username cache.
647 This is a trade-off between memory utilization (long intervals - say
648 2 days) and CPU (short intervals - say 1 minute). Only change if you
652 NAME: authenticate_ttl
655 LOC: Config.authenticateTTL
657 The time a user & their credentials stay in the logged in
658 user cache since their last request. When the garbage
659 interval passes, all user credentials that have passed their
660 TTL are removed from memory.
663 NAME: authenticate_ip_ttl
665 LOC: Config.authenticateIpTTL
668 If you use proxy authentication and the 'max_user_ip' ACL,
669 this directive controls how long Squid remembers the IP
670 addresses associated with each user. Use a small value
671 (e.g., 60 seconds) if your users might change addresses
672 quickly, as is the case with dialup. You might be safe
673 using a larger value (e.g., 2 hours) in a corporate LAN
674 environment with relatively static address assignments.
679 -----------------------------------------------------------------------------
682 NAME: external_acl_type
683 TYPE: externalAclHelper
684 LOC: Config.externalAclHelperList
687 This option defines external acl classes using a helper program
688 to look up the status
690 external_acl_type name [options] FORMAT.. /path/to/helper [helper arguments..]
694 ttl=n TTL in seconds for cached results (defaults to 3600
697 TTL for cached negative lookups (default same
700 Maximum number of acl helper processes spawned to service
701 external acl lookups of this type. (default 20)
703 Minimum number of acl helper processes to spawn during
704 startup and reconfigure to service external acl lookups
705 of this type. (default 0)
707 Number of acl helper processes to keep ahead of traffic
708 loads. Squid will spawn this many at once whenever load
709 rises above the capabilities of existing processes.
710 Up to the value of children-max. (default 1)
711 concurrency=n concurrency level per process. Only used with helpers
712 capable of processing more than one query at a time.
713 cache=n limit the result cache size, default is unbounded.
714 grace=n Percentage remaining of TTL where a refresh of a
715 cached entry should be initiated without needing to
716 wait for a new reply. (default is for no grace period)
717 protocol=2.5 Compatibility mode for Squid-2.5 external acl helpers
718 ipv4 / ipv6 IP protocol used to communicate with this helper.
719 The default is to auto-detect IPv6 and use it when available.
721 FORMAT specifications
723 %LOGIN Authenticated user login name
724 %EXT_USER Username from previous external acl
725 %EXT_LOG Log details from previous external acl
726 %EXT_TAG Tag from previous external acl
727 %IDENT Ident user name
729 %SRCPORT Client source port
732 %PROTO Requested URL scheme
734 %PATH Requested URL path
735 %METHOD Request method
736 %MYADDR Squid interface address
737 %MYPORT Squid http_port number
738 %PATH Requested URL-path (including query-string if any)
739 %USER_CERT SSL User certificate in PEM format
740 %USER_CERTCHAIN SSL User certificate chain in PEM format
741 %USER_CERT_xx SSL User certificate subject attribute xx
742 %USER_CA_xx SSL User certificate issuer attribute xx
744 %>{Header} HTTP request header "Header"
746 HTTP request header "Hdr" list member "member"
748 HTTP request header list member using ; as
749 list separator. ; can be any non-alphanumeric
752 %<{Header} HTTP reply header "Header"
754 HTTP reply header "Hdr" list member "member"
756 HTTP reply header list member using ; as
757 list separator. ; can be any non-alphanumeric
760 %ACL The name of the ACL being tested.
761 %DATA The ACL arguments. If not used then any arguments
762 is automatically added at the end of the line
764 NOTE: this will encode the arguments as one token,
765 whereas the default will pass each separately.
767 %% The percent sign. Useful for helpers which need
768 an unchanging input format.
771 General request syntax:
773 [channel-ID] FORMAT-values [acl-values ...]
776 FORMAT-values consists of transaction details expanded with
777 whitespace separation per the config file FORMAT specification
778 using the FORMAT macros listed above.
780 acl-values consists of any string specified in the referencing
781 config 'acl ... external' line. see the "acl external" directive.
783 Request values sent to the helper are URL escaped to protect
784 each value in requests against whitespaces.
786 If using protocol=2.5 then the request sent to the helper is not
787 URL escaped to protect against whitespace.
789 NOTE: protocol=3.0 is deprecated as no longer necessary.
791 When using the concurrency= option the protocol is changed by
792 introducing a query channel tag in front of the request/response.
793 The query channel tag is a number between 0 and concurrency-1.
794 This value must be echoed back unchanged to Squid as the first part
795 of the response relating to its request.
798 The helper receives lines expanded per the above format specification
799 and for each input line returns 1 line starting with OK/ERR/BH result
800 code and optionally followed by additional keywords with more details.
803 General result syntax:
805 [channel-ID] result keyword=value ...
807 Result consists of one of the codes:
810 the ACL test produced a match.
813 the ACL test does not produce a match.
816 An internal error occurred in the helper, preventing
817 a result being identified.
819 The meaning of 'a match' is determined by your squid.conf
820 access control configuration. See the Squid wiki for details.
824 user= The users name (login)
826 password= The users password (for login= cache_peer option)
828 message= Message describing the reason for this response.
829 Available as %o in error pages.
830 Useful on (ERR and BH results).
832 tag= Apply a tag to a request. Only sets a tag once,
833 does not alter existing tags.
835 log= String to be logged in access.log. Available as
836 %ea in logformat specifications.
838 Any keywords may be sent on any response whether OK, ERR or BH.
840 All response keyword values need to be a single token with URL
841 escaping, or enclosed in double quotes (") and escaped using \ on
842 any double quotes or \ characters within the value. The wrapping
843 double quotes are removed before the value is interpreted by Squid.
844 \r and \n are also replace by CR and LF.
846 Some example key values:
850 user="J. \"Bob\" Smith"
857 DEFAULT: ssl::certHasExpired ssl_error X509_V_ERR_CERT_HAS_EXPIRED
858 DEFAULT: ssl::certNotYetValid ssl_error X509_V_ERR_CERT_NOT_YET_VALID
859 DEFAULT: ssl::certDomainMismatch ssl_error SQUID_X509_V_ERR_DOMAIN_MISMATCH
860 DEFAULT: ssl::certUntrusted ssl_error X509_V_ERR_INVALID_CA X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY X509_V_ERR_CERT_UNTRUSTED
861 DEFAULT: ssl::certSelfSigned ssl_error X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT
864 DEFAULT: manager url_regex -i ^cache_object:// +i ^https?://[^/]+/squid-internal-mgr/
865 DEFAULT: localhost src 127.0.0.1/32 ::1
866 DEFAULT: to_localhost dst 127.0.0.0/8 0.0.0.0/32 ::1
867 DEFAULT_DOC: ACLs all, manager, localhost, and to_localhost are predefined.
869 Defining an Access List
871 Every access list definition must begin with an aclname and acltype,
872 followed by either type-specific arguments or a quoted filename that
875 acl aclname acltype argument ...
876 acl aclname acltype "file" ...
878 When using "file", the file should contain one item per line.
880 Some acl types supports options which changes their default behaviour.
881 The available options are:
883 -i,+i By default, regular expressions are CASE-SENSITIVE. To make them
884 case-insensitive, use the -i option. To return case-sensitive
885 use the +i option between patterns, or make a new ACL line
888 -n Disable lookups and address type conversions. If lookup or
889 conversion is required because the parameter type (IP or
890 domain name) does not match the message address type (domain
891 name or IP), then the ACL would immediately declare a mismatch
892 without any warnings or lookups.
894 -- Used to stop processing all options, in the case the first acl
895 value has '-' character as first character (for example the '-'
896 is a valid domain name)
898 Some acl types require suspending the current request in order
899 to access some external data source.
900 Those which do are marked with the tag [slow], those which
901 don't are marked as [fast].
902 See http://wiki.squid-cache.org/SquidFaq/SquidAcl
903 for further information
905 ***** ACL TYPES AVAILABLE *****
907 acl aclname src ip-address/mask ... # clients IP address [fast]
908 acl aclname src addr1-addr2/mask ... # range of addresses [fast]
909 acl aclname dst [-n] ip-address/mask ... # URL host's IP address [slow]
910 acl aclname localip ip-address/mask ... # IP address the client connected to [fast]
912 acl aclname arp mac-address ... (xx:xx:xx:xx:xx:xx notation)
913 # The arp ACL requires the special configure option --enable-arp-acl.
914 # Furthermore, the ARP ACL code is not portable to all operating systems.
915 # It works on Linux, Solaris, Windows, FreeBSD, and some
916 # other *BSD variants.
919 # NOTE: Squid can only determine the MAC address for clients that are on
920 # the same subnet. If the client is on a different subnet,
921 # then Squid cannot find out its MAC address.
923 acl aclname srcdomain .foo.com ...
924 # reverse lookup, from client IP [slow]
925 acl aclname dstdomain [-n] .foo.com ...
926 # Destination server from URL [fast]
927 acl aclname srcdom_regex [-i] \.foo\.com ...
928 # regex matching client name [slow]
929 acl aclname dstdom_regex [-n] [-i] \.foo\.com ...
930 # regex matching server [fast]
932 # For dstdomain and dstdom_regex a reverse lookup is tried if a IP
933 # based URL is used and no match is found. The name "none" is used
934 # if the reverse lookup fails.
936 acl aclname src_as number ...
937 acl aclname dst_as number ...
939 # Except for access control, AS numbers can be used for
940 # routing of requests to specific caches. Here's an
941 # example for routing all requests for AS#1241 and only
942 # those to mycache.mydomain.net:
943 # acl asexample dst_as 1241
944 # cache_peer_access mycache.mydomain.net allow asexample
945 # cache_peer_access mycache_mydomain.net deny all
947 acl aclname peername myPeer ...
949 # match against a named cache_peer entry
950 # set unique name= on cache_peer lines for reliable use.
952 acl aclname time [day-abbrevs] [h1:m1-h2:m2]
962 # h1:m1 must be less than h2:m2
964 acl aclname url_regex [-i] ^http:// ...
965 # regex matching on whole URL [fast]
966 acl aclname urllogin [-i] [^a-zA-Z0-9] ...
967 # regex matching on URL login field
968 acl aclname urlpath_regex [-i] \.gif$ ...
969 # regex matching on URL path [fast]
971 acl aclname port 80 70 21 0-1024... # destination TCP port [fast]
973 acl aclname localport 3128 ... # TCP port the client connected to [fast]
974 # NP: for interception mode this is usually '80'
976 acl aclname myportname 3128 ... # http(s)_port name [fast]
978 acl aclname proto HTTP FTP ... # request protocol [fast]
980 acl aclname method GET POST ... # HTTP request method [fast]
982 acl aclname http_status 200 301 500- 400-403 ...
983 # status code in reply [fast]
985 acl aclname browser [-i] regexp ...
986 # pattern match on User-Agent header (see also req_header below) [fast]
988 acl aclname referer_regex [-i] regexp ...
989 # pattern match on Referer header [fast]
990 # Referer is highly unreliable, so use with care
992 acl aclname ident username ...
993 acl aclname ident_regex [-i] pattern ...
994 # string match on ident output [slow]
995 # use REQUIRED to accept any non-null ident.
997 acl aclname proxy_auth [-i] username ...
998 acl aclname proxy_auth_regex [-i] pattern ...
999 # perform http authentication challenge to the client and match against
1000 # supplied credentials [slow]
1002 # takes a list of allowed usernames.
1003 # use REQUIRED to accept any valid username.
1005 # Will use proxy authentication in forward-proxy scenarios, and plain
1006 # http authenticaiton in reverse-proxy scenarios
1008 # NOTE: when a Proxy-Authentication header is sent but it is not
1009 # needed during ACL checking the username is NOT logged
1012 # NOTE: proxy_auth requires a EXTERNAL authentication program
1013 # to check username/password combinations (see
1014 # auth_param directive).
1016 # NOTE: proxy_auth can't be used in a transparent/intercepting proxy
1017 # as the browser needs to be configured for using a proxy in order
1018 # to respond to proxy authentication.
1020 acl aclname snmp_community string ...
1021 # A community string to limit access to your SNMP Agent [fast]
1024 # acl snmppublic snmp_community public
1026 acl aclname maxconn number
1027 # This will be matched when the client's IP address has
1028 # more than <number> TCP connections established. [fast]
1029 # NOTE: This only measures direct TCP links so X-Forwarded-For
1030 # indirect clients are not counted.
1032 acl aclname max_user_ip [-s] number
1033 # This will be matched when the user attempts to log in from more
1034 # than <number> different ip addresses. The authenticate_ip_ttl
1035 # parameter controls the timeout on the ip entries. [fast]
1036 # If -s is specified the limit is strict, denying browsing
1037 # from any further IP addresses until the ttl has expired. Without
1038 # -s Squid will just annoy the user by "randomly" denying requests.
1039 # (the counter is reset each time the limit is reached and a
1040 # request is denied)
1041 # NOTE: in acceleration mode or where there is mesh of child proxies,
1042 # clients may appear to come from multiple addresses if they are
1043 # going through proxy farms, so a limit of 1 may cause user problems.
1045 acl aclname random probability
1046 # Pseudo-randomly match requests. Based on the probability given.
1047 # Probability may be written as a decimal (0.333), fraction (1/3)
1048 # or ratio of matches:non-matches (3:5).
1050 acl aclname req_mime_type [-i] mime-type ...
1051 # regex match against the mime type of the request generated
1052 # by the client. Can be used to detect file upload or some
1053 # types HTTP tunneling requests [fast]
1054 # NOTE: This does NOT match the reply. You cannot use this
1055 # to match the returned file type.
1057 acl aclname req_header header-name [-i] any\.regex\.here
1058 # regex match against any of the known request headers. May be
1059 # thought of as a superset of "browser", "referer" and "mime-type"
1062 acl aclname rep_mime_type [-i] mime-type ...
1063 # regex match against the mime type of the reply received by
1064 # squid. Can be used to detect file download or some
1065 # types HTTP tunneling requests. [fast]
1066 # NOTE: This has no effect in http_access rules. It only has
1067 # effect in rules that affect the reply data stream such as
1068 # http_reply_access.
1070 acl aclname rep_header header-name [-i] any\.regex\.here
1071 # regex match against any of the known reply headers. May be
1072 # thought of as a superset of "browser", "referer" and "mime-type"
1075 acl aclname external class_name [arguments...]
1076 # external ACL lookup via a helper class defined by the
1077 # external_acl_type directive [slow]
1079 acl aclname user_cert attribute values...
1080 # match against attributes in a user SSL certificate
1081 # attribute is one of DN/C/O/CN/L/ST [fast]
1083 acl aclname ca_cert attribute values...
1084 # match against attributes a users issuing CA SSL certificate
1085 # attribute is one of DN/C/O/CN/L/ST [fast]
1087 acl aclname ext_user username ...
1088 acl aclname ext_user_regex [-i] pattern ...
1089 # string match on username returned by external acl helper [slow]
1090 # use REQUIRED to accept any non-null user name.
1092 acl aclname tag tagvalue ...
1093 # string match on tag returned by external acl helper [slow]
1095 acl aclname hier_code codename ...
1096 # string match against squid hierarchy code(s); [fast]
1097 # e.g., DIRECT, PARENT_HIT, NONE, etc.
1099 # NOTE: This has no effect in http_access rules. It only has
1100 # effect in rules that affect the reply data stream such as
1101 # http_reply_access.
1103 acl aclname note name [value ...]
1104 # match transaction annotation [fast]
1105 # Without values, matches any annotation with a given name.
1106 # With value(s), matches any annotation with a given name that
1107 # also has one of the given values.
1108 # Names and values are compared using a string equality test.
1109 # Annotation sources include note and adaptation_meta directives
1110 # as well as helper and eCAP responses.
1112 acl aclname adaptation_service service ...
1113 # Matches the name of any icap_service, ecap_service,
1114 # adaptation_service_set, or adaptation_service_chain that Squid
1115 # has used (or attempted to use) for the master transaction.
1116 # This ACL must be defined after the corresponding adaptation
1117 # service is named in squid.conf. This ACL is usable with
1118 # adaptation_meta because it starts matching immediately after
1119 # the service has been selected for adaptation.
1122 acl aclname ssl_error errorname
1123 # match against SSL certificate validation error [fast]
1125 # For valid error names see in @DEFAULT_ERROR_DIR@/templates/error-details.txt
1128 # The following can be used as shortcuts for certificate properties:
1129 # [ssl::]certHasExpired: the "not after" field is in the past
1130 # [ssl::]certNotYetValid: the "not before" field is in the future
1131 # [ssl::]certUntrusted: The certificate issuer is not to be trusted.
1132 # [ssl::]certSelfSigned: The certificate is self signed.
1133 # [ssl::]certDomainMismatch: The certificate CN domain does not
1134 # match the name the name of the host we are connecting to.
1136 # The ssl::certHasExpired, ssl::certNotYetValid, ssl::certDomainMismatch,
1137 # ssl::certUntrusted, and ssl::certSelfSigned can also be used as
1138 # predefined ACLs, just like the 'all' ACL.
1140 # NOTE: The ssl_error ACL is only supported with sslproxy_cert_error,
1141 # sslproxy_cert_sign, and sslproxy_cert_adapt options.
1143 acl aclname server_cert_fingerprint [-sha1] fingerprint
1144 # match against server SSL certificate fingerprint [fast]
1146 # The fingerprint is the digest of the DER encoded version
1147 # of the whole certificate. The user should use the form: XX:XX:...
1148 # Optional argument specifies the digest algorithm to use.
1149 # The SHA1 digest algorithm is the default and is currently
1150 # the only algorithm supported (-sha1).
1152 acl aclname any-of acl1 acl2 ...
1153 # match any one of the acls [fast or slow]
1154 # The first matching ACL stops further ACL evaluation.
1156 # ACLs from multiple any-of lines with the same name are ORed.
1157 # For example, A = (a1 or a2) or (a3 or a4) can be written as
1158 # acl A any-of a1 a2
1159 # acl A any-of a3 a4
1161 # This group ACL is fast if all evaluated ACLs in the group are fast
1162 # and slow otherwise.
1164 acl aclname all-of acl1 acl2 ...
1165 # match all of the acls [fast or slow]
1166 # The first mismatching ACL stops further ACL evaluation.
1168 # ACLs from multiple all-of lines with the same name are ORed.
1169 # For example, B = (b1 and b2) or (b3 and b4) can be written as
1170 # acl B all-of b1 b2
1171 # acl B all-of b3 b4
1173 # This group ACL is fast if all evaluated ACLs in the group are fast
1174 # and slow otherwise.
1177 acl macaddress arp 09:00:2b:23:45:67
1178 acl myexample dst_as 1241
1179 acl password proxy_auth REQUIRED
1180 acl fileupload req_mime_type -i ^multipart/form-data$
1181 acl javascript rep_mime_type -i ^application/x-javascript$
1185 # Recommended minimum configuration:
1188 # Example rule allowing access from your local networks.
1189 # Adapt to list your (internal) IP networks from where browsing
1191 acl localnet src 10.0.0.0/8 # RFC1918 possible internal network
1192 acl localnet src 172.16.0.0/12 # RFC1918 possible internal network
1193 acl localnet src 192.168.0.0/16 # RFC1918 possible internal network
1194 acl localnet src fc00::/7 # RFC 4193 local private network range
1195 acl localnet src fe80::/10 # RFC 4291 link-local (directly plugged) machines
1197 acl SSL_ports port 443
1198 acl Safe_ports port 80 # http
1199 acl Safe_ports port 21 # ftp
1200 acl Safe_ports port 443 # https
1201 acl Safe_ports port 70 # gopher
1202 acl Safe_ports port 210 # wais
1203 acl Safe_ports port 1025-65535 # unregistered ports
1204 acl Safe_ports port 280 # http-mgmt
1205 acl Safe_ports port 488 # gss-http
1206 acl Safe_ports port 591 # filemaker
1207 acl Safe_ports port 777 # multiling http
1208 acl CONNECT method CONNECT
1212 NAME: follow_x_forwarded_for
1214 IFDEF: FOLLOW_X_FORWARDED_FOR
1215 LOC: Config.accessList.followXFF
1216 DEFAULT_IF_NONE: deny all
1217 DEFAULT_DOC: X-Forwarded-For header will be ignored.
1219 Allowing or Denying the X-Forwarded-For header to be followed to
1220 find the original source of a request.
1222 Requests may pass through a chain of several other proxies
1223 before reaching us. The X-Forwarded-For header will contain a
1224 comma-separated list of the IP addresses in the chain, with the
1225 rightmost address being the most recent.
1227 If a request reaches us from a source that is allowed by this
1228 configuration item, then we consult the X-Forwarded-For header
1229 to see where that host received the request from. If the
1230 X-Forwarded-For header contains multiple addresses, we continue
1231 backtracking until we reach an address for which we are not allowed
1232 to follow the X-Forwarded-For header, or until we reach the first
1233 address in the list. For the purpose of ACL used in the
1234 follow_x_forwarded_for directive the src ACL type always matches
1235 the address we are testing and srcdomain matches its rDNS.
1237 The end result of this process is an IP address that we will
1238 refer to as the indirect client address. This address may
1239 be treated as the client address for access control, ICAP, delay
1240 pools and logging, depending on the acl_uses_indirect_client,
1241 icap_uses_indirect_client, delay_pool_uses_indirect_client,
1242 log_uses_indirect_client and tproxy_uses_indirect_client options.
1244 This clause only supports fast acl types.
1245 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1247 SECURITY CONSIDERATIONS:
1249 Any host for which we follow the X-Forwarded-For header
1250 can place incorrect information in the header, and Squid
1251 will use the incorrect information as if it were the
1252 source address of the request. This may enable remote
1253 hosts to bypass any access control restrictions that are
1254 based on the client's source addresses.
1258 acl localhost src 127.0.0.1
1259 acl my_other_proxy srcdomain .proxy.example.com
1260 follow_x_forwarded_for allow localhost
1261 follow_x_forwarded_for allow my_other_proxy
1264 NAME: acl_uses_indirect_client
1267 IFDEF: FOLLOW_X_FORWARDED_FOR
1269 LOC: Config.onoff.acl_uses_indirect_client
1271 Controls whether the indirect client address
1272 (see follow_x_forwarded_for) is used instead of the
1273 direct client address in acl matching.
1275 NOTE: maxconn ACL considers direct TCP links and indirect
1276 clients will always have zero. So no match.
1279 NAME: delay_pool_uses_indirect_client
1282 IFDEF: FOLLOW_X_FORWARDED_FOR&&USE_DELAY_POOLS
1284 LOC: Config.onoff.delay_pool_uses_indirect_client
1286 Controls whether the indirect client address
1287 (see follow_x_forwarded_for) is used instead of the
1288 direct client address in delay pools.
1291 NAME: log_uses_indirect_client
1294 IFDEF: FOLLOW_X_FORWARDED_FOR
1296 LOC: Config.onoff.log_uses_indirect_client
1298 Controls whether the indirect client address
1299 (see follow_x_forwarded_for) is used instead of the
1300 direct client address in the access log.
1303 NAME: tproxy_uses_indirect_client
1306 IFDEF: FOLLOW_X_FORWARDED_FOR&&LINUX_NETFILTER
1308 LOC: Config.onoff.tproxy_uses_indirect_client
1310 Controls whether the indirect client address
1311 (see follow_x_forwarded_for) is used instead of the
1312 direct client address when spoofing the outgoing client.
1314 This has no effect on requests arriving in non-tproxy
1317 SECURITY WARNING: Usage of this option is dangerous
1318 and should not be used trivially. Correct configuration
1319 of follow_x_forewarded_for with a limited set of trusted
1320 sources is required to prevent abuse of your proxy.
1323 NAME: spoof_client_ip
1325 LOC: Config.accessList.spoof_client_ip
1327 DEFAULT_DOC: Allow spoofing on all TPROXY traffic.
1329 Control client IP address spoofing of TPROXY traffic based on
1330 defined access lists.
1332 spoof_client_ip allow|deny [!]aclname ...
1334 If there are no "spoof_client_ip" lines present, the default
1335 is to "allow" spoofing of any suitable request.
1337 Note that the cache_peer "no-tproxy" option overrides this ACL.
1339 This clause supports fast acl types.
1340 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1345 LOC: Config.accessList.http
1346 DEFAULT_IF_NONE: deny all
1347 DEFAULT_DOC: Deny, unless rules exist in squid.conf.
1349 Allowing or Denying access based on defined access lists
1351 Access to the HTTP port:
1352 http_access allow|deny [!]aclname ...
1354 NOTE on default values:
1356 If there are no "access" lines present, the default is to deny
1359 If none of the "access" lines cause a match, the default is the
1360 opposite of the last line in the list. If the last line was
1361 deny, the default is allow. Conversely, if the last line
1362 is allow, the default will be deny. For these reasons, it is a
1363 good idea to have an "deny all" entry at the end of your access
1364 lists to avoid potential confusion.
1366 This clause supports both fast and slow acl types.
1367 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1372 # Recommended minimum Access Permission configuration:
1374 # Deny requests to certain unsafe ports
1375 http_access deny !Safe_ports
1377 # Deny CONNECT to other than secure SSL ports
1378 http_access deny CONNECT !SSL_ports
1380 # Only allow cachemgr access from localhost
1381 http_access allow localhost manager
1382 http_access deny manager
1384 # We strongly recommend the following be uncommented to protect innocent
1385 # web applications running on the proxy server who think the only
1386 # one who can access services on "localhost" is a local user
1387 #http_access deny to_localhost
1390 # INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS
1393 # Example rule allowing access from your local networks.
1394 # Adapt localnet in the ACL section to list your (internal) IP networks
1395 # from where browsing should be allowed
1396 http_access allow localnet
1397 http_access allow localhost
1399 # And finally deny all other access to this proxy
1400 http_access deny all
1404 NAME: adapted_http_access http_access2
1406 LOC: Config.accessList.adapted_http
1408 DEFAULT_DOC: Allow, unless rules exist in squid.conf.
1410 Allowing or Denying access based on defined access lists
1412 Essentially identical to http_access, but runs after redirectors
1413 and ICAP/eCAP adaptation. Allowing access control based on their
1416 If not set then only http_access is used.
1419 NAME: http_reply_access
1421 LOC: Config.accessList.reply
1423 DEFAULT_DOC: Allow, unless rules exist in squid.conf.
1425 Allow replies to client requests. This is complementary to http_access.
1427 http_reply_access allow|deny [!] aclname ...
1429 NOTE: if there are no access lines present, the default is to allow
1432 If none of the access lines cause a match the opposite of the
1433 last line will apply. Thus it is good practice to end the rules
1434 with an "allow all" or "deny all" entry.
1436 This clause supports both fast and slow acl types.
1437 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1442 LOC: Config.accessList.icp
1444 DEFAULT_DOC: Deny, unless rules exist in squid.conf.
1446 Allowing or Denying access to the ICP port based on defined
1449 icp_access allow|deny [!]aclname ...
1451 NOTE: The default if no icp_access lines are present is to
1452 deny all traffic. This default may cause problems with peers
1455 This clause only supports fast acl types.
1456 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1458 # Allow ICP queries from local networks only
1459 #icp_access allow localnet
1460 #icp_access deny all
1466 LOC: Config.accessList.htcp
1468 DEFAULT_DOC: Deny, unless rules exist in squid.conf.
1470 Allowing or Denying access to the HTCP port based on defined
1473 htcp_access allow|deny [!]aclname ...
1475 See also htcp_clr_access for details on access control for
1476 cache purge (CLR) HTCP messages.
1478 NOTE: The default if no htcp_access lines are present is to
1479 deny all traffic. This default may cause problems with peers
1480 using the htcp option.
1482 This clause only supports fast acl types.
1483 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1485 # Allow HTCP queries from local networks only
1486 #htcp_access allow localnet
1487 #htcp_access deny all
1490 NAME: htcp_clr_access
1493 LOC: Config.accessList.htcp_clr
1495 DEFAULT_DOC: Deny, unless rules exist in squid.conf.
1497 Allowing or Denying access to purge content using HTCP based
1498 on defined access lists.
1499 See htcp_access for details on general HTCP access control.
1501 htcp_clr_access allow|deny [!]aclname ...
1503 This clause only supports fast acl types.
1504 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1506 # Allow HTCP CLR requests from trusted peers
1507 acl htcp_clr_peer src 192.0.2.2 2001:DB8::2
1508 htcp_clr_access allow htcp_clr_peer
1509 htcp_clr_access deny all
1514 LOC: Config.accessList.miss
1516 DEFAULT_DOC: Allow, unless rules exist in squid.conf.
1518 Determins whether network access is permitted when satisfying a request.
1521 to force your neighbors to use you as a sibling instead of
1524 acl localclients src 192.0.2.0/24 2001:DB8::a:0/64
1525 miss_access deny !localclients
1526 miss_access allow all
1528 This means only your local clients are allowed to fetch relayed/MISS
1529 replies from the network and all other clients can only fetch cached
1532 The default for this setting allows all clients who passed the
1533 http_access rules to relay via this proxy.
1535 This clause only supports fast acl types.
1536 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1539 NAME: ident_lookup_access
1543 DEFAULT_DOC: Unless rules exist in squid.conf, IDENT is not fetched.
1544 LOC: Ident::TheConfig.identLookup
1546 A list of ACL elements which, if matched, cause an ident
1547 (RFC 931) lookup to be performed for this request. For
1548 example, you might choose to always perform ident lookups
1549 for your main multi-user Unix boxes, but not for your Macs
1550 and PCs. By default, ident lookups are not performed for
1553 To enable ident lookups for specific client addresses, you
1554 can follow this example:
1556 acl ident_aware_hosts src 198.168.1.0/24
1557 ident_lookup_access allow ident_aware_hosts
1558 ident_lookup_access deny all
1560 Only src type ACL checks are fully supported. A srcdomain
1561 ACL might work at times, but it will not always provide
1564 This clause only supports fast acl types.
1565 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1568 NAME: reply_body_max_size
1569 COMMENT: size [acl acl...]
1572 DEFAULT_DOC: No limit is applied.
1573 LOC: Config.ReplyBodySize
1575 This option specifies the maximum size of a reply body. It can be
1576 used to prevent users from downloading very large files, such as
1577 MP3's and movies. When the reply headers are received, the
1578 reply_body_max_size lines are processed, and the first line where
1579 all (if any) listed ACLs are true is used as the maximum body size
1582 This size is checked twice. First when we get the reply headers,
1583 we check the content-length value. If the content length value exists
1584 and is larger than the allowed size, the request is denied and the
1585 user receives an error message that says "the request or reply
1586 is too large." If there is no content-length, and the reply
1587 size exceeds this limit, the client's connection is just closed
1588 and they will receive a partial reply.
1590 WARNING: downstream caches probably can not detect a partial reply
1591 if there is no content-length header, so they will cache
1592 partial responses and give them out as hits. You should NOT
1593 use this option if you have downstream caches.
1595 WARNING: A maximum size smaller than the size of squid's error messages
1596 will cause an infinite loop and crash squid. Ensure that the smallest
1597 non-zero value you use is greater that the maximum header size plus
1598 the size of your largest error page.
1600 If you set this parameter none (the default), there will be
1603 Configuration Format is:
1604 reply_body_max_size SIZE UNITS [acl ...]
1606 reply_body_max_size 10 MB
1612 -----------------------------------------------------------------------------
1615 NAME: http_port ascii_port
1618 LOC: Config.Sockaddr.http
1620 Usage: port [mode] [options]
1621 hostname:port [mode] [options]
1622 1.2.3.4:port [mode] [options]
1624 The socket addresses where Squid will listen for HTTP client
1625 requests. You may specify multiple socket addresses.
1626 There are three forms: port alone, hostname with port, and
1627 IP address with port. If you specify a hostname or IP
1628 address, Squid binds the socket to that specific
1629 address. Most likely, you do not need to bind to a specific
1630 address, so you can use the port number alone.
1632 If you are running Squid in accelerator mode, you
1633 probably want to listen on port 80 also, or instead.
1635 The -a command line option may be used to specify additional
1636 port(s) where Squid listens for proxy request. Such ports will
1637 be plain proxy ports with no options.
1639 You may specify multiple socket addresses on multiple lines.
1643 intercept Support for IP-Layer interception of
1644 outgoing requests without browser settings.
1645 NP: disables authentication and IPv6 on the port.
1647 tproxy Support Linux TPROXY for spoofing outgoing
1648 connections using the client IP address.
1649 NP: disables authentication and maybe IPv6 on the port.
1651 accel Accelerator / reverse proxy mode
1653 ssl-bump For each CONNECT request allowed by ssl_bump ACLs,
1654 establish secure connection with the client and with
1655 the server, decrypt HTTPS messages as they pass through
1656 Squid, and treat them as unencrypted HTTP messages,
1657 becoming the man-in-the-middle.
1659 The ssl_bump option is required to fully enable
1660 bumping of CONNECT requests.
1662 Omitting the mode flag causes default forward proxy mode to be used.
1665 Accelerator Mode Options:
1667 defaultsite=domainname
1668 What to use for the Host: header if it is not present
1669 in a request. Determines what site (not origin server)
1670 accelerators should consider the default.
1672 no-vhost Disable using HTTP/1.1 Host header for virtual domain support.
1674 protocol= Protocol to reconstruct accelerated and intercepted
1675 requests with. Defaults to HTTP/1.1 for http_port and
1676 HTTPS/1.1 for https_port.
1677 When an unsupported value is configured Squid will
1678 produce a FATAL error.
1679 Values: HTTP or HTTP/1.1, HTTPS or HTTPS/1.1
1681 vport Virtual host port support. Using the http_port number
1682 instead of the port passed on Host: headers.
1684 vport=NN Virtual host port support. Using the specified port
1685 number instead of the port passed on Host: headers.
1688 Act as if this Squid is the origin server.
1689 This currently means generate new Date: and Expires:
1690 headers on HIT instead of adding Age:.
1692 ignore-cc Ignore request Cache-Control headers.
1694 WARNING: This option violates HTTP specifications if
1695 used in non-accelerator setups.
1697 allow-direct Allow direct forwarding in accelerator mode. Normally
1698 accelerated requests are denied direct forwarding as if
1699 never_direct was used.
1701 WARNING: this option opens accelerator mode to security
1702 vulnerabilities usually only affecting in interception
1703 mode. Make sure to protect forwarding with suitable
1704 http_access rules when using this.
1707 SSL Bump Mode Options:
1708 In addition to these options ssl-bump requires TLS/SSL options.
1710 generate-host-certificates[=<on|off>]
1711 Dynamically create SSL server certificates for the
1712 destination hosts of bumped CONNECT requests.When
1713 enabled, the cert and key options are used to sign
1714 generated certificates. Otherwise generated
1715 certificate will be selfsigned.
1716 If there is a CA certificate lifetime of the generated
1717 certificate equals lifetime of the CA certificate. If
1718 generated certificate is selfsigned lifetime is three
1720 This option is enabled by default when ssl-bump is used.
1721 See the ssl-bump option above for more information.
1723 dynamic_cert_mem_cache_size=SIZE
1724 Approximate total RAM size spent on cached generated
1725 certificates. If set to zero, caching is disabled. The
1726 default value is 4MB.
1730 cert= Path to SSL certificate (PEM format).
1732 key= Path to SSL private key file (PEM format)
1733 if not specified, the certificate file is
1734 assumed to be a combined certificate and
1737 version= The version of SSL/TLS supported
1738 1 automatic (default)
1745 cipher= Colon separated list of supported ciphers.
1746 NOTE: some ciphers such as EDH ciphers depend on
1747 additional settings. If those settings are
1748 omitted the ciphers may be silently ignored
1749 by the OpenSSL library.
1751 options= Various SSL implementation options. The most important
1753 NO_SSLv2 Disallow the use of SSLv2
1754 NO_SSLv3 Disallow the use of SSLv3
1755 NO_TLSv1 Disallow the use of TLSv1.0
1756 NO_TLSv1_1 Disallow the use of TLSv1.1
1757 NO_TLSv1_2 Disallow the use of TLSv1.2
1758 SINGLE_DH_USE Always create a new key when using
1759 temporary/ephemeral DH key exchanges
1760 ALL Enable various bug workarounds
1761 suggested as "harmless" by OpenSSL
1762 Be warned that this reduces SSL/TLS
1763 strength to some attacks.
1764 See OpenSSL SSL_CTX_set_options documentation for a
1765 complete list of options.
1767 clientca= File containing the list of CAs to use when
1768 requesting a client certificate.
1770 cafile= File containing additional CA certificates to
1771 use when verifying client certificates. If unset
1772 clientca will be used.
1774 capath= Directory containing additional CA certificates
1775 and CRL lists to use when verifying client certificates.
1777 crlfile= File of additional CRL lists to use when verifying
1778 the client certificate, in addition to CRLs stored in
1779 the capath. Implies VERIFY_CRL flag below.
1781 dhparams= File containing DH parameters for temporary/ephemeral
1782 DH key exchanges. See OpenSSL documentation for details
1783 on how to create this file.
1784 WARNING: EDH ciphers will be silently disabled if this
1787 sslflags= Various flags modifying the use of SSL:
1789 Don't request client certificates
1790 immediately, but wait until acl processing
1791 requires a certificate (not yet implemented).
1793 Don't use the default CA lists built in
1796 Don't allow for session reuse. Each connection
1797 will result in a new SSL session.
1799 Verify CRL lists when accepting client
1802 Verify CRL lists for all certificates in the
1803 client certificate chain.
1805 sslcontext= SSL session ID context identifier.
1809 connection-auth[=on|off]
1810 use connection-auth=off to tell Squid to prevent
1811 forwarding Microsoft connection oriented authentication
1812 (NTLM, Negotiate and Kerberos)
1814 disable-pmtu-discovery=
1815 Control Path-MTU discovery usage:
1816 off lets OS decide on what to do (default).
1817 transparent disable PMTU discovery when transparent
1819 always disable always PMTU discovery.
1821 In many setups of transparently intercepting proxies
1822 Path-MTU discovery can not work on traffic towards the
1823 clients. This is the case when the intercepting device
1824 does not fully track connections and fails to forward
1825 ICMP must fragment messages to the cache server. If you
1826 have such setup and experience that certain clients
1827 sporadically hang or never complete requests set
1828 disable-pmtu-discovery option to 'transparent'.
1830 name= Specifies a internal name for the port. Defaults to
1831 the port specification (port or addr:port)
1833 tcpkeepalive[=idle,interval,timeout]
1834 Enable TCP keepalive probes of idle connections.
1835 In seconds; idle is the initial time before TCP starts
1836 probing the connection, interval how often to probe, and
1837 timeout the time before giving up.
1839 If you run Squid on a dual-homed machine with an internal
1840 and an external interface we recommend you to specify the
1841 internal address:port in http_port. This way Squid will only be
1842 visible on the internal address.
1846 # Squid normally listens to port 3128
1847 http_port @DEFAULT_HTTP_PORT@
1855 LOC: Config.Sockaddr.https
1857 Usage: [ip:]port cert=certificate.pem [key=key.pem] [mode] [options...]
1859 The socket address where Squid will listen for client requests made
1860 over TLS or SSL connections. Commonly referred to as HTTPS.
1862 This is most useful for situations where you are running squid in
1863 accelerator mode and you want to do the SSL work at the accelerator level.
1865 You may specify multiple socket addresses on multiple lines,
1866 each with their own SSL certificate and/or options.
1870 accel Accelerator / reverse proxy mode
1872 intercept Support for IP-Layer interception of
1873 outgoing requests without browser settings.
1874 NP: disables authentication and IPv6 on the port.
1876 tproxy Support Linux TPROXY for spoofing outgoing
1877 connections using the client IP address.
1878 NP: disables authentication and maybe IPv6 on the port.
1880 ssl-bump For each intercepted connection allowed by ssl_bump
1881 ACLs, establish a secure connection with the client and with
1882 the server, decrypt HTTPS messages as they pass through
1883 Squid, and treat them as unencrypted HTTP messages,
1884 becoming the man-in-the-middle.
1886 An "ssl_bump server-first" match is required to
1887 fully enable bumping of intercepted SSL connections.
1889 Requires tproxy or intercept.
1891 Omitting the mode flag causes default forward proxy mode to be used.
1894 See http_port for a list of generic options
1899 cert= Path to SSL certificate (PEM format).
1901 key= Path to SSL private key file (PEM format)
1902 if not specified, the certificate file is
1903 assumed to be a combined certificate and
1906 version= The version of SSL/TLS supported
1907 1 automatic (default)
1912 cipher= Colon separated list of supported ciphers.
1914 options= Various SSL engine options. The most important
1916 NO_SSLv2 Disallow the use of SSLv2
1917 NO_SSLv3 Disallow the use of SSLv3
1918 NO_TLSv1 Disallow the use of TLSv1
1919 SINGLE_DH_USE Always create a new key when using
1920 temporary/ephemeral DH key exchanges
1921 See src/ssl_support.c or OpenSSL SSL_CTX_set_options
1922 documentation for a complete list of options.
1924 clientca= File containing the list of CAs to use when
1925 requesting a client certificate.
1927 cafile= File containing additional CA certificates to
1928 use when verifying client certificates. If unset
1929 clientca will be used.
1931 capath= Directory containing additional CA certificates
1932 and CRL lists to use when verifying client certificates.
1934 crlfile= File of additional CRL lists to use when verifying
1935 the client certificate, in addition to CRLs stored in
1936 the capath. Implies VERIFY_CRL flag below.
1938 dhparams= File containing DH parameters for temporary/ephemeral
1941 sslflags= Various flags modifying the use of SSL:
1943 Don't request client certificates
1944 immediately, but wait until acl processing
1945 requires a certificate (not yet implemented).
1947 Don't use the default CA lists built in
1950 Don't allow for session reuse. Each connection
1951 will result in a new SSL session.
1953 Verify CRL lists when accepting client
1956 Verify CRL lists for all certificates in the
1957 client certificate chain.
1959 sslcontext= SSL session ID context identifier.
1961 generate-host-certificates[=<on|off>]
1962 Dynamically create SSL server certificates for the
1963 destination hosts of bumped SSL requests.When
1964 enabled, the cert and key options are used to sign
1965 generated certificates. Otherwise generated
1966 certificate will be selfsigned.
1967 If there is CA certificate life time of generated
1968 certificate equals lifetime of CA certificate. If
1969 generated certificate is selfsigned lifetime is three
1971 This option is enabled by default when SslBump is used.
1972 See the sslBump option above for more information.
1974 dynamic_cert_mem_cache_size=SIZE
1975 Approximate total RAM size spent on cached generated
1976 certificates. If set to zero, caching is disabled. The
1977 default value is 4MB.
1979 See http_port for a list of available options.
1982 NAME: tcp_outgoing_tos tcp_outgoing_ds tcp_outgoing_dscp
1985 LOC: Ip::Qos::TheConfig.tosToServer
1987 Allows you to select a TOS/Diffserv value for packets outgoing
1988 on the server side, based on an ACL.
1990 tcp_outgoing_tos ds-field [!]aclname ...
1992 Example where normal_service_net uses the TOS value 0x00
1993 and good_service_net uses 0x20
1995 acl normal_service_net src 10.0.0.0/24
1996 acl good_service_net src 10.0.1.0/24
1997 tcp_outgoing_tos 0x00 normal_service_net
1998 tcp_outgoing_tos 0x20 good_service_net
2000 TOS/DSCP values really only have local significance - so you should
2001 know what you're specifying. For more information, see RFC2474,
2002 RFC2475, and RFC3260.
2004 The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or
2005 "default" to use whatever default your host has. Note that in
2006 practice often only multiples of 4 is usable as the two rightmost bits
2007 have been redefined for use by ECN (RFC 3168 section 23.1).
2009 Processing proceeds in the order specified, and stops at first fully
2013 NAME: clientside_tos
2016 LOC: Ip::Qos::TheConfig.tosToClient
2018 Allows you to select a TOS/Diffserv value for packets being transmitted
2019 on the client-side, based on an ACL.
2021 clientside_tos ds-field [!]aclname ...
2023 Example where normal_service_net uses the TOS value 0x00
2024 and good_service_net uses 0x20
2026 acl normal_service_net src 10.0.0.0/24
2027 acl good_service_net src 10.0.1.0/24
2028 clientside_tos 0x00 normal_service_net
2029 clientside_tos 0x20 good_service_net
2031 Note: This feature is incompatible with qos_flows. Any TOS values set here
2032 will be overwritten by TOS values in qos_flows.
2035 NAME: tcp_outgoing_mark
2037 IFDEF: SO_MARK&&USE_LIBCAP
2039 LOC: Ip::Qos::TheConfig.nfmarkToServer
2041 Allows you to apply a Netfilter mark value to outgoing packets
2042 on the server side, based on an ACL.
2044 tcp_outgoing_mark mark-value [!]aclname ...
2046 Example where normal_service_net uses the mark value 0x00
2047 and good_service_net uses 0x20
2049 acl normal_service_net src 10.0.0.0/24
2050 acl good_service_net src 10.0.1.0/24
2051 tcp_outgoing_mark 0x00 normal_service_net
2052 tcp_outgoing_mark 0x20 good_service_net
2055 NAME: clientside_mark
2057 IFDEF: SO_MARK&&USE_LIBCAP
2059 LOC: Ip::Qos::TheConfig.nfmarkToClient
2061 Allows you to apply a Netfilter mark value to packets being transmitted
2062 on the client-side, based on an ACL.
2064 clientside_mark mark-value [!]aclname ...
2066 Example where normal_service_net uses the mark value 0x00
2067 and good_service_net uses 0x20
2069 acl normal_service_net src 10.0.0.0/24
2070 acl good_service_net src 10.0.1.0/24
2071 clientside_mark 0x00 normal_service_net
2072 clientside_mark 0x20 good_service_net
2074 Note: This feature is incompatible with qos_flows. Any mark values set here
2075 will be overwritten by mark values in qos_flows.
2082 LOC: Ip::Qos::TheConfig
2084 Allows you to select a TOS/DSCP value to mark outgoing
2085 connections to the client, based on where the reply was sourced.
2086 For platforms using netfilter, allows you to set a netfilter mark
2087 value instead of, or in addition to, a TOS value.
2089 By default this functionality is disabled. To enable it with the default
2090 settings simply use "qos_flows mark" or "qos_flows tos". Default
2091 settings will result in the netfilter mark or TOS value being copied
2092 from the upstream connection to the client. Note that it is the connection
2093 CONNMARK value not the packet MARK value that is copied.
2095 It is not currently possible to copy the mark or TOS value from the
2096 client to the upstream connection request.
2098 TOS values really only have local significance - so you should
2099 know what you're specifying. For more information, see RFC2474,
2100 RFC2475, and RFC3260.
2102 The TOS/DSCP byte must be exactly that - a octet value 0 - 255. Note that
2103 in practice often only multiples of 4 is usable as the two rightmost bits
2104 have been redefined for use by ECN (RFC 3168 section 23.1).
2106 Mark values can be any unsigned 32-bit integer value.
2108 This setting is configured by setting the following values:
2110 tos|mark Whether to set TOS or netfilter mark values
2112 local-hit=0xFF Value to mark local cache hits.
2114 sibling-hit=0xFF Value to mark hits from sibling peers.
2116 parent-hit=0xFF Value to mark hits from parent peers.
2118 miss=0xFF[/mask] Value to mark cache misses. Takes precedence
2119 over the preserve-miss feature (see below), unless
2120 mask is specified, in which case only the bits
2121 specified in the mask are written.
2123 The TOS variant of the following features are only possible on Linux
2124 and require your kernel to be patched with the TOS preserving ZPH
2125 patch, available from http://zph.bratcheda.org
2126 No patch is needed to preserve the netfilter mark, which will work
2127 with all variants of netfilter.
2129 disable-preserve-miss
2130 This option disables the preservation of the TOS or netfilter
2131 mark. By default, the existing TOS or netfilter mark value of
2132 the response coming from the remote server will be retained
2133 and masked with miss-mark.
2134 NOTE: in the case of a netfilter mark, the mark must be set on
2135 the connection (using the CONNMARK target) not on the packet
2139 Allows you to mask certain bits in the TOS or mark value
2140 received from the remote server, before copying the value to
2141 the TOS sent towards clients.
2142 Default for tos: 0xFF (TOS from server is not changed).
2143 Default for mark: 0xFFFFFFFF (mark from server is not changed).
2145 All of these features require the --enable-zph-qos compilation flag
2146 (enabled by default). Netfilter marking also requires the
2147 libnetfilter_conntrack libraries (--with-netfilter-conntrack) and
2148 libcap 2.09+ (--with-libcap).
2152 NAME: tcp_outgoing_address
2155 DEFAULT_DOC: Address selection is performed by the operating system.
2156 LOC: Config.accessList.outgoing_address
2158 Allows you to map requests to different outgoing IP addresses
2159 based on the username or source address of the user making
2162 tcp_outgoing_address ipaddr [[!]aclname] ...
2165 Forwarding clients with dedicated IPs for certain subnets.
2167 acl normal_service_net src 10.0.0.0/24
2168 acl good_service_net src 10.0.2.0/24
2170 tcp_outgoing_address 2001:db8::c001 good_service_net
2171 tcp_outgoing_address 10.1.0.2 good_service_net
2173 tcp_outgoing_address 2001:db8::beef normal_service_net
2174 tcp_outgoing_address 10.1.0.1 normal_service_net
2176 tcp_outgoing_address 2001:db8::1
2177 tcp_outgoing_address 10.1.0.3
2179 Processing proceeds in the order specified, and stops at first fully
2182 Squid will add an implicit IP version test to each line.
2183 Requests going to IPv4 websites will use the outgoing 10.1.0.* addresses.
2184 Requests going to IPv6 websites will use the outgoing 2001:db8:* addresses.
2187 NOTE: The use of this directive using client dependent ACLs is
2188 incompatible with the use of server side persistent connections. To
2189 ensure correct results it is best to set server_persistent_connections
2190 to off when using this directive in such configurations.
2192 NOTE: The use of this directive to set a local IP on outgoing TCP links
2193 is incompatible with using TPROXY to set client IP out outbound TCP links.
2194 When needing to contact peers use the no-tproxy cache_peer option and the
2195 client_dst_passthru directive re-enable normal forwarding such as this.
2199 NAME: host_verify_strict
2202 LOC: Config.onoff.hostStrictVerify
2204 Regardless of this option setting, when dealing with intercepted
2205 traffic, Squid always verifies that the destination IP address matches
2206 the Host header domain or IP (called 'authority form URL').
2208 This enforcement is performed to satisfy a MUST-level requirement in
2209 RFC 2616 section 14.23: "The Host field value MUST represent the naming
2210 authority of the origin server or gateway given by the original URL".
2213 Squid always responds with an HTTP 409 (Conflict) error
2214 page and logs a security warning if there is no match.
2216 Squid verifies that the destination IP address matches
2217 the Host header for forward-proxy and reverse-proxy traffic
2218 as well. For those traffic types, Squid also enables the
2219 following checks, comparing the corresponding Host header
2220 and Request-URI components:
2222 * The host names (domain or IP) must be identical,
2223 but valueless or missing Host header disables all checks.
2224 For the two host names to match, both must be either IP
2227 * Port numbers must be identical, but if a port is missing
2228 the scheme-default port is assumed.
2231 When set to OFF (the default):
2232 Squid allows suspicious requests to continue but logs a
2233 security warning and blocks caching of the response.
2235 * Forward-proxy traffic is not checked at all.
2237 * Reverse-proxy traffic is not checked at all.
2239 * Intercepted traffic which passes verification is handled
2240 according to client_dst_passthru.
2242 * Intercepted requests which fail verification are sent
2243 to the client original destination instead of DIRECT.
2244 This overrides 'client_dst_passthru off'.
2246 For now suspicious intercepted CONNECT requests are always
2247 responded to with an HTTP 409 (Conflict) error page.
2252 As described in CVE-2009-0801 when the Host: header alone is used
2253 to determine the destination of a request it becomes trivial for
2254 malicious scripts on remote websites to bypass browser same-origin
2255 security policy and sandboxing protections.
2257 The cause of this is that such applets are allowed to perform their
2258 own HTTP stack, in which case the same-origin policy of the browser
2259 sandbox only verifies that the applet tries to contact the same IP
2260 as from where it was loaded at the IP level. The Host: header may
2261 be different from the connected IP and approved origin.
2265 NAME: client_dst_passthru
2268 LOC: Config.onoff.client_dst_passthru
2270 With NAT or TPROXY intercepted traffic Squid may pass the request
2271 directly to the original client destination IP or seek a faster
2272 source using the HTTP Host header.
2274 Using Host to locate alternative servers can provide faster
2275 connectivity with a range of failure recovery options.
2276 But can also lead to connectivity trouble when the client and
2277 server are attempting stateful interactions unaware of the proxy.
2279 This option (on by default) prevents alternative DNS entries being
2280 located to send intercepted traffic DIRECT to an origin server.
2281 The clients original destination IP and port will be used instead.
2283 Regardless of this option setting, when dealing with intercepted
2284 traffic Squid will verify the Host: header and any traffic which
2285 fails Host verification will be treated as if this option were ON.
2287 see host_verify_strict for details on the verification process.
2292 -----------------------------------------------------------------------------
2295 NAME: ssl_unclean_shutdown
2299 LOC: Config.SSL.unclean_shutdown
2301 Some browsers (especially MSIE) bugs out on SSL shutdown
2308 LOC: Config.SSL.ssl_engine
2311 The OpenSSL engine to use. You will need to set this if you
2312 would like to use hardware SSL acceleration for example.
2315 NAME: sslproxy_client_certificate
2318 LOC: Config.ssl_client.cert
2321 Client SSL Certificate to use when proxying https:// URLs
2324 NAME: sslproxy_client_key
2327 LOC: Config.ssl_client.key
2330 Client SSL Key to use when proxying https:// URLs
2333 NAME: sslproxy_version
2336 DEFAULT_DOC: automatic SSL/TLS version negotiation
2337 LOC: Config.ssl_client.version
2340 SSL version level to use when proxying https:// URLs
2342 The versions of SSL/TLS supported:
2344 1 automatic (default)
2352 NAME: sslproxy_options
2355 LOC: Config.ssl_client.options
2358 SSL implementation options to use when proxying https:// URLs
2360 The most important being:
2362 NO_SSLv2 Disallow the use of SSLv2
2363 NO_SSLv3 Disallow the use of SSLv3
2364 NO_TLSv1 Disallow the use of TLSv1.0
2365 NO_TLSv1_1 Disallow the use of TLSv1.1
2366 NO_TLSv1_2 Disallow the use of TLSv1.2
2368 Always create a new key when using temporary/ephemeral
2371 Disable use of RFC5077 session tickets. Some servers
2372 may have problems understanding the TLS extension due
2373 to ambiguous specification in RFC4507.
2374 ALL Enable various bug workarounds suggested as "harmless"
2375 by OpenSSL. Be warned that this may reduce SSL/TLS
2376 strength to some attacks.
2378 See the OpenSSL SSL_CTX_set_options documentation for a
2379 complete list of possible options.
2382 NAME: sslproxy_cipher
2385 LOC: Config.ssl_client.cipher
2388 SSL cipher list to use when proxying https:// URLs
2390 Colon separated list of supported ciphers.
2393 NAME: sslproxy_cafile
2396 LOC: Config.ssl_client.cafile
2399 file containing CA certificates to use when verifying server
2400 certificates while proxying https:// URLs
2403 NAME: sslproxy_capath
2406 LOC: Config.ssl_client.capath
2409 directory containing CA certificates to use when verifying
2410 server certificates while proxying https:// URLs
2413 NAME: sslproxy_session_ttl
2416 LOC: Config.SSL.session_ttl
2419 Sets the timeout value for SSL sessions
2422 NAME: sslproxy_session_cache_size
2425 LOC: Config.SSL.sessionCacheSize
2428 Sets the cache size to use for ssl session
2433 TYPE: sslproxy_ssl_bump
2434 LOC: Config.accessList.ssl_bump
2435 DEFAULT_DOC: Does not bump unless rules are present in squid.conf
2438 This option is consulted when a CONNECT request is received on
2439 an http_port (or a new connection is intercepted at an
2440 https_port), provided that port was configured with an ssl-bump
2441 flag. The subsequent data on the connection is either treated as
2442 HTTPS and decrypted OR tunneled at TCP level without decryption,
2443 depending on the first bumping "mode" which ACLs match.
2445 ssl_bump <mode> [!]acl ...
2447 The following bumping modes are supported:
2450 Allow bumping of the connection. Establish a secure connection
2451 with the client first, then connect to the server. This old mode
2452 does not allow Squid to mimic server SSL certificate and does
2453 not work with intercepted SSL connections.
2456 Allow bumping of the connection. Establish a secure connection
2457 with the server first, then establish a secure connection with
2458 the client, using a mimicked server certificate. Works with both
2459 CONNECT requests and intercepted SSL connections.
2462 Become a TCP tunnel without decoding the connection.
2463 Works with both CONNECT requests and intercepted SSL
2464 connections. This is the default behavior when no
2465 ssl_bump option is given or no ssl_bump ACLs match.
2467 By default, no connections are bumped.
2469 The first matching ssl_bump option wins. If no ACLs match, the
2470 connection is not bumped. Unlike most allow/deny ACL lists, ssl_bump
2471 does not have an implicit "negate the last given option" rule. You
2472 must make that rule explicit if you convert old ssl_bump allow/deny
2473 rules that rely on such an implicit rule.
2475 This clause supports both fast and slow acl types.
2476 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
2478 See also: http_port ssl-bump, https_port ssl-bump
2481 # Example: Bump all requests except those originating from
2482 # localhost or those going to example.com.
2484 acl broken_sites dstdomain .example.com
2485 ssl_bump none localhost
2486 ssl_bump none broken_sites
2487 ssl_bump server-first all
2490 NAME: sslproxy_flags
2493 LOC: Config.ssl_client.flags
2496 Various flags modifying the use of SSL while proxying https:// URLs:
2497 DONT_VERIFY_PEER Accept certificates that fail verification.
2498 For refined control, see sslproxy_cert_error.
2499 NO_DEFAULT_CA Don't use the default CA list built in
2503 NAME: sslproxy_cert_error
2506 DEFAULT_DOC: Server certificate errors terminate the transaction.
2507 LOC: Config.ssl_client.cert_error
2510 Use this ACL to bypass server certificate validation errors.
2512 For example, the following lines will bypass all validation errors
2513 when talking to servers for example.com. All other
2514 validation errors will result in ERR_SECURE_CONNECT_FAIL error.
2516 acl BrokenButTrustedServers dstdomain example.com
2517 sslproxy_cert_error allow BrokenButTrustedServers
2518 sslproxy_cert_error deny all
2520 This clause only supports fast acl types.
2521 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
2522 Using slow acl types may result in server crashes
2524 Without this option, all server certificate validation errors
2525 terminate the transaction to protect Squid and the client.
2527 SQUID_X509_V_ERR_INFINITE_VALIDATION error cannot be bypassed
2528 but should not happen unless your OpenSSL library is buggy.
2531 Bypassing validation errors is dangerous because an
2532 error usually implies that the server cannot be trusted
2533 and the connection may be insecure.
2535 See also: sslproxy_flags and DONT_VERIFY_PEER.
2538 NAME: sslproxy_cert_sign
2541 POSTSCRIPTUM: signUntrusted ssl::certUntrusted
2542 POSTSCRIPTUM: signSelf ssl::certSelfSigned
2543 POSTSCRIPTUM: signTrusted all
2544 TYPE: sslproxy_cert_sign
2545 LOC: Config.ssl_client.cert_sign
2548 sslproxy_cert_sign <signing algorithm> acl ...
2550 The following certificate signing algorithms are supported:
2553 Sign using the configured CA certificate which is usually
2554 placed in and trusted by end-user browsers. This is the
2555 default for trusted origin server certificates.
2558 Sign to guarantee an X509_V_ERR_CERT_UNTRUSTED browser error.
2559 This is the default for untrusted origin server certificates
2560 that are not self-signed (see ssl::certUntrusted).
2563 Sign using a self-signed certificate with the right CN to
2564 generate a X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT error in the
2565 browser. This is the default for self-signed origin server
2566 certificates (see ssl::certSelfSigned).
2568 This clause only supports fast acl types.
2570 When sslproxy_cert_sign acl(s) match, Squid uses the corresponding
2571 signing algorithm to generate the certificate and ignores all
2572 subsequent sslproxy_cert_sign options (the first match wins). If no
2573 acl(s) match, the default signing algorithm is determined by errors
2574 detected when obtaining and validating the origin server certificate.
2576 WARNING: SQUID_X509_V_ERR_DOMAIN_MISMATCH and ssl:certDomainMismatch can
2577 be used with sslproxy_cert_adapt, but if and only if Squid is bumping a
2578 CONNECT request that carries a domain name. In all other cases (CONNECT
2579 to an IP address or an intercepted SSL connection), Squid cannot detect
2580 the domain mismatch at certificate generation time when
2581 bump-server-first is used.
2584 NAME: sslproxy_cert_adapt
2587 TYPE: sslproxy_cert_adapt
2588 LOC: Config.ssl_client.cert_adapt
2591 sslproxy_cert_adapt <adaptation algorithm> acl ...
2593 The following certificate adaptation algorithms are supported:
2596 Sets the "Not After" property to the "Not After" property of
2597 the CA certificate used to sign generated certificates.
2600 Sets the "Not Before" property to the "Not Before" property of
2601 the CA certificate used to sign generated certificates.
2603 setCommonName or setCommonName{CN}
2604 Sets Subject.CN property to the host name specified as a
2605 CN parameter or, if no explicit CN parameter was specified,
2606 extracted from the CONNECT request. It is a misconfiguration
2607 to use setCommonName without an explicit parameter for
2608 intercepted or tproxied SSL connections.
2610 This clause only supports fast acl types.
2612 Squid first groups sslproxy_cert_adapt options by adaptation algorithm.
2613 Within a group, when sslproxy_cert_adapt acl(s) match, Squid uses the
2614 corresponding adaptation algorithm to generate the certificate and
2615 ignores all subsequent sslproxy_cert_adapt options in that algorithm's
2616 group (i.e., the first match wins within each algorithm group). If no
2617 acl(s) match, the default mimicking action takes place.
2619 WARNING: SQUID_X509_V_ERR_DOMAIN_MISMATCH and ssl:certDomainMismatch can
2620 be used with sslproxy_cert_adapt, but if and only if Squid is bumping a
2621 CONNECT request that carries a domain name. In all other cases (CONNECT
2622 to an IP address or an intercepted SSL connection), Squid cannot detect
2623 the domain mismatch at certificate generation time when
2624 bump-server-first is used.
2627 NAME: sslpassword_program
2630 LOC: Config.Program.ssl_password
2633 Specify a program used for entering SSL key passphrases
2634 when using encrypted SSL certificate keys. If not specified
2635 keys must either be unencrypted, or Squid started with the -N
2636 option to allow it to query interactively for the passphrase.
2638 The key file name is given as argument to the program allowing
2639 selection of the right password if you have multiple encrypted
2644 OPTIONS RELATING TO EXTERNAL SSL_CRTD
2645 -----------------------------------------------------------------------------
2648 NAME: sslcrtd_program
2651 DEFAULT: @DEFAULT_SSL_CRTD@ -s @DEFAULT_SSL_DB_DIR@ -M 4MB
2652 LOC: Ssl::TheConfig.ssl_crtd
2654 Specify the location and options of the executable for ssl_crtd process.
2655 @DEFAULT_SSL_CRTD@ program requires -s and -M parameters
2656 For more information use:
2657 @DEFAULT_SSL_CRTD@ -h
2660 NAME: sslcrtd_children
2661 TYPE: HelperChildConfig
2663 DEFAULT: 32 startup=5 idle=1
2664 LOC: Ssl::TheConfig.ssl_crtdChildren
2666 The maximum number of processes spawn to service ssl server.
2667 The maximum this may be safely set to is 32.
2669 The startup= and idle= options allow some measure of skew in your
2674 Sets the minimum number of processes to spawn when Squid
2675 starts or reconfigures. When set to zero the first request will
2676 cause spawning of the first child process to handle it.
2678 Starting too few children temporary slows Squid under load while it
2679 tries to spawn enough additional processes to cope with traffic.
2683 Sets a minimum of how many processes Squid is to try and keep available
2684 at all times. When traffic begins to rise above what the existing
2685 processes can handle this many more will be spawned up to the maximum
2686 configured. A minimum setting of 1 is required.
2688 You must have at least one ssl_crtd process.
2691 NAME: sslcrtvalidator_program
2695 LOC: Ssl::TheConfig.ssl_crt_validator
2697 Specify the location and options of the executable for ssl_crt_validator
2700 Usage: sslcrtvalidator_program [ttl=n] [cache=n] path ...
2703 ttl=n TTL in seconds for cached results. The default is 60 secs
2704 cache=n limit the result cache size. The default value is 2048
2707 NAME: sslcrtvalidator_children
2708 TYPE: HelperChildConfig
2710 DEFAULT: 32 startup=5 idle=1 concurrency=1
2711 LOC: Ssl::TheConfig.ssl_crt_validator_Children
2713 The maximum number of processes spawn to service SSL server.
2714 The maximum this may be safely set to is 32.
2716 The startup= and idle= options allow some measure of skew in your
2721 Sets the minimum number of processes to spawn when Squid
2722 starts or reconfigures. When set to zero the first request will
2723 cause spawning of the first child process to handle it.
2725 Starting too few children temporary slows Squid under load while it
2726 tries to spawn enough additional processes to cope with traffic.
2730 Sets a minimum of how many processes Squid is to try and keep available
2731 at all times. When traffic begins to rise above what the existing
2732 processes can handle this many more will be spawned up to the maximum
2733 configured. A minimum setting of 1 is required.
2737 The number of requests each certificate validator helper can handle in
2738 parallel. A value of 0 indicates the certficate validator does not
2739 support concurrency. Defaults to 1.
2741 When this directive is set to a value >= 1 then the protocol
2742 used to communicate with the helper is modified to include
2743 a request ID in front of the request/response. The request
2744 ID from the request must be echoed back with the response
2747 You must have at least one ssl_crt_validator process.
2751 OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM
2752 -----------------------------------------------------------------------------
2760 To specify other caches in a hierarchy, use the format:
2762 cache_peer hostname type http-port icp-port [options]
2767 # hostname type port port options
2768 # -------------------- -------- ----- ----- -----------
2769 cache_peer parent.foo.net parent 3128 3130 default
2770 cache_peer sib1.foo.net sibling 3128 3130 proxy-only
2771 cache_peer sib2.foo.net sibling 3128 3130 proxy-only
2772 cache_peer example.com parent 80 0 default
2773 cache_peer cdn.example.com sibling 3128 0
2775 type: either 'parent', 'sibling', or 'multicast'.
2777 proxy-port: The port number where the peer accept HTTP requests.
2778 For other Squid proxies this is usually 3128
2779 For web servers this is usually 80
2781 icp-port: Used for querying neighbor caches about objects.
2782 Set to 0 if the peer does not support ICP or HTCP.
2783 See ICP and HTCP options below for additional details.
2786 ==== ICP OPTIONS ====
2788 You MUST also set icp_port and icp_access explicitly when using these options.
2789 The defaults will prevent peer traffic using ICP.
2792 no-query Disable ICP queries to this neighbor.
2795 Indicates the named peer is a member of a multicast group.
2796 ICP queries will not be sent directly to the peer, but ICP
2797 replies will be accepted from it.
2799 closest-only Indicates that, for ICP_OP_MISS replies, we'll only forward
2800 CLOSEST_PARENT_MISSes and never FIRST_PARENT_MISSes.
2803 To only send ICP queries to this neighbor infrequently.
2804 This is used to keep the neighbor round trip time updated
2805 and is usually used in conjunction with weighted-round-robin.
2808 ==== HTCP OPTIONS ====
2810 You MUST also set htcp_port and htcp_access explicitly when using these options.
2811 The defaults will prevent peer traffic using HTCP.
2814 htcp Send HTCP, instead of ICP, queries to the neighbor.
2815 You probably also want to set the "icp-port" to 4827
2816 instead of 3130. This directive accepts a comma separated
2817 list of options described below.
2819 htcp=oldsquid Send HTCP to old Squid versions (2.5 or earlier).
2821 htcp=no-clr Send HTCP to the neighbor but without
2822 sending any CLR requests. This cannot be used with
2825 htcp=only-clr Send HTCP to the neighbor but ONLY CLR requests.
2826 This cannot be used with no-clr.
2829 Send HTCP to the neighbor including CLRs but only when
2830 they do not result from PURGE requests.
2833 Forward any HTCP CLR requests this proxy receives to the peer.
2836 ==== PEER SELECTION METHODS ====
2838 The default peer selection method is ICP, with the first responding peer
2839 being used as source. These options can be used for better load balancing.
2842 default This is a parent cache which can be used as a "last-resort"
2843 if a peer cannot be located by any of the peer-selection methods.
2844 If specified more than once, only the first is used.
2846 round-robin Load-Balance parents which should be used in a round-robin
2847 fashion in the absence of any ICP queries.
2848 weight=N can be used to add bias.
2850 weighted-round-robin
2851 Load-Balance parents which should be used in a round-robin
2852 fashion with the frequency of each parent being based on the
2853 round trip time. Closer parents are used more often.
2854 Usually used for background-ping parents.
2855 weight=N can be used to add bias.
2857 carp Load-Balance parents which should be used as a CARP array.
2858 The requests will be distributed among the parents based on the
2859 CARP load balancing hash function based on their weight.
2861 userhash Load-balance parents based on the client proxy_auth or ident username.
2863 sourcehash Load-balance parents based on the client source IP.
2866 To be used only for cache peers of type "multicast".
2867 ALL members of this multicast group have "sibling"
2868 relationship with it, not "parent". This is to a multicast
2869 group when the requested object would be fetched only from
2870 a "parent" cache, anyway. It's useful, e.g., when
2871 configuring a pool of redundant Squid proxies, being
2872 members of the same multicast group.
2875 ==== PEER SELECTION OPTIONS ====
2877 weight=N use to affect the selection of a peer during any weighted
2878 peer-selection mechanisms.
2879 The weight must be an integer; default is 1,
2880 larger weights are favored more.
2881 This option does not affect parent selection if a peering
2882 protocol is not in use.
2884 basetime=N Specify a base amount to be subtracted from round trip
2886 It is subtracted before division by weight in calculating
2887 which parent to fectch from. If the rtt is less than the
2888 base time the rtt is set to a minimal value.
2890 ttl=N Specify a TTL to use when sending multicast ICP queries
2892 Only useful when sending to a multicast group.
2893 Because we don't accept ICP replies from random
2894 hosts, you must configure other group members as
2895 peers with the 'multicast-responder' option.
2897 no-delay To prevent access to this neighbor from influencing the
2900 digest-url=URL Tell Squid to fetch the cache digest (if digests are
2901 enabled) for this host from the specified URL rather
2902 than the Squid default location.
2905 ==== CARP OPTIONS ====
2907 carp-key=key-specification
2908 use a different key than the full URL to hash against the peer.
2909 the key-specification is a comma-separated list of the keywords
2910 scheme, host, port, path, params
2911 Order is not important.
2913 ==== ACCELERATOR / REVERSE-PROXY OPTIONS ====
2915 originserver Causes this parent to be contacted as an origin server.
2916 Meant to be used in accelerator setups when the peer
2920 Set the Host header of requests forwarded to this peer.
2921 Useful in accelerator setups where the server (peer)
2922 expects a certain domain name but clients may request
2923 others. ie example.com or www.example.com
2925 no-digest Disable request of cache digests.
2928 Disables requesting ICMP RTT database (NetDB).
2931 ==== AUTHENTICATION OPTIONS ====
2934 If this is a personal/workgroup proxy and your parent
2935 requires proxy authentication.
2937 Note: The string can include URL escapes (i.e. %20 for
2938 spaces). This also means % must be written as %%.
2941 Send login details received from client to this peer.
2942 Both Proxy- and WWW-Authorization headers are passed
2943 without alteration to the peer.
2944 Authentication is not required by Squid for this to work.
2946 Note: This will pass any form of authentication but
2947 only Basic auth will work through a proxy unless the
2948 connection-auth options are also used.
2950 login=PASS Send login details received from client to this peer.
2951 Authentication is not required by this option.
2953 If there are no client-provided authentication headers
2954 to pass on, but username and password are available
2955 from an external ACL user= and password= result tags
2956 they may be sent instead.
2958 Note: To combine this with proxy_auth both proxies must
2959 share the same user database as HTTP only allows for
2960 a single login (one for proxy, one for origin server).
2961 Also be warned this will expose your users proxy
2962 password to the peer. USE WITH CAUTION
2965 Send the username to the upstream cache, but with a
2966 fixed password. This is meant to be used when the peer
2967 is in another administrative domain, but it is still
2968 needed to identify each user.
2969 The star can optionally be followed by some extra
2970 information which is added to the username. This can
2971 be used to identify this proxy to the peer, similar to
2972 the login=username:password option above.
2975 If this is a personal/workgroup proxy and your parent
2976 requires a secure proxy authentication.
2977 The first principal from the default keytab or defined by
2978 the environment variable KRB5_KTNAME will be used.
2980 WARNING: The connection may transmit requests from multiple
2981 clients. Negotiate often assumes end-to-end authentication
2982 and a single-client. Which is not strictly true here.
2984 login=NEGOTIATE:principal_name
2985 If this is a personal/workgroup proxy and your parent
2986 requires a secure proxy authentication.
2987 The principal principal_name from the default keytab or
2988 defined by the environment variable KRB5_KTNAME will be
2991 WARNING: The connection may transmit requests from multiple
2992 clients. Negotiate often assumes end-to-end authentication
2993 and a single-client. Which is not strictly true here.
2995 connection-auth=on|off
2996 Tell Squid that this peer does or not support Microsoft
2997 connection oriented authentication, and any such
2998 challenges received from there should be ignored.
2999 Default is auto to automatically determine the status
3003 ==== SSL / HTTPS / TLS OPTIONS ====
3005 ssl Encrypt connections to this peer with SSL/TLS.
3007 sslcert=/path/to/ssl/certificate
3008 A client SSL certificate to use when connecting to
3011 sslkey=/path/to/ssl/key
3012 The private SSL key corresponding to sslcert above.
3013 If 'sslkey' is not specified 'sslcert' is assumed to
3014 reference a combined file containing both the
3015 certificate and the key.
3017 sslversion=1|2|3|4|5|6
3018 The SSL version to use when connecting to this peer
3019 1 = automatic (default)
3026 sslcipher=... The list of valid SSL ciphers to use when connecting
3029 ssloptions=... Specify various SSL implementation options:
3031 NO_SSLv2 Disallow the use of SSLv2
3032 NO_SSLv3 Disallow the use of SSLv3
3033 NO_TLSv1 Disallow the use of TLSv1.0
3034 NO_TLSv1_1 Disallow the use of TLSv1.1
3035 NO_TLSv1_2 Disallow the use of TLSv1.2
3037 Always create a new key when using
3038 temporary/ephemeral DH key exchanges
3039 ALL Enable various bug workarounds
3040 suggested as "harmless" by OpenSSL
3041 Be warned that this reduces SSL/TLS
3042 strength to some attacks.
3044 See the OpenSSL SSL_CTX_set_options documentation for a
3047 sslcafile=... A file containing additional CA certificates to use
3048 when verifying the peer certificate.
3050 sslcapath=... A directory containing additional CA certificates to
3051 use when verifying the peer certificate.
3053 sslcrlfile=... A certificate revocation list file to use when
3054 verifying the peer certificate.
3056 sslflags=... Specify various flags modifying the SSL implementation:
3059 Accept certificates even if they fail to
3062 Don't use the default CA list built in
3065 Don't verify the peer certificate
3066 matches the server name
3068 ssldomain= The peer name as advertised in it's certificate.
3069 Used for verifying the correctness of the received peer
3070 certificate. If not specified the peer hostname will be
3074 Enable the "Front-End-Https: On" header needed when
3075 using Squid as a SSL frontend in front of Microsoft OWA.
3076 See MS KB document Q307347 for details on this header.
3077 If set to auto the header will only be added if the
3078 request is forwarded as a https:// URL.
3081 ==== GENERAL OPTIONS ====
3084 A peer-specific connect timeout.
3085 Also see the peer_connect_timeout directive.
3087 connect-fail-limit=N
3088 How many times connecting to a peer must fail before
3089 it is marked as down. Default is 10.
3091 allow-miss Disable Squid's use of only-if-cached when forwarding
3092 requests to siblings. This is primarily useful when
3093 icp_hit_stale is used by the sibling. To extensive use
3094 of this option may result in forwarding loops, and you
3095 should avoid having two-way peerings with this option.
3096 For example to deny peer usage on requests from peer
3097 by denying cache_peer_access if the source is a peer.
3099 max-conn=N Limit the amount of connections Squid may open to this
3102 name=xxx Unique name for the peer.
3103 Required if you have multiple peers on the same host
3104 but different ports.
3105 This name can be used in cache_peer_access and similar
3106 directives to dentify the peer.
3107 Can be used by outgoing access controls through the
3110 no-tproxy Do not use the client-spoof TPROXY support when forwarding
3111 requests to this peer. Use normal address selection instead.
3112 This overrides the spoof_client_ip ACL.
3114 proxy-only objects fetched from the peer will not be stored locally.
3118 NAME: cache_peer_domain cache_host_domain
3123 Use to limit the domains for which a neighbor cache will be
3127 cache_peer_domain cache-host domain [domain ...]
3128 cache_peer_domain cache-host !domain
3130 For example, specifying
3132 cache_peer_domain parent.foo.net .edu
3134 has the effect such that UDP query packets are sent to
3135 'bigserver' only when the requested object exists on a
3136 server in the .edu domain. Prefixing the domainname
3137 with '!' means the cache will be queried for objects
3140 NOTE: * Any number of domains may be given for a cache-host,
3141 either on the same or separate lines.
3142 * When multiple domains are given for a particular
3143 cache-host, the first matched domain is applied.
3144 * Cache hosts with no domain restrictions are queried
3146 * There are no defaults.
3147 * There is also a 'cache_peer_access' tag in the ACL
3151 NAME: cache_peer_access
3156 Similar to 'cache_peer_domain' but provides more flexibility by
3160 cache_peer_access cache-host allow|deny [!]aclname ...
3162 The syntax is identical to 'http_access' and the other lists of
3163 ACL elements. See the comments for 'http_access' below, or
3164 the Squid FAQ (http://wiki.squid-cache.org/SquidFaq/SquidAcl).
3167 NAME: neighbor_type_domain
3168 TYPE: hostdomaintype
3170 DEFAULT_DOC: The peer type from cache_peer directive is used for all requests to that peer.
3173 Modify the cache_peer neighbor type when passing requests
3174 about specific domains to the peer.
3177 neighbor_type_domain neighbor parent|sibling domain domain ...
3180 cache_peer foo.example.com parent 3128 3130
3181 neighbor_type_domain foo.example.com sibling .au .de
3183 The above configuration treats all requests to foo.example.com as a
3184 parent proxy unless the request is for a .au or .de ccTLD domain name.
3187 NAME: dead_peer_timeout
3191 LOC: Config.Timeout.deadPeer
3193 This controls how long Squid waits to declare a peer cache
3194 as "dead." If there are no ICP replies received in this
3195 amount of time, Squid will declare the peer dead and not
3196 expect to receive any further ICP replies. However, it
3197 continues to send ICP queries, and will mark the peer as
3198 alive upon receipt of the first subsequent ICP reply.
3200 This timeout also affects when Squid expects to receive ICP
3201 replies from peers. If more than 'dead_peer' seconds have
3202 passed since the last ICP reply was received, Squid will not
3203 expect to receive an ICP reply on the next query. Thus, if
3204 your time between requests is greater than this timeout, you
3205 will see a lot of requests sent DIRECT to origin servers
3206 instead of to your parents.
3209 NAME: forward_max_tries
3212 LOC: Config.forward_max_tries
3214 Controls how many different forward paths Squid will try
3215 before giving up. See also forward_timeout.
3217 NOTE: connect_retries (default: none) can make each of these
3218 possible forwarding paths be tried multiple times.
3221 NAME: hierarchy_stoplist
3224 LOC: Config.hierarchy_stoplist
3226 A list of words which, if found in a URL, cause the object to
3227 be handled directly by this cache. In other words, use this
3228 to not query neighbor caches for certain objects. You may
3229 list this option multiple times.
3232 hierarchy_stoplist cgi-bin ?
3234 Note: never_direct overrides this option.
3238 MEMORY CACHE OPTIONS
3239 -----------------------------------------------------------------------------
3246 LOC: Config.memMaxSize
3248 NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS SIZE.
3249 IT ONLY PLACES A LIMIT ON HOW MUCH ADDITIONAL MEMORY SQUID WILL
3250 USE AS A MEMORY CACHE OF OBJECTS. SQUID USES MEMORY FOR OTHER
3251 THINGS AS WELL. SEE THE SQUID FAQ SECTION 8 FOR DETAILS.
3253 'cache_mem' specifies the ideal amount of memory to be used
3255 * In-Transit objects
3257 * Negative-Cached objects
3259 Data for these objects are stored in 4 KB blocks. This
3260 parameter specifies the ideal upper limit on the total size of
3261 4 KB blocks allocated. In-Transit objects take the highest
3264 In-transit objects have priority over the others. When
3265 additional space is needed for incoming data, negative-cached
3266 and hot objects will be released. In other words, the
3267 negative-cached and hot objects will fill up any unused space
3268 not needed for in-transit objects.
3270 If circumstances require, this limit will be exceeded.
3271 Specifically, if your incoming request rate requires more than
3272 'cache_mem' of memory to hold in-transit objects, Squid will
3273 exceed this limit to satisfy the new requests. When the load
3274 decreases, blocks will be freed until the high-water mark is
3275 reached. Thereafter, blocks will be used to store hot
3278 If shared memory caching is enabled, Squid does not use the shared
3279 cache space for in-transit objects, but they still consume as much
3280 local memory as they need. For more details about the shared memory
3281 cache, see memory_cache_shared.
3284 NAME: maximum_object_size_in_memory
3288 LOC: Config.Store.maxInMemObjSize
3290 Objects greater than this size will not be attempted to kept in
3291 the memory cache. This should be set high enough to keep objects
3292 accessed frequently in memory to improve performance whilst low
3293 enough to keep larger objects from hoarding cache_mem.
3296 NAME: memory_cache_shared
3299 LOC: Config.memShared
3301 DEFAULT_DOC: "on" where supported if doing memory caching with multiple SMP workers.
3303 Controls whether the memory cache is shared among SMP workers.
3305 The shared memory cache is meant to occupy cache_mem bytes and replace
3306 the non-shared memory cache, although some entities may still be
3307 cached locally by workers for now (e.g., internal and in-transit
3308 objects may be served from a local memory cache even if shared memory
3309 caching is enabled).
3311 By default, the memory cache is shared if and only if all of the
3312 following conditions are satisfied: Squid runs in SMP mode with
3313 multiple workers, cache_mem is positive, and Squid environment
3314 supports required IPC primitives (e.g., POSIX shared memory segments
3315 and GCC-style atomic operations).
3317 To avoid blocking locks, shared memory uses opportunistic algorithms
3318 that do not guarantee that every cachable entity that could have been
3319 shared among SMP workers will actually be shared.
3321 Currently, entities exceeding 32KB in size cannot be shared.
3324 NAME: memory_cache_mode
3328 DEFAULT_DOC: Keep the most recently fetched objects in memory
3330 Controls which objects to keep in the memory cache (cache_mem)
3332 always Keep most recently fetched objects in memory (default)
3334 disk Only disk cache hits are kept in memory, which means
3335 an object must first be cached on disk and then hit
3336 a second time before cached in memory.
3338 network Only objects fetched from network is kept in memory
3341 NAME: memory_replacement_policy
3343 LOC: Config.memPolicy
3346 The memory replacement policy parameter determines which
3347 objects are purged from memory when memory space is needed.
3349 See cache_replacement_policy for details on algorithms.
3354 -----------------------------------------------------------------------------
3357 NAME: cache_replacement_policy
3359 LOC: Config.replPolicy
3362 The cache replacement policy parameter determines which
3363 objects are evicted (replaced) when disk space is needed.
3365 lru : Squid's original list based LRU policy
3366 heap GDSF : Greedy-Dual Size Frequency
3367 heap LFUDA: Least Frequently Used with Dynamic Aging
3368 heap LRU : LRU policy implemented using a heap
3370 Applies to any cache_dir lines listed below this directive.
3372 The LRU policies keeps recently referenced objects.
3374 The heap GDSF policy optimizes object hit rate by keeping smaller
3375 popular objects in cache so it has a better chance of getting a
3376 hit. It achieves a lower byte hit rate than LFUDA though since
3377 it evicts larger (possibly popular) objects.
3379 The heap LFUDA policy keeps popular objects in cache regardless of
3380 their size and thus optimizes byte hit rate at the expense of
3381 hit rate since one large, popular object will prevent many
3382 smaller, slightly less popular objects from being cached.
3384 Both policies utilize a dynamic aging mechanism that prevents
3385 cache pollution that can otherwise occur with frequency-based
3386 replacement policies.
3388 NOTE: if using the LFUDA replacement policy you should increase
3389 the value of maximum_object_size above its default of 4 MB to
3390 to maximize the potential byte hit rate improvement of LFUDA.
3392 For more information about the GDSF and LFUDA cache replacement
3393 policies see http://www.hpl.hp.com/techreports/1999/HPL-1999-69.html
3394 and http://fog.hpl.external.hp.com/techreports/98/HPL-98-173.html.
3397 NAME: minimum_object_size
3401 DEFAULT_DOC: no limit
3402 LOC: Config.Store.minObjectSize
3404 Objects smaller than this size will NOT be saved on disk. The
3405 value is specified in bytes, and the default is 0 KB, which
3406 means all responses can be stored.
3409 NAME: maximum_object_size
3413 LOC: Config.Store.maxObjectSize
3415 Set the default value for max-size parameter on any cache_dir.
3416 The value is specified in bytes, and the default is 4 MB.
3418 If you wish to get a high BYTES hit ratio, you should probably
3419 increase this (one 32 MB object hit counts for 3200 10KB
3422 If you wish to increase hit ratio more than you want to
3423 save bandwidth you should leave this low.
3425 NOTE: if using the LFUDA replacement policy you should increase
3426 this value to maximize the byte hit rate improvement of LFUDA!
3427 See cache_replacement_policy for a discussion of this policy.
3433 DEFAULT_DOC: No disk cache. Store cache ojects only in memory.
3434 LOC: Config.cacheSwap
3437 cache_dir Type Directory-Name Fs-specific-data [options]
3439 You can specify multiple cache_dir lines to spread the
3440 cache among different disk partitions.
3442 Type specifies the kind of storage system to use. Only "ufs"
3443 is built by default. To enable any of the other storage systems
3444 see the --enable-storeio configure option.
3446 'Directory' is a top-level directory where cache swap
3447 files will be stored. If you want to use an entire disk
3448 for caching, this can be the mount-point directory.
3449 The directory must exist and be writable by the Squid
3450 process. Squid will NOT create this directory for you.
3452 In SMP configurations, cache_dir must not precede the workers option
3453 and should use configuration macros or conditionals to give each
3454 worker interested in disk caching a dedicated cache directory.
3457 ==== The ufs store type ====
3459 "ufs" is the old well-known Squid storage format that has always
3463 cache_dir ufs Directory-Name Mbytes L1 L2 [options]
3465 'Mbytes' is the amount of disk space (MB) to use under this
3466 directory. The default is 100 MB. Change this to suit your
3467 configuration. Do NOT put the size of your disk drive here.
3468 Instead, if you want Squid to use the entire disk drive,
3469 subtract 20% and use that value.
3471 'L1' is the number of first-level subdirectories which
3472 will be created under the 'Directory'. The default is 16.
3474 'L2' is the number of second-level subdirectories which
3475 will be created under each first-level directory. The default
3479 ==== The aufs store type ====
3481 "aufs" uses the same storage format as "ufs", utilizing
3482 POSIX-threads to avoid blocking the main Squid process on
3483 disk-I/O. This was formerly known in Squid as async-io.
3486 cache_dir aufs Directory-Name Mbytes L1 L2 [options]
3488 see argument descriptions under ufs above
3491 ==== The diskd store type ====
3493 "diskd" uses the same storage format as "ufs", utilizing a
3494 separate process to avoid blocking the main Squid process on
3498 cache_dir diskd Directory-Name Mbytes L1 L2 [options] [Q1=n] [Q2=n]
3500 see argument descriptions under ufs above
3502 Q1 specifies the number of unacknowledged I/O requests when Squid
3503 stops opening new files. If this many messages are in the queues,
3504 Squid won't open new files. Default is 64
3506 Q2 specifies the number of unacknowledged messages when Squid
3507 starts blocking. If this many messages are in the queues,
3508 Squid blocks until it receives some replies. Default is 72
3510 When Q1 < Q2 (the default), the cache directory is optimized
3511 for lower response time at the expense of a decrease in hit
3512 ratio. If Q1 > Q2, the cache directory is optimized for
3513 higher hit ratio at the expense of an increase in response
3517 ==== The rock store type ====
3520 cache_dir rock Directory-Name Mbytes [options]
3522 The Rock Store type is a database-style storage. All cached
3523 entries are stored in a "database" file, using fixed-size slots.
3524 A single entry occupies one or more slots.
3526 If possible, Squid using Rock Store creates a dedicated kid
3527 process called "disker" to avoid blocking Squid worker(s) on disk
3528 I/O. One disker kid is created for each rock cache_dir. Diskers
3529 are created only when Squid, running in daemon mode, has support
3530 for the IpcIo disk I/O module.
3532 swap-timeout=msec: Squid will not start writing a miss to or
3533 reading a hit from disk if it estimates that the swap operation
3534 will take more than the specified number of milliseconds. By
3535 default and when set to zero, disables the disk I/O time limit
3536 enforcement. Ignored when using blocking I/O module because
3537 blocking synchronous I/O does not allow Squid to estimate the
3538 expected swap wait time.
3540 max-swap-rate=swaps/sec: Artificially limits disk access using
3541 the specified I/O rate limit. Swap out requests that
3542 would cause the average I/O rate to exceed the limit are
3543 delayed. Individual swap in requests (i.e., hits or reads) are
3544 not delayed, but they do contribute to measured swap rate and
3545 since they are placed in the same FIFO queue as swap out
3546 requests, they may wait longer if max-swap-rate is smaller.
3547 This is necessary on file systems that buffer "too
3548 many" writes and then start blocking Squid and other processes
3549 while committing those writes to disk. Usually used together
3550 with swap-timeout to avoid excessive delays and queue overflows
3551 when disk demand exceeds available disk "bandwidth". By default
3552 and when set to zero, disables the disk I/O rate limit
3553 enforcement. Currently supported by IpcIo module only.
3555 slot-size=bytes: The size of a database "record" used for
3556 storing cached responses. A cached response occupies at least
3557 one slot and all database I/O is done using individual slots so
3558 increasing this parameter leads to more disk space waste while
3559 decreasing it leads to more disk I/O overheads. Should be a
3560 multiple of your operating system I/O page size. Defaults to
3561 16KBytes. A housekeeping header is stored with each slot and
3562 smaller slot-sizes will be rejected. The header is smaller than
3566 ==== COMMON OPTIONS ====
3568 no-store no new objects should be stored to this cache_dir.
3570 min-size=n the minimum object size in bytes this cache_dir
3571 will accept. It's used to restrict a cache_dir
3572 to only store large objects (e.g. AUFS) while
3573 other stores are optimized for smaller objects
3577 max-size=n the maximum object size in bytes this cache_dir
3579 The value in maximum_object_size directive sets
3580 the default unless more specific details are
3581 available (ie a small store capacity).
3583 Note: To make optimal use of the max-size limits you should order
3584 the cache_dir lines with the smallest max-size value first.
3588 # Uncomment and adjust the following to add a disk cache directory.
3589 #cache_dir ufs @DEFAULT_SWAP_DIR@ 100 16 256
3593 NAME: store_dir_select_algorithm
3595 LOC: Config.store_dir_select_algorithm
3598 How Squid selects which cache_dir to use when the response
3599 object will fit into more than one.
3601 Regardless of which algorithm is used the cache_dir min-size
3602 and max-size parameters are obeyed. As such they can affect
3603 the selection algorithm by limiting the set of considered
3610 This algorithm is suited to caches with similar cache_dir
3611 sizes and disk speeds.
3613 The disk with the least I/O pending is selected.
3614 When there are multiple disks with the same I/O load ranking
3615 the cache_dir with most available capacity is selected.
3617 When a mix of cache_dir sizes are configured the faster disks
3618 have a naturally lower I/O loading and larger disks have more
3619 capacity. So space used to store objects and data throughput
3620 may be very unbalanced towards larger disks.
3625 This algorithm is suited to caches with unequal cache_dir
3628 Each cache_dir is selected in a rotation. The next suitable
3631 Available cache_dir capacity is only considered in relation
3632 to whether the object will fit and meets the min-size and
3633 max-size parameters.
3635 Disk I/O loading is only considered to prevent overload on slow
3636 disks. This algorithm does not spread objects by size, so any
3637 I/O loading per-disk may appear very unbalanced and volatile.
3641 NAME: max_open_disk_fds
3643 LOC: Config.max_open_disk_fds
3645 DEFAULT_DOC: no limit
3647 To avoid having disk as the I/O bottleneck Squid can optionally
3648 bypass the on-disk cache if more than this amount of disk file
3649 descriptors are open.
3651 A value of 0 indicates no limit.
3654 NAME: cache_swap_low
3655 COMMENT: (percent, 0-100)
3658 LOC: Config.Swap.lowWaterMark
3660 The low-water mark for cache object replacement.
3661 Replacement begins when the swap (disk) usage is above the
3662 low-water mark and attempts to maintain utilization near the
3663 low-water mark. As swap utilization gets close to high-water
3664 mark object eviction becomes more aggressive. If utilization is
3665 close to the low-water mark less replacement is done each time.
3667 Defaults are 90% and 95%. If you have a large cache, 5% could be
3668 hundreds of MB. If this is the case you may wish to set these
3669 numbers closer together.
3671 See also cache_swap_high
3674 NAME: cache_swap_high
3675 COMMENT: (percent, 0-100)
3678 LOC: Config.Swap.highWaterMark
3680 The high-water mark for cache object replacement.
3681 Replacement begins when the swap (disk) usage is above the
3682 low-water mark and attempts to maintain utilization near the
3683 low-water mark. As swap utilization gets close to high-water
3684 mark object eviction becomes more aggressive. If utilization is
3685 close to the low-water mark less replacement is done each time.
3687 Defaults are 90% and 95%. If you have a large cache, 5% could be
3688 hundreds of MB. If this is the case you may wish to set these
3689 numbers closer together.
3691 See also cache_swap_low
3696 -----------------------------------------------------------------------------
3703 DEFAULT_DOC: The format definitions squid, common, combined, referrer, useragent are built in.
3707 logformat <name> <format specification>
3709 Defines an access log format.
3711 The <format specification> is a string with embedded % format codes
3713 % format codes all follow the same basic structure where all but
3714 the formatcode is optional. Output strings are automatically escaped
3715 as required according to their context and the output format
3716 modifiers are usually not needed, but can be specified if an explicit
3717 output format is desired.
3719 % ["|[|'|#] [-] [[0]width] [{argument}] formatcode
3721 " output in quoted string format
3722 [ output in squid text log format as used by log_mime_hdrs
3723 # output in URL quoted format
3728 width minimum and/or maximum field width:
3729 [width_min][.width_max]
3730 When minimum starts with 0, the field is zero-padded.
3731 String values exceeding maximum width are truncated.
3733 {arg} argument such as header name etc
3737 % a literal % character
3738 sn Unique sequence number per log line entry
3739 err_code The ID of an error response served by Squid or
3740 a similar internal error identifier.
3741 err_detail Additional err_code-dependent error information.
3742 note The meta header specified by the argument. Also
3743 logs the adaptation meta headers set by the
3744 adaptation_meta configuration parameter.
3745 If no argument given all meta headers logged.
3747 Connection related format codes:
3749 >a Client source IP address
3751 >p Client source port
3752 >eui Client source EUI (MAC address, EUI-48 or EUI-64 identifier)
3753 >la Local IP address the client connected to
3754 >lp Local port number the client connected to
3755 >qos Client connection TOS/DSCP value set by Squid
3756 >nfmark Client connection netfilter mark set by Squid
3758 la Local listening IP address the client connection was connected to.
3759 lp Local listening port number the client connection was connected to.
3761 <a Server IP address of the last server or peer connection
3762 <A Server FQDN or peer name
3763 <p Server port number of the last server or peer connection
3764 <la Local IP address of the last server or peer connection
3765 <lp Local port number of the last server or peer connection
3766 <qos Server connection TOS/DSCP value set by Squid
3767 <nfmark Server connection netfilter mark set by Squid
3769 Time related format codes:
3771 ts Seconds since epoch
3772 tu subsecond time (milliseconds)
3773 tl Local time. Optional strftime format argument
3774 default %d/%b/%Y:%H:%M:%S %z
3775 tg GMT time. Optional strftime format argument
3776 default %d/%b/%Y:%H:%M:%S %z
3777 tr Response time (milliseconds)
3778 dt Total time spent making DNS lookups (milliseconds)
3779 tS Approximate master transaction start time in
3780 <full seconds since epoch>.<fractional seconds> format.
3781 Currently, Squid considers the master transaction
3782 started when a complete HTTP request header initiating
3783 the transaction is received from the client. This is
3784 the same value that Squid uses to calculate transaction
3785 response time when logging %tr to access.log. Currently,
3786 Squid uses millisecond resolution for %tS values,
3787 similar to the default access.log "current time" field
3790 Access Control related format codes:
3792 et Tag returned by external acl
3793 ea Log string returned by external acl
3794 un User name (any available)
3795 ul User name from authentication
3796 ue User name from external acl helper
3797 ui User name from ident
3798 us User name from SSL
3799 credentials Client credentials. The exact meaning depends on
3800 the authentication scheme: For Basic authentication,
3801 it is the password; for Digest, the realm sent by the
3802 client; for NTLM and Negotiate, the client challenge
3803 or client credentials prefixed with "YR " or "KK ".
3805 HTTP related format codes:
3809 [http::]rm Request method (GET/POST etc)
3810 [http::]>rm Request method from client
3811 [http::]<rm Request method sent to server or peer
3812 [http::]ru Request URL from client (historic, filtered for logging)
3813 [http::]>ru Request URL from client
3814 [http::]<ru Request URL sent to server or peer
3815 [http::]>rd Request URL domain from client
3816 [http::]rp Request URL-Path excluding hostname
3817 [http::]>rp Request URL-Path excluding hostname from client
3818 [http::]<rp Request URL-Path excluding hostname sent to server or peer
3819 [http::]rv Request protocol version
3820 [http::]>rv Request protocol version from client
3821 [http::]<rv Request protocol version sent to server or peer
3823 [http::]>h Original received request header.
3824 Usually differs from the request header sent by
3825 Squid, although most fields are often preserved.
3826 Accepts optional header field name/value filter
3827 argument using name[:[separator]element] format.
3828 [http::]>ha Received request header after adaptation and
3829 redirection (pre-cache REQMOD vectoring point).
3830 Usually differs from the request header sent by
3831 Squid, although most fields are often preserved.
3832 Optional header name argument as for >h
3837 [http::]<Hs HTTP status code received from the next hop
3838 [http::]>Hs HTTP status code sent to the client
3840 [http::]<h Reply header. Optional header name argument
3843 [http::]mt MIME content type
3848 [http::]st Total size of request + reply traffic with client
3849 [http::]>st Total size of request received from client.
3850 Excluding chunked encoding bytes.
3851 [http::]<st Total size of reply sent to client (after adaptation)
3853 [http::]>sh Size of request headers received from client
3854 [http::]<sh Size of reply headers sent to client (after adaptation)
3856 [http::]<sH Reply high offset sent
3857 [http::]<sS Upstream object size
3859 [http::]<bs Number of HTTP-equivalent message body bytes
3860 received from the next hop, excluding chunked
3861 transfer encoding and control messages.
3862 Generated FTP/Gopher listings are treated as
3868 [http::]<pt Peer response time in milliseconds. The timer starts
3869 when the last request byte is sent to the next hop
3870 and stops when the last response byte is received.
3871 [http::]<tt Total server-side time in milliseconds. The timer
3872 starts with the first connect request (or write I/O)
3873 sent to the first selected peer. The timer stops
3874 with the last I/O with the last peer.
3876 Squid handling related format codes:
3878 Ss Squid request status (TCP_MISS etc)
3879 Sh Squid hierarchy status (DEFAULT_PARENT etc)
3881 SSL-related format codes:
3883 ssl::bump_mode SslBump decision for the transaction:
3885 For CONNECT requests that initiated bumping of
3886 a connection and for any request received on
3887 an already bumped connection, Squid logs the
3888 corresponding SslBump mode ("server-first" or
3889 "client-first"). See the ssl_bump option for
3890 more information about these modes.
3892 A "none" token is logged for requests that
3893 triggered "ssl_bump" ACL evaluation matching
3894 either a "none" rule or no rules at all.
3896 In all other cases, a single dash ("-") is
3899 If ICAP is enabled, the following code becomes available (as
3900 well as ICAP log codes documented with the icap_log option):
3902 icap::tt Total ICAP processing time for the HTTP
3903 transaction. The timer ticks when ICAP
3904 ACLs are checked and when ICAP
3905 transaction is in progress.
3907 If adaptation is enabled the following three codes become available:
3909 adapt::<last_h The header of the last ICAP response or
3910 meta-information from the last eCAP
3911 transaction related to the HTTP transaction.
3912 Like <h, accepts an optional header name
3915 adapt::sum_trs Summed adaptation transaction response
3916 times recorded as a comma-separated list in
3917 the order of transaction start time. Each time
3918 value is recorded as an integer number,
3919 representing response time of one or more
3920 adaptation (ICAP or eCAP) transaction in
3921 milliseconds. When a failed transaction is
3922 being retried or repeated, its time is not
3923 logged individually but added to the
3924 replacement (next) transaction. See also:
3927 adapt::all_trs All adaptation transaction response times.
3928 Same as adaptation_strs but response times of
3929 individual transactions are never added
3930 together. Instead, all transaction response
3931 times are recorded individually.
3933 You can prefix adapt::*_trs format codes with adaptation
3934 service name in curly braces to record response time(s) specific
3935 to that service. For example: %{my_service}adapt::sum_trs
3937 If SSL is enabled, the following formating codes become available:
3939 %ssl::>cert_subject The Subject field of the received client
3940 SSL certificate or a dash ('-') if Squid has
3941 received an invalid/malformed certificate or
3942 no certificate at all. Consider encoding the
3943 logged value because Subject often has spaces.
3945 %ssl::>cert_issuer The Issuer field of the received client
3946 SSL certificate or a dash ('-') if Squid has
3947 received an invalid/malformed certificate or
3948 no certificate at all. Consider encoding the
3949 logged value because Issuer often has spaces.
3951 The default formats available (which do not need re-defining) are:
3953 logformat squid %ts.%03tu %6tr %>a %Ss/%03>Hs %<st %rm %ru %[un %Sh/%<a %mt
3954 logformat common %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st %Ss:%Sh
3955 logformat combined %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh
3956 logformat referrer %ts.%03tu %>a %{Referer}>h %ru
3957 logformat useragent %>a [%tl] "%{User-Agent}>h"
3959 NOTE: When the log_mime_hdrs directive is set to ON.
3960 The squid, common and combined formats have a safely encoded copy
3961 of the mime headers appended to each line within a pair of brackets.
3963 NOTE: The common and combined formats are not quite true to the Apache definition.
3964 The logs from Squid contain an extra status and hierarchy code appended.
3968 NAME: access_log cache_access_log
3970 LOC: Config.Log.accesslogs
3971 DEFAULT_IF_NONE: daemon:@DEFAULT_ACCESS_LOG@ squid
3973 Configures whether and how Squid logs HTTP and ICP transactions.
3974 If access logging is enabled, a single line is logged for every
3975 matching HTTP or ICP request. The recommended directive formats are:
3977 access_log <module>:<place> [option ...] [acl acl ...]
3978 access_log none [acl acl ...]
3980 The following directive format is accepted but may be deprecated:
3981 access_log <module>:<place> [<logformat name> [acl acl ...]]
3983 In most cases, the first ACL name must not contain the '=' character
3984 and should not be equal to an existing logformat name. You can always
3985 start with an 'all' ACL to work around those restrictions.
3987 Will log to the specified module:place using the specified format (which
3988 must be defined in a logformat directive) those entries which match
3989 ALL the acl's specified (which must be defined in acl clauses).
3990 If no acl is specified, all requests will be logged to this destination.
3992 ===== Available options for the recommended directive format =====
3994 logformat=name Names log line format (either built-in or
3995 defined by a logformat directive). Defaults
3998 buffer-size=64KB Defines approximate buffering limit for log
3999 records (see buffered_logs). Squid should not
4000 keep more than the specified size and, hence,
4001 should flush records before the buffer becomes
4002 full to avoid overflows under normal
4003 conditions (the exact flushing algorithm is
4004 module-dependent though). The on-error option
4005 controls overflow handling.
4007 on-error=die|drop Defines action on unrecoverable errors. The
4008 'drop' action ignores (i.e., does not log)
4009 affected log records. The default 'die' action
4010 kills the affected worker. The drop action
4011 support has not been tested for modules other
4014 ===== Modules Currently available =====
4016 none Do not log any requests matching these ACL.
4017 Do not specify Place or logformat name.
4019 stdio Write each log line to disk immediately at the completion of
4021 Place: the filename and path to be written.
4023 daemon Very similar to stdio. But instead of writing to disk the log
4024 line is passed to a daemon helper for asychronous handling instead.
4025 Place: varies depending on the daemon.
4027 log_file_daemon Place: the file name and path to be written.
4029 syslog To log each request via syslog facility.
4030 Place: The syslog facility and priority level for these entries.
4031 Place Format: facility.priority
4033 where facility could be any of:
4034 authpriv, daemon, local0 ... local7 or user.
4036 And priority could be any of:
4037 err, warning, notice, info, debug.
4039 udp To send each log line as text data to a UDP receiver.
4040 Place: The destination host name or IP and port.
4041 Place Format: //host:port
4043 tcp To send each log line as text data to a TCP receiver.
4044 Lines may be accumulated before sending (see buffered_logs).
4045 Place: The destination host name or IP and port.
4046 Place Format: //host:port
4049 access_log daemon:@DEFAULT_ACCESS_LOG@ squid
4055 LOC: Config.Log.icaplogs
4058 ICAP log files record ICAP transaction summaries, one line per
4061 The icap_log option format is:
4062 icap_log <filepath> [<logformat name> [acl acl ...]]
4063 icap_log none [acl acl ...]]
4065 Please see access_log option documentation for details. The two
4066 kinds of logs share the overall configuration approach and many
4069 ICAP processing of a single HTTP message or transaction may
4070 require multiple ICAP transactions. In such cases, multiple
4071 ICAP transaction log lines will correspond to a single access
4074 ICAP log uses logformat codes that make sense for an ICAP
4075 transaction. Header-related codes are applied to the HTTP header
4076 embedded in an ICAP server response, with the following caveats:
4077 For REQMOD, there is no HTTP response header unless the ICAP
4078 server performed request satisfaction. For RESPMOD, the HTTP
4079 request header is the header sent to the ICAP server. For
4080 OPTIONS, there are no HTTP headers.
4082 The following format codes are also available for ICAP logs:
4084 icap::<A ICAP server IP address. Similar to <A.
4086 icap::<service_name ICAP service name from the icap_service
4087 option in Squid configuration file.
4089 icap::ru ICAP Request-URI. Similar to ru.
4091 icap::rm ICAP request method (REQMOD, RESPMOD, or
4092 OPTIONS). Similar to existing rm.
4094 icap::>st Bytes sent to the ICAP server (TCP payload
4095 only; i.e., what Squid writes to the socket).
4097 icap::<st Bytes received from the ICAP server (TCP
4098 payload only; i.e., what Squid reads from
4101 icap::<bs Number of message body bytes received from the
4102 ICAP server. ICAP message body, if any, usually
4103 includes encapsulated HTTP message headers and
4104 possibly encapsulated HTTP message body. The
4105 HTTP body part is dechunked before its size is
4108 icap::tr Transaction response time (in
4109 milliseconds). The timer starts when
4110 the ICAP transaction is created and
4111 stops when the transaction is completed.
4114 icap::tio Transaction I/O time (in milliseconds). The
4115 timer starts when the first ICAP request
4116 byte is scheduled for sending. The timers
4117 stops when the last byte of the ICAP response
4120 icap::to Transaction outcome: ICAP_ERR* for all
4121 transaction errors, ICAP_OPT for OPTION
4122 transactions, ICAP_ECHO for 204
4123 responses, ICAP_MOD for message
4124 modification, and ICAP_SAT for request
4125 satisfaction. Similar to Ss.
4127 icap::Hs ICAP response status code. Similar to Hs.
4129 icap::>h ICAP request header(s). Similar to >h.
4131 icap::<h ICAP response header(s). Similar to <h.
4133 The default ICAP log format, which can be used without an explicit
4134 definition, is called icap_squid:
4136 logformat icap_squid %ts.%03tu %6icap::tr %>a %icap::to/%03icap::Hs %icap::<size %icap::rm %icap::ru% %un -/%icap::<A -
4138 See also: logformat, log_icap, and %adapt::<last_h
4141 NAME: logfile_daemon
4143 DEFAULT: @DEFAULT_LOGFILED@
4144 LOC: Log::TheConfig.logfile_daemon
4146 Specify the path to the logfile-writing daemon. This daemon is
4147 used to write the access and store logs, if configured.
4149 Squid sends a number of commands to the log daemon:
4150 L<data>\n - logfile data
4155 r<n>\n - set rotate count to <n>
4156 b<n>\n - 1 = buffer output, 0 = don't buffer output
4158 No responses is expected.
4164 Remove this line. Use acls with access_log directives to control access logging
4170 Remove this line. Use acls with icap_log directives to control icap logging
4173 NAME: stats_collection
4175 LOC: Config.accessList.stats_collection
4177 DEFAULT_DOC: Allow logging for all transactions.
4178 COMMENT: allow|deny acl acl...
4180 This options allows you to control which requests gets accounted
4181 in performance counters.
4183 This clause only supports fast acl types.
4184 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
4187 NAME: cache_store_log
4190 LOC: Config.Log.store
4192 Logs the activities of the storage manager. Shows which
4193 objects are ejected from the cache, and which objects are
4194 saved and for how long.
4195 There are not really utilities to analyze this data, so you can safely
4196 disable it (the default).
4198 Store log uses modular logging outputs. See access_log for the list
4199 of modules supported.
4202 cache_store_log stdio:@DEFAULT_STORE_LOG@
4203 cache_store_log daemon:@DEFAULT_STORE_LOG@
4206 NAME: cache_swap_state cache_swap_log
4208 LOC: Config.Log.swap
4210 DEFAULT_DOC: Store the journal inside its cache_dir
4212 Location for the cache "swap.state" file. This index file holds
4213 the metadata of objects saved on disk. It is used to rebuild
4214 the cache during startup. Normally this file resides in each
4215 'cache_dir' directory, but you may specify an alternate
4216 pathname here. Note you must give a full filename, not just
4217 a directory. Since this is the index for the whole object
4218 list you CANNOT periodically rotate it!
4220 If %s can be used in the file name it will be replaced with a
4221 a representation of the cache_dir name where each / is replaced
4222 with '.'. This is needed to allow adding/removing cache_dir
4223 lines when cache_swap_log is being used.
4225 If have more than one 'cache_dir', and %s is not used in the name
4226 these swap logs will have names such as:
4232 The numbered extension (which is added automatically)
4233 corresponds to the order of the 'cache_dir' lines in this
4234 configuration file. If you change the order of the 'cache_dir'
4235 lines in this file, these index files will NOT correspond to
4236 the correct 'cache_dir' entry (unless you manually rename
4237 them). We recommend you do NOT use this option. It is
4238 better to keep these index files in each 'cache_dir' directory.
4241 NAME: logfile_rotate
4244 LOC: Config.Log.rotateNumber
4246 Specifies the number of logfile rotations to make when you
4247 type 'squid -k rotate'. The default is 10, which will rotate
4248 with extensions 0 through 9. Setting logfile_rotate to 0 will
4249 disable the file name rotation, but the logfiles are still closed
4250 and re-opened. This will enable you to rename the logfiles
4251 yourself just before sending the rotate signal.
4253 Note, the 'squid -k rotate' command normally sends a USR1
4254 signal to the running squid process. In certain situations
4255 (e.g. on Linux with Async I/O), USR1 is used for other
4256 purposes, so -k rotate uses another signal. It is best to get
4257 in the habit of using 'squid -k rotate' instead of 'kill -USR1
4260 Note, from Squid-3.1 this option is only a default for cache.log,
4261 that log can be rotated separately by using debug_options.
4264 NAME: emulate_httpd_log
4267 Replace this with an access_log directive using the format 'common' or 'combined'.
4270 NAME: log_ip_on_direct
4273 Remove this option from your config. To log server or peer names use %<A in the log format.
4278 DEFAULT: @DEFAULT_MIME_TABLE@
4279 LOC: Config.mimeTablePathname
4281 Path to Squid's icon configuration file.
4283 You shouldn't need to change this, but the default file contains
4284 examples and formatting information if you do.
4290 LOC: Config.onoff.log_mime_hdrs
4293 The Cache can record both the request and the response MIME
4294 headers for each HTTP transaction. The headers are encoded
4295 safely and will appear as two bracketed fields at the end of
4296 the access log (for either the native or httpd-emulated log
4297 formats). To enable this logging set log_mime_hdrs to 'on'.
4303 Replace this with an access_log directive using the format 'useragent'.
4306 NAME: referer_log referrer_log
4309 Replace this with an access_log directive using the format 'referrer'.
4314 DEFAULT: @DEFAULT_PID_FILE@
4315 LOC: Config.pidFilename
4317 A filename to write the process-id to. To disable, enter "none".
4323 Remove this option from your config. To log FQDN use %>A in the log format.
4326 NAME: client_netmask
4328 LOC: Config.Addrs.client_netmask
4330 DEFAULT_DOC: Log full client IP address
4332 A netmask for client addresses in logfiles and cachemgr output.
4333 Change this to protect the privacy of your cache clients.
4334 A netmask of 255.255.255.0 will log all IP's in that range with
4335 the last digit set to '0'.
4341 Use a regular access.log with ACL limiting it to MISS events.
4344 NAME: strip_query_terms
4346 LOC: Config.onoff.strip_query_terms
4349 By default, Squid strips query terms from requested URLs before
4350 logging. This protects your user's privacy and reduces log size.
4352 When investigating HIT/MISS or other caching behaviour you
4353 will need to disable this to see the full URL used by Squid.
4360 LOC: Config.onoff.buffered_logs
4362 Whether to write/send access_log records ASAP or accumulate them and
4363 then write/send them in larger chunks. Buffering may improve
4364 performance because it decreases the number of I/Os. However,
4365 buffering increases the delay before log records become available to
4366 the final recipient (e.g., a disk file or logging daemon) and,
4367 hence, increases the risk of log records loss.
4369 Note that even when buffered_logs are off, Squid may have to buffer
4370 records if it cannot write/send them immediately due to pending I/Os
4371 (e.g., the I/O writing the previous log record) or connectivity loss.
4373 Currently honored by 'daemon' and 'tcp' access_log modules only.
4376 NAME: netdb_filename
4378 DEFAULT: stdio:@DEFAULT_NETDB_FILE@
4379 LOC: Config.netdbFilename
4382 Where Squid stores it's netdb journal.
4383 When enabled this journal preserves netdb state between restarts.
4385 To disable, enter "none".
4389 OPTIONS FOR TROUBLESHOOTING
4390 -----------------------------------------------------------------------------
4395 DEFAULT_IF_NONE: @DEFAULT_CACHE_LOG@
4396 LOC: Debug::cache_log
4398 Squid administrative logging file.
4400 This is where general information about Squid behavior goes. You can
4401 increase the amount of data logged to this file and how often it is
4402 rotated with "debug_options"
4408 DEFAULT_DOC: Log all critical and important messages.
4409 LOC: Debug::debugOptions
4411 Logging options are set as section,level where each source file
4412 is assigned a unique section. Lower levels result in less
4413 output, Full debugging (level 9) can result in a very large
4414 log file, so be careful.
4416 The magic word "ALL" sets debugging levels for all sections.
4417 The default is to run with "ALL,1" to record important warnings.
4419 The rotate=N option can be used to keep more or less of these logs
4420 than would otherwise be kept by logfile_rotate.
4421 For most uses a single log should be enough to monitor current
4422 events affecting Squid.
4427 LOC: Config.coredump_dir
4428 DEFAULT_IF_NONE: none
4429 DEFAULT_DOC: Use the directory from where Squid was started.
4431 By default Squid leaves core files in the directory from where
4432 it was started. If you set 'coredump_dir' to a directory
4433 that exists, Squid will chdir() to that directory at startup
4434 and coredump files will be left there.
4438 # Leave coredumps in the first cache dir
4439 coredump_dir @DEFAULT_SWAP_DIR@
4445 OPTIONS FOR FTP GATEWAYING
4446 -----------------------------------------------------------------------------
4452 LOC: Config.Ftp.anon_user
4454 If you want the anonymous login password to be more informative
4455 (and enable the use of picky FTP servers), set this to something
4456 reasonable for your domain, like wwwuser@somewhere.net
4458 The reason why this is domainless by default is the
4459 request can be made on the behalf of a user in any domain,
4460 depending on how the cache is used.
4461 Some FTP server also validate the email address is valid
4462 (for example perl.com).
4468 LOC: Config.Ftp.passive
4470 If your firewall does not allow Squid to use passive
4471 connections, turn off this option.
4473 Use of ftp_epsv_all option requires this to be ON.
4479 LOC: Config.Ftp.epsv_all
4481 FTP Protocol extensions permit the use of a special "EPSV ALL" command.
4483 NATs may be able to put the connection on a "fast path" through the
4484 translator, as the EPRT command will never be used and therefore,
4485 translation of the data portion of the segments will never be needed.
4487 When a client only expects to do two-way FTP transfers this may be
4489 If squid finds that it must do a three-way FTP transfer after issuing
4490 an EPSV ALL command, the FTP session will fail.
4492 If you have any doubts about this option do not use it.
4493 Squid will nicely attempt all other connection methods.
4495 Requires ftp_passive to be ON (default) for any effect.
4501 LOC: Config.accessList.ftp_epsv
4503 FTP Protocol extensions permit the use of a special "EPSV" command.
4505 NATs may be able to put the connection on a "fast path" through the
4506 translator using EPSV, as the EPRT command will never be used
4507 and therefore, translation of the data portion of the segments
4508 will never be needed.
4510 EPSV is often required to interoperate with FTP servers on IPv6
4511 networks. On the other hand, it may break some IPv4 servers.
4513 By default, EPSV may try EPSV with any FTP server. To fine tune
4514 that decision, you may restrict EPSV to certain clients or servers
4517 ftp_epsv allow|deny al1 acl2 ...
4519 WARNING: Disabling EPSV may cause problems with external NAT and IPv6.
4521 Only fast ACLs are supported.
4522 Requires ftp_passive to be ON (default) for any effect.
4528 LOC: Config.Ftp.eprt
4530 FTP Protocol extensions permit the use of a special "EPRT" command.
4532 This extension provides a protocol neutral alternative to the
4533 IPv4-only PORT command. When supported it enables active FTP data
4534 channels over IPv6 and efficient NAT handling.
4536 Turning this OFF will prevent EPRT being attempted and will skip
4537 straight to using PORT for IPv4 servers.
4539 Some devices are known to not handle this extension correctly and
4540 may result in crashes. Devices which suport EPRT enough to fail
4541 cleanly will result in Squid attempting PORT anyway. This directive
4542 should only be disabled when EPRT results in device failures.
4544 WARNING: Doing so will convert Squid back to the old behavior with all
4545 the related problems with external NAT devices/layers and IPv4-only FTP.
4548 NAME: ftp_sanitycheck
4551 LOC: Config.Ftp.sanitycheck
4553 For security and data integrity reasons Squid by default performs
4554 sanity checks of the addresses of FTP data connections ensure the
4555 data connection is to the requested server. If you need to allow
4556 FTP connections to servers using another IP address for the data
4557 connection turn this off.
4560 NAME: ftp_telnet_protocol
4563 LOC: Config.Ftp.telnet
4565 The FTP protocol is officially defined to use the telnet protocol
4566 as transport channel for the control connection. However, many
4567 implementations are broken and does not respect this aspect of
4570 If you have trouble accessing files with ASCII code 255 in the
4571 path or similar problems involving this ASCII code you can
4572 try setting this directive to off. If that helps, report to the
4573 operator of the FTP server in question that their FTP server
4574 is broken and does not follow the FTP standard.
4578 OPTIONS FOR EXTERNAL SUPPORT PROGRAMS
4579 -----------------------------------------------------------------------------
4584 DEFAULT: @DEFAULT_DISKD@
4585 LOC: Config.Program.diskd
4587 Specify the location of the diskd executable.
4588 Note this is only useful if you have compiled in
4589 diskd as one of the store io modules.
4592 NAME: unlinkd_program
4595 DEFAULT: @DEFAULT_UNLINKD@
4596 LOC: Config.Program.unlinkd
4598 Specify the location of the executable for file deletion process.
4601 NAME: pinger_program
4603 DEFAULT: @DEFAULT_PINGER@
4604 LOC: Config.pinger.program
4607 Specify the location of the executable for the pinger process.
4613 LOC: Config.pinger.enable
4616 Control whether the pinger is active at run-time.
4617 Enables turning ICMP pinger on and off with a simple
4618 squid -k reconfigure.
4623 OPTIONS FOR URL REWRITING
4624 -----------------------------------------------------------------------------
4627 NAME: url_rewrite_program redirect_program
4629 LOC: Config.Program.redirect
4632 Specify the location of the executable URL rewriter to use.
4633 Since they can perform almost any function there isn't one included.
4635 For each requested URL, the rewriter will receive on line with the format
4637 [channel-ID <SP>] URL [<SP> extras]<NL>
4640 After processing the request the helper must reply using the following format:
4642 [channel-ID <SP>] result [<SP> kv-pairs]
4644 The result code can be:
4646 OK status=30N url="..."
4647 Redirect the URL to the one supplied in 'url='.
4648 'status=' is optional and contains the status code to send
4649 the client in Squids HTTP response. It must be one of the
4650 HTTP redirect status codes: 301, 302, 303, 307, 308.
4651 When no status is given Squid will use 302.
4653 OK rewrite-url="..."
4654 Rewrite the URL to the one supplied in 'rewrite-url='.
4655 The new URL is fetched directly by Squid and returned to
4656 the client as the response to its request.
4659 When neither of url= and rewrite-url= are sent Squid does
4663 Do not change the URL.
4666 An internal error occurred in the helper, preventing
4667 a result being identified. The 'message=' key name is
4668 reserved for delivering a log message.
4671 In the future, the interface protocol will be extended with
4672 key=value pairs ("kv-pairs" shown above). Helper programs
4673 should be prepared to receive and possibly ignore additional
4674 whitespace-separated tokens on each input line.
4676 When using the concurrency= option the protocol is changed by
4677 introducing a query channel tag in front of the request/response.
4678 The query channel tag is a number between 0 and concurrency-1.
4679 This value must be echoed back unchanged to Squid as the first part
4680 of the response relating to its request.
4682 WARNING: URL re-writing ability should be avoided whenever possible.
4683 Use the URL redirect form of response instead.
4685 Re-write creates a difference in the state held by the client
4686 and server. Possibly causing confusion when the server response
4687 contains snippets of its view state. Embeded URLs, response
4688 and content Location headers, etc. are not re-written by this
4691 By default, a URL rewriter is not used.
4694 NAME: url_rewrite_children redirect_children
4695 TYPE: HelperChildConfig
4696 DEFAULT: 20 startup=0 idle=1 concurrency=0
4697 LOC: Config.redirectChildren
4699 The maximum number of redirector processes to spawn. If you limit
4700 it too few Squid will have to wait for them to process a backlog of
4701 URLs, slowing it down. If you allow too many they will use RAM
4702 and other system resources noticably.
4704 The startup= and idle= options allow some measure of skew in your
4709 Sets a minimum of how many processes are to be spawned when Squid
4710 starts or reconfigures. When set to zero the first request will
4711 cause spawning of the first child process to handle it.
4713 Starting too few will cause an initial slowdown in traffic as Squid
4714 attempts to simultaneously spawn enough processes to cope.
4718 Sets a minimum of how many processes Squid is to try and keep available
4719 at all times. When traffic begins to rise above what the existing
4720 processes can handle this many more will be spawned up to the maximum
4721 configured. A minimum setting of 1 is required.
4725 The number of requests each redirector helper can handle in
4726 parallel. Defaults to 0 which indicates the redirector
4727 is a old-style single threaded redirector.
4729 When this directive is set to a value >= 1 then the protocol
4730 used to communicate with the helper is modified to include
4731 an ID in front of the request/response. The ID from the request
4732 must be echoed back with the response to that request.
4735 NAME: url_rewrite_host_header redirect_rewrites_host_header
4738 LOC: Config.onoff.redir_rewrites_host
4740 To preserve same-origin security policies in browsers and
4741 prevent Host: header forgery by redirectors Squid rewrites
4742 any Host: header in redirected requests.
4744 If you are running an accelerator this may not be a wanted
4745 effect of a redirector. This directive enables you disable
4746 Host: alteration in reverse-proxy traffic.
4748 WARNING: Entries are cached on the result of the URL rewriting
4749 process, so be careful if you have domain-virtual hosts.
4751 WARNING: Squid and other software verifies the URL and Host
4752 are matching, so be careful not to relay through other proxies
4753 or inspecting firewalls with this disabled.
4756 NAME: url_rewrite_access redirector_access
4759 DEFAULT_DOC: Allow, unless rules exist in squid.conf.
4760 LOC: Config.accessList.redirector
4762 If defined, this access list specifies which requests are
4763 sent to the redirector processes.
4765 This clause supports both fast and slow acl types.
4766 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
4769 NAME: url_rewrite_bypass redirector_bypass
4771 LOC: Config.onoff.redirector_bypass
4774 When this is 'on', a request will not go through the
4775 redirector if all the helpers are busy. If this is 'off'
4776 and the redirector queue grows too large, Squid will exit
4777 with a FATAL error and ask you to increase the number of
4778 redirectors. You should only enable this if the redirectors
4779 are not critical to your caching system. If you use
4780 redirectors for access control, and you enable this option,
4781 users may have access to pages they should not
4782 be allowed to request.
4785 NAME: url_rewrite_extras
4786 TYPE: TokenOrQuotedString
4787 LOC: Config.redirector_extras
4788 DEFAULT: "%>a/%>A %un %>rm myip=%la myport=%lp"
4790 Specifies a string to be append to request line format for the
4791 rewriter helper. "Quoted" format values may contain spaces and
4792 logformat %macros. In theory, any logformat %macro can be used.
4793 In practice, a %macro expands as a dash (-) if the helper request is
4794 sent before the required macro information is available to Squid.
4798 OPTIONS FOR STORE ID
4799 -----------------------------------------------------------------------------
4802 NAME: store_id_program storeurl_rewrite_program
4804 LOC: Config.Program.store_id
4807 Specify the location of the executable StoreID helper to use.
4808 Since they can perform almost any function there isn't one included.
4810 For each requested URL, the helper will receive one line with the format
4812 [channel-ID <SP>] URL [<SP> extras]<NL>
4815 After processing the request the helper must reply using the following format:
4817 [channel-ID <SP>] result [<SP> kv-pairs]
4819 The result code can be:
4822 Use the StoreID supplied in 'store-id='.
4825 The default is to use HTTP request URL as the store ID.
4828 An internal error occured in the helper, preventing
4829 a result being identified.
4832 Helper programs should be prepared to receive and possibly ignore
4833 additional whitespace-separated tokens on each input line.
4835 When using the concurrency= option the protocol is changed by
4836 introducing a query channel tag in front of the request/response.
4837 The query channel tag is a number between 0 and concurrency-1.
4838 This value must be echoed back unchanged to Squid as the first part
4839 of the response relating to its request.
4841 NOTE: when using StoreID refresh_pattern will apply to the StoreID
4842 returned from the helper and not the URL.
4844 WARNING: Wrong StoreID value returned by a careless helper may result
4845 in the wrong cached response returned to the user.
4847 By default, a StoreID helper is not used.
4850 NAME: store_id_extras
4851 TYPE: TokenOrQuotedString
4852 LOC: Config.storeId_extras
4853 DEFAULT: "%>a/%>A %un %>rm myip=%la myport=%lp"
4855 Specifies a string to be append to request line format for the
4856 StoreId helper. "Quoted" format values may contain spaces and
4857 logformat %macros. In theory, any logformat %macro can be used.
4858 In practice, a %macro expands as a dash (-) if the helper request is
4859 sent before the required macro information is available to Squid.
4862 NAME: store_id_children storeurl_rewrite_children
4863 TYPE: HelperChildConfig
4864 DEFAULT: 20 startup=0 idle=1 concurrency=0
4865 LOC: Config.storeIdChildren
4867 The maximum number of StoreID helper processes to spawn. If you limit
4868 it too few Squid will have to wait for them to process a backlog of
4869 requests, slowing it down. If you allow too many they will use RAM
4870 and other system resources noticably.
4872 The startup= and idle= options allow some measure of skew in your
4877 Sets a minimum of how many processes are to be spawned when Squid
4878 starts or reconfigures. When set to zero the first request will
4879 cause spawning of the first child process to handle it.
4881 Starting too few will cause an initial slowdown in traffic as Squid
4882 attempts to simultaneously spawn enough processes to cope.
4886 Sets a minimum of how many processes Squid is to try and keep available
4887 at all times. When traffic begins to rise above what the existing
4888 processes can handle this many more will be spawned up to the maximum
4889 configured. A minimum setting of 1 is required.
4893 The number of requests each storeID helper can handle in
4894 parallel. Defaults to 0 which indicates the helper
4895 is a old-style single threaded program.
4897 When this directive is set to a value >= 1 then the protocol
4898 used to communicate with the helper is modified to include
4899 an ID in front of the request/response. The ID from the request
4900 must be echoed back with the response to that request.
4903 NAME: store_id_access storeurl_rewrite_access
4906 DEFAULT_DOC: Allow, unless rules exist in squid.conf.
4907 LOC: Config.accessList.store_id
4909 If defined, this access list specifies which requests are
4910 sent to the StoreID processes. By default all requests
4913 This clause supports both fast and slow acl types.
4914 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
4917 NAME: store_id_bypass storeurl_rewrite_bypass
4919 LOC: Config.onoff.store_id_bypass
4922 When this is 'on', a request will not go through the
4923 helper if all helpers are busy. If this is 'off'
4924 and the helper queue grows too large, Squid will exit
4925 with a FATAL error and ask you to increase the number of
4926 helpers. You should only enable this if the helperss
4927 are not critical to your caching system. If you use
4928 helpers for critical caching components, and you enable this
4929 option, users may not get objects from cache.
4933 OPTIONS FOR TUNING THE CACHE
4934 -----------------------------------------------------------------------------
4937 NAME: cache no_cache
4940 DEFAULT_DOC: By default, this directive is unused and has no effect.
4941 LOC: Config.accessList.noCache
4943 Requests denied by this directive will not be served from the cache
4944 and their responses will not be stored in the cache. This directive
4945 has no effect on other transactions and on already cached responses.
4947 This clause supports both fast and slow acl types.
4948 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
4950 This and the two other similar caching directives listed below are
4951 checked at different transaction processing stages, have different
4952 access to response information, affect different cache operations,
4953 and differ in slow ACLs support:
4955 * cache: Checked before Squid makes a hit/miss determination.
4956 No access to reply information!
4957 Denies both serving a hit and storing a miss.
4958 Supports both fast and slow ACLs.
4959 * send_hit: Checked after a hit was detected.
4960 Has access to reply (hit) information.
4961 Denies serving a hit only.
4962 Supports fast ACLs only.
4963 * store_miss: Checked before storing a cachable miss.
4964 Has access to reply (miss) information.
4965 Denies storing a miss only.
4966 Supports fast ACLs only.
4968 If you are not sure which of the three directives to use, apply the
4969 following decision logic:
4971 * If your ACL(s) are of slow type _and_ need response info, redesign.
4972 Squid does not support that particular combination at this time.
4974 * If your directive ACL(s) are of slow type, use "cache"; and/or
4975 * if your directive ACL(s) need no response info, use "cache".
4977 * If you do not want the response cached, use store_miss; and/or
4978 * if you do not want a hit on a cached response, use send_hit.
4984 DEFAULT_DOC: By default, this directive is unused and has no effect.
4985 LOC: Config.accessList.sendHit
4987 Responses denied by this directive will not be served from the cache
4988 (but may still be cached, see store_miss). This directive has no
4989 effect on the responses it allows and on the cached objects.
4991 Please see the "cache" directive for a summary of differences among
4992 store_miss, send_hit, and cache directives.
4994 Unlike the "cache" directive, send_hit only supports fast acl
4995 types. See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
4999 # apply custom Store ID mapping to some URLs
5000 acl MapMe dstdomain .c.example.com
5001 store_id_program ...
5002 store_id_access allow MapMe
5004 # but prevent caching of special responses
5005 # such as 302 redirects that cause StoreID loops
5006 acl Ordinary http_status 200-299
5007 store_miss deny MapMe !Ordinary
5009 # and do not serve any previously stored special responses
5010 # from the cache (in case they were already cached before
5011 # the above store_miss rule was in effect).
5012 send_hit deny MapMe !Ordinary
5018 DEFAULT_DOC: By default, this directive is unused and has no effect.
5019 LOC: Config.accessList.storeMiss
5021 Responses denied by this directive will not be cached (but may still
5022 be served from the cache, see send_hit). This directive has no
5023 effect on the responses it allows and on the already cached responses.
5025 Please see the "cache" directive for a summary of differences among
5026 store_miss, send_hit, and cache directives. See the
5027 send_hit directive for a usage example.
5029 Unlike the "cache" directive, store_miss only supports fast acl
5030 types. See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
5036 LOC: Config.maxStale
5039 This option puts an upper limit on how stale content Squid
5040 will serve from the cache if cache validation fails.
5041 Can be overriden by the refresh_pattern max-stale option.
5044 NAME: refresh_pattern
5045 TYPE: refreshpattern
5049 usage: refresh_pattern [-i] regex min percent max [options]
5051 By default, regular expressions are CASE-SENSITIVE. To make
5052 them case-insensitive, use the -i option.
5054 'Min' is the time (in minutes) an object without an explicit
5055 expiry time should be considered fresh. The recommended
5056 value is 0, any higher values may cause dynamic applications
5057 to be erroneously cached unless the application designer
5058 has taken the appropriate actions.
5060 'Percent' is a percentage of the objects age (time since last
5061 modification age) an object without explicit expiry time
5062 will be considered fresh.
5064 'Max' is an upper limit on how long objects without an explicit
5065 expiry time will be considered fresh.
5067 options: override-expire
5072 ignore-must-revalidate
5079 override-expire enforces min age even if the server
5080 sent an explicit expiry time (e.g., with the
5081 Expires: header or Cache-Control: max-age). Doing this
5082 VIOLATES the HTTP standard. Enabling this feature
5083 could make you liable for problems which it causes.
5085 Note: override-expire does not enforce staleness - it only extends
5086 freshness / min. If the server returns a Expires time which
5087 is longer than your max time, Squid will still consider
5088 the object fresh for that period of time.
5090 override-lastmod enforces min age even on objects
5091 that were modified recently.
5093 reload-into-ims changes a client no-cache or ``reload''
5094 request for a cached entry into a conditional request using
5095 If-Modified-Since and/or If-None-Match headers, provided the
5096 cached entry has a Last-Modified and/or a strong ETag header.
5097 Doing this VIOLATES the HTTP standard. Enabling this feature
5098 could make you liable for problems which it causes.
5100 ignore-reload ignores a client no-cache or ``reload''
5101 header. Doing this VIOLATES the HTTP standard. Enabling
5102 this feature could make you liable for problems which
5105 ignore-no-store ignores any ``Cache-control: no-store''
5106 headers received from a server. Doing this VIOLATES
5107 the HTTP standard. Enabling this feature could make you
5108 liable for problems which it causes.
5110 ignore-must-revalidate ignores any ``Cache-Control: must-revalidate``
5111 headers received from a server. Doing this VIOLATES
5112 the HTTP standard. Enabling this feature could make you
5113 liable for problems which it causes.
5115 ignore-private ignores any ``Cache-control: private''
5116 headers received from a server. Doing this VIOLATES
5117 the HTTP standard. Enabling this feature could make you
5118 liable for problems which it causes.
5120 ignore-auth caches responses to requests with authorization,
5121 as if the originserver had sent ``Cache-control: public''
5122 in the response header. Doing this VIOLATES the HTTP standard.
5123 Enabling this feature could make you liable for problems which
5126 refresh-ims causes squid to contact the origin server
5127 when a client issues an If-Modified-Since request. This
5128 ensures that the client will receive an updated version
5129 if one is available.
5131 store-stale stores responses even if they don't have explicit
5132 freshness or a validator (i.e., Last-Modified or an ETag)
5133 present, or if they're already stale. By default, Squid will
5134 not cache such responses because they usually can't be
5135 reused. Note that such responses will be stale by default.
5137 max-stale=NN provide a maximum staleness factor. Squid won't
5138 serve objects more stale than this even if it failed to
5139 validate the object. Default: use the max_stale global limit.
5141 Basically a cached object is:
5143 FRESH if expires < now, else STALE
5145 FRESH if lm-factor < percent, else STALE
5149 The refresh_pattern lines are checked in the order listed here.
5150 The first entry which matches is used. If none of the entries
5151 match the default will be used.
5153 Note, you must uncomment all the default lines if you want
5154 to change one. The default setting is only active if none is
5160 # Add any of your own refresh_pattern entries above these.
5162 refresh_pattern ^ftp: 1440 20% 10080
5163 refresh_pattern ^gopher: 1440 0% 1440
5164 refresh_pattern -i (/cgi-bin/|\?) 0 0% 0
5165 refresh_pattern . 0 20% 4320
5169 NAME: quick_abort_min
5173 LOC: Config.quickAbort.min
5176 NAME: quick_abort_max
5180 LOC: Config.quickAbort.max
5183 NAME: quick_abort_pct
5187 LOC: Config.quickAbort.pct
5189 The cache by default continues downloading aborted requests
5190 which are almost completed (less than 16 KB remaining). This
5191 may be undesirable on slow (e.g. SLIP) links and/or very busy
5192 caches. Impatient users may tie up file descriptors and
5193 bandwidth by repeatedly requesting and immediately aborting
5196 When the user aborts a request, Squid will check the
5197 quick_abort values to the amount of data transfered until
5200 If the transfer has less than 'quick_abort_min' KB remaining,
5201 it will finish the retrieval.
5203 If the transfer has more than 'quick_abort_max' KB remaining,
5204 it will abort the retrieval.
5206 If more than 'quick_abort_pct' of the transfer has completed,
5207 it will finish the retrieval.
5209 If you do not want any retrieval to continue after the client
5210 has aborted, set both 'quick_abort_min' and 'quick_abort_max'
5213 If you want retrievals to always continue if they are being
5214 cached set 'quick_abort_min' to '-1 KB'.
5217 NAME: read_ahead_gap
5218 COMMENT: buffer-size
5220 LOC: Config.readAheadGap
5223 The amount of data the cache will buffer ahead of what has been
5224 sent to the client when retrieving an object from another server.
5228 IFDEF: USE_HTTP_VIOLATIONS
5231 LOC: Config.negativeTtl
5234 Set the Default Time-to-Live (TTL) for failed requests.
5235 Certain types of failures (such as "connection refused" and
5236 "404 Not Found") are able to be negatively-cached for a short time.
5237 Modern web servers should provide Expires: header, however if they
5238 do not this can provide a minimum TTL.
5239 The default is not to cache errors with unknown expiry details.
5241 Note that this is different from negative caching of DNS lookups.
5243 WARNING: Doing this VIOLATES the HTTP standard. Enabling
5244 this feature could make you liable for problems which it
5248 NAME: positive_dns_ttl
5251 LOC: Config.positiveDnsTtl
5254 Upper limit on how long Squid will cache positive DNS responses.
5255 Default is 6 hours (360 minutes). This directive must be set
5256 larger than negative_dns_ttl.
5259 NAME: negative_dns_ttl
5262 LOC: Config.negativeDnsTtl
5265 Time-to-Live (TTL) for negative caching of failed DNS lookups.
5266 This also sets the lower cache limit on positive lookups.
5267 Minimum value is 1 second, and it is not recommendable to go
5268 much below 10 seconds.
5271 NAME: range_offset_limit
5272 COMMENT: size [acl acl...]
5274 LOC: Config.rangeOffsetLimit
5277 usage: (size) [units] [[!]aclname]
5279 Sets an upper limit on how far (number of bytes) into the file
5280 a Range request may be to cause Squid to prefetch the whole file.
5281 If beyond this limit, Squid forwards the Range request as it is and
5282 the result is NOT cached.
5284 This is to stop a far ahead range request (lets say start at 17MB)
5285 from making Squid fetch the whole object up to that point before
5286 sending anything to the client.
5288 Multiple range_offset_limit lines may be specified, and they will
5289 be searched from top to bottom on each request until a match is found.
5290 The first match found will be used. If no line matches a request, the
5291 default limit of 0 bytes will be used.
5293 'size' is the limit specified as a number of units.
5295 'units' specifies whether to use bytes, KB, MB, etc.
5296 If no units are specified bytes are assumed.
5298 A size of 0 causes Squid to never fetch more than the
5299 client requested. (default)
5301 A size of 'none' causes Squid to always fetch the object from the
5302 beginning so it may cache the result. (2.0 style)
5304 'aclname' is the name of a defined ACL.
5306 NP: Using 'none' as the byte value here will override any quick_abort settings
5307 that may otherwise apply to the range request. The range request will
5308 be fully fetched from start to finish regardless of the client
5309 actions. This affects bandwidth usage.
5312 NAME: minimum_expiry_time
5315 LOC: Config.minimum_expiry_time
5318 The minimum caching time according to (Expires - Date)
5319 headers Squid honors if the object can't be revalidated.
5320 The default is 60 seconds.
5322 In reverse proxy environments it might be desirable to honor
5323 shorter object lifetimes. It is most likely better to make
5324 your server return a meaningful Last-Modified header however.
5326 In ESI environments where page fragments often have short
5327 lifetimes, this will often be best set to 0.
5330 NAME: store_avg_object_size
5334 LOC: Config.Store.avgObjectSize
5336 Average object size, used to estimate number of objects your
5337 cache can hold. The default is 13 KB.
5339 This is used to pre-seed the cache index memory allocation to
5340 reduce expensive reallocate operations while handling clients
5341 traffic. Too-large values may result in memory allocation during
5342 peak traffic, too-small values will result in wasted memory.
5344 Check the cache manager 'info' report metrics for the real
5345 object sizes seen by your Squid before tuning this.
5348 NAME: store_objects_per_bucket
5351 LOC: Config.Store.objectsPerBucket
5353 Target number of objects per bucket in the store hash table.
5354 Lowering this value increases the total number of buckets and
5355 also the storage maintenance rate. The default is 20.
5360 -----------------------------------------------------------------------------
5363 NAME: request_header_max_size
5367 LOC: Config.maxRequestHeaderSize
5369 This specifies the maximum size for HTTP headers in a request.
5370 Request headers are usually relatively small (about 512 bytes).
5371 Placing a limit on the request header size will catch certain
5372 bugs (for example with persistent connections) and possibly
5373 buffer-overflow or denial-of-service attacks.
5376 NAME: reply_header_max_size
5380 LOC: Config.maxReplyHeaderSize
5382 This specifies the maximum size for HTTP headers in a reply.
5383 Reply headers are usually relatively small (about 512 bytes).
5384 Placing a limit on the reply header size will catch certain
5385 bugs (for example with persistent connections) and possibly
5386 buffer-overflow or denial-of-service attacks.
5389 NAME: request_body_max_size
5393 DEFAULT_DOC: No limit.
5394 LOC: Config.maxRequestBodySize
5396 This specifies the maximum size for an HTTP request body.
5397 In other words, the maximum size of a PUT/POST request.
5398 A user who attempts to send a request with a body larger
5399 than this limit receives an "Invalid Request" error message.
5400 If you set this parameter to a zero (the default), there will
5401 be no limit imposed.
5403 See also client_request_buffer_max_size for an alternative
5404 limitation on client uploads which can be configured.
5407 NAME: client_request_buffer_max_size
5411 LOC: Config.maxRequestBufferSize
5413 This specifies the maximum buffer size of a client request.
5414 It prevents squid eating too much memory when somebody uploads
5418 NAME: chunked_request_body_max_size
5422 LOC: Config.maxChunkedRequestBodySize
5424 A broken or confused HTTP/1.1 client may send a chunked HTTP
5425 request to Squid. Squid does not have full support for that
5426 feature yet. To cope with such requests, Squid buffers the
5427 entire request and then dechunks request body to create a
5428 plain HTTP/1.0 request with a known content length. The plain
5429 request is then used by the rest of Squid code as usual.
5431 The option value specifies the maximum size of the buffer used
5432 to hold the request before the conversion. If the chunked
5433 request size exceeds the specified limit, the conversion
5434 fails, and the client receives an "unsupported request" error,
5435 as if dechunking was disabled.
5437 Dechunking is enabled by default. To disable conversion of
5438 chunked requests, set the maximum to zero.
5440 Request dechunking feature and this option in particular are a
5441 temporary hack. When chunking requests and responses are fully
5442 supported, there will be no need to buffer a chunked request.
5446 IFDEF: USE_HTTP_VIOLATIONS
5449 DEFAULT_DOC: Obey RFC 2616.
5450 LOC: Config.accessList.brokenPosts
5452 A list of ACL elements which, if matched, causes Squid to send
5453 an extra CRLF pair after the body of a PUT/POST request.
5455 Some HTTP servers has broken implementations of PUT/POST,
5456 and rely on an extra CRLF pair sent by some WWW clients.
5458 Quote from RFC2616 section 4.1 on this matter:
5460 Note: certain buggy HTTP/1.0 client implementations generate an
5461 extra CRLF's after a POST request. To restate what is explicitly
5462 forbidden by the BNF, an HTTP/1.1 client must not preface or follow
5463 a request with an extra CRLF.
5465 This clause only supports fast acl types.
5466 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
5469 acl buggy_server url_regex ^http://....
5470 broken_posts allow buggy_server
5473 NAME: adaptation_uses_indirect_client icap_uses_indirect_client
5476 IFDEF: FOLLOW_X_FORWARDED_FOR&&USE_ADAPTATION
5478 LOC: Adaptation::Config::use_indirect_client
5480 Controls whether the indirect client IP address (instead of the direct
5481 client IP address) is passed to adaptation services.
5483 See also: follow_x_forwarded_for adaptation_send_client_ip
5487 IFDEF: USE_HTTP_VIOLATIONS
5491 LOC: Config.onoff.via
5493 If set (default), Squid will include a Via header in requests and
5494 replies as required by RFC2616.
5500 LOC: Config.onoff.ie_refresh
5503 Microsoft Internet Explorer up until version 5.5 Service
5504 Pack 1 has an issue with transparent proxies, wherein it
5505 is impossible to force a refresh. Turning this on provides
5506 a partial fix to the problem, by causing all IMS-REFRESH
5507 requests from older IE versions to check the origin server
5508 for fresh content. This reduces hit ratio by some amount
5509 (~10% in my experience), but allows users to actually get
5510 fresh content when they want it. Note because Squid
5511 cannot tell if the user is using 5.5 or 5.5SP1, the behavior
5512 of 5.5 is unchanged from old versions of Squid (i.e. a
5513 forced refresh is impossible). Newer versions of IE will,
5514 hopefully, continue to have the new behavior and will be
5515 handled based on that assumption. This option defaults to
5516 the old Squid behavior, which is better for hit ratios but
5517 worse for clients using IE, if they need to be able to
5518 force fresh content.
5521 NAME: vary_ignore_expire
5524 LOC: Config.onoff.vary_ignore_expire
5527 Many HTTP servers supporting Vary gives such objects
5528 immediate expiry time with no cache-control header
5529 when requested by a HTTP/1.0 client. This option
5530 enables Squid to ignore such expiry times until
5531 HTTP/1.1 is fully implemented.
5533 WARNING: If turned on this may eventually cause some
5534 varying objects not intended for caching to get cached.
5537 NAME: request_entities
5539 LOC: Config.onoff.request_entities
5542 Squid defaults to deny GET and HEAD requests with request entities,
5543 as the meaning of such requests are undefined in the HTTP standard
5544 even if not explicitly forbidden.
5546 Set this directive to on if you have clients which insists
5547 on sending request entities in GET or HEAD requests. But be warned
5548 that there is server software (both proxies and web servers) which
5549 can fail to properly process this kind of request which may make you
5550 vulnerable to cache pollution attacks if enabled.
5553 NAME: request_header_access
5554 IFDEF: USE_HTTP_VIOLATIONS
5555 TYPE: http_header_access
5556 LOC: Config.request_header_access
5558 DEFAULT_DOC: No limits.
5560 Usage: request_header_access header_name allow|deny [!]aclname ...
5562 WARNING: Doing this VIOLATES the HTTP standard. Enabling
5563 this feature could make you liable for problems which it
5566 This option replaces the old 'anonymize_headers' and the
5567 older 'http_anonymizer' option with something that is much
5568 more configurable. A list of ACLs for each header name allows
5569 removal of specific header fields under specific conditions.
5571 This option only applies to outgoing HTTP request headers (i.e.,
5572 headers sent by Squid to the next HTTP hop such as a cache peer
5573 or an origin server). The option has no effect during cache hit
5574 detection. The equivalent adaptation vectoring point in ICAP
5575 terminology is post-cache REQMOD.
5577 The option is applied to individual outgoing request header
5578 fields. For each request header field F, Squid uses the first
5579 qualifying sets of request_header_access rules:
5581 1. Rules with header_name equal to F's name.
5582 2. Rules with header_name 'Other', provided F's name is not
5583 on the hard-coded list of commonly used HTTP header names.
5584 3. Rules with header_name 'All'.
5586 Within that qualifying rule set, rule ACLs are checked as usual.
5587 If ACLs of an "allow" rule match, the header field is allowed to
5588 go through as is. If ACLs of a "deny" rule match, the header is
5589 removed and request_header_replace is then checked to identify
5590 if the removed header has a replacement. If no rules within the
5591 set have matching ACLs, the header field is left as is.
5593 For example, to achieve the same behavior as the old
5594 'http_anonymizer standard' option, you should use:
5596 request_header_access From deny all
5597 request_header_access Referer deny all
5598 request_header_access User-Agent deny all
5600 Or, to reproduce the old 'http_anonymizer paranoid' feature
5603 request_header_access Authorization allow all
5604 request_header_access Proxy-Authorization allow all
5605 request_header_access Cache-Control allow all
5606 request_header_access Content-Length allow all
5607 request_header_access Content-Type allow all
5608 request_header_access Date allow all
5609 request_header_access Host allow all
5610 request_header_access If-Modified-Since allow all
5611 request_header_access Pragma allow all
5612 request_header_access Accept allow all
5613 request_header_access Accept-Charset allow all
5614 request_header_access Accept-Encoding allow all
5615 request_header_access Accept-Language allow all
5616 request_header_access Connection allow all
5617 request_header_access All deny all
5619 HTTP reply headers are controlled with the reply_header_access directive.
5621 By default, all headers are allowed (no anonymizing is performed).
5624 NAME: reply_header_access
5625 IFDEF: USE_HTTP_VIOLATIONS
5626 TYPE: http_header_access
5627 LOC: Config.reply_header_access
5629 DEFAULT_DOC: No limits.
5631 Usage: reply_header_access header_name allow|deny [!]aclname ...
5633 WARNING: Doing this VIOLATES the HTTP standard. Enabling
5634 this feature could make you liable for problems which it
5637 This option only applies to reply headers, i.e., from the
5638 server to the client.
5640 This is the same as request_header_access, but in the other
5641 direction. Please see request_header_access for detailed
5644 For example, to achieve the same behavior as the old
5645 'http_anonymizer standard' option, you should use:
5647 reply_header_access Server deny all
5648 reply_header_access WWW-Authenticate deny all
5649 reply_header_access Link deny all
5651 Or, to reproduce the old 'http_anonymizer paranoid' feature
5654 reply_header_access Allow allow all
5655 reply_header_access WWW-Authenticate allow all
5656 reply_header_access Proxy-Authenticate allow all
5657 reply_header_access Cache-Control allow all
5658 reply_header_access Content-Encoding allow all
5659 reply_header_access Content-Length allow all
5660 reply_header_access Content-Type allow all
5661 reply_header_access Date allow all
5662 reply_header_access Expires allow all
5663 reply_header_access Last-Modified allow all
5664 reply_header_access Location allow all
5665 reply_header_access Pragma allow all
5666 reply_header_access Content-Language allow all
5667 reply_header_access Retry-After allow all
5668 reply_header_access Title allow all
5669 reply_header_access Content-Disposition allow all
5670 reply_header_access Connection allow all
5671 reply_header_access All deny all
5673 HTTP request headers are controlled with the request_header_access directive.
5675 By default, all headers are allowed (no anonymizing is
5679 NAME: request_header_replace header_replace
5680 IFDEF: USE_HTTP_VIOLATIONS
5681 TYPE: http_header_replace
5682 LOC: Config.request_header_access
5685 Usage: request_header_replace header_name message
5686 Example: request_header_replace User-Agent Nutscrape/1.0 (CP/M; 8-bit)
5688 This option allows you to change the contents of headers
5689 denied with request_header_access above, by replacing them
5690 with some fixed string.
5692 This only applies to request headers, not reply headers.
5694 By default, headers are removed if denied.
5697 NAME: reply_header_replace
5698 IFDEF: USE_HTTP_VIOLATIONS
5699 TYPE: http_header_replace
5700 LOC: Config.reply_header_access
5703 Usage: reply_header_replace header_name message
5704 Example: reply_header_replace Server Foo/1.0
5706 This option allows you to change the contents of headers
5707 denied with reply_header_access above, by replacing them
5708 with some fixed string.
5710 This only applies to reply headers, not request headers.
5712 By default, headers are removed if denied.
5715 NAME: request_header_add
5716 TYPE: HeaderWithAclList
5717 LOC: Config.request_header_add
5720 Usage: request_header_add field-name field-value acl1 [acl2] ...
5721 Example: request_header_add X-Client-CA "CA=%ssl::>cert_issuer" all
5723 This option adds header fields to outgoing HTTP requests (i.e.,
5724 request headers sent by Squid to the next HTTP hop such as a
5725 cache peer or an origin server). The option has no effect during
5726 cache hit detection. The equivalent adaptation vectoring point
5727 in ICAP terminology is post-cache REQMOD.
5729 Field-name is a token specifying an HTTP header name. If a
5730 standard HTTP header name is used, Squid does not check whether
5731 the new header conflicts with any existing headers or violates
5732 HTTP rules. If the request to be modified already contains a
5733 field with the same name, the old field is preserved but the
5734 header field values are not merged.
5736 Field-value is either a token or a quoted string. If quoted
5737 string format is used, then the surrounding quotes are removed
5738 while escape sequences and %macros are processed.
5740 In theory, all of the logformat codes can be used as %macros.
5741 However, unlike logging (which happens at the very end of
5742 transaction lifetime), the transaction may not yet have enough
5743 information to expand a macro when the new header value is needed.
5744 And some information may already be available to Squid but not yet
5745 committed where the macro expansion code can access it (report
5746 such instances!). The macro will be expanded into a single dash
5747 ('-') in such cases. Not all macros have been tested.
5749 One or more Squid ACLs may be specified to restrict header
5750 injection to matching requests. As always in squid.conf, all
5751 ACLs in an option ACL list must be satisfied for the insertion
5752 to happen. The request_header_add option supports fast ACLs
5761 This option used to log custom information about the master
5762 transaction. For example, an admin may configure Squid to log
5763 which "user group" the transaction belongs to, where "user group"
5764 will be determined based on a set of ACLs and not [just]
5765 authentication information.
5766 Values of key/value pairs can be logged using %{key}note macros:
5768 note key value acl ...
5769 logformat myFormat ... %{key}note ...
5772 NAME: relaxed_header_parser
5773 COMMENT: on|off|warn
5775 LOC: Config.onoff.relaxed_header_parser
5778 In the default "on" setting Squid accepts certain forms
5779 of non-compliant HTTP messages where it is unambiguous
5780 what the sending application intended even if the message
5781 is not correctly formatted. The messages is then normalized
5782 to the correct form when forwarded by Squid.
5784 If set to "warn" then a warning will be emitted in cache.log
5785 each time such HTTP error is encountered.
5787 If set to "off" then such HTTP errors will cause the request
5788 or response to be rejected.
5791 NAME: collapsed_forwarding
5794 LOC: Config.onoff.collapsed_forwarding
5797 This option controls whether Squid is allowed to merge multiple
5798 potentially cachable requests for the same URI before Squid knows
5799 whether the response is going to be cachable.
5801 This feature is disabled by default: Enabling collapsed forwarding
5802 needlessly delays forwarding requests that look cachable (when they are
5803 collapsed) but then need to be forwarded individually anyway because
5804 they end up being for uncachable content. However, in some cases, such
5805 as accelleration of highly cachable content with periodic or groupped
5806 expiration times, the gains from collapsing [large volumes of
5807 simultenous refresh requests] outweigh losses from such delays.
5812 -----------------------------------------------------------------------------
5815 NAME: forward_timeout
5818 LOC: Config.Timeout.forward
5821 This parameter specifies how long Squid should at most attempt in
5822 finding a forwarding path for the request before giving up.
5825 NAME: connect_timeout
5828 LOC: Config.Timeout.connect
5831 This parameter specifies how long to wait for the TCP connect to
5832 the requested server or peer to complete before Squid should
5833 attempt to find another path where to forward the request.
5836 NAME: peer_connect_timeout
5839 LOC: Config.Timeout.peer_connect
5842 This parameter specifies how long to wait for a pending TCP
5843 connection to a peer cache. The default is 30 seconds. You
5844 may also set different timeout values for individual neighbors
5845 with the 'connect-timeout' option on a 'cache_peer' line.
5851 LOC: Config.Timeout.read
5854 The read_timeout is applied on server-side connections. After
5855 each successful read(), the timeout will be extended by this
5856 amount. If no data is read again after this amount of time,
5857 the request is aborted and logged with ERR_READ_TIMEOUT. The
5858 default is 15 minutes.
5864 LOC: Config.Timeout.write
5867 This timeout is tracked for all connections that have data
5868 available for writing and are waiting for the socket to become
5869 ready. After each successful write, the timeout is extended by
5870 the configured amount. If Squid has data to write but the
5871 connection is not ready for the configured duration, the
5872 transaction associated with the connection is terminated. The
5873 default is 15 minutes.
5876 NAME: request_timeout
5878 LOC: Config.Timeout.request
5881 How long to wait for complete HTTP request headers after initial
5882 connection establishment.
5885 NAME: client_idle_pconn_timeout persistent_request_timeout
5887 LOC: Config.Timeout.clientIdlePconn
5890 How long to wait for the next HTTP request on a persistent
5891 client connection after the previous request completes.
5894 NAME: client_lifetime
5897 LOC: Config.Timeout.lifetime
5900 The maximum amount of time a client (browser) is allowed to
5901 remain connected to the cache process. This protects the Cache
5902 from having a lot of sockets (and hence file descriptors) tied up
5903 in a CLOSE_WAIT state from remote clients that go away without
5904 properly shutting down (either because of a network failure or
5905 because of a poor client implementation). The default is one
5908 NOTE: The default value is intended to be much larger than any
5909 client would ever need to be connected to your cache. You
5910 should probably change client_lifetime only as a last resort.
5911 If you seem to have many client connections tying up
5912 filedescriptors, we recommend first tuning the read_timeout,
5913 request_timeout, persistent_request_timeout and quick_abort values.
5916 NAME: half_closed_clients
5918 LOC: Config.onoff.half_closed_clients
5921 Some clients may shutdown the sending side of their TCP
5922 connections, while leaving their receiving sides open. Sometimes,
5923 Squid can not tell the difference between a half-closed and a
5924 fully-closed TCP connection.
5926 By default, Squid will immediately close client connections when
5927 read(2) returns "no more data to read."
5929 Change this option to 'on' and Squid will keep open connections
5930 until a read(2) or write(2) on the socket returns an error.
5931 This may show some benefits for reverse proxies. But if not
5932 it is recommended to leave OFF.
5935 NAME: server_idle_pconn_timeout pconn_timeout
5937 LOC: Config.Timeout.serverIdlePconn
5940 Timeout for idle persistent connections to servers and other
5947 LOC: Ident::TheConfig.timeout
5950 Maximum time to wait for IDENT lookups to complete.
5952 If this is too high, and you enabled IDENT lookups from untrusted
5953 users, you might be susceptible to denial-of-service by having
5954 many ident requests going at once.
5957 NAME: shutdown_lifetime
5960 LOC: Config.shutdownLifetime
5963 When SIGTERM or SIGHUP is received, the cache is put into
5964 "shutdown pending" mode until all active sockets are closed.
5965 This value is the lifetime to set for all open descriptors
5966 during shutdown mode. Any active clients after this many
5967 seconds will receive a 'timeout' message.
5971 ADMINISTRATIVE PARAMETERS
5972 -----------------------------------------------------------------------------
5978 LOC: Config.adminEmail
5980 Email-address of local cache manager who will receive
5981 mail if the cache dies. The default is "webmaster".
5987 LOC: Config.EmailFrom
5989 From: email-address for mail sent when the cache dies.
5990 The default is to use 'squid@unique_hostname'.
5992 See also: unique_hostname directive.
5998 LOC: Config.EmailProgram
6000 Email program used to send mail if the cache dies.
6001 The default is "mail". The specified program must comply
6002 with the standard Unix mail syntax:
6003 mail-program recipient < mailfile
6005 Optional command line options can be specified.
6008 NAME: cache_effective_user
6010 DEFAULT: @DEFAULT_CACHE_EFFECTIVE_USER@
6011 LOC: Config.effectiveUser
6013 If you start Squid as root, it will change its effective/real
6014 UID/GID to the user specified below. The default is to change
6015 to UID of @DEFAULT_CACHE_EFFECTIVE_USER@.
6016 see also; cache_effective_group
6019 NAME: cache_effective_group
6022 DEFAULT_DOC: Use system group memberships of the cache_effective_user account
6023 LOC: Config.effectiveGroup
6025 Squid sets the GID to the effective user's default group ID
6026 (taken from the password file) and supplementary group list
6027 from the groups membership.
6029 If you want Squid to run with a specific GID regardless of
6030 the group memberships of the effective user then set this
6031 to the group (or GID) you want Squid to run as. When set
6032 all other group privileges of the effective user are ignored
6033 and only this GID is effective. If Squid is not started as
6034 root the user starting Squid MUST be member of the specified
6037 This option is not recommended by the Squid Team.
6038 Our preference is for administrators to configure a secure
6039 user account for squid with UID/GID matching system policies.
6042 NAME: httpd_suppress_version_string
6046 LOC: Config.onoff.httpd_suppress_version_string
6048 Suppress Squid version string info in HTTP headers and HTML error pages.
6051 NAME: visible_hostname
6053 LOC: Config.visibleHostname
6055 DEFAULT_DOC: Automatically detect the system host name
6057 If you want to present a special hostname in error messages, etc,
6058 define this. Otherwise, the return value of gethostname()
6059 will be used. If you have multiple caches in a cluster and
6060 get errors about IP-forwarding you must set them to have individual
6061 names with this setting.
6064 NAME: unique_hostname
6066 LOC: Config.uniqueHostname
6068 DEFAULT_DOC: Copy the value from visible_hostname
6070 If you want to have multiple machines with the same
6071 'visible_hostname' you must give each machine a different
6072 'unique_hostname' so forwarding loops can be detected.
6075 NAME: hostname_aliases
6077 LOC: Config.hostnameAliases
6080 A list of other DNS names your cache has.
6088 Minimum umask which should be enforced while the proxy
6089 is running, in addition to the umask set at startup.
6091 For a traditional octal representation of umasks, start
6096 OPTIONS FOR THE CACHE REGISTRATION SERVICE
6097 -----------------------------------------------------------------------------
6099 This section contains parameters for the (optional) cache
6100 announcement service. This service is provided to help
6101 cache administrators locate one another in order to join or
6102 create cache hierarchies.
6104 An 'announcement' message is sent (via UDP) to the registration
6105 service by Squid. By default, the announcement message is NOT
6106 SENT unless you enable it with 'announce_period' below.
6108 The announcement message includes your hostname, plus the
6109 following information from this configuration file:
6115 All current information is processed regularly and made
6116 available on the Web at http://www.ircache.net/Cache/Tracker/.
6119 NAME: announce_period
6121 LOC: Config.Announce.period
6123 DEFAULT_DOC: Announcement messages disabled.
6125 This is how frequently to send cache announcements.
6127 To enable announcing your cache, just set an announce period.
6130 announce_period 1 day
6135 DEFAULT: tracker.ircache.net
6136 LOC: Config.Announce.host
6138 Set the hostname where announce registration messages will be sent.
6140 See also announce_port and announce_file
6146 LOC: Config.Announce.file
6148 The contents of this file will be included in the announce
6149 registration messages.
6155 LOC: Config.Announce.port
6157 Set the port where announce registration messages will be sent.
6159 See also announce_host and announce_file
6163 HTTPD-ACCELERATOR OPTIONS
6164 -----------------------------------------------------------------------------
6167 NAME: httpd_accel_surrogate_id
6170 DEFAULT_DOC: visible_hostname is used if no specific ID is set.
6171 LOC: Config.Accel.surrogate_id
6173 Surrogates (http://www.esi.org/architecture_spec_1.0.html)
6174 need an identification token to allow control targeting. Because
6175 a farm of surrogates may all perform the same tasks, they may share
6176 an identification token.
6179 NAME: http_accel_surrogate_remote
6183 LOC: Config.onoff.surrogate_is_remote
6185 Remote surrogates (such as those in a CDN) honour the header
6186 "Surrogate-Control: no-store-remote".
6188 Set this to on to have squid behave as a remote surrogate.
6192 IFDEF: USE_SQUID_ESI
6193 COMMENT: libxml2|expat|custom
6195 LOC: ESIParser::Type
6198 ESI markup is not strictly XML compatible. The custom ESI parser
6199 will give higher performance, but cannot handle non ASCII character
6204 DELAY POOL PARAMETERS
6205 -----------------------------------------------------------------------------
6209 TYPE: delay_pool_count
6211 IFDEF: USE_DELAY_POOLS
6214 This represents the number of delay pools to be used. For example,
6215 if you have one class 2 delay pool and one class 3 delays pool, you
6216 have a total of 2 delay pools.
6218 See also delay_parameters, delay_class, delay_access for pool
6219 configuration details.
6223 TYPE: delay_pool_class
6225 IFDEF: USE_DELAY_POOLS
6228 This defines the class of each delay pool. There must be exactly one
6229 delay_class line for each delay pool. For example, to define two
6230 delay pools, one of class 2 and one of class 3, the settings above
6234 delay_pools 4 # 4 delay pools
6235 delay_class 1 2 # pool 1 is a class 2 pool
6236 delay_class 2 3 # pool 2 is a class 3 pool
6237 delay_class 3 4 # pool 3 is a class 4 pool
6238 delay_class 4 5 # pool 4 is a class 5 pool
6240 The delay pool classes are:
6242 class 1 Everything is limited by a single aggregate
6245 class 2 Everything is limited by a single aggregate
6246 bucket as well as an "individual" bucket chosen
6247 from bits 25 through 32 of the IPv4 address.
6249 class 3 Everything is limited by a single aggregate
6250 bucket as well as a "network" bucket chosen
6251 from bits 17 through 24 of the IP address and a
6252 "individual" bucket chosen from bits 17 through
6253 32 of the IPv4 address.
6255 class 4 Everything in a class 3 delay pool, with an
6256 additional limit on a per user basis. This
6257 only takes effect if the username is established
6258 in advance - by forcing authentication in your
6261 class 5 Requests are grouped according their tag (see
6262 external_acl's tag= reply).
6265 Each pool also requires a delay_parameters directive to configure the pool size
6266 and speed limits used whenever the pool is applied to a request. Along with
6267 a set of delay_access directives to determine when it is used.
6269 NOTE: If an IP address is a.b.c.d
6270 -> bits 25 through 32 are "d"
6271 -> bits 17 through 24 are "c"
6272 -> bits 17 through 32 are "c * 256 + d"
6274 NOTE-2: Due to the use of bitmasks in class 2,3,4 pools they only apply to
6275 IPv4 traffic. Class 1 and 5 pools may be used with IPv6 traffic.
6277 This clause only supports fast acl types.
6278 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
6280 See also delay_parameters and delay_access.
6284 TYPE: delay_pool_access
6286 DEFAULT_DOC: Deny using the pool, unless allow rules exist in squid.conf for the pool.
6287 IFDEF: USE_DELAY_POOLS
6290 This is used to determine which delay pool a request falls into.
6292 delay_access is sorted per pool and the matching starts with pool 1,
6293 then pool 2, ..., and finally pool N. The first delay pool where the
6294 request is allowed is selected for the request. If it does not allow
6295 the request to any pool then the request is not delayed (default).
6297 For example, if you want some_big_clients in delay
6298 pool 1 and lotsa_little_clients in delay pool 2:
6300 delay_access 1 allow some_big_clients
6301 delay_access 1 deny all
6302 delay_access 2 allow lotsa_little_clients
6303 delay_access 2 deny all
6304 delay_access 3 allow authenticated_clients
6306 See also delay_parameters and delay_class.
6310 NAME: delay_parameters
6311 TYPE: delay_pool_rates
6313 IFDEF: USE_DELAY_POOLS
6316 This defines the parameters for a delay pool. Each delay pool has
6317 a number of "buckets" associated with it, as explained in the
6318 description of delay_class.
6320 For a class 1 delay pool, the syntax is:
6322 delay_parameters pool aggregate
6324 For a class 2 delay pool:
6326 delay_parameters pool aggregate individual
6328 For a class 3 delay pool:
6330 delay_parameters pool aggregate network individual
6332 For a class 4 delay pool:
6334 delay_parameters pool aggregate network individual user
6336 For a class 5 delay pool:
6338 delay_parameters pool tagrate
6340 The option variables are:
6342 pool a pool number - ie, a number between 1 and the
6343 number specified in delay_pools as used in
6346 aggregate the speed limit parameters for the aggregate bucket
6349 individual the speed limit parameters for the individual
6350 buckets (class 2, 3).
6352 network the speed limit parameters for the network buckets
6355 user the speed limit parameters for the user buckets
6358 tagrate the speed limit parameters for the tag buckets
6361 A pair of delay parameters is written restore/maximum, where restore is
6362 the number of bytes (not bits - modem and network speeds are usually
6363 quoted in bits) per second placed into the bucket, and maximum is the
6364 maximum number of bytes which can be in the bucket at any time.
6366 There must be one delay_parameters line for each delay pool.
6369 For example, if delay pool number 1 is a class 2 delay pool as in the
6370 above example, and is being used to strictly limit each host to 64Kbit/sec
6371 (plus overheads), with no overall limit, the line is:
6373 delay_parameters 1 -1/-1 8000/8000
6375 Note that 8 x 8000 KByte/sec -> 64Kbit/sec.
6377 Note that the figure -1 is used to represent "unlimited".
6380 And, if delay pool number 2 is a class 3 delay pool as in the above
6381 example, and you want to limit it to a total of 256Kbit/sec (strict limit)
6382 with each 8-bit network permitted 64Kbit/sec (strict limit) and each
6383 individual host permitted 4800bit/sec with a bucket maximum size of 64Kbits
6384 to permit a decent web page to be downloaded at a decent speed
6385 (if the network is not being limited due to overuse) but slow down
6386 large downloads more significantly:
6388 delay_parameters 2 32000/32000 8000/8000 600/8000
6390 Note that 8 x 32000 KByte/sec -> 256Kbit/sec.
6391 8 x 8000 KByte/sec -> 64Kbit/sec.
6392 8 x 600 Byte/sec -> 4800bit/sec.
6395 Finally, for a class 4 delay pool as in the example - each user will
6396 be limited to 128Kbits/sec no matter how many workstations they are logged into.:
6398 delay_parameters 4 32000/32000 8000/8000 600/64000 16000/16000
6401 See also delay_class and delay_access.
6405 NAME: delay_initial_bucket_level
6406 COMMENT: (percent, 0-100)
6409 IFDEF: USE_DELAY_POOLS
6410 LOC: Config.Delay.initial
6412 The initial bucket percentage is used to determine how much is put
6413 in each bucket when squid starts, is reconfigured, or first notices
6414 a host accessing it (in class 2 and class 3, individual hosts and
6415 networks only have buckets associated with them once they have been
6420 CLIENT DELAY POOL PARAMETERS
6421 -----------------------------------------------------------------------------
6424 NAME: client_delay_pools
6425 TYPE: client_delay_pool_count
6427 IFDEF: USE_DELAY_POOLS
6428 LOC: Config.ClientDelay
6430 This option specifies the number of client delay pools used. It must
6431 preceed other client_delay_* options.
6434 client_delay_pools 2
6436 See also client_delay_parameters and client_delay_access.
6439 NAME: client_delay_initial_bucket_level
6440 COMMENT: (percent, 0-no_limit)
6443 IFDEF: USE_DELAY_POOLS
6444 LOC: Config.ClientDelay.initial
6446 This option determines the initial bucket size as a percentage of
6447 max_bucket_size from client_delay_parameters. Buckets are created
6448 at the time of the "first" connection from the matching IP. Idle
6449 buckets are periodically deleted up.
6451 You can specify more than 100 percent but note that such "oversized"
6452 buckets are not refilled until their size goes down to max_bucket_size
6453 from client_delay_parameters.
6456 client_delay_initial_bucket_level 50
6459 NAME: client_delay_parameters
6460 TYPE: client_delay_pool_rates
6462 IFDEF: USE_DELAY_POOLS
6463 LOC: Config.ClientDelay
6466 This option configures client-side bandwidth limits using the
6469 client_delay_parameters pool speed_limit max_bucket_size
6471 pool is an integer ID used for client_delay_access matching.
6473 speed_limit is bytes added to the bucket per second.
6475 max_bucket_size is the maximum size of a bucket, enforced after any
6476 speed_limit additions.
6478 Please see the delay_parameters option for more information and
6482 client_delay_parameters 1 1024 2048
6483 client_delay_parameters 2 51200 16384
6485 See also client_delay_access.
6489 NAME: client_delay_access
6490 TYPE: client_delay_pool_access
6492 DEFAULT_DOC: Deny use of the pool, unless allow rules exist in squid.conf for the pool.
6493 IFDEF: USE_DELAY_POOLS
6494 LOC: Config.ClientDelay
6496 This option determines the client-side delay pool for the
6499 client_delay_access pool_ID allow|deny acl_name
6501 All client_delay_access options are checked in their pool ID
6502 order, starting with pool 1. The first checked pool with allowed
6503 request is selected for the request. If no ACL matches or there
6504 are no client_delay_access options, the request bandwidth is not
6507 The ACL-selected pool is then used to find the
6508 client_delay_parameters for the request. Client-side pools are
6509 not used to aggregate clients. Clients are always aggregated
6510 based on their source IP addresses (one bucket per source IP).
6512 This clause only supports fast acl types.
6513 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
6514 Additionally, only the client TCP connection details are available.
6515 ACLs testing HTTP properties will not work.
6517 Please see delay_access for more examples.
6520 client_delay_access 1 allow low_rate_network
6521 client_delay_access 2 allow vips_network
6524 See also client_delay_parameters and client_delay_pools.
6528 WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS
6529 -----------------------------------------------------------------------------
6534 LOC: Config.Wccp.router
6536 DEFAULT_DOC: WCCP disabled.
6539 Use this option to define your WCCP ``home'' router for
6542 wccp_router supports a single WCCP(v1) router
6544 wccp2_router supports multiple WCCPv2 routers
6546 only one of the two may be used at the same time and defines
6547 which version of WCCP to use.
6551 TYPE: IpAddress_list
6552 LOC: Config.Wccp2.router
6554 DEFAULT_DOC: WCCPv2 disabled.
6557 Use this option to define your WCCP ``home'' router for
6560 wccp_router supports a single WCCP(v1) router
6562 wccp2_router supports multiple WCCPv2 routers
6564 only one of the two may be used at the same time and defines
6565 which version of WCCP to use.
6570 LOC: Config.Wccp.version
6574 This directive is only relevant if you need to set up WCCP(v1)
6575 to some very old and end-of-life Cisco routers. In all other
6576 setups it must be left unset or at the default setting.
6577 It defines an internal version in the WCCP(v1) protocol,
6578 with version 4 being the officially documented protocol.
6580 According to some users, Cisco IOS 11.2 and earlier only
6581 support WCCP version 3. If you're using that or an earlier
6582 version of IOS, you may need to change this value to 3, otherwise
6583 do not specify this parameter.
6586 NAME: wccp2_rebuild_wait
6588 LOC: Config.Wccp2.rebuildwait
6592 If this is enabled Squid will wait for the cache dir rebuild to finish
6593 before sending the first wccp2 HereIAm packet
6596 NAME: wccp2_forwarding_method
6598 LOC: Config.Wccp2.forwarding_method
6602 WCCP2 allows the setting of forwarding methods between the
6603 router/switch and the cache. Valid values are as follows:
6605 gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
6606 l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting)
6608 Currently (as of IOS 12.4) cisco routers only support GRE.
6609 Cisco switches only support the L2 redirect assignment method.
6612 NAME: wccp2_return_method
6614 LOC: Config.Wccp2.return_method
6618 WCCP2 allows the setting of return methods between the
6619 router/switch and the cache for packets that the cache
6620 decides not to handle. Valid values are as follows:
6622 gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
6623 l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting)
6625 Currently (as of IOS 12.4) cisco routers only support GRE.
6626 Cisco switches only support the L2 redirect assignment.
6628 If the "ip wccp redirect exclude in" command has been
6629 enabled on the cache interface, then it is still safe for
6630 the proxy server to use a l2 redirect method even if this
6631 option is set to GRE.
6634 NAME: wccp2_assignment_method
6636 LOC: Config.Wccp2.assignment_method
6640 WCCP2 allows the setting of methods to assign the WCCP hash
6641 Valid values are as follows:
6643 hash - Hash assignment
6644 mask - Mask assignment
6646 As a general rule, cisco routers support the hash assignment method
6647 and cisco switches support the mask assignment method.
6652 LOC: Config.Wccp2.info
6653 DEFAULT_IF_NONE: standard 0
6654 DEFAULT_DOC: Use the 'web-cache' standard service.
6657 WCCP2 allows for multiple traffic services. There are two
6658 types: "standard" and "dynamic". The standard type defines
6659 one service id - http (id 0). The dynamic service ids can be from
6660 51 to 255 inclusive. In order to use a dynamic service id
6661 one must define the type of traffic to be redirected; this is done
6662 using the wccp2_service_info option.
6664 The "standard" type does not require a wccp2_service_info option,
6665 just specifying the service id will suffice.
6667 MD5 service authentication can be enabled by adding
6668 "password=<password>" to the end of this service declaration.
6672 wccp2_service standard 0 # for the 'web-cache' standard service
6673 wccp2_service dynamic 80 # a dynamic service type which will be
6674 # fleshed out with subsequent options.
6675 wccp2_service standard 0 password=foo
6678 NAME: wccp2_service_info
6679 TYPE: wccp2_service_info
6680 LOC: Config.Wccp2.info
6684 Dynamic WCCPv2 services require further information to define the
6685 traffic you wish to have diverted.
6689 wccp2_service_info <id> protocol=<protocol> flags=<flag>,<flag>..
6690 priority=<priority> ports=<port>,<port>..
6692 The relevant WCCPv2 flags:
6693 + src_ip_hash, dst_ip_hash
6694 + source_port_hash, dst_port_hash
6695 + src_ip_alt_hash, dst_ip_alt_hash
6696 + src_port_alt_hash, dst_port_alt_hash
6699 The port list can be one to eight entries.
6703 wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source
6704 priority=240 ports=80
6706 Note: the service id must have been defined by a previous
6707 'wccp2_service dynamic <id>' entry.
6712 LOC: Config.Wccp2.weight
6716 Each cache server gets assigned a set of the destination
6717 hash proportional to their weight.
6722 LOC: Config.Wccp.address
6724 DEFAULT_DOC: Address selected by the operating system.
6727 Use this option if you require WCCPv2 to use a specific
6730 The default behavior is to not bind to any specific address.
6735 LOC: Config.Wccp2.address
6737 DEFAULT_DOC: Address selected by the operating system.
6740 Use this option if you require WCCP to use a specific
6743 The default behavior is to not bind to any specific address.
6747 PERSISTENT CONNECTION HANDLING
6748 -----------------------------------------------------------------------------
6750 Also see "pconn_timeout" in the TIMEOUTS section
6753 NAME: client_persistent_connections
6755 LOC: Config.onoff.client_pconns
6758 Persistent connection support for clients.
6759 Squid uses persistent connections (when allowed). You can use
6760 this option to disable persistent connections with clients.
6763 NAME: server_persistent_connections
6765 LOC: Config.onoff.server_pconns
6768 Persistent connection support for servers.
6769 Squid uses persistent connections (when allowed). You can use
6770 this option to disable persistent connections with servers.
6773 NAME: persistent_connection_after_error
6775 LOC: Config.onoff.error_pconns
6778 With this directive the use of persistent connections after
6779 HTTP errors can be disabled. Useful if you have clients
6780 who fail to handle errors on persistent connections proper.
6783 NAME: detect_broken_pconn
6785 LOC: Config.onoff.detect_broken_server_pconns
6788 Some servers have been found to incorrectly signal the use
6789 of HTTP/1.0 persistent connections even on replies not
6790 compatible, causing significant delays. This server problem
6791 has mostly been seen on redirects.
6793 By enabling this directive Squid attempts to detect such
6794 broken replies and automatically assume the reply is finished
6795 after 10 seconds timeout.
6799 CACHE DIGEST OPTIONS
6800 -----------------------------------------------------------------------------
6803 NAME: digest_generation
6804 IFDEF: USE_CACHE_DIGESTS
6806 LOC: Config.onoff.digest_generation
6809 This controls whether the server will generate a Cache Digest
6810 of its contents. By default, Cache Digest generation is
6811 enabled if Squid is compiled with --enable-cache-digests defined.
6814 NAME: digest_bits_per_entry
6815 IFDEF: USE_CACHE_DIGESTS
6817 LOC: Config.digest.bits_per_entry
6820 This is the number of bits of the server's Cache Digest which
6821 will be associated with the Digest entry for a given HTTP
6822 Method and URL (public key) combination. The default is 5.
6825 NAME: digest_rebuild_period
6826 IFDEF: USE_CACHE_DIGESTS
6829 LOC: Config.digest.rebuild_period
6832 This is the wait time between Cache Digest rebuilds.
6835 NAME: digest_rewrite_period
6837 IFDEF: USE_CACHE_DIGESTS
6839 LOC: Config.digest.rewrite_period
6842 This is the wait time between Cache Digest writes to
6846 NAME: digest_swapout_chunk_size
6849 IFDEF: USE_CACHE_DIGESTS
6850 LOC: Config.digest.swapout_chunk_size
6853 This is the number of bytes of the Cache Digest to write to
6854 disk at a time. It defaults to 4096 bytes (4KB), the Squid
6858 NAME: digest_rebuild_chunk_percentage
6859 COMMENT: (percent, 0-100)
6860 IFDEF: USE_CACHE_DIGESTS
6862 LOC: Config.digest.rebuild_chunk_percentage
6865 This is the percentage of the Cache Digest to be scanned at a
6866 time. By default it is set to 10% of the Cache Digest.
6871 -----------------------------------------------------------------------------
6876 LOC: Config.Port.snmp
6878 DEFAULT_DOC: SNMP disabled.
6881 The port number where Squid listens for SNMP requests. To enable
6882 SNMP support set this to a suitable port number. Port number
6883 3401 is often used for the Squid SNMP agent. By default it's
6884 set to "0" (disabled)
6892 LOC: Config.accessList.snmp
6894 DEFAULT_DOC: Deny, unless rules exist in squid.conf.
6897 Allowing or denying access to the SNMP port.
6899 All access to the agent is denied by default.
6902 snmp_access allow|deny [!]aclname ...
6904 This clause only supports fast acl types.
6905 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
6908 snmp_access allow snmppublic localhost
6909 snmp_access deny all
6912 NAME: snmp_incoming_address
6914 LOC: Config.Addrs.snmp_incoming
6916 DEFAULT_DOC: Accept SNMP packets from all machine interfaces.
6919 Just like 'udp_incoming_address', but for the SNMP port.
6921 snmp_incoming_address is used for the SNMP socket receiving
6922 messages from SNMP agents.
6924 The default snmp_incoming_address is to listen on all
6925 available network interfaces.
6928 NAME: snmp_outgoing_address
6930 LOC: Config.Addrs.snmp_outgoing
6932 DEFAULT_DOC: Use snmp_incoming_address or an address selected by the operating system.
6935 Just like 'udp_outgoing_address', but for the SNMP port.
6937 snmp_outgoing_address is used for SNMP packets returned to SNMP
6940 If snmp_outgoing_address is not set it will use the same socket
6941 as snmp_incoming_address. Only change this if you want to have
6942 SNMP replies sent using another address than where this Squid
6943 listens for SNMP queries.
6945 NOTE, snmp_incoming_address and snmp_outgoing_address can not have
6946 the same value since they both use the same port.
6951 -----------------------------------------------------------------------------
6954 NAME: icp_port udp_port
6957 DEFAULT_DOC: ICP disabled.
6958 LOC: Config.Port.icp
6960 The port number where Squid sends and receives ICP queries to
6961 and from neighbor caches. The standard UDP port for ICP is 3130.
6964 icp_port @DEFAULT_ICP_PORT@
6971 DEFAULT_DOC: HTCP disabled.
6972 LOC: Config.Port.htcp
6974 The port number where Squid sends and receives HTCP queries to
6975 and from neighbor caches. To turn it on you want to set it to
6982 NAME: log_icp_queries
6986 LOC: Config.onoff.log_udp
6988 If set, ICP queries are logged to access.log. You may wish
6989 do disable this if your ICP load is VERY high to speed things
6990 up or to simplify log analysis.
6993 NAME: udp_incoming_address
6995 LOC:Config.Addrs.udp_incoming
6997 DEFAULT_DOC: Accept packets from all machine interfaces.
6999 udp_incoming_address is used for UDP packets received from other
7002 The default behavior is to not bind to any specific address.
7004 Only change this if you want to have all UDP queries received on
7005 a specific interface/address.
7007 NOTE: udp_incoming_address is used by the ICP, HTCP, and DNS
7008 modules. Altering it will affect all of them in the same manner.
7010 see also; udp_outgoing_address
7012 NOTE, udp_incoming_address and udp_outgoing_address can not
7013 have the same value since they both use the same port.
7016 NAME: udp_outgoing_address
7018 LOC: Config.Addrs.udp_outgoing
7020 DEFAULT_DOC: Use udp_incoming_address or an address selected by the operating system.
7022 udp_outgoing_address is used for UDP packets sent out to other
7025 The default behavior is to not bind to any specific address.
7027 Instead it will use the same socket as udp_incoming_address.
7028 Only change this if you want to have UDP queries sent using another
7029 address than where this Squid listens for UDP queries from other
7032 NOTE: udp_outgoing_address is used by the ICP, HTCP, and DNS
7033 modules. Altering it will affect all of them in the same manner.
7035 see also; udp_incoming_address
7037 NOTE, udp_incoming_address and udp_outgoing_address can not
7038 have the same value since they both use the same port.
7045 LOC: Config.onoff.icp_hit_stale
7047 If you want to return ICP_HIT for stale cache objects, set this
7048 option to 'on'. If you have sibling relationships with caches
7049 in other administrative domains, this should be 'off'. If you only
7050 have sibling relationships with caches under your control,
7051 it is probably okay to set this to 'on'.
7052 If set to 'on', your siblings should use the option "allow-miss"
7053 on their cache_peer lines for connecting to you.
7056 NAME: minimum_direct_hops
7059 LOC: Config.minDirectHops
7061 If using the ICMP pinging stuff, do direct fetches for sites
7062 which are no more than this many hops away.
7065 NAME: minimum_direct_rtt
7069 LOC: Config.minDirectRtt
7071 If using the ICMP pinging stuff, do direct fetches for sites
7072 which are no more than this many rtt milliseconds away.
7078 LOC: Config.Netdb.low
7080 The low water mark for the ICMP measurement database.
7082 Note: high watermark controlled by netdb_high directive.
7084 These watermarks are counts, not percents. The defaults are
7085 (low) 900 and (high) 1000. When the high water mark is
7086 reached, database entries will be deleted until the low
7093 LOC: Config.Netdb.high
7095 The high water mark for the ICMP measurement database.
7097 Note: low watermark controlled by netdb_low directive.
7099 These watermarks are counts, not percents. The defaults are
7100 (low) 900 and (high) 1000. When the high water mark is
7101 reached, database entries will be deleted until the low
7105 NAME: netdb_ping_period
7107 LOC: Config.Netdb.period
7110 The minimum period for measuring a site. There will be at
7111 least this much delay between successive pings to the same
7112 network. The default is five minutes.
7119 LOC: Config.onoff.query_icmp
7121 If you want to ask your peers to include ICMP data in their ICP
7122 replies, enable this option.
7124 If your peer has configured Squid (during compilation) with
7125 '--enable-icmp' that peer will send ICMP pings to origin server
7126 sites of the URLs it receives. If you enable this option the
7127 ICP replies from that peer will include the ICMP data (if available).
7128 Then, when choosing a parent cache, Squid will choose the parent with
7129 the minimal RTT to the origin server. When this happens, the
7130 hierarchy field of the access.log will be
7131 "CLOSEST_PARENT_MISS". This option is off by default.
7134 NAME: test_reachability
7138 LOC: Config.onoff.test_reachability
7140 When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH
7141 instead of ICP_MISS if the target host is NOT in the ICMP
7142 database, or has a zero RTT.
7145 NAME: icp_query_timeout
7148 DEFAULT_DOC: Dynamic detection.
7150 LOC: Config.Timeout.icp_query
7152 Normally Squid will automatically determine an optimal ICP
7153 query timeout value based on the round-trip-time of recent ICP
7154 queries. If you want to override the value determined by
7155 Squid, set this 'icp_query_timeout' to a non-zero value. This
7156 value is specified in MILLISECONDS, so, to use a 2-second
7157 timeout (the old default), you would write:
7159 icp_query_timeout 2000
7162 NAME: maximum_icp_query_timeout
7166 LOC: Config.Timeout.icp_query_max
7168 Normally the ICP query timeout is determined dynamically. But
7169 sometimes it can lead to very large values (say 5 seconds).
7170 Use this option to put an upper limit on the dynamic timeout
7171 value. Do NOT use this option to always use a fixed (instead
7172 of a dynamic) timeout value. To set a fixed timeout see the
7173 'icp_query_timeout' directive.
7176 NAME: minimum_icp_query_timeout
7180 LOC: Config.Timeout.icp_query_min
7182 Normally the ICP query timeout is determined dynamically. But
7183 sometimes it can lead to very small timeouts, even lower than
7184 the normal latency variance on your link due to traffic.
7185 Use this option to put an lower limit on the dynamic timeout
7186 value. Do NOT use this option to always use a fixed (instead
7187 of a dynamic) timeout value. To set a fixed timeout see the
7188 'icp_query_timeout' directive.
7191 NAME: background_ping_rate
7195 LOC: Config.backgroundPingRate
7197 Controls how often the ICP pings are sent to siblings that
7198 have background-ping set.
7202 MULTICAST ICP OPTIONS
7203 -----------------------------------------------------------------------------
7208 LOC: Config.mcast_group_list
7211 This tag specifies a list of multicast groups which your server
7212 should join to receive multicasted ICP queries.
7214 NOTE! Be very careful what you put here! Be sure you
7215 understand the difference between an ICP _query_ and an ICP
7216 _reply_. This option is to be set only if you want to RECEIVE
7217 multicast queries. Do NOT set this option to SEND multicast
7218 ICP (use cache_peer for that). ICP replies are always sent via
7219 unicast, so this option does not affect whether or not you will
7220 receive replies from multicast group members.
7222 You must be very careful to NOT use a multicast address which
7223 is already in use by another group of caches.
7225 If you are unsure about multicast, please read the Multicast
7226 chapter in the Squid FAQ (http://www.squid-cache.org/FAQ/).
7228 Usage: mcast_groups 239.128.16.128 224.0.1.20
7230 By default, Squid doesn't listen on any multicast groups.
7233 NAME: mcast_miss_addr
7234 IFDEF: MULTICAST_MISS_STREAM
7236 LOC: Config.mcast_miss.addr
7238 DEFAULT_DOC: disabled.
7240 If you enable this option, every "cache miss" URL will
7241 be sent out on the specified multicast address.
7243 Do not enable this option unless you are are absolutely
7244 certain you understand what you are doing.
7247 NAME: mcast_miss_ttl
7248 IFDEF: MULTICAST_MISS_STREAM
7250 LOC: Config.mcast_miss.ttl
7253 This is the time-to-live value for packets multicasted
7254 when multicasting off cache miss URLs is enabled. By
7255 default this is set to 'site scope', i.e. 16.
7258 NAME: mcast_miss_port
7259 IFDEF: MULTICAST_MISS_STREAM
7261 LOC: Config.mcast_miss.port
7264 This is the port number to be used in conjunction with
7268 NAME: mcast_miss_encode_key
7269 IFDEF: MULTICAST_MISS_STREAM
7271 LOC: Config.mcast_miss.encode_key
7272 DEFAULT: XXXXXXXXXXXXXXXX
7274 The URLs that are sent in the multicast miss stream are
7275 encrypted. This is the encryption key.
7278 NAME: mcast_icp_query_timeout
7282 LOC: Config.Timeout.mcast_icp_query
7284 For multicast peers, Squid regularly sends out ICP "probes" to
7285 count how many other peers are listening on the given multicast
7286 address. This value specifies how long Squid should wait to
7287 count all the replies. The default is 2000 msec, or 2
7292 INTERNAL ICON OPTIONS
7293 -----------------------------------------------------------------------------
7296 NAME: icon_directory
7298 LOC: Config.icons.directory
7299 DEFAULT: @DEFAULT_ICON_DIR@
7301 Where the icons are stored. These are normally kept in
7305 NAME: global_internal_static
7307 LOC: Config.onoff.global_internal_static
7310 This directive controls is Squid should intercept all requests for
7311 /squid-internal-static/ no matter which host the URL is requesting
7312 (default on setting), or if nothing special should be done for
7313 such URLs (off setting). The purpose of this directive is to make
7314 icons etc work better in complex cache hierarchies where it may
7315 not always be possible for all corners in the cache mesh to reach
7316 the server generating a directory listing.
7319 NAME: short_icon_urls
7321 LOC: Config.icons.use_short_names
7324 If this is enabled Squid will use short URLs for icons.
7325 If disabled it will revert to the old behavior of including
7326 it's own name and port in the URL.
7328 If you run a complex cache hierarchy with a mix of Squid and
7329 other proxies you may need to disable this directive.
7334 -----------------------------------------------------------------------------
7337 NAME: error_directory
7339 LOC: Config.errorDirectory
7341 DEFAULT_DOC: Send error pages in the clients preferred language
7343 If you wish to create your own versions of the default
7344 error files to customize them to suit your company copy
7345 the error/template files to another directory and point
7348 WARNING: This option will disable multi-language support
7349 on error pages if used.
7351 The squid developers are interested in making squid available in
7352 a wide variety of languages. If you are making translations for a
7353 language that Squid does not currently provide please consider
7354 contributing your translation back to the project.
7355 http://wiki.squid-cache.org/Translations
7357 The squid developers working on translations are happy to supply drop-in
7358 translated error files in exchange for any new language contributions.
7361 NAME: error_default_language
7362 IFDEF: USE_ERR_LOCALES
7364 LOC: Config.errorDefaultLanguage
7366 DEFAULT_DOC: Generate English language pages.
7368 Set the default language which squid will send error pages in
7369 if no existing translation matches the clients language
7372 If unset (default) generic English will be used.
7374 The squid developers are interested in making squid available in
7375 a wide variety of languages. If you are interested in making
7376 translations for any language see the squid wiki for details.
7377 http://wiki.squid-cache.org/Translations
7380 NAME: error_log_languages
7381 IFDEF: USE_ERR_LOCALES
7383 LOC: Config.errorLogMissingLanguages
7386 Log to cache.log what languages users are attempting to
7387 auto-negotiate for translations.
7389 Successful negotiations are not logged. Only failures
7390 have meaning to indicate that Squid may need an upgrade
7391 of its error page translations.
7394 NAME: err_page_stylesheet
7396 LOC: Config.errorStylesheet
7397 DEFAULT: @DEFAULT_CONFIG_DIR@/errorpage.css
7399 CSS Stylesheet to pattern the display of Squid default error pages.
7401 For information on CSS see http://www.w3.org/Style/CSS/
7406 LOC: Config.errHtmlText
7409 HTML text to include in error messages. Make this a "mailto"
7410 URL to your admin address, or maybe just a link to your
7411 organizations Web page.
7413 To include this in your error messages, you must rewrite
7414 the error template files (found in the "errors" directory).
7415 Wherever you want the 'err_html_text' line to appear,
7416 insert a %L tag in the error template file.
7419 NAME: email_err_data
7422 LOC: Config.onoff.emailErrData
7425 If enabled, information about the occurred error will be
7426 included in the mailto links of the ERR pages (if %W is set)
7427 so that the email body contains the data.
7428 Syntax is <A HREF="mailto:%w%W">%w</A>
7433 LOC: Config.denyInfoList
7436 Usage: deny_info err_page_name acl
7437 or deny_info http://... acl
7438 or deny_info TCP_RESET acl
7440 This can be used to return a ERR_ page for requests which
7441 do not pass the 'http_access' rules. Squid remembers the last
7442 acl it evaluated in http_access, and if a 'deny_info' line exists
7443 for that ACL Squid returns a corresponding error page.
7445 The acl is typically the last acl on the http_access deny line which
7446 denied access. The exceptions to this rule are:
7447 - When Squid needs to request authentication credentials. It's then
7448 the first authentication related acl encountered
7449 - When none of the http_access lines matches. It's then the last
7450 acl processed on the last http_access line.
7451 - When the decision to deny access was made by an adaptation service,
7452 the acl name is the corresponding eCAP or ICAP service_name.
7454 NP: If providing your own custom error pages with error_directory
7455 you may also specify them by your custom file name:
7456 Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys
7458 By defaut Squid will send "403 Forbidden". A different 4xx or 5xx
7459 may be specified by prefixing the file name with the code and a colon.
7460 e.g. 404:ERR_CUSTOM_ACCESS_DENIED
7462 Alternatively you can tell Squid to reset the TCP connection
7463 by specifying TCP_RESET.
7465 Or you can specify an error URL or URL pattern. The browsers will
7466 get redirected to the specified URL after formatting tags have
7467 been replaced. Redirect will be done with 302 or 307 according to
7468 HTTP/1.1 specs. A different 3xx code may be specified by prefixing
7469 the URL. e.g. 303:http://example.com/
7472 %a - username (if available. Password NOT included)
7475 %E - Error description
7477 %H - Request domain name
7478 %i - Client IP Address
7480 %o - Message result from external ACL helper
7481 %p - Request Port number
7482 %P - Request Protocol name
7483 %R - Request URL path
7484 %T - Timestamp in RFC 1123 format
7485 %U - Full canonical URL from client
7486 (HTTPS URLs terminate with *)
7487 %u - Full canonical URL from client
7488 %w - Admin email from squid.conf
7490 %% - Literal percent (%) code
7495 OPTIONS INFLUENCING REQUEST FORWARDING
7496 -----------------------------------------------------------------------------
7499 NAME: nonhierarchical_direct
7501 LOC: Config.onoff.nonhierarchical_direct
7504 By default, Squid will send any non-hierarchical requests
7505 (matching hierarchy_stoplist or not cacheable request type) direct
7508 When this is set to "off", Squid will prefer to send these
7509 requests to parents.
7511 Note that in most configurations, by turning this off you will only
7512 add latency to these request without any improvement in global hit
7515 This option only sets a preference. If the parent is unavailable a
7516 direct connection to the origin server may still be attempted. To
7517 completely prevent direct connections use never_direct.
7522 LOC: Config.onoff.prefer_direct
7525 Normally Squid tries to use parents for most requests. If you for some
7526 reason like it to first try going direct and only use a parent if
7527 going direct fails set this to on.
7529 By combining nonhierarchical_direct off and prefer_direct on you
7530 can set up Squid to use a parent as a backup path if going direct
7533 Note: If you want Squid to use parents for all requests see
7534 the never_direct directive. prefer_direct only modifies how Squid
7535 acts on cacheable requests.
7538 NAME: cache_miss_revalidate
7542 LOC: Config.onoff.cache_miss_revalidate
7544 Whether Squid on cache MISS will pass client revalidation requests
7545 to the server or tries to fetch new content for caching.
7546 This is useful while the cache is mostly empty to more quickly
7547 have the cache populated.
7549 When set to 'on' (default), Squid will pass all client If-* headers
7552 When set to 'off' and if the request is cacheable, Squid will
7553 remove the clients If-Modified-Since and If-None-Match headers from
7554 the request sent to the server.
7559 LOC: Config.accessList.AlwaysDirect
7561 DEFAULT_DOC: Prevent any cache_peer being used for this request.
7563 Usage: always_direct allow|deny [!]aclname ...
7565 Here you can use ACL elements to specify requests which should
7566 ALWAYS be forwarded by Squid to the origin servers without using
7567 any peers. For example, to always directly forward requests for
7568 local servers ignoring any parents or siblings you may have use
7571 acl local-servers dstdomain my.domain.net
7572 always_direct allow local-servers
7574 To always forward FTP requests directly, use
7577 always_direct allow FTP
7579 NOTE: There is a similar, but opposite option named
7580 'never_direct'. You need to be aware that "always_direct deny
7581 foo" is NOT the same thing as "never_direct allow foo". You
7582 may need to use a deny rule to exclude a more-specific case of
7583 some other rule. Example:
7585 acl local-external dstdomain external.foo.net
7586 acl local-servers dstdomain .foo.net
7587 always_direct deny local-external
7588 always_direct allow local-servers
7590 NOTE: If your goal is to make the client forward the request
7591 directly to the origin server bypassing Squid then this needs
7592 to be done in the client configuration. Squid configuration
7593 can only tell Squid how Squid should fetch the object.
7595 NOTE: This directive is not related to caching. The replies
7596 is cached as usual even if you use always_direct. To not cache
7597 the replies see the 'cache' directive.
7599 This clause supports both fast and slow acl types.
7600 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
7605 LOC: Config.accessList.NeverDirect
7607 DEFAULT_DOC: Allow DNS results to be used for this request.
7609 Usage: never_direct allow|deny [!]aclname ...
7611 never_direct is the opposite of always_direct. Please read
7612 the description for always_direct if you have not already.
7614 With 'never_direct' you can use ACL elements to specify
7615 requests which should NEVER be forwarded directly to origin
7616 servers. For example, to force the use of a proxy for all
7617 requests, except those in your local domain use something like:
7619 acl local-servers dstdomain .foo.net
7620 never_direct deny local-servers
7621 never_direct allow all
7623 or if Squid is inside a firewall and there are local intranet
7624 servers inside the firewall use something like:
7626 acl local-intranet dstdomain .foo.net
7627 acl local-external dstdomain external.foo.net
7628 always_direct deny local-external
7629 always_direct allow local-intranet
7630 never_direct allow all
7632 This clause supports both fast and slow acl types.
7633 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
7637 ADVANCED NETWORKING OPTIONS
7638 -----------------------------------------------------------------------------
7641 NAME: incoming_udp_average incoming_icp_average
7644 LOC: Config.comm_incoming.udp.average
7646 Heavy voodoo here. I can't even believe you are reading this.
7647 Are you crazy? Don't even think about adjusting these unless
7648 you understand the algorithms in comm_select.c first!
7651 NAME: incoming_tcp_average incoming_http_average
7654 LOC: Config.comm_incoming.tcp.average
7656 Heavy voodoo here. I can't even believe you are reading this.
7657 Are you crazy? Don't even think about adjusting these unless
7658 you understand the algorithms in comm_select.c first!
7661 NAME: incoming_dns_average
7664 LOC: Config.comm_incoming.dns.average
7666 Heavy voodoo here. I can't even believe you are reading this.
7667 Are you crazy? Don't even think about adjusting these unless
7668 you understand the algorithms in comm_select.c first!
7671 NAME: min_udp_poll_cnt min_icp_poll_cnt
7674 LOC: Config.comm_incoming.udp.min_poll
7676 Heavy voodoo here. I can't even believe you are reading this.
7677 Are you crazy? Don't even think about adjusting these unless
7678 you understand the algorithms in comm_select.c first!
7681 NAME: min_dns_poll_cnt
7684 LOC: Config.comm_incoming.dns.min_poll
7686 Heavy voodoo here. I can't even believe you are reading this.
7687 Are you crazy? Don't even think about adjusting these unless
7688 you understand the algorithms in comm_select.c first!
7691 NAME: min_tcp_poll_cnt min_http_poll_cnt
7694 LOC: Config.comm_incoming.tcp.min_poll
7696 Heavy voodoo here. I can't even believe you are reading this.
7697 Are you crazy? Don't even think about adjusting these unless
7698 you understand the algorithms in comm_select.c first!
7704 LOC: Config.accept_filter
7708 The name of an accept(2) filter to install on Squid's
7709 listen socket(s). This feature is perhaps specific to
7710 FreeBSD and requires support in the kernel.
7712 The 'httpready' filter delays delivering new connections
7713 to Squid until a full HTTP request has been received.
7714 See the accf_http(9) man page for details.
7716 The 'dataready' filter delays delivering new connections
7717 to Squid until there is some data to process.
7718 See the accf_dataready(9) man page for details.
7722 The 'data' filter delays delivering of new connections
7723 to Squid until there is some data to process by TCP_ACCEPT_DEFER.
7724 You may optionally specify a number of seconds to wait by
7725 'data=N' where N is the number of seconds. Defaults to 30
7726 if not specified. See the tcp(7) man page for details.
7729 accept_filter httpready
7734 NAME: client_ip_max_connections
7736 LOC: Config.client_ip_max_connections
7738 DEFAULT_DOC: No limit.
7740 Set an absolute limit on the number of connections a single
7741 client IP can use. Any more than this and Squid will begin to drop
7742 new connections from the client until it closes some links.
7744 Note that this is a global limit. It affects all HTTP, HTCP, Gopher and FTP
7745 connections from the client. For finer control use the ACL access controls.
7747 Requires client_db to be enabled (the default).
7749 WARNING: This may noticably slow down traffic received via external proxies
7750 or NAT devices and cause them to rebound error messages back to their clients.
7753 NAME: tcp_recv_bufsize
7757 DEFAULT_DOC: Use operating system TCP defaults.
7758 LOC: Config.tcpRcvBufsz
7760 Size of receive buffer to set for TCP sockets. Probably just
7761 as easy to change your kernel's default.
7762 Omit from squid.conf to use the default buffer size.
7767 -----------------------------------------------------------------------------
7774 LOC: Adaptation::Icap::TheConfig.onoff
7777 If you want to enable the ICAP module support, set this to on.
7780 NAME: icap_connect_timeout
7783 LOC: Adaptation::Icap::TheConfig.connect_timeout_raw
7786 This parameter specifies how long to wait for the TCP connect to
7787 the requested ICAP server to complete before giving up and either
7788 terminating the HTTP transaction or bypassing the failure.
7790 The default for optional services is peer_connect_timeout.
7791 The default for essential services is connect_timeout.
7792 If this option is explicitly set, its value applies to all services.
7795 NAME: icap_io_timeout
7799 DEFAULT_DOC: Use read_timeout.
7800 LOC: Adaptation::Icap::TheConfig.io_timeout_raw
7803 This parameter specifies how long to wait for an I/O activity on
7804 an established, active ICAP connection before giving up and
7805 either terminating the HTTP transaction or bypassing the
7809 NAME: icap_service_failure_limit
7810 COMMENT: limit [in memory-depth time-units]
7811 TYPE: icap_service_failure_limit
7813 LOC: Adaptation::Icap::TheConfig
7816 The limit specifies the number of failures that Squid tolerates
7817 when establishing a new TCP connection with an ICAP service. If
7818 the number of failures exceeds the limit, the ICAP service is
7819 not used for new ICAP requests until it is time to refresh its
7822 A negative value disables the limit. Without the limit, an ICAP
7823 service will not be considered down due to connectivity failures
7824 between ICAP OPTIONS requests.
7826 Squid forgets ICAP service failures older than the specified
7827 value of memory-depth. The memory fading algorithm
7828 is approximate because Squid does not remember individual
7829 errors but groups them instead, splitting the option
7830 value into ten time slots of equal length.
7832 When memory-depth is 0 and by default this option has no
7833 effect on service failure expiration.
7835 Squid always forgets failures when updating service settings
7836 using an ICAP OPTIONS transaction, regardless of this option
7840 # suspend service usage after 10 failures in 5 seconds:
7841 icap_service_failure_limit 10 in 5 seconds
7844 NAME: icap_service_revival_delay
7847 LOC: Adaptation::Icap::TheConfig.service_revival_delay
7850 The delay specifies the number of seconds to wait after an ICAP
7851 OPTIONS request failure before requesting the options again. The
7852 failed ICAP service is considered "down" until fresh OPTIONS are
7855 The actual delay cannot be smaller than the hardcoded minimum
7856 delay of 30 seconds.
7859 NAME: icap_preview_enable
7863 LOC: Adaptation::Icap::TheConfig.preview_enable
7866 The ICAP Preview feature allows the ICAP server to handle the
7867 HTTP message by looking only at the beginning of the message body
7868 or even without receiving the body at all. In some environments,
7869 previews greatly speedup ICAP processing.
7871 During an ICAP OPTIONS transaction, the server may tell Squid what
7872 HTTP messages should be previewed and how big the preview should be.
7873 Squid will not use Preview if the server did not request one.
7875 To disable ICAP Preview for all ICAP services, regardless of
7876 individual ICAP server OPTIONS responses, set this option to "off".
7878 icap_preview_enable off
7881 NAME: icap_preview_size
7884 LOC: Adaptation::Icap::TheConfig.preview_size
7886 DEFAULT_DOC: No preview sent.
7888 The default size of preview data to be sent to the ICAP server.
7889 This value might be overwritten on a per server basis by OPTIONS requests.
7892 NAME: icap_206_enable
7896 LOC: Adaptation::Icap::TheConfig.allow206_enable
7899 206 (Partial Content) responses is an ICAP extension that allows the
7900 ICAP agents to optionally combine adapted and original HTTP message
7901 content. The decision to combine is postponed until the end of the
7902 ICAP response. Squid supports Partial Content extension by default.
7904 Activation of the Partial Content extension is negotiated with each
7905 ICAP service during OPTIONS exchange. Most ICAP servers should handle
7906 negotation correctly even if they do not support the extension, but
7907 some might fail. To disable Partial Content support for all ICAP
7908 services and to avoid any negotiation, set this option to "off".
7914 NAME: icap_default_options_ttl
7917 LOC: Adaptation::Icap::TheConfig.default_options_ttl
7920 The default TTL value for ICAP OPTIONS responses that don't have
7921 an Options-TTL header.
7924 NAME: icap_persistent_connections
7928 LOC: Adaptation::Icap::TheConfig.reuse_connections
7931 Whether or not Squid should use persistent connections to
7935 NAME: adaptation_send_client_ip icap_send_client_ip
7937 IFDEF: USE_ADAPTATION
7939 LOC: Adaptation::Config::send_client_ip
7942 If enabled, Squid shares HTTP client IP information with adaptation
7943 services. For ICAP, Squid adds the X-Client-IP header to ICAP requests.
7944 For eCAP, Squid sets the libecap::metaClientIp transaction option.
7946 See also: adaptation_uses_indirect_client
7949 NAME: adaptation_send_username icap_send_client_username
7951 IFDEF: USE_ADAPTATION
7953 LOC: Adaptation::Config::send_username
7956 This sends authenticated HTTP client username (if available) to
7957 the adaptation service.
7959 For ICAP, the username value is encoded based on the
7960 icap_client_username_encode option and is sent using the header
7961 specified by the icap_client_username_header option.
7964 NAME: icap_client_username_header
7967 LOC: Adaptation::Icap::TheConfig.client_username_header
7968 DEFAULT: X-Client-Username
7970 ICAP request header name to use for adaptation_send_username.
7973 NAME: icap_client_username_encode
7977 LOC: Adaptation::Icap::TheConfig.client_username_encode
7980 Whether to base64 encode the authenticated client username.
7984 TYPE: icap_service_type
7986 LOC: Adaptation::Icap::TheConfig
7989 Defines a single ICAP service using the following format:
7991 icap_service id vectoring_point uri [option ...]
7994 an opaque identifier or name which is used to direct traffic to
7995 this specific service. Must be unique among all adaptation
7996 services in squid.conf.
7998 vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
7999 This specifies at which point of transaction processing the
8000 ICAP service should be activated. *_postcache vectoring points
8001 are not yet supported.
8003 uri: icap://servername:port/servicepath
8004 ICAP server and service location.
8006 ICAP does not allow a single service to handle both REQMOD and RESPMOD
8007 transactions. Squid does not enforce that requirement. You can specify
8008 services with the same service_url and different vectoring_points. You
8009 can even specify multiple identical services as long as their
8010 service_names differ.
8012 To activate a service, use the adaptation_access directive. To group
8013 services, use adaptation_service_chain and adaptation_service_set.
8015 Service options are separated by white space. ICAP services support
8016 the following name=value options:
8019 If set to 'on' or '1', the ICAP service is treated as
8020 optional. If the service cannot be reached or malfunctions,
8021 Squid will try to ignore any errors and process the message as
8022 if the service was not enabled. No all ICAP errors can be
8023 bypassed. If set to 0, the ICAP service is treated as
8024 essential and all ICAP errors will result in an error page
8025 returned to the HTTP client.
8027 Bypass is off by default: services are treated as essential.
8030 If set to 'on' or '1', the ICAP service is allowed to
8031 dynamically change the current message adaptation plan by
8032 returning a chain of services to be used next. The services
8033 are specified using the X-Next-Services ICAP response header
8034 value, formatted as a comma-separated list of service names.
8035 Each named service should be configured in squid.conf. Other
8036 services are ignored. An empty X-Next-Services value results
8037 in an empty plan which ends the current adaptation.
8039 Dynamic adaptation plan may cross or cover multiple supported
8040 vectoring points in their natural processing order.
8042 Routing is not allowed by default: the ICAP X-Next-Services
8043 response header is ignored.
8046 Only has effect on split-stack systems. The default on those systems
8047 is to use IPv4-only connections. When set to 'on' this option will
8048 make Squid use IPv6-only connections to contact this ICAP service.
8050 on-overload=block|bypass|wait|force
8051 If the service Max-Connections limit has been reached, do
8052 one of the following for each new ICAP transaction:
8053 * block: send an HTTP error response to the client
8054 * bypass: ignore the "over-connected" ICAP service
8055 * wait: wait (in a FIFO queue) for an ICAP connection slot
8056 * force: proceed, ignoring the Max-Connections limit
8058 In SMP mode with N workers, each worker assumes the service
8059 connection limit is Max-Connections/N, even though not all
8060 workers may use a given service.
8062 The default value is "bypass" if service is bypassable,
8063 otherwise it is set to "wait".
8067 Use the given number as the Max-Connections limit, regardless
8068 of the Max-Connections value given by the service, if any.
8070 Older icap_service format without optional named parameters is
8071 deprecated but supported for backward compatibility.
8074 icap_service svcBlocker reqmod_precache icap://icap1.mydomain.net:1344/reqmod bypass=0
8075 icap_service svcLogger reqmod_precache icap://icap2.mydomain.net:1344/respmod routing=on
8079 TYPE: icap_class_type
8084 This deprecated option was documented to define an ICAP service
8085 chain, even though it actually defined a set of similar, redundant
8086 services, and the chains were not supported.
8088 To define a set of redundant services, please use the
8089 adaptation_service_set directive. For service chains, use
8090 adaptation_service_chain.
8094 TYPE: icap_access_type
8099 This option is deprecated. Please use adaptation_access, which
8100 has the same ICAP functionality, but comes with better
8101 documentation, and eCAP support.
8106 -----------------------------------------------------------------------------
8113 LOC: Adaptation::Ecap::TheConfig.onoff
8116 Controls whether eCAP support is enabled.
8120 TYPE: ecap_service_type
8122 LOC: Adaptation::Ecap::TheConfig
8125 Defines a single eCAP service
8127 ecap_service id vectoring_point uri [option ...]
8130 an opaque identifier or name which is used to direct traffic to
8131 this specific service. Must be unique among all adaptation
8132 services in squid.conf.
8134 vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
8135 This specifies at which point of transaction processing the
8136 eCAP service should be activated. *_postcache vectoring points
8137 are not yet supported.
8139 uri: ecap://vendor/service_name?custom&cgi=style¶meters=optional
8140 Squid uses the eCAP service URI to match this configuration
8141 line with one of the dynamically loaded services. Each loaded
8142 eCAP service must have a unique URI. Obtain the right URI from
8143 the service provider.
8145 To activate a service, use the adaptation_access directive. To group
8146 services, use adaptation_service_chain and adaptation_service_set.
8148 Service options are separated by white space. eCAP services support
8149 the following name=value options:
8152 If set to 'on' or '1', the eCAP service is treated as optional.
8153 If the service cannot be reached or malfunctions, Squid will try
8154 to ignore any errors and process the message as if the service
8155 was not enabled. No all eCAP errors can be bypassed.
8156 If set to 'off' or '0', the eCAP service is treated as essential
8157 and all eCAP errors will result in an error page returned to the
8160 Bypass is off by default: services are treated as essential.
8163 If set to 'on' or '1', the eCAP service is allowed to
8164 dynamically change the current message adaptation plan by
8165 returning a chain of services to be used next.
8167 Dynamic adaptation plan may cross or cover multiple supported
8168 vectoring points in their natural processing order.
8170 Routing is not allowed by default.
8172 Older ecap_service format without optional named parameters is
8173 deprecated but supported for backward compatibility.
8177 ecap_service s1 reqmod_precache ecap://filters.R.us/leakDetector?on_error=block bypass=off
8178 ecap_service s2 respmod_precache ecap://filters.R.us/virusFilter config=/etc/vf.cfg bypass=on
8181 NAME: loadable_modules
8183 IFDEF: USE_LOADABLE_MODULES
8184 LOC: Config.loadable_module_names
8187 Instructs Squid to load the specified dynamic module(s) or activate
8188 preloaded module(s).
8190 loadable_modules @DEFAULT_PREFIX@/lib/MinimalAdapter.so
8194 MESSAGE ADAPTATION OPTIONS
8195 -----------------------------------------------------------------------------
8198 NAME: adaptation_service_set
8199 TYPE: adaptation_service_set_type
8200 IFDEF: USE_ADAPTATION
8205 Configures an ordered set of similar, redundant services. This is
8206 useful when hot standby or backup adaptation servers are available.
8208 adaptation_service_set set_name service_name1 service_name2 ...
8210 The named services are used in the set declaration order. The first
8211 applicable adaptation service from the set is used first. The next
8212 applicable service is tried if and only if the transaction with the
8213 previous service fails and the message waiting to be adapted is still
8216 When adaptation starts, broken services are ignored as if they were
8217 not a part of the set. A broken service is a down optional service.
8219 The services in a set must be attached to the same vectoring point
8220 (e.g., pre-cache) and use the same adaptation method (e.g., REQMOD).
8222 If all services in a set are optional then adaptation failures are
8223 bypassable. If all services in the set are essential, then a
8224 transaction failure with one service may still be retried using
8225 another service from the set, but when all services fail, the master
8226 transaction fails as well.
8228 A set may contain a mix of optional and essential services, but that
8229 is likely to lead to surprising results because broken services become
8230 ignored (see above), making previously bypassable failures fatal.
8231 Technically, it is the bypassability of the last failed service that
8234 See also: adaptation_access adaptation_service_chain
8237 adaptation_service_set svcBlocker urlFilterPrimary urlFilterBackup
8238 adaptation service_set svcLogger loggerLocal loggerRemote
8241 NAME: adaptation_service_chain
8242 TYPE: adaptation_service_chain_type
8243 IFDEF: USE_ADAPTATION
8248 Configures a list of complementary services that will be applied
8249 one-by-one, forming an adaptation chain or pipeline. This is useful
8250 when Squid must perform different adaptations on the same message.
8252 adaptation_service_chain chain_name service_name1 svc_name2 ...
8254 The named services are used in the chain declaration order. The first
8255 applicable adaptation service from the chain is used first. The next
8256 applicable service is applied to the successful adaptation results of
8257 the previous service in the chain.
8259 When adaptation starts, broken services are ignored as if they were
8260 not a part of the chain. A broken service is a down optional service.
8262 Request satisfaction terminates the adaptation chain because Squid
8263 does not currently allow declaration of RESPMOD services at the
8264 "reqmod_precache" vectoring point (see icap_service or ecap_service).
8266 The services in a chain must be attached to the same vectoring point
8267 (e.g., pre-cache) and use the same adaptation method (e.g., REQMOD).
8269 A chain may contain a mix of optional and essential services. If an
8270 essential adaptation fails (or the failure cannot be bypassed for
8271 other reasons), the master transaction fails. Otherwise, the failure
8272 is bypassed as if the failed adaptation service was not in the chain.
8274 See also: adaptation_access adaptation_service_set
8277 adaptation_service_chain svcRequest requestLogger urlFilter leakDetector
8280 NAME: adaptation_access
8281 TYPE: adaptation_access_type
8282 IFDEF: USE_ADAPTATION
8285 DEFAULT_DOC: Allow, unless rules exist in squid.conf.
8287 Sends an HTTP transaction to an ICAP or eCAP adaptation service.
8289 adaptation_access service_name allow|deny [!]aclname...
8290 adaptation_access set_name allow|deny [!]aclname...
8292 At each supported vectoring point, the adaptation_access
8293 statements are processed in the order they appear in this
8294 configuration file. Statements pointing to the following services
8295 are ignored (i.e., skipped without checking their ACL):
8297 - services serving different vectoring points
8298 - "broken-but-bypassable" services
8299 - "up" services configured to ignore such transactions
8300 (e.g., based on the ICAP Transfer-Ignore header).
8302 When a set_name is used, all services in the set are checked
8303 using the same rules, to find the first applicable one. See
8304 adaptation_service_set for details.
8306 If an access list is checked and there is a match, the
8307 processing stops: For an "allow" rule, the corresponding
8308 adaptation service is used for the transaction. For a "deny"
8309 rule, no adaptation service is activated.
8311 It is currently not possible to apply more than one adaptation
8312 service at the same vectoring point to the same HTTP transaction.
8314 See also: icap_service and ecap_service
8317 adaptation_access service_1 allow all
8320 NAME: adaptation_service_iteration_limit
8322 IFDEF: USE_ADAPTATION
8323 LOC: Adaptation::Config::service_iteration_limit
8326 Limits the number of iterations allowed when applying adaptation
8327 services to a message. If your longest adaptation set or chain
8328 may have more than 16 services, increase the limit beyond its
8329 default value of 16. If detecting infinite iteration loops sooner
8330 is critical, make the iteration limit match the actual number
8331 of services in your longest adaptation set or chain.
8333 Infinite adaptation loops are most likely with routing services.
8335 See also: icap_service routing=1
8338 NAME: adaptation_masterx_shared_names
8340 IFDEF: USE_ADAPTATION
8341 LOC: Adaptation::Config::masterx_shared_name
8344 For each master transaction (i.e., the HTTP request and response
8345 sequence, including all related ICAP and eCAP exchanges), Squid
8346 maintains a table of metadata. The table entries are (name, value)
8347 pairs shared among eCAP and ICAP exchanges. The table is destroyed
8348 with the master transaction.
8350 This option specifies the table entry names that Squid must accept
8351 from and forward to the adaptation transactions.
8353 An ICAP REQMOD or RESPMOD transaction may set an entry in the
8354 shared table by returning an ICAP header field with a name
8355 specified in adaptation_masterx_shared_names.
8357 An eCAP REQMOD or RESPMOD transaction may set an entry in the
8358 shared table by implementing the libecap::visitEachOption() API
8359 to provide an option with a name specified in
8360 adaptation_masterx_shared_names.
8362 Squid will store and forward the set entry to subsequent adaptation
8363 transactions within the same master transaction scope.
8365 Only one shared entry name is supported at this time.
8368 # share authentication information among ICAP services
8369 adaptation_masterx_shared_names X-Subscriber-ID
8372 NAME: adaptation_meta
8374 IFDEF: USE_ADAPTATION
8375 LOC: Adaptation::Config::metaHeaders
8378 This option allows Squid administrator to add custom ICAP request
8379 headers or eCAP options to Squid ICAP requests or eCAP transactions.
8380 Use it to pass custom authentication tokens and other
8381 transaction-state related meta information to an ICAP/eCAP service.
8383 The addition of a meta header is ACL-driven:
8384 adaptation_meta name value [!]aclname ...
8386 Processing for a given header name stops after the first ACL list match.
8387 Thus, it is impossible to add two headers with the same name. If no ACL
8388 lists match for a given header name, no such header is added. For
8391 # do not debug transactions except for those that need debugging
8392 adaptation_meta X-Debug 1 needs_debugging
8394 # log all transactions except for those that must remain secret
8395 adaptation_meta X-Log 1 !keep_secret
8397 # mark transactions from users in the "G 1" group
8398 adaptation_meta X-Authenticated-Groups "G 1" authed_as_G1
8400 The "value" parameter may be a regular squid.conf token or a "double
8401 quoted string". Within the quoted string, use backslash (\) to escape
8402 any character, which is currently only useful for escaping backslashes
8403 and double quotes. For example,
8404 "this string has one backslash (\\) and two \"quotes\""
8406 Used adaptation_meta header values may be logged via %note
8407 logformat code. If multiple adaptation_meta headers with the same name
8408 are used during master transaction lifetime, the header values are
8409 logged in the order they were used and duplicate values are ignored
8410 (only the first repeated value will be logged).
8416 LOC: Adaptation::Icap::TheConfig.repeat
8417 DEFAULT_IF_NONE: deny all
8419 This ACL determines which retriable ICAP transactions are
8420 retried. Transactions that received a complete ICAP response
8421 and did not have to consume or produce HTTP bodies to receive
8422 that response are usually retriable.
8424 icap_retry allow|deny [!]aclname ...
8426 Squid automatically retries some ICAP I/O timeouts and errors
8427 due to persistent connection race conditions.
8429 See also: icap_retry_limit
8432 NAME: icap_retry_limit
8435 LOC: Adaptation::Icap::TheConfig.repeat_limit
8437 DEFAULT_DOC: No retries are allowed.
8439 Limits the number of retries allowed.
8441 Communication errors due to persistent connection race
8442 conditions are unavoidable, automatically retried, and do not
8443 count against this limit.
8445 See also: icap_retry
8451 -----------------------------------------------------------------------------
8454 NAME: check_hostnames
8457 LOC: Config.onoff.check_hostnames
8459 For security and stability reasons Squid can check
8460 hostnames for Internet standard RFC compliance. If you want
8461 Squid to perform these checks turn this directive on.
8464 NAME: allow_underscore
8467 LOC: Config.onoff.allow_underscore
8469 Underscore characters is not strictly allowed in Internet hostnames
8470 but nevertheless used by many sites. Set this to off if you want
8471 Squid to be strict about the standard.
8472 This check is performed only when check_hostnames is set to on.
8475 NAME: dns_retransmit_interval
8478 LOC: Config.Timeout.idns_retransmit
8480 Initial retransmit interval for DNS queries. The interval is
8481 doubled each time all configured DNS servers have been tried.
8487 LOC: Config.Timeout.idns_query
8489 DNS Query timeout. If no response is received to a DNS query
8490 within this time all DNS servers for the queried domain
8491 are assumed to be unavailable.
8494 NAME: dns_packet_max
8496 DEFAULT_DOC: EDNS disabled
8498 LOC: Config.dns.packet_max
8500 Maximum number of bytes packet size to advertise via EDNS.
8501 Set to "none" to disable EDNS large packet support.
8503 For legacy reasons DNS UDP replies will default to 512 bytes which
8504 is too small for many responses. EDNS provides a means for Squid to
8505 negotiate receiving larger responses back immediately without having
8506 to failover with repeat requests. Responses larger than this limit
8507 will retain the old behaviour of failover to TCP DNS.
8509 Squid has no real fixed limit internally, but allowing packet sizes
8510 over 1500 bytes requires network jumbogram support and is usually not
8513 WARNING: The RFC also indicates that some older resolvers will reply
8514 with failure of the whole request if the extension is added. Some
8515 resolvers have already been identified which will reply with mangled
8516 EDNS response on occasion. Usually in response to many-KB jumbogram
8517 sizes being advertised by Squid.
8518 Squid will currently treat these both as an unable-to-resolve domain
8519 even if it would be resolvable without EDNS.
8526 DEFAULT_DOC: Search for single-label domain names is disabled.
8527 LOC: Config.onoff.res_defnames
8529 Normally the RES_DEFNAMES resolver option is disabled
8530 (see res_init(3)). This prevents caches in a hierarchy
8531 from interpreting single-component hostnames locally. To allow
8532 Squid to handle single-component names, enable this option.
8535 NAME: dns_multicast_local
8539 DEFAULT_DOC: Search for .local and .arpa names is disabled.
8540 LOC: Config.onoff.dns_mdns
8542 When set to on, Squid sends multicast DNS lookups on the local
8543 network for domains ending in .local and .arpa.
8544 This enables local servers and devices to be contacted in an
8545 ad-hoc or zero-configuration network environment.
8548 NAME: dns_nameservers
8551 DEFAULT_DOC: Use operating system definitions
8552 LOC: Config.dns_nameservers
8554 Use this if you want to specify a list of DNS name servers
8555 (IP addresses) to use instead of those given in your
8556 /etc/resolv.conf file.
8558 On Windows platforms, if no value is specified here or in
8559 the /etc/resolv.conf file, the list of DNS name servers are
8560 taken from the Windows registry, both static and dynamic DHCP
8561 configurations are supported.
8563 Example: dns_nameservers 10.0.0.1 192.172.0.4
8568 DEFAULT: @DEFAULT_HOSTS@
8569 LOC: Config.etcHostsPath
8571 Location of the host-local IP name-address associations
8572 database. Most Operating Systems have such a file on different
8574 - Un*X & Linux: /etc/hosts
8575 - Windows NT/2000: %SystemRoot%\system32\drivers\etc\hosts
8576 (%SystemRoot% value install default is c:\winnt)
8577 - Windows XP/2003: %SystemRoot%\system32\drivers\etc\hosts
8578 (%SystemRoot% value install default is c:\windows)
8579 - Windows 9x/Me: %windir%\hosts
8580 (%windir% value is usually c:\windows)
8581 - Cygwin: /etc/hosts
8583 The file contains newline-separated definitions, in the
8584 form ip_address_in_dotted_form name [name ...] names are
8585 whitespace-separated. Lines beginning with an hash (#)
8586 character are comments.
8588 The file is checked at startup and upon configuration.
8589 If set to 'none', it won't be checked.
8590 If append_domain is used, that domain will be added to
8591 domain-local (i.e. not containing any dot character) host
8597 LOC: Config.appendDomain
8599 DEFAULT_DOC: Use operating system definitions
8601 Appends local domain name to hostnames without any dots in
8602 them. append_domain must begin with a period.
8604 Be warned there are now Internet names with no dots in
8605 them using only top-domain names, so setting this may
8606 cause some Internet sites to become unavailable.
8609 append_domain .yourdomain.com
8612 NAME: ignore_unknown_nameservers
8614 LOC: Config.onoff.ignore_unknown_nameservers
8617 By default Squid checks that DNS responses are received
8618 from the same IP addresses they are sent to. If they
8619 don't match, Squid ignores the response and writes a warning
8620 message to cache.log. You can allow responses from unknown
8621 nameservers by setting this option to 'off'.
8627 LOC: Config.dns.v4_first
8629 With the IPv6 Internet being as fast or faster than IPv4 Internet
8630 for most networks Squid prefers to contact websites over IPv6.
8632 This option reverses the order of preference to make Squid contact
8633 dual-stack websites over IPv4 first. Squid will still perform both
8634 IPv6 and IPv4 DNS lookups before connecting.
8637 This option will restrict the situations under which IPv6
8638 connectivity is used (and tested). Hiding network problems
8639 which would otherwise be detected and warned about.
8643 COMMENT: (number of entries)
8646 LOC: Config.ipcache.size
8648 Maximum number of DNS IP cache entries.
8655 LOC: Config.ipcache.low
8662 LOC: Config.ipcache.high
8664 The size, low-, and high-water marks for the IP cache.
8667 NAME: fqdncache_size
8668 COMMENT: (number of entries)
8671 LOC: Config.fqdncache.size
8673 Maximum number of FQDN cache entries.
8678 -----------------------------------------------------------------------------
8681 NAME: configuration_includes_quoted_values
8683 TYPE: configuration_includes_quoted_values
8685 LOC: ConfigParser::RecognizeQuotedValues
8687 If set, Squid will recognize each "quoted string" after a configuration
8688 directive as a single parameter. The quotes are stripped before the
8689 parameter value is interpreted or used.
8690 See "Values with spaces, quotes, and other special characters"
8691 section for more details.
8698 LOC: Config.onoff.mem_pools
8700 If set, Squid will keep pools of allocated (but unused) memory
8701 available for future use. If memory is a premium on your
8702 system and you believe your malloc library outperforms Squid
8703 routines, disable this.
8706 NAME: memory_pools_limit
8710 LOC: Config.MemPools.limit
8712 Used only with memory_pools on:
8713 memory_pools_limit 50 MB
8715 If set to a non-zero value, Squid will keep at most the specified
8716 limit of allocated (but unused) memory in memory pools. All free()
8717 requests that exceed this limit will be handled by your malloc
8718 library. Squid does not pre-allocate any memory, just safe-keeps
8719 objects that otherwise would be free()d. Thus, it is safe to set
8720 memory_pools_limit to a reasonably high value even if your
8721 configuration will use less memory.
8723 If set to none, Squid will keep all memory it can. That is, there
8724 will be no limit on the total amount of memory used for safe-keeping.
8726 To disable memory allocation optimization, do not set
8727 memory_pools_limit to 0 or none. Set memory_pools to "off" instead.
8729 An overhead for maintaining memory pools is not taken into account
8730 when the limit is checked. This overhead is close to four bytes per
8731 object kept. However, pools may actually _save_ memory because of
8732 reduced memory thrashing in your malloc library.
8736 COMMENT: on|off|transparent|truncate|delete
8739 LOC: opt_forwarded_for
8741 If set to "on", Squid will append your client's IP address
8742 in the HTTP requests it forwards. By default it looks like:
8744 X-Forwarded-For: 192.1.2.3
8746 If set to "off", it will appear as
8748 X-Forwarded-For: unknown
8750 If set to "transparent", Squid will not alter the
8751 X-Forwarded-For header in any way.
8753 If set to "delete", Squid will delete the entire
8754 X-Forwarded-For header.
8756 If set to "truncate", Squid will remove all existing
8757 X-Forwarded-For entries, and place the client IP as the sole entry.
8760 NAME: cachemgr_passwd
8761 TYPE: cachemgrpasswd
8763 DEFAULT_DOC: No password. Actions which require password are denied.
8764 LOC: Config.passwd_list
8766 Specify passwords for cachemgr operations.
8768 Usage: cachemgr_passwd password action action ...
8770 Some valid actions are (see cache manager menu for a full list):
8810 * Indicates actions which will not be performed without a
8811 valid password, others can be performed if not listed here.
8813 To disable an action, set the password to "disable".
8814 To allow performing an action without a password, set the
8817 Use the keyword "all" to set the same password for all actions.
8820 cachemgr_passwd secret shutdown
8821 cachemgr_passwd lesssssssecret info stats/objects
8822 cachemgr_passwd disable all
8829 LOC: Config.onoff.client_db
8831 If you want to disable collecting per-client statistics,
8832 turn off client_db here.
8835 NAME: refresh_all_ims
8839 LOC: Config.onoff.refresh_all_ims
8841 When you enable this option, squid will always check
8842 the origin server for an update when a client sends an
8843 If-Modified-Since request. Many browsers use IMS
8844 requests when the user requests a reload, and this
8845 ensures those clients receive the latest version.
8847 By default (off), squid may return a Not Modified response
8848 based on the age of the cached version.
8851 NAME: reload_into_ims
8852 IFDEF: USE_HTTP_VIOLATIONS
8856 LOC: Config.onoff.reload_into_ims
8858 When you enable this option, client no-cache or ``reload''
8859 requests will be changed to If-Modified-Since requests.
8860 Doing this VIOLATES the HTTP standard. Enabling this
8861 feature could make you liable for problems which it
8864 see also refresh_pattern for a more selective approach.
8867 NAME: connect_retries
8869 LOC: Config.connect_retries
8871 DEFAULT_DOC: Do not retry failed connections.
8873 This sets the maximum number of connection attempts made for each
8874 TCP connection. The connect_retries attempts must all still
8875 complete within the connection timeout period.
8877 The default is not to re-try if the first connection attempt fails.
8878 The (not recommended) maximum is 10 tries.
8880 A warning message will be generated if it is set to a too-high
8881 value and the configured value will be over-ridden.
8883 Note: These re-tries are in addition to forward_max_tries
8884 which limit how many different addresses may be tried to find
8888 NAME: retry_on_error
8890 LOC: Config.retry.onerror
8893 If set to ON Squid will automatically retry requests when
8894 receiving an error response with status 403 (Forbidden),
8895 500 (Internal Error), 501 or 503 (Service not available).
8896 Status 502 and 504 (Gateway errors) are always retried.
8898 This is mainly useful if you are in a complex cache hierarchy to
8899 work around access control errors.
8901 NOTE: This retry will attempt to find another working destination.
8902 Which is different from the server which just failed.
8905 NAME: as_whois_server
8907 LOC: Config.as_whois_server
8908 DEFAULT: whois.ra.net
8910 WHOIS server to query for AS numbers. NOTE: AS numbers are
8911 queried only when Squid starts up, not for every request.
8916 LOC: Config.onoff.offline
8919 Enable this option and Squid will never try to validate cached
8923 NAME: uri_whitespace
8924 TYPE: uri_whitespace
8925 LOC: Config.uri_whitespace
8928 What to do with requests that have whitespace characters in the
8931 strip: The whitespace characters are stripped out of the URL.
8932 This is the behavior recommended by RFC2396 and RFC3986
8933 for tolerant handling of generic URI.
8934 NOTE: This is one difference between generic URI and HTTP URLs.
8936 deny: The request is denied. The user receives an "Invalid
8938 This is the behaviour recommended by RFC2616 for safe
8939 handling of HTTP request URL.
8941 allow: The request is allowed and the URI is not changed. The
8942 whitespace characters remain in the URI. Note the
8943 whitespace is passed to redirector processes if they
8945 Note this may be considered a violation of RFC2616
8946 request parsing where whitespace is prohibited in the
8949 encode: The request is allowed and the whitespace characters are
8950 encoded according to RFC1738.
8952 chop: The request is allowed and the URI is chopped at the
8956 NOTE the current Squid implementation of encode and chop violates
8957 RFC2616 by not using a 301 redirect after altering the URL.
8962 LOC: Config.chroot_dir
8965 Specifies a directory where Squid should do a chroot() while
8966 initializing. This also causes Squid to fully drop root
8967 privileges after initializing. This means, for example, if you
8968 use a HTTP port less than 1024 and try to reconfigure, you may
8969 get an error saying that Squid can not open the port.
8972 NAME: balance_on_multiple_ip
8974 LOC: Config.onoff.balance_on_multiple_ip
8977 Modern IP resolvers in squid sort lookup results by preferred access.
8978 By default squid will use these IP in order and only rotates to
8979 the next listed when the most preffered fails.
8981 Some load balancing servers based on round robin DNS have been
8982 found not to preserve user session state across requests
8983 to different IP addresses.
8985 Enabling this directive Squid rotates IP's per request.
8988 NAME: pipeline_prefetch
8989 TYPE: pipelinePrefetch
8990 LOC: Config.pipeline_max_prefetch
8992 DEFAULT_DOC: Do not pre-parse pipelined requests.
8994 HTTP clients may send a pipeline of 1+N requests to Squid using a
8995 single connection, without waiting for Squid to respond to the first
8996 of those requests. This option limits the number of concurrent
8997 requests Squid will try to handle in parallel. If set to N, Squid
8998 will try to receive and process up to 1+N requests on the same
8999 connection concurrently.
9001 Defaults to 0 (off) for bandwidth management and access logging
9004 NOTE: pipelining requires persistent connections to clients.
9006 WARNING: pipelining breaks NTLM and Negotiate/Kerberos authentication.
9009 NAME: high_response_time_warning
9012 LOC: Config.warnings.high_rptm
9014 DEFAULT_DOC: disabled.
9016 If the one-minute median response time exceeds this value,
9017 Squid prints a WARNING with debug level 0 to get the
9018 administrators attention. The value is in milliseconds.
9021 NAME: high_page_fault_warning
9023 LOC: Config.warnings.high_pf
9025 DEFAULT_DOC: disabled.
9027 If the one-minute average page fault rate exceeds this
9028 value, Squid prints a WARNING with debug level 0 to get
9029 the administrators attention. The value is in page faults
9033 NAME: high_memory_warning
9035 LOC: Config.warnings.high_memory
9036 IFDEF: HAVE_MSTATS&&HAVE_GNUMALLOC_H
9038 DEFAULT_DOC: disabled.
9040 If the memory usage (as determined by gnumalloc, if available and used)
9041 exceeds this amount, Squid prints a WARNING with debug level 0 to get
9042 the administrators attention.
9044 # TODO: link high_memory_warning to mempools?
9046 NAME: sleep_after_fork
9047 COMMENT: (microseconds)
9049 LOC: Config.sleep_after_fork
9052 When this is set to a non-zero value, the main Squid process
9053 sleeps the specified number of microseconds after a fork()
9054 system call. This sleep may help the situation where your
9055 system reports fork() failures due to lack of (virtual)
9056 memory. Note, however, if you have a lot of child
9057 processes, these sleep delays will add up and your
9058 Squid will not service requests for some amount of time
9059 until all the child processes have been started.
9060 On Windows value less then 1000 (1 milliseconds) are
9064 NAME: windows_ipaddrchangemonitor
9065 IFDEF: _SQUID_WINDOWS_
9069 LOC: Config.onoff.WIN32_IpAddrChangeMonitor
9071 On Windows Squid by default will monitor IP address changes and will
9072 reconfigure itself after any detected event. This is very useful for
9073 proxies connected to internet with dial-up interfaces.
9074 In some cases (a Proxy server acting as VPN gateway is one) it could be
9075 desiderable to disable this behaviour setting this to 'off'.
9076 Note: after changing this, Squid service must be restarted.
9081 IFDEF: USE_SQUID_EUI
9083 LOC: Eui::TheConfig.euiLookup
9085 Whether to lookup the EUI or MAC address of a connected client.
9088 NAME: max_filedescriptors max_filedesc
9091 DEFAULT_DOC: Use operating system limits set by ulimit.
9092 LOC: Config.max_filedescriptors
9094 Reduce the maximum number of filedescriptors supported below
9095 the usual operating system defaults.
9097 Remove from squid.conf to inherit the current ulimit setting.
9099 Note: Changing this requires a restart of Squid. Also
9100 not all I/O types supports large values (eg on Windows).
9107 DEFAULT_DOC: SMP support disabled.
9109 Number of main Squid processes or "workers" to fork and maintain.
9110 0: "no daemon" mode, like running "squid -N ..."
9111 1: "no SMP" mode, start one main Squid process daemon (default)
9112 N: start N main Squid process daemons (i.e., SMP mode)
9114 In SMP mode, each worker does nearly all what a single Squid daemon
9115 does (e.g., listen on http_port and forward HTTP requests).
9118 NAME: cpu_affinity_map
9119 TYPE: CpuAffinityMap
9120 LOC: Config.cpuAffinityMap
9122 DEFAULT_DOC: Let operating system decide.
9124 Usage: cpu_affinity_map process_numbers=P1,P2,... cores=C1,C2,...
9126 Sets 1:1 mapping between Squid processes and CPU cores. For example,
9128 cpu_affinity_map process_numbers=1,2,3,4 cores=1,3,5,7
9130 affects processes 1 through 4 only and places them on the first
9131 four even cores, starting with core #1.
9133 CPU cores are numbered starting from 1. Requires support for
9134 sched_getaffinity(2) and sched_setaffinity(2) system calls.
9136 Multiple cpu_affinity_map options are merged.
projects / thirdparty / squid.git / blob