1 ## Copyright (C) 1996-2015 The Squid Software Foundation and contributors
3 ## Squid software is distributed under GPLv2+ license and includes
4 ## contributions from numerous individuals and organizations.
5 ## Please see the COPYING and CONTRIBUTORS files for details.
10 ----------------------------
12 This is the documentation for the Squid configuration file.
13 This documentation can also be found online at:
14 http://www.squid-cache.org/Doc/config/
16 You may wish to look at the Squid home page and wiki for the
17 FAQ and other documentation:
18 http://www.squid-cache.org/
19 http://wiki.squid-cache.org/SquidFaq
20 http://wiki.squid-cache.org/ConfigExamples
22 This documentation shows what the defaults for various directives
23 happen to be. If you don't need to change the default, you should
24 leave the line out of your squid.conf in most cases.
26 In some cases "none" refers to no default setting at all,
27 while in other cases it refers to the value of the option
28 - the comments for that keyword indicate if this is the case.
33 Configuration options can be included using the "include" directive.
34 Include takes a list of files to include. Quoting and wildcards are
39 include /path/to/included/file/squid.acl.config
41 Includes can be nested up to a hard-coded depth of 16 levels.
42 This arbitrary restriction is to prevent recursive include references
43 from causing Squid entering an infinite loop whilst trying to load
46 Values with byte units
48 Squid accepts size units on some size related directives. All
49 such directives are documented with a default value displaying
52 Units accepted by Squid are:
54 KB - Kilobyte (1024 bytes)
58 Values with spaces, quotes, and other special characters
60 Squid supports directive parameters with spaces, quotes, and other
61 special characters. Surround such parameters with "double quotes". Use
62 the configuration_includes_quoted_values directive to enable or
65 Squid supports reading configuration option parameters from external
66 files using the syntax:
67 parameters("/path/filename")
69 acl whitelist dstdomain parameters("/etc/squid/whitelist.txt")
71 Conditional configuration
73 If-statements can be used to make configuration directives
77 ... regular configuration directives ...
79 ... regular configuration directives ...]
82 The else part is optional. The keywords "if", "else", and "endif"
83 must be typed on their own lines, as if they were regular
84 configuration directives.
86 NOTE: An else-if condition is not supported.
88 These individual conditions types are supported:
91 Always evaluates to true.
93 Always evaluates to false.
95 Equality comparison of two integer numbers.
100 The following SMP-related preprocessor macros can be used.
102 ${process_name} expands to the current Squid process "name"
103 (e.g., squid1, squid2, or cache1).
105 ${process_number} expands to the current Squid process
106 identifier, which is an integer number (e.g., 1, 2, 3) unique
107 across all Squid processes of the current service instance.
109 ${service_name} expands into the current Squid service instance
110 name identifier which is provided by -n on the command line.
114 # options still not yet ported from 2.7 to 3.x
115 NAME: broken_vary_encoding
118 This option is not yet supported by Squid-3.
124 This option is not yet supported by Squid-3.
130 This option is not yet supported by Squid-3.
133 NAME: external_refresh_check
136 This option is not yet supported by Squid-3.
139 NAME: location_rewrite_program location_rewrite_access location_rewrite_children location_rewrite_concurrency
142 This option is not yet supported by Squid-3.
145 NAME: refresh_stale_hit
148 This option is not yet supported by Squid-3.
151 # Options removed in 3.6
152 NAME: cache_peer_domain cache_host_domain
155 Replace with dstdomain ACLs and cache_peer_access.
158 NAME: sslproxy_cafile
161 Remove this line. Use tls_outgoing_options cafile= instead.
164 NAME: sslproxy_capath
167 Remove this line. Use tls_outgoing_options capath= instead.
170 NAME: sslproxy_cipher
173 Remove this line. Use tls_outgoing_options cipher= instead.
176 NAME: sslproxy_client_certificate
179 Remove this line. Use tls_outgoing_options cert= instead.
182 NAME: sslproxy_client_key
185 Remove this line. Use tls_outgoing_options key= instead.
191 Remove this line. Use tls_outgoing_options flags= instead.
194 NAME: sslproxy_options
197 Remove this line. Use tls_outgoing_options options= instead.
200 NAME: sslproxy_version
203 Remove this line. Use tls_outgoing_options options= instead.
206 # Options removed in 3.5
207 NAME: hierarchy_stoplist
210 Remove this line. Use always_direct or cache_peer_access ACLs instead if you need to prevent cache_peer use.
213 # Options removed in 3.4
217 Remove this line. Use acls with access_log directives to control access logging
223 Remove this line. Use acls with icap_log directives to control icap logging
226 # Options Removed in 3.3
227 NAME: ignore_ims_on_miss
230 Remove this line. The HTTP/1.1 feature is now configured by 'cache_miss_revalidate'.
233 # Options Removed in 3.2
234 NAME: chunked_request_body_max_size
237 Remove this line. Squid is now HTTP/1.1 compliant.
240 NAME: dns_v4_fallback
243 Remove this line. Squid performs a 'Happy Eyeballs' algorithm, the 'fallback' algorithm is no longer relevant.
246 NAME: emulate_httpd_log
249 Replace this with an access_log directive using the format 'common' or 'combined'.
255 Use a regular access.log with ACL limiting it to MISS events.
261 Remove this line. Configure FTP page display using the CSS controls in errorpages.css instead.
264 NAME: ignore_expect_100
267 Remove this line. The HTTP/1.1 feature is now fully supported by default.
273 Remove this option from your config. To log FQDN use %>A in the log format.
276 NAME: log_ip_on_direct
279 Remove this option from your config. To log server or peer names use %<A in the log format.
282 NAME: maximum_single_addr_tries
285 Replaced by connect_retries. The behaviour has changed, please read the documentation before altering.
288 NAME: referer_log referrer_log
291 Replace this with an access_log directive using the format 'referrer'.
297 Remove this line. The feature is supported by default in storage types where update is implemented.
300 NAME: url_rewrite_concurrency
303 Remove this line. Set the 'concurrency=' option of url_rewrite_children instead.
309 Replace this with an access_log directive using the format 'useragent'.
312 # Options Removed in 3.1
316 Remove this line. DNS is no longer tested on startup.
319 NAME: extension_methods
322 Remove this line. All valid methods for HTTP are accepted by default.
325 # 2.7 Options Removed/Replaced in 3.2
330 # 2.7 Options Removed/Replaced in 3.1
338 Remove this line. HTTP/1.1 is supported by default.
341 NAME: upgrade_http0.9
344 Remove this line. ICY/1.0 streaming protocol is supported by default.
347 NAME: zph_local zph_mode zph_option zph_parent zph_sibling
350 Alter these entries. Use the qos_flows directive instead.
353 # Options Removed in 3.0
357 Since squid-3.0 replace with request_header_access or reply_header_access
358 depending on whether you wish to match client requests or server replies.
361 NAME: httpd_accel_no_pmtu_disc
364 Since squid-3.0 use the 'disable-pmtu-discovery' flag on http_port instead.
367 NAME: wais_relay_host
370 Replace this line with 'cache_peer' configuration.
373 NAME: wais_relay_port
376 Replace this line with 'cache_peer' configuration.
381 -----------------------------------------------------------------------------
388 DEFAULT_DOC: SMP support disabled.
390 Number of main Squid processes or "workers" to fork and maintain.
391 0: "no daemon" mode, like running "squid -N ..."
392 1: "no SMP" mode, start one main Squid process daemon (default)
393 N: start N main Squid process daemons (i.e., SMP mode)
395 In SMP mode, each worker does nearly all what a single Squid daemon
396 does (e.g., listen on http_port and forward HTTP requests).
399 NAME: cpu_affinity_map
401 LOC: Config.cpuAffinityMap
403 DEFAULT_DOC: Let operating system decide.
405 Usage: cpu_affinity_map process_numbers=P1,P2,... cores=C1,C2,...
407 Sets 1:1 mapping between Squid processes and CPU cores. For example,
409 cpu_affinity_map process_numbers=1,2,3,4 cores=1,3,5,7
411 affects processes 1 through 4 only and places them on the first
412 four even cores, starting with core #1.
414 CPU cores are numbered starting from 1. Requires support for
415 sched_getaffinity(2) and sched_setaffinity(2) system calls.
417 Multiple cpu_affinity_map options are merged.
423 OPTIONS FOR AUTHENTICATION
424 -----------------------------------------------------------------------------
433 This is used to define parameters for the various authentication
434 schemes supported by Squid.
436 format: auth_param scheme parameter [setting]
438 The order in which authentication schemes are presented to the client is
439 dependent on the order the scheme first appears in config file. IE
440 has a bug (it's not RFC 2617 compliant) in that it will use the basic
441 scheme if basic is the first entry presented, even if more secure
442 schemes are presented. For now use the order in the recommended
443 settings section below. If other browsers have difficulties (don't
444 recognize the schemes offered even if you are using basic) either
445 put basic first, or disable the other schemes (by commenting out their
448 Once an authentication scheme is fully configured, it can only be
449 shutdown by shutting squid down and restarting. Changes can be made on
450 the fly and activated with a reconfigure. I.E. You can change to a
451 different helper, but not unconfigure the helper completely.
453 Please note that while this directive defines how Squid processes
454 authentication it does not automatically activate authentication.
455 To use authentication you must in addition make use of ACLs based
456 on login name in http_access (proxy_auth, proxy_auth_regex or
457 external with %LOGIN used in the format tag). The browser will be
458 challenged for authentication on the first such acl encountered
459 in http_access processing and will also be re-challenged for new
460 login credentials if the request is being denied by a proxy_auth
463 WARNING: authentication can't be used in a transparently intercepting
464 proxy as the client then thinks it is talking to an origin server and
465 not the proxy. This is a limitation of bending the TCP/IP protocol to
466 transparently intercepting port 80, not a limitation in Squid.
467 Ports flagged 'transparent', 'intercept', or 'tproxy' have
468 authentication disabled.
470 === Parameters common to all schemes. ===
473 Specifies the command for the external authenticator.
475 By default, each authentication scheme is not used unless a
476 program is specified.
478 See http://wiki.squid-cache.org/Features/AddonHelpers for
479 more details on helper operations and creating your own.
482 Specifies a string to be append to request line format for
483 the authentication helper. "Quoted" format values may contain
484 spaces and logformat %macros. In theory, any logformat %macro
485 can be used. In practice, a %macro expands as a dash (-) if
486 the helper request is sent before the required macro
487 information is available to Squid.
489 By default, Squid uses request formats provided in
490 scheme-specific examples below (search for %credentials).
492 The expanded key_extras value is added to the Squid credentials
493 cache and, hence, will affect authentication. It can be used to
494 autenticate different users with identical user names (e.g.,
495 when user authentication depends on http_port).
497 Avoid adding frequently changing information to key_extras. For
498 example, if you add user source IP, and it changes frequently
499 in your environment, then max_user_ip ACL is going to treat
500 every user+IP combination as a unique "user", breaking the ACL
501 and wasting a lot of memory on those user records. It will also
502 force users to authenticate from scratch whenever their IP
506 Specifies the protection scope (aka realm name) which is to be
507 reported to the client for the authentication scheme. It is
508 commonly part of the text the user will see when prompted for
509 their username and password.
511 For Basic the default is "Squid proxy-caching web server".
512 For Digest there is no default, this parameter is mandatory.
513 For NTLM and Negotiate this parameter is ignored.
515 "children" numberofchildren [startup=N] [idle=N] [concurrency=N] [queue-size=N]
517 The maximum number of authenticator processes to spawn. If
518 you start too few Squid will have to wait for them to process
519 a backlog of credential verifications, slowing it down. When
520 password verifications are done via a (slow) network you are
521 likely to need lots of authenticator processes.
523 The startup= and idle= options permit some skew in the exact
524 amount run. A minimum of startup=N will begin during startup
525 and reconfigure. Squid will start more in groups of up to
526 idle=N in an attempt to meet traffic needs and to keep idle=N
527 free above those traffic needs up to the maximum.
529 The concurrency= option sets the number of concurrent requests
530 the helper can process. The default of 0 is used for helpers
531 who only supports one request at a time. Setting this to a
532 number greater than 0 changes the protocol used to include a
533 channel ID field first on the request/response line, allowing
534 multiple requests to be sent to the same helper in parallel
535 without waiting for the response.
537 Concurrency must not be set unless it's known the helper
538 supports the input format with channel-ID fields.
540 The queue-size= option sets the maximum number of queued
541 requests. If the queued requests exceed queue size for more
542 than 3 minutes then squid aborts its operation.
543 The default value is set to 2*numberofchildren/
545 NOTE: NTLM and Negotiate schemes do not support concurrency
546 in the Squid code module even though some helpers can.
549 IF HAVE_AUTH_MODULE_BASIC
550 === Basic authentication parameters ===
553 HTTP uses iso-latin-1 as character set, while some
554 authentication backends such as LDAP expects UTF-8. If this is
555 set to on Squid will translate the HTTP iso-latin-1 charset to
556 UTF-8 before sending the username and password to the helper.
558 "credentialsttl" timetolive
559 Specifies how long squid assumes an externally validated
560 username:password pair is valid for - in other words how
561 often the helper program is called for that user. Set this
562 low to force revalidation with short lived passwords.
564 NOTE: setting this high does not impact your susceptibility
565 to replay attacks unless you are using an one-time password
566 system (such as SecureID). If you are using such a system,
567 you will be vulnerable to replay attacks unless you also
568 use the max_user_ip ACL in an http_access rule.
570 "casesensitive" on|off
571 Specifies if usernames are case sensitive. Most user databases
572 are case insensitive allowing the same username to be spelled
573 using both lower and upper case letters, but some are case
574 sensitive. This makes a big difference for user_max_ip ACL
575 processing and similar.
578 IF HAVE_AUTH_MODULE_DIGEST
579 === Digest authentication parameters ===
582 HTTP uses iso-latin-1 as character set, while some
583 authentication backends such as LDAP expects UTF-8. If this is
584 set to on Squid will translate the HTTP iso-latin-1 charset to
585 UTF-8 before sending the username and password to the helper.
587 "nonce_garbage_interval" timeinterval
588 Specifies the interval that nonces that have been issued
589 to client_agent's are checked for validity.
591 "nonce_max_duration" timeinterval
592 Specifies the maximum length of time a given nonce will be
595 "nonce_max_count" number
596 Specifies the maximum number of times a given nonce can be
599 "nonce_strictness" on|off
600 Determines if squid requires strict increment-by-1 behavior
601 for nonce counts, or just incrementing (off - for use when
602 user agents generate nonce counts that occasionally miss 1
603 (ie, 1,2,4,6)). Default off.
605 "check_nonce_count" on|off
606 This directive if set to off can disable the nonce count check
607 completely to work around buggy digest qop implementations in
608 certain mainstream browser versions. Default on to check the
609 nonce count to protect from authentication replay attacks.
611 "post_workaround" on|off
612 This is a workaround to certain buggy browsers who send an
613 incorrect request digest in POST requests when reusing the
614 same nonce as acquired earlier on a GET request.
617 IF HAVE_AUTH_MODULE_NEGOTIATE
618 === Negotiate authentication parameters ===
621 If you experience problems with PUT/POST requests when using
622 the this authentication scheme then you can try setting this
623 to off. This will cause Squid to forcibly close the connection
624 on the initial request where the browser asks which schemes
625 are supported by the proxy.
628 IF HAVE_AUTH_MODULE_NTLM
629 === NTLM authentication parameters ===
632 If you experience problems with PUT/POST requests when using
633 the this authentication scheme then you can try setting this
634 to off. This will cause Squid to forcibly close the connection
635 on the initial request where the browser asks which schemes
636 are supported by the proxy.
639 === Example Configuration ===
641 This configuration displays the recommended authentication scheme
642 order from most to least secure with recommended minimum configuration
643 settings for each scheme:
645 #auth_param negotiate program <uncomment and complete this line to activate>
646 #auth_param negotiate children 20 startup=0 idle=1
647 #auth_param negotiate keep_alive on
649 #auth_param digest program <uncomment and complete this line to activate>
650 #auth_param digest children 20 startup=0 idle=1
651 #auth_param digest realm Squid proxy-caching web server
652 #auth_param digest nonce_garbage_interval 5 minutes
653 #auth_param digest nonce_max_duration 30 minutes
654 #auth_param digest nonce_max_count 50
656 #auth_param ntlm program <uncomment and complete this line to activate>
657 #auth_param ntlm children 20 startup=0 idle=1
658 #auth_param ntlm keep_alive on
660 #auth_param basic program <uncomment and complete this line>
661 #auth_param basic children 5 startup=5 idle=1
662 #auth_param basic realm Squid proxy-caching web server
663 #auth_param basic credentialsttl 2 hours
666 NAME: authenticate_cache_garbage_interval
669 LOC: Config.authenticateGCInterval
671 The time period between garbage collection across the username cache.
672 This is a trade-off between memory utilization (long intervals - say
673 2 days) and CPU (short intervals - say 1 minute). Only change if you
677 NAME: authenticate_ttl
680 LOC: Config.authenticateTTL
682 The time a user & their credentials stay in the logged in
683 user cache since their last request. When the garbage
684 interval passes, all user credentials that have passed their
685 TTL are removed from memory.
688 NAME: authenticate_ip_ttl
690 LOC: Config.authenticateIpTTL
693 If you use proxy authentication and the 'max_user_ip' ACL,
694 this directive controls how long Squid remembers the IP
695 addresses associated with each user. Use a small value
696 (e.g., 60 seconds) if your users might change addresses
697 quickly, as is the case with dialup. You might be safe
698 using a larger value (e.g., 2 hours) in a corporate LAN
699 environment with relatively static address assignments.
704 -----------------------------------------------------------------------------
707 NAME: external_acl_type
708 TYPE: externalAclHelper
709 LOC: Config.externalAclHelperList
712 This option defines external acl classes using a helper program
713 to look up the status
715 external_acl_type name [options] FORMAT.. /path/to/helper [helper arguments..]
719 ttl=n TTL in seconds for cached results (defaults to 3600
723 TTL for cached negative lookups (default same
726 grace=n Percentage remaining of TTL where a refresh of a
727 cached entry should be initiated without needing to
728 wait for a new reply. (default is for no grace period)
730 cache=n Limit the result cache size, default is 262144.
731 The expanded FORMAT value is used as the cache key, so
732 if the details in FORMAT are highly variable a larger
733 cache may be needed to produce reduction in helper load.
736 Maximum number of acl helper processes spawned to service
737 external acl lookups of this type. (default 20)
740 Minimum number of acl helper processes to spawn during
741 startup and reconfigure to service external acl lookups
742 of this type. (default 0)
745 Number of acl helper processes to keep ahead of traffic
746 loads. Squid will spawn this many at once whenever load
747 rises above the capabilities of existing processes.
748 Up to the value of children-max. (default 1)
750 concurrency=n concurrency level per process. Only used with helpers
751 capable of processing more than one query at a time.
753 queue-size=N The queue-size= option sets the maximum number of queued
754 requests. If the queued requests exceed queue size
756 The default value is set to 2*children-max.
758 protocol=2.5 Compatibility mode for Squid-2.5 external acl helpers.
760 ipv4 / ipv6 IP protocol used to communicate with this helper.
761 The default is to auto-detect IPv6 and use it when available.
764 FORMAT specifications
766 %LOGIN Authenticated user login name
767 %un A user name. Expands to the first available name
768 from the following list of information sources:
769 - authenticated user name, like %ul or %LOGIN
770 - user name sent by an external ACL, like %EXT_USER
771 - SSL client name, like %us in logformat
772 - ident user name, like %ui in logformat
773 %EXT_USER Username from previous external acl
774 %EXT_LOG Log details from previous external acl
775 %EXT_TAG Tag from previous external acl
776 %IDENT Ident user name
778 %SRCPORT Client source port
781 %PROTO Requested URL scheme
783 %PATH Requested URL path
784 %METHOD Request method
785 %MYADDR Squid interface address
786 %MYPORT Squid http_port number
787 %PATH Requested URL-path (including query-string if any)
788 %USER_CERT SSL User certificate in PEM format
789 %USER_CERTCHAIN SSL User certificate chain in PEM format
790 %USER_CERT_xx SSL User certificate subject attribute xx
791 %USER_CA_CERT_xx SSL User certificate issuer attribute xx
792 %ssl::>sni SSL client SNI sent to Squid
793 %ssl::<cert_subject SSL server certificate DN
794 %ssl::<cert_issuer SSL server certificate issuer DN
796 %>{Header} HTTP request header "Header"
798 HTTP request header "Hdr" list member "member"
800 HTTP request header list member using ; as
801 list separator. ; can be any non-alphanumeric
804 %<{Header} HTTP reply header "Header"
806 HTTP reply header "Hdr" list member "member"
808 HTTP reply header list member using ; as
809 list separator. ; can be any non-alphanumeric
812 %ACL The name of the ACL being tested.
813 %DATA The ACL arguments. If not used then any arguments
814 is automatically added at the end of the line
816 NOTE: this will encode the arguments as one token,
817 whereas the default will pass each separately.
819 %% The percent sign. Useful for helpers which need
820 an unchanging input format.
823 General request syntax:
825 [channel-ID] FORMAT-values [acl-values ...]
828 FORMAT-values consists of transaction details expanded with
829 whitespace separation per the config file FORMAT specification
830 using the FORMAT macros listed above.
832 acl-values consists of any string specified in the referencing
833 config 'acl ... external' line. see the "acl external" directive.
835 Request values sent to the helper are URL escaped to protect
836 each value in requests against whitespaces.
838 If using protocol=2.5 then the request sent to the helper is not
839 URL escaped to protect against whitespace.
841 NOTE: protocol=3.0 is deprecated as no longer necessary.
843 When using the concurrency= option the protocol is changed by
844 introducing a query channel tag in front of the request/response.
845 The query channel tag is a number between 0 and concurrency-1.
846 This value must be echoed back unchanged to Squid as the first part
847 of the response relating to its request.
850 The helper receives lines expanded per the above format specification
851 and for each input line returns 1 line starting with OK/ERR/BH result
852 code and optionally followed by additional keywords with more details.
855 General result syntax:
857 [channel-ID] result keyword=value ...
859 Result consists of one of the codes:
862 the ACL test produced a match.
865 the ACL test does not produce a match.
868 An internal error occurred in the helper, preventing
869 a result being identified.
871 The meaning of 'a match' is determined by your squid.conf
872 access control configuration. See the Squid wiki for details.
876 user= The users name (login)
878 password= The users password (for login= cache_peer option)
880 message= Message describing the reason for this response.
881 Available as %o in error pages.
882 Useful on (ERR and BH results).
884 tag= Apply a tag to a request. Only sets a tag once,
885 does not alter existing tags.
887 log= String to be logged in access.log. Available as
888 %ea in logformat specifications.
890 clt_conn_tag= Associates a TAG with the client TCP connection.
891 Please see url_rewrite_program related documentation
894 Any keywords may be sent on any response whether OK, ERR or BH.
896 All response keyword values need to be a single token with URL
897 escaping, or enclosed in double quotes (") and escaped using \ on
898 any double quotes or \ characters within the value. The wrapping
899 double quotes are removed before the value is interpreted by Squid.
900 \r and \n are also replace by CR and LF.
902 Some example key values:
906 user="J. \"Bob\" Smith"
913 DEFAULT: ssl::certHasExpired ssl_error X509_V_ERR_CERT_HAS_EXPIRED
914 DEFAULT: ssl::certNotYetValid ssl_error X509_V_ERR_CERT_NOT_YET_VALID
915 DEFAULT: ssl::certDomainMismatch ssl_error SQUID_X509_V_ERR_DOMAIN_MISMATCH
916 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
917 DEFAULT: ssl::certSelfSigned ssl_error X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT
920 DEFAULT: manager url_regex -i ^cache_object:// +i ^https?://[^/]+/squid-internal-mgr/
921 DEFAULT: localhost src 127.0.0.1/32 ::1
922 DEFAULT: to_localhost dst 127.0.0.0/8 0.0.0.0/32 ::1
923 DEFAULT_DOC: ACLs all, manager, localhost, and to_localhost are predefined.
925 Defining an Access List
927 Every access list definition must begin with an aclname and acltype,
928 followed by either type-specific arguments or a quoted filename that
931 acl aclname acltype argument ...
932 acl aclname acltype "file" ...
934 When using "file", the file should contain one item per line.
936 Some acl types supports options which changes their default behaviour.
937 The available options are:
939 -i,+i By default, regular expressions are CASE-SENSITIVE. To make them
940 case-insensitive, use the -i option. To return case-sensitive
941 use the +i option between patterns, or make a new ACL line
944 -n Disable lookups and address type conversions. If lookup or
945 conversion is required because the parameter type (IP or
946 domain name) does not match the message address type (domain
947 name or IP), then the ACL would immediately declare a mismatch
948 without any warnings or lookups.
950 -- Used to stop processing all options, in the case the first acl
951 value has '-' character as first character (for example the '-'
952 is a valid domain name)
954 Some acl types require suspending the current request in order
955 to access some external data source.
956 Those which do are marked with the tag [slow], those which
957 don't are marked as [fast].
958 See http://wiki.squid-cache.org/SquidFaq/SquidAcl
959 for further information
961 ***** ACL TYPES AVAILABLE *****
963 acl aclname src ip-address/mask ... # clients IP address [fast]
964 acl aclname src addr1-addr2/mask ... # range of addresses [fast]
965 acl aclname dst [-n] ip-address/mask ... # URL host's IP address [slow]
966 acl aclname localip ip-address/mask ... # IP address the client connected to [fast]
968 acl aclname arp mac-address ... (xx:xx:xx:xx:xx:xx notation)
969 # The arp ACL requires the special configure option --enable-arp-acl.
970 # Furthermore, the ARP ACL code is not portable to all operating systems.
971 # It works on Linux, Solaris, Windows, FreeBSD, and some
972 # other *BSD variants.
975 # NOTE: Squid can only determine the MAC address for clients that are on
976 # the same subnet. If the client is on a different subnet,
977 # then Squid cannot find out its MAC address.
979 acl aclname srcdomain .foo.com ...
980 # reverse lookup, from client IP [slow]
981 acl aclname dstdomain [-n] .foo.com ...
982 # Destination server from URL [fast]
983 acl aclname srcdom_regex [-i] \.foo\.com ...
984 # regex matching client name [slow]
985 acl aclname dstdom_regex [-n] [-i] \.foo\.com ...
986 # regex matching server [fast]
988 # For dstdomain and dstdom_regex a reverse lookup is tried if a IP
989 # based URL is used and no match is found. The name "none" is used
990 # if the reverse lookup fails.
992 acl aclname src_as number ...
993 acl aclname dst_as number ...
995 # Except for access control, AS numbers can be used for
996 # routing of requests to specific caches. Here's an
997 # example for routing all requests for AS#1241 and only
998 # those to mycache.mydomain.net:
999 # acl asexample dst_as 1241
1000 # cache_peer_access mycache.mydomain.net allow asexample
1001 # cache_peer_access mycache_mydomain.net deny all
1003 acl aclname peername myPeer ...
1005 # match against a named cache_peer entry
1006 # set unique name= on cache_peer lines for reliable use.
1008 acl aclname time [day-abbrevs] [h1:m1-h2:m2]
1018 # h1:m1 must be less than h2:m2
1020 acl aclname url_regex [-i] ^http:// ...
1021 # regex matching on whole URL [fast]
1022 acl aclname urllogin [-i] [^a-zA-Z0-9] ...
1023 # regex matching on URL login field
1024 acl aclname urlpath_regex [-i] \.gif$ ...
1025 # regex matching on URL path [fast]
1027 acl aclname port 80 70 21 0-1024... # destination TCP port [fast]
1029 acl aclname localport 3128 ... # TCP port the client connected to [fast]
1030 # NP: for interception mode this is usually '80'
1032 acl aclname myportname 3128 ... # *_port name [fast]
1034 acl aclname proto HTTP FTP ... # request protocol [fast]
1036 acl aclname method GET POST ... # HTTP request method [fast]
1038 acl aclname http_status 200 301 500- 400-403 ...
1039 # status code in reply [fast]
1041 acl aclname browser [-i] regexp ...
1042 # pattern match on User-Agent header (see also req_header below) [fast]
1044 acl aclname referer_regex [-i] regexp ...
1045 # pattern match on Referer header [fast]
1046 # Referer is highly unreliable, so use with care
1048 acl aclname ident username ...
1049 acl aclname ident_regex [-i] pattern ...
1050 # string match on ident output [slow]
1051 # use REQUIRED to accept any non-null ident.
1053 acl aclname proxy_auth [-i] username ...
1054 acl aclname proxy_auth_regex [-i] pattern ...
1055 # perform http authentication challenge to the client and match against
1056 # supplied credentials [slow]
1058 # takes a list of allowed usernames.
1059 # use REQUIRED to accept any valid username.
1061 # Will use proxy authentication in forward-proxy scenarios, and plain
1062 # http authenticaiton in reverse-proxy scenarios
1064 # NOTE: when a Proxy-Authentication header is sent but it is not
1065 # needed during ACL checking the username is NOT logged
1068 # NOTE: proxy_auth requires a EXTERNAL authentication program
1069 # to check username/password combinations (see
1070 # auth_param directive).
1072 # NOTE: proxy_auth can't be used in a transparent/intercepting proxy
1073 # as the browser needs to be configured for using a proxy in order
1074 # to respond to proxy authentication.
1076 acl aclname snmp_community string ...
1077 # A community string to limit access to your SNMP Agent [fast]
1080 # acl snmppublic snmp_community public
1082 acl aclname maxconn number
1083 # This will be matched when the client's IP address has
1084 # more than <number> TCP connections established. [fast]
1085 # NOTE: This only measures direct TCP links so X-Forwarded-For
1086 # indirect clients are not counted.
1088 acl aclname max_user_ip [-s] number
1089 # This will be matched when the user attempts to log in from more
1090 # than <number> different ip addresses. The authenticate_ip_ttl
1091 # parameter controls the timeout on the ip entries. [fast]
1092 # If -s is specified the limit is strict, denying browsing
1093 # from any further IP addresses until the ttl has expired. Without
1094 # -s Squid will just annoy the user by "randomly" denying requests.
1095 # (the counter is reset each time the limit is reached and a
1096 # request is denied)
1097 # NOTE: in acceleration mode or where there is mesh of child proxies,
1098 # clients may appear to come from multiple addresses if they are
1099 # going through proxy farms, so a limit of 1 may cause user problems.
1101 acl aclname random probability
1102 # Pseudo-randomly match requests. Based on the probability given.
1103 # Probability may be written as a decimal (0.333), fraction (1/3)
1104 # or ratio of matches:non-matches (3:5).
1106 acl aclname req_mime_type [-i] mime-type ...
1107 # regex match against the mime type of the request generated
1108 # by the client. Can be used to detect file upload or some
1109 # types HTTP tunneling requests [fast]
1110 # NOTE: This does NOT match the reply. You cannot use this
1111 # to match the returned file type.
1113 acl aclname req_header header-name [-i] any\.regex\.here
1114 # regex match against any of the known request headers. May be
1115 # thought of as a superset of "browser", "referer" and "mime-type"
1118 acl aclname rep_mime_type [-i] mime-type ...
1119 # regex match against the mime type of the reply received by
1120 # squid. Can be used to detect file download or some
1121 # types HTTP tunneling requests. [fast]
1122 # NOTE: This has no effect in http_access rules. It only has
1123 # effect in rules that affect the reply data stream such as
1124 # http_reply_access.
1126 acl aclname rep_header header-name [-i] any\.regex\.here
1127 # regex match against any of the known reply headers. May be
1128 # thought of as a superset of "browser", "referer" and "mime-type"
1131 acl aclname external class_name [arguments...]
1132 # external ACL lookup via a helper class defined by the
1133 # external_acl_type directive [slow]
1135 acl aclname user_cert attribute values...
1136 # match against attributes in a user SSL certificate
1137 # attribute is one of DN/C/O/CN/L/ST or a numerical OID [fast]
1139 acl aclname ca_cert attribute values...
1140 # match against attributes a users issuing CA SSL certificate
1141 # attribute is one of DN/C/O/CN/L/ST or a numerical OID [fast]
1143 acl aclname ext_user username ...
1144 acl aclname ext_user_regex [-i] pattern ...
1145 # string match on username returned by external acl helper [slow]
1146 # use REQUIRED to accept any non-null user name.
1148 acl aclname tag tagvalue ...
1149 # string match on tag returned by external acl helper [fast]
1150 # DEPRECATED. Only the first tag will match with this ACL.
1151 # Use the 'note' ACL instead for handling multiple tag values.
1153 acl aclname hier_code codename ...
1154 # string match against squid hierarchy code(s); [fast]
1155 # e.g., DIRECT, PARENT_HIT, NONE, etc.
1157 # NOTE: This has no effect in http_access rules. It only has
1158 # effect in rules that affect the reply data stream such as
1159 # http_reply_access.
1161 acl aclname note name [value ...]
1162 # match transaction annotation [fast]
1163 # Without values, matches any annotation with a given name.
1164 # With value(s), matches any annotation with a given name that
1165 # also has one of the given values.
1166 # Names and values are compared using a string equality test.
1167 # Annotation sources include note and adaptation_meta directives
1168 # as well as helper and eCAP responses.
1170 acl aclname adaptation_service service ...
1171 # Matches the name of any icap_service, ecap_service,
1172 # adaptation_service_set, or adaptation_service_chain that Squid
1173 # has used (or attempted to use) for the master transaction.
1174 # This ACL must be defined after the corresponding adaptation
1175 # service is named in squid.conf. This ACL is usable with
1176 # adaptation_meta because it starts matching immediately after
1177 # the service has been selected for adaptation.
1180 acl aclname ssl_error errorname
1181 # match against SSL certificate validation error [fast]
1183 # For valid error names see in @DEFAULT_ERROR_DIR@/templates/error-details.txt
1186 # The following can be used as shortcuts for certificate properties:
1187 # [ssl::]certHasExpired: the "not after" field is in the past
1188 # [ssl::]certNotYetValid: the "not before" field is in the future
1189 # [ssl::]certUntrusted: The certificate issuer is not to be trusted.
1190 # [ssl::]certSelfSigned: The certificate is self signed.
1191 # [ssl::]certDomainMismatch: The certificate CN domain does not
1192 # match the name the name of the host we are connecting to.
1194 # The ssl::certHasExpired, ssl::certNotYetValid, ssl::certDomainMismatch,
1195 # ssl::certUntrusted, and ssl::certSelfSigned can also be used as
1196 # predefined ACLs, just like the 'all' ACL.
1198 # NOTE: The ssl_error ACL is only supported with sslproxy_cert_error,
1199 # sslproxy_cert_sign, and sslproxy_cert_adapt options.
1201 acl aclname server_cert_fingerprint [-sha1] fingerprint
1202 # match against server SSL certificate fingerprint [fast]
1204 # The fingerprint is the digest of the DER encoded version
1205 # of the whole certificate. The user should use the form: XX:XX:...
1206 # Optional argument specifies the digest algorithm to use.
1207 # The SHA1 digest algorithm is the default and is currently
1208 # the only algorithm supported (-sha1).
1210 acl aclname at_step step
1211 # match against the current step during ssl_bump evaluation [fast]
1212 # Never matches and should not be used outside the ssl_bump context.
1214 # At each SslBump step, Squid evaluates ssl_bump directives to find
1215 # the next bumping action (e.g., peek or splice). Valid SslBump step
1216 # values and the corresponding ssl_bump evaluation moments are:
1217 # SslBump1: After getting TCP-level and HTTP CONNECT info.
1218 # SslBump2: After getting SSL Client Hello info.
1219 # SslBump3: After getting SSL Server Hello info.
1221 acl aclname ssl::server_name .foo.com ...
1222 # matches server name obtained from various sources [fast]
1224 # The server name is obtained during Ssl-Bump steps from such sources
1225 # as CONNECT request URI, client SNI, and SSL server certificate CN.
1226 # During each Ssl-Bump step, Squid may improve its understanding of a
1227 # "true server name". Unlike dstdomain, this ACL does not perform
1230 acl aclname ssl::server_name_regex [-i] \.foo\.com ...
1231 # regex matches server name obtained from various sources [fast]
1233 acl aclname any-of acl1 acl2 ...
1234 # match any one of the acls [fast or slow]
1235 # The first matching ACL stops further ACL evaluation.
1237 # ACLs from multiple any-of lines with the same name are ORed.
1238 # For example, A = (a1 or a2) or (a3 or a4) can be written as
1239 # acl A any-of a1 a2
1240 # acl A any-of a3 a4
1242 # This group ACL is fast if all evaluated ACLs in the group are fast
1243 # and slow otherwise.
1245 acl aclname all-of acl1 acl2 ...
1246 # match all of the acls [fast or slow]
1247 # The first mismatching ACL stops further ACL evaluation.
1249 # ACLs from multiple all-of lines with the same name are ORed.
1250 # For example, B = (b1 and b2) or (b3 and b4) can be written as
1251 # acl B all-of b1 b2
1252 # acl B all-of b3 b4
1254 # This group ACL is fast if all evaluated ACLs in the group are fast
1255 # and slow otherwise.
1258 acl macaddress arp 09:00:2b:23:45:67
1259 acl myexample dst_as 1241
1260 acl password proxy_auth REQUIRED
1261 acl fileupload req_mime_type -i ^multipart/form-data$
1262 acl javascript rep_mime_type -i ^application/x-javascript$
1266 # Recommended minimum configuration:
1269 # Example rule allowing access from your local networks.
1270 # Adapt to list your (internal) IP networks from where browsing
1272 acl localnet src 0.0.0.1-0.255.255.255 # RFC 1122 "this" network (LAN)
1273 acl localnet src 10.0.0.0/8 # RFC 1918 local private network (LAN)
1274 acl localnet src 100.64.0.0/10 # RFC 6598 shared address space (CGN)
1275 acl localhet src 169.254.0.0/16 # RFC 3927 link-local (directly plugged) machines
1276 acl localnet src 172.16.0.0/12 # RFC 1918 local private network (LAN)
1277 acl localnet src 192.168.0.0/16 # RFC 1918 local private network (LAN)
1278 acl localnet src fc00::/7 # RFC 4193 local private network range
1279 acl localnet src fe80::/10 # RFC 4291 link-local (directly plugged) machines
1281 acl SSL_ports port 443
1282 acl Safe_ports port 80 # http
1283 acl Safe_ports port 21 # ftp
1284 acl Safe_ports port 443 # https
1285 acl Safe_ports port 70 # gopher
1286 acl Safe_ports port 210 # wais
1287 acl Safe_ports port 1025-65535 # unregistered ports
1288 acl Safe_ports port 280 # http-mgmt
1289 acl Safe_ports port 488 # gss-http
1290 acl Safe_ports port 591 # filemaker
1291 acl Safe_ports port 777 # multiling http
1292 acl CONNECT method CONNECT
1296 NAME: proxy_protocol_access
1298 LOC: Config.accessList.proxyProtocol
1300 DEFAULT_DOC: all TCP connections to ports with require-proxy-header will be denied
1302 Determine which client proxies can be trusted to provide correct
1303 information regarding real client IP address using PROXY protocol.
1305 Requests may pass through a chain of several other proxies
1306 before reaching us. The original source details may by sent in:
1307 * HTTP message Forwarded header, or
1308 * HTTP message X-Forwarded-For header, or
1309 * PROXY protocol connection header.
1311 This directive is solely for validating new PROXY protocol
1312 connections received from a port flagged with require-proxy-header.
1313 It is checked only once after TCP connection setup.
1315 A deny match results in TCP connection closure.
1317 An allow match is required for Squid to permit the corresponding
1318 TCP connection, before Squid even looks for HTTP request headers.
1319 If there is an allow match, Squid starts using PROXY header information
1320 to determine the source address of the connection for all future ACL
1321 checks, logging, etc.
1323 SECURITY CONSIDERATIONS:
1325 Any host from which we accept client IP details can place
1326 incorrect information in the relevant header, and Squid
1327 will use the incorrect information as if it were the
1328 source address of the request. This may enable remote
1329 hosts to bypass any access control restrictions that are
1330 based on the client's source addresses.
1332 This clause only supports fast acl types.
1333 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1336 NAME: follow_x_forwarded_for
1338 IFDEF: FOLLOW_X_FORWARDED_FOR
1339 LOC: Config.accessList.followXFF
1340 DEFAULT_IF_NONE: deny all
1341 DEFAULT_DOC: X-Forwarded-For header will be ignored.
1343 Determine which client proxies can be trusted to provide correct
1344 information regarding real client IP address.
1346 Requests may pass through a chain of several other proxies
1347 before reaching us. The original source details may by sent in:
1348 * HTTP message Forwarded header, or
1349 * HTTP message X-Forwarded-For header, or
1350 * PROXY protocol connection header.
1352 PROXY protocol connections are controlled by the proxy_protocol_access
1353 directive which is checked before this.
1355 If a request reaches us from a source that is allowed by this
1356 directive, then we trust the information it provides regarding
1357 the IP of the client it received from (if any).
1359 For the purpose of ACLs used in this directive the src ACL type always
1360 matches the address we are testing and srcdomain matches its rDNS.
1362 On each HTTP request Squid checks for X-Forwarded-For header fields.
1363 If found the header values are iterated in reverse order and an allow
1364 match is required for Squid to continue on to the next value.
1365 The verification ends when a value receives a deny match, cannot be
1366 tested, or there are no more values to test.
1367 NOTE: Squid does not yet follow the Forwarded HTTP header.
1369 The end result of this process is an IP address that we will
1370 refer to as the indirect client address. This address may
1371 be treated as the client address for access control, ICAP, delay
1372 pools and logging, depending on the acl_uses_indirect_client,
1373 icap_uses_indirect_client, delay_pool_uses_indirect_client,
1374 log_uses_indirect_client and tproxy_uses_indirect_client options.
1376 This clause only supports fast acl types.
1377 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1379 SECURITY CONSIDERATIONS:
1381 Any host from which we accept client IP details can place
1382 incorrect information in the relevant header, and Squid
1383 will use the incorrect information as if it were the
1384 source address of the request. This may enable remote
1385 hosts to bypass any access control restrictions that are
1386 based on the client's source addresses.
1390 acl localhost src 127.0.0.1
1391 acl my_other_proxy srcdomain .proxy.example.com
1392 follow_x_forwarded_for allow localhost
1393 follow_x_forwarded_for allow my_other_proxy
1396 NAME: acl_uses_indirect_client
1399 IFDEF: FOLLOW_X_FORWARDED_FOR
1401 LOC: Config.onoff.acl_uses_indirect_client
1403 Controls whether the indirect client address
1404 (see follow_x_forwarded_for) is used instead of the
1405 direct client address in acl matching.
1407 NOTE: maxconn ACL considers direct TCP links and indirect
1408 clients will always have zero. So no match.
1411 NAME: delay_pool_uses_indirect_client
1414 IFDEF: FOLLOW_X_FORWARDED_FOR&&USE_DELAY_POOLS
1416 LOC: Config.onoff.delay_pool_uses_indirect_client
1418 Controls whether the indirect client address
1419 (see follow_x_forwarded_for) is used instead of the
1420 direct client address in delay pools.
1423 NAME: log_uses_indirect_client
1426 IFDEF: FOLLOW_X_FORWARDED_FOR
1428 LOC: Config.onoff.log_uses_indirect_client
1430 Controls whether the indirect client address
1431 (see follow_x_forwarded_for) is used instead of the
1432 direct client address in the access log.
1435 NAME: tproxy_uses_indirect_client
1438 IFDEF: FOLLOW_X_FORWARDED_FOR&&LINUX_NETFILTER
1440 LOC: Config.onoff.tproxy_uses_indirect_client
1442 Controls whether the indirect client address
1443 (see follow_x_forwarded_for) is used instead of the
1444 direct client address when spoofing the outgoing client.
1446 This has no effect on requests arriving in non-tproxy
1449 SECURITY WARNING: Usage of this option is dangerous
1450 and should not be used trivially. Correct configuration
1451 of follow_x_forewarded_for with a limited set of trusted
1452 sources is required to prevent abuse of your proxy.
1455 NAME: spoof_client_ip
1457 LOC: Config.accessList.spoof_client_ip
1459 DEFAULT_DOC: Allow spoofing on all TPROXY traffic.
1461 Control client IP address spoofing of TPROXY traffic based on
1462 defined access lists.
1464 spoof_client_ip allow|deny [!]aclname ...
1466 If there are no "spoof_client_ip" lines present, the default
1467 is to "allow" spoofing of any suitable request.
1469 Note that the cache_peer "no-tproxy" option overrides this ACL.
1471 This clause supports fast acl types.
1472 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1477 LOC: Config.accessList.http
1478 DEFAULT_IF_NONE: deny all
1479 DEFAULT_DOC: Deny, unless rules exist in squid.conf.
1481 Allowing or Denying access based on defined access lists
1483 To allow or deny a message received on an HTTP, HTTPS, or FTP port:
1484 http_access allow|deny [!]aclname ...
1486 NOTE on default values:
1488 If there are no "access" lines present, the default is to deny
1491 If none of the "access" lines cause a match, the default is the
1492 opposite of the last line in the list. If the last line was
1493 deny, the default is allow. Conversely, if the last line
1494 is allow, the default will be deny. For these reasons, it is a
1495 good idea to have an "deny all" entry at the end of your access
1496 lists to avoid potential confusion.
1498 This clause supports both fast and slow acl types.
1499 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1504 # Recommended minimum Access Permission configuration:
1506 # Deny requests to certain unsafe ports
1507 http_access deny !Safe_ports
1509 # Deny CONNECT to other than secure SSL ports
1510 http_access deny CONNECT !SSL_ports
1512 # Only allow cachemgr access from localhost
1513 http_access allow localhost manager
1514 http_access deny manager
1516 # We strongly recommend the following be uncommented to protect innocent
1517 # web applications running on the proxy server who think the only
1518 # one who can access services on "localhost" is a local user
1519 #http_access deny to_localhost
1522 # INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS
1525 # Example rule allowing access from your local networks.
1526 # Adapt localnet in the ACL section to list your (internal) IP networks
1527 # from where browsing should be allowed
1528 http_access allow localnet
1529 http_access allow localhost
1531 # And finally deny all other access to this proxy
1532 http_access deny all
1536 NAME: adapted_http_access http_access2
1538 LOC: Config.accessList.adapted_http
1540 DEFAULT_DOC: Allow, unless rules exist in squid.conf.
1542 Allowing or Denying access based on defined access lists
1544 Essentially identical to http_access, but runs after redirectors
1545 and ICAP/eCAP adaptation. Allowing access control based on their
1548 If not set then only http_access is used.
1551 NAME: http_reply_access
1553 LOC: Config.accessList.reply
1555 DEFAULT_DOC: Allow, unless rules exist in squid.conf.
1557 Allow replies to client requests. This is complementary to http_access.
1559 http_reply_access allow|deny [!] aclname ...
1561 NOTE: if there are no access lines present, the default is to allow
1564 If none of the access lines cause a match the opposite of the
1565 last line will apply. Thus it is good practice to end the rules
1566 with an "allow all" or "deny all" entry.
1568 This clause supports both fast and slow acl types.
1569 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1574 LOC: Config.accessList.icp
1576 DEFAULT_DOC: Deny, unless rules exist in squid.conf.
1578 Allowing or Denying access to the ICP port based on defined
1581 icp_access allow|deny [!]aclname ...
1583 NOTE: The default if no icp_access lines are present is to
1584 deny all traffic. This default may cause problems with peers
1587 This clause only supports fast acl types.
1588 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1590 # Allow ICP queries from local networks only
1591 #icp_access allow localnet
1592 #icp_access deny all
1598 LOC: Config.accessList.htcp
1600 DEFAULT_DOC: Deny, unless rules exist in squid.conf.
1602 Allowing or Denying access to the HTCP port based on defined
1605 htcp_access allow|deny [!]aclname ...
1607 See also htcp_clr_access for details on access control for
1608 cache purge (CLR) HTCP messages.
1610 NOTE: The default if no htcp_access lines are present is to
1611 deny all traffic. This default may cause problems with peers
1612 using the htcp option.
1614 This clause only supports fast acl types.
1615 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1617 # Allow HTCP queries from local networks only
1618 #htcp_access allow localnet
1619 #htcp_access deny all
1622 NAME: htcp_clr_access
1625 LOC: Config.accessList.htcp_clr
1627 DEFAULT_DOC: Deny, unless rules exist in squid.conf.
1629 Allowing or Denying access to purge content using HTCP based
1630 on defined access lists.
1631 See htcp_access for details on general HTCP access control.
1633 htcp_clr_access allow|deny [!]aclname ...
1635 This clause only supports fast acl types.
1636 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1638 # Allow HTCP CLR requests from trusted peers
1639 acl htcp_clr_peer src 192.0.2.2 2001:DB8::2
1640 htcp_clr_access allow htcp_clr_peer
1641 htcp_clr_access deny all
1646 LOC: Config.accessList.miss
1648 DEFAULT_DOC: Allow, unless rules exist in squid.conf.
1650 Determins whether network access is permitted when satisfying a request.
1653 to force your neighbors to use you as a sibling instead of
1656 acl localclients src 192.0.2.0/24 2001:DB8::a:0/64
1657 miss_access deny !localclients
1658 miss_access allow all
1660 This means only your local clients are allowed to fetch relayed/MISS
1661 replies from the network and all other clients can only fetch cached
1664 The default for this setting allows all clients who passed the
1665 http_access rules to relay via this proxy.
1667 This clause only supports fast acl types.
1668 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1671 NAME: ident_lookup_access
1675 DEFAULT_DOC: Unless rules exist in squid.conf, IDENT is not fetched.
1676 LOC: Ident::TheConfig.identLookup
1678 A list of ACL elements which, if matched, cause an ident
1679 (RFC 931) lookup to be performed for this request. For
1680 example, you might choose to always perform ident lookups
1681 for your main multi-user Unix boxes, but not for your Macs
1682 and PCs. By default, ident lookups are not performed for
1685 To enable ident lookups for specific client addresses, you
1686 can follow this example:
1688 acl ident_aware_hosts src 198.168.1.0/24
1689 ident_lookup_access allow ident_aware_hosts
1690 ident_lookup_access deny all
1692 Only src type ACL checks are fully supported. A srcdomain
1693 ACL might work at times, but it will not always provide
1696 This clause only supports fast acl types.
1697 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1700 NAME: reply_body_max_size
1701 COMMENT: size [acl acl...]
1704 DEFAULT_DOC: No limit is applied.
1705 LOC: Config.ReplyBodySize
1707 This option specifies the maximum size of a reply body. It can be
1708 used to prevent users from downloading very large files, such as
1709 MP3's and movies. When the reply headers are received, the
1710 reply_body_max_size lines are processed, and the first line where
1711 all (if any) listed ACLs are true is used as the maximum body size
1714 This size is checked twice. First when we get the reply headers,
1715 we check the content-length value. If the content length value exists
1716 and is larger than the allowed size, the request is denied and the
1717 user receives an error message that says "the request or reply
1718 is too large." If there is no content-length, and the reply
1719 size exceeds this limit, the client's connection is just closed
1720 and they will receive a partial reply.
1722 WARNING: downstream caches probably can not detect a partial reply
1723 if there is no content-length header, so they will cache
1724 partial responses and give them out as hits. You should NOT
1725 use this option if you have downstream caches.
1727 WARNING: A maximum size smaller than the size of squid's error messages
1728 will cause an infinite loop and crash squid. Ensure that the smallest
1729 non-zero value you use is greater that the maximum header size plus
1730 the size of your largest error page.
1732 If you set this parameter none (the default), there will be
1735 Configuration Format is:
1736 reply_body_max_size SIZE UNITS [acl ...]
1738 reply_body_max_size 10 MB
1742 NAME: on_unsupported_protocol
1743 TYPE: on_unsupported_protocol
1744 LOC: Config.accessList.on_unsupported_protocol
1746 DEFAULT_DOC: Respond with an error message to unidentifiable traffic
1748 Determines Squid behavior when encountering strange requests at the
1749 beginning of an accepted TCP connection or the beginning of a bumped
1750 CONNECT tunnel. Controlling Squid reaction to unexpected traffic is
1751 especially useful in interception environments where Squid is likely
1752 to see connections for unsupported protocols that Squid should either
1753 terminate or tunnel at TCP level.
1755 on_unsupported_protocol <action> [!]acl ...
1757 The first matching action wins. Only fast ACLs are supported.
1759 Supported actions are:
1761 tunnel: Establish a TCP connection with the intended server and
1762 blindly shovel TCP packets between the client and server.
1764 respond: Respond with an error message, using the transfer protocol
1765 for the Squid port that received the request (e.g., HTTP
1766 for connections intercepted at the http_port). This is the
1769 Squid expects the following traffic patterns:
1771 http_port: a plain HTTP request
1772 https_port: SSL/TLS handshake followed by an [encrypted] HTTP request
1773 ftp_port: a plain FTP command (no on_unsupported_protocol support yet!)
1774 CONNECT tunnel on http_port: same as https_port
1775 CONNECT tunnel on https_port: same as https_port
1777 Currently, this directive has effect on intercepted connections and
1778 bumped tunnels only. Other cases are not supported because Squid
1779 cannot know the intended destination of other traffic.
1782 # define what Squid errors indicate receiving non-HTTP traffic:
1783 acl foreignProtocol squid_error ERR_PROTOCOL_UNKNOWN ERR_TOO_BIG
1784 # define what Squid errors indicate receiving nothing:
1785 acl serverTalksFirstProtocol squid_error ERR_REQUEST_START_TIMEOUT
1786 # tunnel everything that does not look like HTTP:
1787 on_unsupported_protocol tunnel foreignProtocol
1788 # tunnel if we think the client waits for the server to talk first:
1789 on_unsupported_protocol tunnel serverTalksFirstProtocol
1790 # in all other error cases, just send an HTTP "error page" response:
1791 on_unsupported_protocol respond all
1793 See also: squid_error ACL
1798 -----------------------------------------------------------------------------
1801 NAME: http_port ascii_port
1806 Usage: port [mode] [options]
1807 hostname:port [mode] [options]
1808 1.2.3.4:port [mode] [options]
1810 The socket addresses where Squid will listen for HTTP client
1811 requests. You may specify multiple socket addresses.
1812 There are three forms: port alone, hostname with port, and
1813 IP address with port. If you specify a hostname or IP
1814 address, Squid binds the socket to that specific
1815 address. Most likely, you do not need to bind to a specific
1816 address, so you can use the port number alone.
1818 If you are running Squid in accelerator mode, you
1819 probably want to listen on port 80 also, or instead.
1821 The -a command line option may be used to specify additional
1822 port(s) where Squid listens for proxy request. Such ports will
1823 be plain proxy ports with no options.
1825 You may specify multiple socket addresses on multiple lines.
1829 intercept Support for IP-Layer interception of
1830 outgoing requests without browser settings.
1831 NP: disables authentication and IPv6 on the port.
1833 tproxy Support Linux TPROXY for spoofing outgoing
1834 connections using the client IP address.
1835 NP: disables authentication and maybe IPv6 on the port.
1837 accel Accelerator / reverse proxy mode
1839 ssl-bump For each CONNECT request allowed by ssl_bump ACLs,
1840 establish secure connection with the client and with
1841 the server, decrypt HTTPS messages as they pass through
1842 Squid, and treat them as unencrypted HTTP messages,
1843 becoming the man-in-the-middle.
1845 The ssl_bump option is required to fully enable
1846 bumping of CONNECT requests.
1848 Omitting the mode flag causes default forward proxy mode to be used.
1851 Accelerator Mode Options:
1853 defaultsite=domainname
1854 What to use for the Host: header if it is not present
1855 in a request. Determines what site (not origin server)
1856 accelerators should consider the default.
1858 no-vhost Disable using HTTP/1.1 Host header for virtual domain support.
1860 protocol= Protocol to reconstruct accelerated and intercepted
1861 requests with. Defaults to HTTP/1.1 for http_port and
1862 HTTPS/1.1 for https_port.
1863 When an unsupported value is configured Squid will
1864 produce a FATAL error.
1865 Values: HTTP or HTTP/1.1, HTTPS or HTTPS/1.1
1867 vport Virtual host port support. Using the http_port number
1868 instead of the port passed on Host: headers.
1870 vport=NN Virtual host port support. Using the specified port
1871 number instead of the port passed on Host: headers.
1874 Act as if this Squid is the origin server.
1875 This currently means generate new Date: and Expires:
1876 headers on HIT instead of adding Age:.
1878 ignore-cc Ignore request Cache-Control headers.
1880 WARNING: This option violates HTTP specifications if
1881 used in non-accelerator setups.
1883 allow-direct Allow direct forwarding in accelerator mode. Normally
1884 accelerated requests are denied direct forwarding as if
1885 never_direct was used.
1887 WARNING: this option opens accelerator mode to security
1888 vulnerabilities usually only affecting in interception
1889 mode. Make sure to protect forwarding with suitable
1890 http_access rules when using this.
1893 SSL Bump Mode Options:
1894 In addition to these options ssl-bump requires TLS/SSL options.
1896 generate-host-certificates[=<on|off>]
1897 Dynamically create SSL server certificates for the
1898 destination hosts of bumped CONNECT requests.When
1899 enabled, the cert and key options are used to sign
1900 generated certificates. Otherwise generated
1901 certificate will be selfsigned.
1902 If there is a CA certificate lifetime of the generated
1903 certificate equals lifetime of the CA certificate. If
1904 generated certificate is selfsigned lifetime is three
1906 This option is enabled by default when ssl-bump is used.
1907 See the ssl-bump option above for more information.
1909 dynamic_cert_mem_cache_size=SIZE
1910 Approximate total RAM size spent on cached generated
1911 certificates. If set to zero, caching is disabled. The
1912 default value is 4MB.
1916 cert= Path to SSL certificate (PEM format).
1918 key= Path to SSL private key file (PEM format)
1919 if not specified, the certificate file is
1920 assumed to be a combined certificate and
1923 cipher= Colon separated list of supported ciphers.
1924 NOTE: some ciphers such as EDH ciphers depend on
1925 additional settings. If those settings are
1926 omitted the ciphers may be silently ignored
1927 by the OpenSSL library.
1929 options= Various SSL implementation options. The most important
1932 NO_SSLv3 Disallow the use of SSLv3
1934 NO_TLSv1 Disallow the use of TLSv1.0
1936 NO_TLSv1_1 Disallow the use of TLSv1.1
1938 NO_TLSv1_2 Disallow the use of TLSv1.2
1941 Always create a new key when using
1942 temporary/ephemeral DH key exchanges
1945 Enable ephemeral ECDH key exchange.
1946 The adopted curve should be specified
1947 using the tls-dh option.
1950 Disable use of RFC5077 session tickets.
1951 Some servers may have problems
1952 understanding the TLS extension due
1953 to ambiguous specification in RFC4507.
1955 ALL Enable various bug workarounds
1956 suggested as "harmless" by OpenSSL
1957 Be warned that this reduces SSL/TLS
1958 strength to some attacks.
1960 See the OpenSSL SSL_CTX_set_options documentation for a
1963 clientca= File containing the list of CAs to use when
1964 requesting a client certificate.
1966 cafile= File containing additional CA certificates to
1967 use when verifying client certificates. If unset
1968 clientca will be used.
1970 capath= Directory containing additional CA certificates
1971 and CRL lists to use when verifying client certificates.
1973 crlfile= File of additional CRL lists to use when verifying
1974 the client certificate, in addition to CRLs stored in
1975 the capath. Implies VERIFY_CRL flag below.
1978 File containing DH parameters for temporary/ephemeral DH key
1979 exchanges, optionally prefixed by a curve for ephemeral ECDH
1981 See OpenSSL documentation for details on how to create the
1982 DH parameter file. Supported curves for ECDH can be listed
1983 using the "openssl ecparam -list_curves" command.
1984 WARNING: EDH and EECDH ciphers will be silently disabled if
1985 this option is not set.
1987 sslflags= Various flags modifying the use of SSL:
1989 Don't request client certificates
1990 immediately, but wait until acl processing
1991 requires a certificate (not yet implemented).
1993 Don't use the default CA lists built in
1996 Don't allow for session reuse. Each connection
1997 will result in a new SSL session.
1999 Verify CRL lists when accepting client
2002 Verify CRL lists for all certificates in the
2003 client certificate chain.
2005 sslcontext= SSL session ID context identifier.
2009 connection-auth[=on|off]
2010 use connection-auth=off to tell Squid to prevent
2011 forwarding Microsoft connection oriented authentication
2012 (NTLM, Negotiate and Kerberos)
2014 disable-pmtu-discovery=
2015 Control Path-MTU discovery usage:
2016 off lets OS decide on what to do (default).
2017 transparent disable PMTU discovery when transparent
2019 always disable always PMTU discovery.
2021 In many setups of transparently intercepting proxies
2022 Path-MTU discovery can not work on traffic towards the
2023 clients. This is the case when the intercepting device
2024 does not fully track connections and fails to forward
2025 ICMP must fragment messages to the cache server. If you
2026 have such setup and experience that certain clients
2027 sporadically hang or never complete requests set
2028 disable-pmtu-discovery option to 'transparent'.
2030 name= Specifies a internal name for the port. Defaults to
2031 the port specification (port or addr:port)
2033 tcpkeepalive[=idle,interval,timeout]
2034 Enable TCP keepalive probes of idle connections.
2035 In seconds; idle is the initial time before TCP starts
2036 probing the connection, interval how often to probe, and
2037 timeout the time before giving up.
2039 require-proxy-header
2040 Require PROXY protocol version 1 or 2 connections.
2041 The proxy_protocol_access is required to whitelist
2042 downstream proxies which can be trusted.
2044 If you run Squid on a dual-homed machine with an internal
2045 and an external interface we recommend you to specify the
2046 internal address:port in http_port. This way Squid will only be
2047 visible on the internal address.
2051 # Squid normally listens to port 3128
2052 http_port @DEFAULT_HTTP_PORT@
2062 Usage: [ip:]port cert=certificate.pem [key=key.pem] [mode] [options...]
2064 The socket address where Squid will listen for client requests made
2065 over TLS or SSL connections. Commonly referred to as HTTPS.
2067 This is most useful for situations where you are running squid in
2068 accelerator mode and you want to do the SSL work at the accelerator level.
2070 You may specify multiple socket addresses on multiple lines,
2071 each with their own SSL certificate and/or options.
2075 accel Accelerator / reverse proxy mode
2077 intercept Support for IP-Layer interception of
2078 outgoing requests without browser settings.
2079 NP: disables authentication and IPv6 on the port.
2081 tproxy Support Linux TPROXY for spoofing outgoing
2082 connections using the client IP address.
2083 NP: disables authentication and maybe IPv6 on the port.
2085 ssl-bump For each intercepted connection allowed by ssl_bump
2086 ACLs, establish a secure connection with the client and with
2087 the server, decrypt HTTPS messages as they pass through
2088 Squid, and treat them as unencrypted HTTP messages,
2089 becoming the man-in-the-middle.
2091 An "ssl_bump server-first" match is required to
2092 fully enable bumping of intercepted SSL connections.
2094 Requires tproxy or intercept.
2096 Omitting the mode flag causes default forward proxy mode to be used.
2099 See http_port for a list of generic options
2104 cert= Path to SSL certificate (PEM format).
2106 key= Path to SSL private key file (PEM format)
2107 if not specified, the certificate file is
2108 assumed to be a combined certificate and
2111 cipher= Colon separated list of supported ciphers.
2113 options= Various SSL engine options. The most important
2116 NO_SSLv3 Disallow the use of SSLv3
2118 NO_TLSv1 Disallow the use of TLSv1.0
2120 NO_TLSv1_1 Disallow the use of TLSv1.1
2122 NO_TLSv1_2 Disallow the use of TLSv1.2
2125 Always create a new key when using
2126 temporary/ephemeral DH key exchanges
2129 Enable ephemeral ECDH key exchange.
2130 The adopted curve should be specified
2131 using the tls-dh option.
2134 Disable use of RFC5077 session tickets.
2135 Some servers may have problems
2136 understanding the TLS extension due
2137 to ambiguous specification in RFC4507.
2139 ALL Enable various bug workarounds
2140 suggested as "harmless" by OpenSSL
2141 Be warned that this reduces SSL/TLS
2142 strength to some attacks.
2144 See the OpenSSL SSL_CTX_set_options documentation for a
2147 clientca= File containing the list of CAs to use when
2148 requesting a client certificate.
2150 cafile= File containing additional CA certificates to
2151 use when verifying client certificates. If unset
2152 clientca will be used.
2154 capath= Directory containing additional CA certificates
2155 and CRL lists to use when verifying client certificates.
2157 crlfile= File of additional CRL lists to use when verifying
2158 the client certificate, in addition to CRLs stored in
2159 the capath. Implies VERIFY_CRL flag below.
2162 File containing DH parameters for temporary/ephemeral DH key
2163 exchanges, optionally prefixed by a curve for ephemeral ECDH
2166 sslflags= Various flags modifying the use of SSL:
2168 Don't request client certificates
2169 immediately, but wait until acl processing
2170 requires a certificate (not yet implemented).
2172 Don't use the default CA lists built in
2175 Don't allow for session reuse. Each connection
2176 will result in a new SSL session.
2178 Verify CRL lists when accepting client
2181 Verify CRL lists for all certificates in the
2182 client certificate chain.
2184 sslcontext= SSL session ID context identifier.
2186 generate-host-certificates[=<on|off>]
2187 Dynamically create SSL server certificates for the
2188 destination hosts of bumped SSL requests.When
2189 enabled, the cert and key options are used to sign
2190 generated certificates. Otherwise generated
2191 certificate will be selfsigned.
2192 If there is CA certificate life time of generated
2193 certificate equals lifetime of CA certificate. If
2194 generated certificate is selfsigned lifetime is three
2196 This option is enabled by default when SslBump is used.
2197 See the sslBump option above for more information.
2199 dynamic_cert_mem_cache_size=SIZE
2200 Approximate total RAM size spent on cached generated
2201 certificates. If set to zero, caching is disabled. The
2202 default value is 4MB.
2204 See http_port for a list of available options.
2212 Enables Native FTP proxy by specifying the socket address where Squid
2213 listens for FTP client requests. See http_port directive for various
2214 ways to specify the listening address and mode.
2216 Usage: ftp_port address [mode] [options]
2218 WARNING: This is a new, experimental, complex feature that has seen
2219 limited production exposure. Some Squid modules (e.g., caching) do not
2220 currently work with native FTP proxying, and many features have not
2221 even been tested for compatibility. Test well before deploying!
2223 Native FTP proxying differs substantially from proxying HTTP requests
2224 with ftp:// URIs because Squid works as an FTP server and receives
2225 actual FTP commands (rather than HTTP requests with FTP URLs).
2227 Native FTP commands accepted at ftp_port are internally converted or
2228 wrapped into HTTP-like messages. The same happens to Native FTP
2229 responses received from FTP origin servers. Those HTTP-like messages
2230 are shoveled through regular access control and adaptation layers
2231 between the FTP client and the FTP origin server. This allows Squid to
2232 examine, adapt, block, and log FTP exchanges. Squid reuses most HTTP
2233 mechanisms when shoveling wrapped FTP messages. For example,
2234 http_access and adaptation_access directives are used.
2238 intercept Same as http_port intercept. The FTP origin address is
2239 determined based on the intended destination of the
2240 intercepted connection.
2242 tproxy Support Linux TPROXY for spoofing outgoing
2243 connections using the client IP address.
2244 NP: disables authentication and maybe IPv6 on the port.
2246 By default (i.e., without an explicit mode option), Squid extracts the
2247 FTP origin address from the login@origin parameter of the FTP USER
2248 command. Many popular FTP clients support such native FTP proxying.
2252 name=token Specifies an internal name for the port. Defaults to
2253 the port address. Usable with myportname ACL.
2256 Enables tracking of FTP directories by injecting extra
2257 PWD commands and adjusting Request-URI (in wrapping
2258 HTTP requests) to reflect the current FTP server
2259 directory. Tracking is disabled by default.
2261 protocol=FTP Protocol to reconstruct accelerated and intercepted
2262 requests with. Defaults to FTP. No other accepted
2263 values have been tested with. An unsupported value
2264 results in a FATAL error. Accepted values are FTP,
2265 HTTP (or HTTP/1.1), and HTTPS (or HTTPS/1.1).
2267 Other http_port modes and options that are not specific to HTTP and
2268 HTTPS may also work.
2271 NAME: tcp_outgoing_tos tcp_outgoing_ds tcp_outgoing_dscp
2274 LOC: Ip::Qos::TheConfig.tosToServer
2276 Allows you to select a TOS/Diffserv value for packets outgoing
2277 on the server side, based on an ACL.
2279 tcp_outgoing_tos ds-field [!]aclname ...
2281 Example where normal_service_net uses the TOS value 0x00
2282 and good_service_net uses 0x20
2284 acl normal_service_net src 10.0.0.0/24
2285 acl good_service_net src 10.0.1.0/24
2286 tcp_outgoing_tos 0x00 normal_service_net
2287 tcp_outgoing_tos 0x20 good_service_net
2289 TOS/DSCP values really only have local significance - so you should
2290 know what you're specifying. For more information, see RFC2474,
2291 RFC2475, and RFC3260.
2293 The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or
2294 "default" to use whatever default your host has.
2295 Note that only multiples of 4 are usable as the two rightmost bits have
2296 been redefined for use by ECN (RFC 3168 section 23.1).
2297 The squid parser will enforce this by masking away the ECN bits.
2299 Processing proceeds in the order specified, and stops at first fully
2302 Only fast ACLs are supported.
2305 NAME: clientside_tos
2308 LOC: Ip::Qos::TheConfig.tosToClient
2310 Allows you to select a TOS/DSCP value for packets being transmitted
2311 on the client-side, based on an ACL.
2313 clientside_tos ds-field [!]aclname ...
2315 Example where normal_service_net uses the TOS value 0x00
2316 and good_service_net uses 0x20
2318 acl normal_service_net src 10.0.0.0/24
2319 acl good_service_net src 10.0.1.0/24
2320 clientside_tos 0x00 normal_service_net
2321 clientside_tos 0x20 good_service_net
2323 Note: This feature is incompatible with qos_flows. Any TOS values set here
2324 will be overwritten by TOS values in qos_flows.
2326 The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or
2327 "default" to use whatever default your host has.
2328 Note that only multiples of 4 are usable as the two rightmost bits have
2329 been redefined for use by ECN (RFC 3168 section 23.1).
2330 The squid parser will enforce this by masking away the ECN bits.
2334 NAME: tcp_outgoing_mark
2336 IFDEF: SO_MARK&&USE_LIBCAP
2338 LOC: Ip::Qos::TheConfig.nfmarkToServer
2340 Allows you to apply a Netfilter mark value to outgoing packets
2341 on the server side, based on an ACL.
2343 tcp_outgoing_mark mark-value [!]aclname ...
2345 Example where normal_service_net uses the mark value 0x00
2346 and good_service_net uses 0x20
2348 acl normal_service_net src 10.0.0.0/24
2349 acl good_service_net src 10.0.1.0/24
2350 tcp_outgoing_mark 0x00 normal_service_net
2351 tcp_outgoing_mark 0x20 good_service_net
2353 Only fast ACLs are supported.
2356 NAME: clientside_mark
2358 IFDEF: SO_MARK&&USE_LIBCAP
2360 LOC: Ip::Qos::TheConfig.nfmarkToClient
2362 Allows you to apply a Netfilter mark value to packets being transmitted
2363 on the client-side, based on an ACL.
2365 clientside_mark mark-value [!]aclname ...
2367 Example where normal_service_net uses the mark value 0x00
2368 and good_service_net uses 0x20
2370 acl normal_service_net src 10.0.0.0/24
2371 acl good_service_net src 10.0.1.0/24
2372 clientside_mark 0x00 normal_service_net
2373 clientside_mark 0x20 good_service_net
2375 Note: This feature is incompatible with qos_flows. Any mark values set here
2376 will be overwritten by mark values in qos_flows.
2383 LOC: Ip::Qos::TheConfig
2385 Allows you to select a TOS/DSCP value to mark outgoing
2386 connections to the client, based on where the reply was sourced.
2387 For platforms using netfilter, allows you to set a netfilter mark
2388 value instead of, or in addition to, a TOS value.
2390 By default this functionality is disabled. To enable it with the default
2391 settings simply use "qos_flows mark" or "qos_flows tos". Default
2392 settings will result in the netfilter mark or TOS value being copied
2393 from the upstream connection to the client. Note that it is the connection
2394 CONNMARK value not the packet MARK value that is copied.
2396 It is not currently possible to copy the mark or TOS value from the
2397 client to the upstream connection request.
2399 TOS values really only have local significance - so you should
2400 know what you're specifying. For more information, see RFC2474,
2401 RFC2475, and RFC3260.
2403 The TOS/DSCP byte must be exactly that - a octet value 0 - 255.
2404 Note that only multiples of 4 are usable as the two rightmost bits have
2405 been redefined for use by ECN (RFC 3168 section 23.1).
2406 The squid parser will enforce this by masking away the ECN bits.
2408 Mark values can be any unsigned 32-bit integer value.
2410 This setting is configured by setting the following values:
2412 tos|mark Whether to set TOS or netfilter mark values
2414 local-hit=0xFF Value to mark local cache hits.
2416 sibling-hit=0xFF Value to mark hits from sibling peers.
2418 parent-hit=0xFF Value to mark hits from parent peers.
2420 miss=0xFF[/mask] Value to mark cache misses. Takes precedence
2421 over the preserve-miss feature (see below), unless
2422 mask is specified, in which case only the bits
2423 specified in the mask are written.
2425 The TOS variant of the following features are only possible on Linux
2426 and require your kernel to be patched with the TOS preserving ZPH
2427 patch, available from http://zph.bratcheda.org
2428 No patch is needed to preserve the netfilter mark, which will work
2429 with all variants of netfilter.
2431 disable-preserve-miss
2432 This option disables the preservation of the TOS or netfilter
2433 mark. By default, the existing TOS or netfilter mark value of
2434 the response coming from the remote server will be retained
2435 and masked with miss-mark.
2436 NOTE: in the case of a netfilter mark, the mark must be set on
2437 the connection (using the CONNMARK target) not on the packet
2441 Allows you to mask certain bits in the TOS or mark value
2442 received from the remote server, before copying the value to
2443 the TOS sent towards clients.
2444 Default for tos: 0xFF (TOS from server is not changed).
2445 Default for mark: 0xFFFFFFFF (mark from server is not changed).
2447 All of these features require the --enable-zph-qos compilation flag
2448 (enabled by default). Netfilter marking also requires the
2449 libnetfilter_conntrack libraries (--with-netfilter-conntrack) and
2450 libcap 2.09+ (--with-libcap).
2454 NAME: tcp_outgoing_address
2457 DEFAULT_DOC: Address selection is performed by the operating system.
2458 LOC: Config.accessList.outgoing_address
2460 Allows you to map requests to different outgoing IP addresses
2461 based on the username or source address of the user making
2464 tcp_outgoing_address ipaddr [[!]aclname] ...
2467 Forwarding clients with dedicated IPs for certain subnets.
2469 acl normal_service_net src 10.0.0.0/24
2470 acl good_service_net src 10.0.2.0/24
2472 tcp_outgoing_address 2001:db8::c001 good_service_net
2473 tcp_outgoing_address 10.1.0.2 good_service_net
2475 tcp_outgoing_address 2001:db8::beef normal_service_net
2476 tcp_outgoing_address 10.1.0.1 normal_service_net
2478 tcp_outgoing_address 2001:db8::1
2479 tcp_outgoing_address 10.1.0.3
2481 Processing proceeds in the order specified, and stops at first fully
2484 Squid will add an implicit IP version test to each line.
2485 Requests going to IPv4 websites will use the outgoing 10.1.0.* addresses.
2486 Requests going to IPv6 websites will use the outgoing 2001:db8:* addresses.
2489 NOTE: The use of this directive using client dependent ACLs is
2490 incompatible with the use of server side persistent connections. To
2491 ensure correct results it is best to set server_persistent_connections
2492 to off when using this directive in such configurations.
2494 NOTE: The use of this directive to set a local IP on outgoing TCP links
2495 is incompatible with using TPROXY to set client IP out outbound TCP links.
2496 When needing to contact peers use the no-tproxy cache_peer option and the
2497 client_dst_passthru directive re-enable normal forwarding such as this.
2501 NAME: host_verify_strict
2504 LOC: Config.onoff.hostStrictVerify
2506 Regardless of this option setting, when dealing with intercepted
2507 traffic, Squid always verifies that the destination IP address matches
2508 the Host header domain or IP (called 'authority form URL').
2510 This enforcement is performed to satisfy a MUST-level requirement in
2511 RFC 2616 section 14.23: "The Host field value MUST represent the naming
2512 authority of the origin server or gateway given by the original URL".
2515 Squid always responds with an HTTP 409 (Conflict) error
2516 page and logs a security warning if there is no match.
2518 Squid verifies that the destination IP address matches
2519 the Host header for forward-proxy and reverse-proxy traffic
2520 as well. For those traffic types, Squid also enables the
2521 following checks, comparing the corresponding Host header
2522 and Request-URI components:
2524 * The host names (domain or IP) must be identical,
2525 but valueless or missing Host header disables all checks.
2526 For the two host names to match, both must be either IP
2529 * Port numbers must be identical, but if a port is missing
2530 the scheme-default port is assumed.
2533 When set to OFF (the default):
2534 Squid allows suspicious requests to continue but logs a
2535 security warning and blocks caching of the response.
2537 * Forward-proxy traffic is not checked at all.
2539 * Reverse-proxy traffic is not checked at all.
2541 * Intercepted traffic which passes verification is handled
2542 according to client_dst_passthru.
2544 * Intercepted requests which fail verification are sent
2545 to the client original destination instead of DIRECT.
2546 This overrides 'client_dst_passthru off'.
2548 For now suspicious intercepted CONNECT requests are always
2549 responded to with an HTTP 409 (Conflict) error page.
2554 As described in CVE-2009-0801 when the Host: header alone is used
2555 to determine the destination of a request it becomes trivial for
2556 malicious scripts on remote websites to bypass browser same-origin
2557 security policy and sandboxing protections.
2559 The cause of this is that such applets are allowed to perform their
2560 own HTTP stack, in which case the same-origin policy of the browser
2561 sandbox only verifies that the applet tries to contact the same IP
2562 as from where it was loaded at the IP level. The Host: header may
2563 be different from the connected IP and approved origin.
2567 NAME: client_dst_passthru
2570 LOC: Config.onoff.client_dst_passthru
2572 With NAT or TPROXY intercepted traffic Squid may pass the request
2573 directly to the original client destination IP or seek a faster
2574 source using the HTTP Host header.
2576 Using Host to locate alternative servers can provide faster
2577 connectivity with a range of failure recovery options.
2578 But can also lead to connectivity trouble when the client and
2579 server are attempting stateful interactions unaware of the proxy.
2581 This option (on by default) prevents alternative DNS entries being
2582 located to send intercepted traffic DIRECT to an origin server.
2583 The clients original destination IP and port will be used instead.
2585 Regardless of this option setting, when dealing with intercepted
2586 traffic Squid will verify the Host: header and any traffic which
2587 fails Host verification will be treated as if this option were ON.
2589 see host_verify_strict for details on the verification process.
2594 -----------------------------------------------------------------------------
2597 NAME: tls_outgoing_options
2598 IFDEF: USE_GNUTLS||USE_OPENSSL
2599 TYPE: securePeerOptions
2600 DEFAULT: min-version=1.0
2601 LOC: Security::ProxyOutgoingConfig
2603 disable Do not support https:// URLs.
2605 cert=/path/to/client/certificate
2606 A client TLS certificate to use when connecting.
2608 key=/path/to/client/private_key
2609 The private TLS key corresponding to the cert= above.
2610 If key= is not specified cert= is assumed to reference
2611 a PEM file containing both the certificate and the key.
2613 cipher=... The list of valid TLS ciphers to use.
2616 The minimum TLS protocol version to permit.
2617 To control SSLv3 use the options= parameter.
2618 Supported Values: 1.0 (default), 1.1, 1.2
2620 options=... Specify various TLS/SSL implementation options:
2622 NO_SSLv3 Disallow the use of SSLv3
2624 NO_TLSv1 Disallow the use of TLSv1.0
2626 NO_TLSv1_1 Disallow the use of TLSv1.1
2628 NO_TLSv1_2 Disallow the use of TLSv1.2
2631 Always create a new key when using
2632 temporary/ephemeral DH key exchanges
2635 Disable use of RFC5077 session tickets.
2636 Some servers may have problems
2637 understanding the TLS extension due
2638 to ambiguous specification in RFC4507.
2640 ALL Enable various bug workarounds
2641 suggested as "harmless" by OpenSSL
2642 Be warned that this reduces SSL/TLS
2643 strength to some attacks.
2645 See the OpenSSL SSL_CTX_set_options documentation for a
2648 cafile=... A file containing additional CA certificates to use
2649 when verifying the peer certificate.
2651 capath=... A directory containing additional CA certificates to
2652 use when verifying the peer certificate.
2654 crlfile=... A certificate revocation list file to use when
2655 verifying the peer certificate.
2657 flags=... Specify various flags modifying the TLS implementation:
2660 Accept certificates even if they fail to
2663 Don't use the default CA list built in
2666 Don't verify the peer certificate
2667 matches the server name
2669 domain= The peer name as advertised in its certificate.
2670 Used for verifying the correctness of the received peer
2671 certificate. If not specified the peer hostname will be
2677 -----------------------------------------------------------------------------
2680 NAME: ssl_unclean_shutdown
2684 LOC: Config.SSL.unclean_shutdown
2686 Some browsers (especially MSIE) bugs out on SSL shutdown
2693 LOC: Config.SSL.ssl_engine
2696 The OpenSSL engine to use. You will need to set this if you
2697 would like to use hardware SSL acceleration for example.
2700 NAME: sslproxy_session_ttl
2703 LOC: Config.SSL.session_ttl
2706 Sets the timeout value for SSL sessions
2709 NAME: sslproxy_session_cache_size
2712 LOC: Config.SSL.sessionCacheSize
2715 Sets the cache size to use for ssl session
2718 NAME: sslproxy_cert_sign_hash
2721 LOC: Config.SSL.certSignHash
2724 Sets the hashing algorithm to use when signing generated certificates.
2725 Valid algorithm names depend on the OpenSSL library used. The following
2726 names are usually available: sha1, sha256, sha512, and md5. Please see
2727 your OpenSSL library manual for the available hashes. By default, Squids
2728 that support this option use sha256 hashes.
2730 Squid does not forcefully purge cached certificates that were generated
2731 with an algorithm other than the currently configured one. They remain
2732 in the cache, subject to the regular cache eviction policy, and become
2733 useful if the algorithm changes again.
2738 TYPE: sslproxy_ssl_bump
2739 LOC: Config.accessList.ssl_bump
2740 DEFAULT_DOC: Become a TCP tunnel without decrypting proxied traffic.
2743 This option is consulted when a CONNECT request is received on
2744 an http_port (or a new connection is intercepted at an
2745 https_port), provided that port was configured with an ssl-bump
2746 flag. The subsequent data on the connection is either treated as
2747 HTTPS and decrypted OR tunneled at TCP level without decryption,
2748 depending on the first matching bumping "action".
2750 ssl_bump <action> [!]acl ...
2752 The following bumping actions are currently supported:
2755 Become a TCP tunnel without decrypting proxied traffic.
2756 This is the default action.
2759 Establish a secure connection with the server and, using a
2760 mimicked server certificate, with the client.
2763 Receive client (step SslBump1) or server (step SslBump2)
2764 certificate while preserving the possibility of splicing the
2765 connection. Peeking at the server certificate (during step 2)
2766 usually precludes bumping of the connection at step 3.
2769 Receive client (step SslBump1) or server (step SslBump2)
2770 certificate while preserving the possibility of bumping the
2771 connection. Staring at the server certificate (during step 2)
2772 usually precludes splicing of the connection at step 3.
2775 Close client and server connections.
2777 Backward compatibility actions available at step SslBump1:
2780 Bump the connection. Establish a secure connection with the
2781 client first, then connect to the server. This old mode does
2782 not allow Squid to mimic server SSL certificate and does not
2783 work with intercepted SSL connections.
2786 Bump the connection. Establish a secure connection with the
2787 server first, then establish a secure connection with the
2788 client, using a mimicked server certificate. Works with both
2789 CONNECT requests and intercepted SSL connections, but does
2790 not allow to make decisions based on SSL handshake info.
2793 Decide whether to bump or splice the connection based on
2794 client-to-squid and server-to-squid SSL hello messages.
2798 Same as the "splice" action.
2800 All ssl_bump rules are evaluated at each of the supported bumping
2801 steps. Rules with actions that are impossible at the current step are
2802 ignored. The first matching ssl_bump action wins and is applied at the
2803 end of the current step. If no rules match, the splice action is used.
2804 See the at_step ACL for a list of the supported SslBump steps.
2806 This clause supports both fast and slow acl types.
2807 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
2809 See also: http_port ssl-bump, https_port ssl-bump, and acl at_step.
2812 # Example: Bump all requests except those originating from
2813 # localhost or those going to example.com.
2815 acl broken_sites dstdomain .example.com
2816 ssl_bump splice localhost
2817 ssl_bump splice broken_sites
2821 NAME: sslproxy_cert_error
2824 DEFAULT_DOC: Server certificate errors terminate the transaction.
2825 LOC: Config.ssl_client.cert_error
2828 Use this ACL to bypass server certificate validation errors.
2830 For example, the following lines will bypass all validation errors
2831 when talking to servers for example.com. All other
2832 validation errors will result in ERR_SECURE_CONNECT_FAIL error.
2834 acl BrokenButTrustedServers dstdomain example.com
2835 sslproxy_cert_error allow BrokenButTrustedServers
2836 sslproxy_cert_error deny all
2838 This clause only supports fast acl types.
2839 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
2840 Using slow acl types may result in server crashes
2842 Without this option, all server certificate validation errors
2843 terminate the transaction to protect Squid and the client.
2845 SQUID_X509_V_ERR_INFINITE_VALIDATION error cannot be bypassed
2846 but should not happen unless your OpenSSL library is buggy.
2849 Bypassing validation errors is dangerous because an
2850 error usually implies that the server cannot be trusted
2851 and the connection may be insecure.
2853 See also: sslproxy_flags and DONT_VERIFY_PEER.
2856 NAME: sslproxy_cert_sign
2859 POSTSCRIPTUM: signUntrusted ssl::certUntrusted
2860 POSTSCRIPTUM: signSelf ssl::certSelfSigned
2861 POSTSCRIPTUM: signTrusted all
2862 TYPE: sslproxy_cert_sign
2863 LOC: Config.ssl_client.cert_sign
2866 sslproxy_cert_sign <signing algorithm> acl ...
2868 The following certificate signing algorithms are supported:
2871 Sign using the configured CA certificate which is usually
2872 placed in and trusted by end-user browsers. This is the
2873 default for trusted origin server certificates.
2876 Sign to guarantee an X509_V_ERR_CERT_UNTRUSTED browser error.
2877 This is the default for untrusted origin server certificates
2878 that are not self-signed (see ssl::certUntrusted).
2881 Sign using a self-signed certificate with the right CN to
2882 generate a X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT error in the
2883 browser. This is the default for self-signed origin server
2884 certificates (see ssl::certSelfSigned).
2886 This clause only supports fast acl types.
2888 When sslproxy_cert_sign acl(s) match, Squid uses the corresponding
2889 signing algorithm to generate the certificate and ignores all
2890 subsequent sslproxy_cert_sign options (the first match wins). If no
2891 acl(s) match, the default signing algorithm is determined by errors
2892 detected when obtaining and validating the origin server certificate.
2894 WARNING: SQUID_X509_V_ERR_DOMAIN_MISMATCH and ssl:certDomainMismatch can
2895 be used with sslproxy_cert_adapt, but if and only if Squid is bumping a
2896 CONNECT request that carries a domain name. In all other cases (CONNECT
2897 to an IP address or an intercepted SSL connection), Squid cannot detect
2898 the domain mismatch at certificate generation time when
2899 bump-server-first is used.
2902 NAME: sslproxy_cert_adapt
2905 TYPE: sslproxy_cert_adapt
2906 LOC: Config.ssl_client.cert_adapt
2909 sslproxy_cert_adapt <adaptation algorithm> acl ...
2911 The following certificate adaptation algorithms are supported:
2914 Sets the "Not After" property to the "Not After" property of
2915 the CA certificate used to sign generated certificates.
2918 Sets the "Not Before" property to the "Not Before" property of
2919 the CA certificate used to sign generated certificates.
2921 setCommonName or setCommonName{CN}
2922 Sets Subject.CN property to the host name specified as a
2923 CN parameter or, if no explicit CN parameter was specified,
2924 extracted from the CONNECT request. It is a misconfiguration
2925 to use setCommonName without an explicit parameter for
2926 intercepted or tproxied SSL connections.
2928 This clause only supports fast acl types.
2930 Squid first groups sslproxy_cert_adapt options by adaptation algorithm.
2931 Within a group, when sslproxy_cert_adapt acl(s) match, Squid uses the
2932 corresponding adaptation algorithm to generate the certificate and
2933 ignores all subsequent sslproxy_cert_adapt options in that algorithm's
2934 group (i.e., the first match wins within each algorithm group). If no
2935 acl(s) match, the default mimicking action takes place.
2937 WARNING: SQUID_X509_V_ERR_DOMAIN_MISMATCH and ssl:certDomainMismatch can
2938 be used with sslproxy_cert_adapt, but if and only if Squid is bumping a
2939 CONNECT request that carries a domain name. In all other cases (CONNECT
2940 to an IP address or an intercepted SSL connection), Squid cannot detect
2941 the domain mismatch at certificate generation time when
2942 bump-server-first is used.
2945 NAME: sslpassword_program
2948 LOC: Config.Program.ssl_password
2951 Specify a program used for entering SSL key passphrases
2952 when using encrypted SSL certificate keys. If not specified
2953 keys must either be unencrypted, or Squid started with the -N
2954 option to allow it to query interactively for the passphrase.
2956 The key file name is given as argument to the program allowing
2957 selection of the right password if you have multiple encrypted
2962 OPTIONS RELATING TO EXTERNAL SSL_CRTD
2963 -----------------------------------------------------------------------------
2966 NAME: sslcrtd_program
2969 DEFAULT: @DEFAULT_SSL_CRTD@ -s @DEFAULT_SSL_DB_DIR@ -M 4MB
2970 LOC: Ssl::TheConfig.ssl_crtd
2972 Specify the location and options of the executable for ssl_crtd process.
2973 @DEFAULT_SSL_CRTD@ program requires -s and -M parameters
2974 For more information use:
2975 @DEFAULT_SSL_CRTD@ -h
2978 NAME: sslcrtd_children
2979 TYPE: HelperChildConfig
2981 DEFAULT: 32 startup=5 idle=1
2982 LOC: Ssl::TheConfig.ssl_crtdChildren
2984 The maximum number of processes spawn to service ssl server.
2985 The maximum this may be safely set to is 32.
2987 The startup= and idle= options allow some measure of skew in your
2992 Sets the minimum number of processes to spawn when Squid
2993 starts or reconfigures. When set to zero the first request will
2994 cause spawning of the first child process to handle it.
2996 Starting too few children temporary slows Squid under load while it
2997 tries to spawn enough additional processes to cope with traffic.
3001 Sets a minimum of how many processes Squid is to try and keep available
3002 at all times. When traffic begins to rise above what the existing
3003 processes can handle this many more will be spawned up to the maximum
3004 configured. A minimum setting of 1 is required.
3008 Sets the maximum number of queued requests.
3009 If the queued requests exceed queue size for more than 3 minutes
3010 squid aborts its operation.
3011 The default value is set to 2*numberofchildren.
3013 You must have at least one ssl_crtd process.
3016 NAME: sslcrtvalidator_program
3020 LOC: Ssl::TheConfig.ssl_crt_validator
3022 Specify the location and options of the executable for ssl_crt_validator
3025 Usage: sslcrtvalidator_program [ttl=n] [cache=n] path ...
3028 ttl=n TTL in seconds for cached results. The default is 60 secs
3029 cache=n limit the result cache size. The default value is 2048
3032 NAME: sslcrtvalidator_children
3033 TYPE: HelperChildConfig
3035 DEFAULT: 32 startup=5 idle=1 concurrency=1
3036 LOC: Ssl::TheConfig.ssl_crt_validator_Children
3038 The maximum number of processes spawn to service SSL server.
3039 The maximum this may be safely set to is 32.
3041 The startup= and idle= options allow some measure of skew in your
3046 Sets the minimum number of processes to spawn when Squid
3047 starts or reconfigures. When set to zero the first request will
3048 cause spawning of the first child process to handle it.
3050 Starting too few children temporary slows Squid under load while it
3051 tries to spawn enough additional processes to cope with traffic.
3055 Sets a minimum of how many processes Squid is to try and keep available
3056 at all times. When traffic begins to rise above what the existing
3057 processes can handle this many more will be spawned up to the maximum
3058 configured. A minimum setting of 1 is required.
3062 The number of requests each certificate validator helper can handle in
3063 parallel. A value of 0 indicates the certficate validator does not
3064 support concurrency. Defaults to 1.
3066 When this directive is set to a value >= 1 then the protocol
3067 used to communicate with the helper is modified to include
3068 a request ID in front of the request/response. The request
3069 ID from the request must be echoed back with the response
3074 Sets the maximum number of queued requests.
3075 If the queued requests exceed queue size for more than 3 minutes
3076 squid aborts its operation.
3077 The default value is set to 2*numberofchildren.
3079 You must have at least one ssl_crt_validator process.
3083 OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM
3084 -----------------------------------------------------------------------------
3092 To specify other caches in a hierarchy, use the format:
3094 cache_peer hostname type http-port icp-port [options]
3099 # hostname type port port options
3100 # -------------------- -------- ----- ----- -----------
3101 cache_peer parent.foo.net parent 3128 3130 default
3102 cache_peer sib1.foo.net sibling 3128 3130 proxy-only
3103 cache_peer sib2.foo.net sibling 3128 3130 proxy-only
3104 cache_peer example.com parent 80 0 default
3105 cache_peer cdn.example.com sibling 3128 0
3107 type: either 'parent', 'sibling', or 'multicast'.
3109 proxy-port: The port number where the peer accept HTTP requests.
3110 For other Squid proxies this is usually 3128
3111 For web servers this is usually 80
3113 icp-port: Used for querying neighbor caches about objects.
3114 Set to 0 if the peer does not support ICP or HTCP.
3115 See ICP and HTCP options below for additional details.
3118 ==== ICP OPTIONS ====
3120 You MUST also set icp_port and icp_access explicitly when using these options.
3121 The defaults will prevent peer traffic using ICP.
3124 no-query Disable ICP queries to this neighbor.
3127 Indicates the named peer is a member of a multicast group.
3128 ICP queries will not be sent directly to the peer, but ICP
3129 replies will be accepted from it.
3131 closest-only Indicates that, for ICP_OP_MISS replies, we'll only forward
3132 CLOSEST_PARENT_MISSes and never FIRST_PARENT_MISSes.
3135 To only send ICP queries to this neighbor infrequently.
3136 This is used to keep the neighbor round trip time updated
3137 and is usually used in conjunction with weighted-round-robin.
3140 ==== HTCP OPTIONS ====
3142 You MUST also set htcp_port and htcp_access explicitly when using these options.
3143 The defaults will prevent peer traffic using HTCP.
3146 htcp Send HTCP, instead of ICP, queries to the neighbor.
3147 You probably also want to set the "icp-port" to 4827
3148 instead of 3130. This directive accepts a comma separated
3149 list of options described below.
3151 htcp=oldsquid Send HTCP to old Squid versions (2.5 or earlier).
3153 htcp=no-clr Send HTCP to the neighbor but without
3154 sending any CLR requests. This cannot be used with
3157 htcp=only-clr Send HTCP to the neighbor but ONLY CLR requests.
3158 This cannot be used with no-clr.
3161 Send HTCP to the neighbor including CLRs but only when
3162 they do not result from PURGE requests.
3165 Forward any HTCP CLR requests this proxy receives to the peer.
3168 ==== PEER SELECTION METHODS ====
3170 The default peer selection method is ICP, with the first responding peer
3171 being used as source. These options can be used for better load balancing.
3174 default This is a parent cache which can be used as a "last-resort"
3175 if a peer cannot be located by any of the peer-selection methods.
3176 If specified more than once, only the first is used.
3178 round-robin Load-Balance parents which should be used in a round-robin
3179 fashion in the absence of any ICP queries.
3180 weight=N can be used to add bias.
3182 weighted-round-robin
3183 Load-Balance parents which should be used in a round-robin
3184 fashion with the frequency of each parent being based on the
3185 round trip time. Closer parents are used more often.
3186 Usually used for background-ping parents.
3187 weight=N can be used to add bias.
3189 carp Load-Balance parents which should be used as a CARP array.
3190 The requests will be distributed among the parents based on the
3191 CARP load balancing hash function based on their weight.
3193 userhash Load-balance parents based on the client proxy_auth or ident username.
3195 sourcehash Load-balance parents based on the client source IP.
3198 To be used only for cache peers of type "multicast".
3199 ALL members of this multicast group have "sibling"
3200 relationship with it, not "parent". This is to a multicast
3201 group when the requested object would be fetched only from
3202 a "parent" cache, anyway. It's useful, e.g., when
3203 configuring a pool of redundant Squid proxies, being
3204 members of the same multicast group.
3207 ==== PEER SELECTION OPTIONS ====
3209 weight=N use to affect the selection of a peer during any weighted
3210 peer-selection mechanisms.
3211 The weight must be an integer; default is 1,
3212 larger weights are favored more.
3213 This option does not affect parent selection if a peering
3214 protocol is not in use.
3216 basetime=N Specify a base amount to be subtracted from round trip
3218 It is subtracted before division by weight in calculating
3219 which parent to fectch from. If the rtt is less than the
3220 base time the rtt is set to a minimal value.
3222 ttl=N Specify a TTL to use when sending multicast ICP queries
3224 Only useful when sending to a multicast group.
3225 Because we don't accept ICP replies from random
3226 hosts, you must configure other group members as
3227 peers with the 'multicast-responder' option.
3229 no-delay To prevent access to this neighbor from influencing the
3232 digest-url=URL Tell Squid to fetch the cache digest (if digests are
3233 enabled) for this host from the specified URL rather
3234 than the Squid default location.
3237 ==== CARP OPTIONS ====
3239 carp-key=key-specification
3240 use a different key than the full URL to hash against the peer.
3241 the key-specification is a comma-separated list of the keywords
3242 scheme, host, port, path, params
3243 Order is not important.
3245 ==== ACCELERATOR / REVERSE-PROXY OPTIONS ====
3247 originserver Causes this parent to be contacted as an origin server.
3248 Meant to be used in accelerator setups when the peer
3252 Set the Host header of requests forwarded to this peer.
3253 Useful in accelerator setups where the server (peer)
3254 expects a certain domain name but clients may request
3255 others. ie example.com or www.example.com
3257 no-digest Disable request of cache digests.
3260 Disables requesting ICMP RTT database (NetDB).
3263 ==== AUTHENTICATION OPTIONS ====
3266 If this is a personal/workgroup proxy and your parent
3267 requires proxy authentication.
3269 Note: The string can include URL escapes (i.e. %20 for
3270 spaces). This also means % must be written as %%.
3273 Send login details received from client to this peer.
3274 Both Proxy- and WWW-Authorization headers are passed
3275 without alteration to the peer.
3276 Authentication is not required by Squid for this to work.
3278 Note: This will pass any form of authentication but
3279 only Basic auth will work through a proxy unless the
3280 connection-auth options are also used.
3282 login=PASS Send login details received from client to this peer.
3283 Authentication is not required by this option.
3285 If there are no client-provided authentication headers
3286 to pass on, but username and password are available
3287 from an external ACL user= and password= result tags
3288 they may be sent instead.
3290 Note: To combine this with proxy_auth both proxies must
3291 share the same user database as HTTP only allows for
3292 a single login (one for proxy, one for origin server).
3293 Also be warned this will expose your users proxy
3294 password to the peer. USE WITH CAUTION
3297 Send the username to the upstream cache, but with a
3298 fixed password. This is meant to be used when the peer
3299 is in another administrative domain, but it is still
3300 needed to identify each user.
3301 The star can optionally be followed by some extra
3302 information which is added to the username. This can
3303 be used to identify this proxy to the peer, similar to
3304 the login=username:password option above.
3307 If this is a personal/workgroup proxy and your parent
3308 requires a secure proxy authentication.
3309 The first principal from the default keytab or defined by
3310 the environment variable KRB5_KTNAME will be used.
3312 WARNING: The connection may transmit requests from multiple
3313 clients. Negotiate often assumes end-to-end authentication
3314 and a single-client. Which is not strictly true here.
3316 login=NEGOTIATE:principal_name
3317 If this is a personal/workgroup proxy and your parent
3318 requires a secure proxy authentication.
3319 The principal principal_name from the default keytab or
3320 defined by the environment variable KRB5_KTNAME will be
3323 WARNING: The connection may transmit requests from multiple
3324 clients. Negotiate often assumes end-to-end authentication
3325 and a single-client. Which is not strictly true here.
3327 connection-auth=on|off
3328 Tell Squid that this peer does or not support Microsoft
3329 connection oriented authentication, and any such
3330 challenges received from there should be ignored.
3331 Default is auto to automatically determine the status
3335 ==== SSL / HTTPS / TLS OPTIONS ====
3337 ssl Encrypt connections to this peer with SSL/TLS.
3339 sslcert=/path/to/ssl/certificate
3340 A client SSL certificate to use when connecting to
3343 sslkey=/path/to/ssl/key
3344 The private SSL key corresponding to sslcert above.
3345 If 'sslkey' is not specified 'sslcert' is assumed to
3346 reference a combined file containing both the
3347 certificate and the key.
3349 sslcipher=... The list of valid SSL ciphers to use when connecting
3353 The minimum TLS protocol version to permit. To control
3354 SSLv3 use the ssloptions= parameter.
3355 Supported Values: 1.0 (default), 1.1, 1.2
3357 ssloptions=... Specify various SSL implementation options:
3359 NO_SSLv3 Disallow the use of SSLv3
3361 NO_TLSv1 Disallow the use of TLSv1.0
3363 NO_TLSv1_1 Disallow the use of TLSv1.1
3365 NO_TLSv1_2 Disallow the use of TLSv1.2
3368 Always create a new key when using
3369 temporary/ephemeral DH key exchanges
3372 Disable use of RFC5077 session tickets.
3373 Some servers may have problems
3374 understanding the TLS extension due
3375 to ambiguous specification in RFC4507.
3377 ALL Enable various bug workarounds
3378 suggested as "harmless" by OpenSSL
3379 Be warned that this reduces SSL/TLS
3380 strength to some attacks.
3382 See the OpenSSL SSL_CTX_set_options documentation for a
3385 sslcafile=... A file containing additional CA certificates to use
3386 when verifying the peer certificate.
3388 sslcapath=... A directory containing additional CA certificates to
3389 use when verifying the peer certificate.
3391 sslcrlfile=... A certificate revocation list file to use when
3392 verifying the peer certificate.
3394 sslflags=... Specify various flags modifying the SSL implementation:
3397 Accept certificates even if they fail to
3401 Don't use the default CA list built in
3405 Don't verify the peer certificate
3406 matches the server name
3408 ssldomain= The peer name as advertised in it's certificate.
3409 Used for verifying the correctness of the received peer
3410 certificate. If not specified the peer hostname will be
3414 Enable the "Front-End-Https: On" header needed when
3415 using Squid as a SSL frontend in front of Microsoft OWA.
3416 See MS KB document Q307347 for details on this header.
3417 If set to auto the header will only be added if the
3418 request is forwarded as a https:// URL.
3421 ==== GENERAL OPTIONS ====
3424 A peer-specific connect timeout.
3425 Also see the peer_connect_timeout directive.
3427 connect-fail-limit=N
3428 How many times connecting to a peer must fail before
3429 it is marked as down. Standby connection failures
3430 count towards this limit. Default is 10.
3432 allow-miss Disable Squid's use of only-if-cached when forwarding
3433 requests to siblings. This is primarily useful when
3434 icp_hit_stale is used by the sibling. To extensive use
3435 of this option may result in forwarding loops, and you
3436 should avoid having two-way peerings with this option.
3437 For example to deny peer usage on requests from peer
3438 by denying cache_peer_access if the source is a peer.
3440 max-conn=N Limit the number of concurrent connections the Squid
3441 may open to this peer, including already opened idle
3442 and standby connections. There is no peer-specific
3443 connection limit by default.
3445 A peer exceeding the limit is not used for new
3446 requests unless a standby connection is available.
3448 max-conn currently works poorly with idle persistent
3449 connections: When a peer reaches its max-conn limit,
3450 and there are idle persistent connections to the peer,
3451 the peer may not be selected because the limiting code
3452 does not know whether Squid can reuse those idle
3455 standby=N Maintain a pool of N "hot standby" connections to an
3456 UP peer, available for requests when no idle
3457 persistent connection is available (or safe) to use.
3458 By default and with zero N, no such pool is maintained.
3459 N must not exceed the max-conn limit (if any).
3461 At start or after reconfiguration, Squid opens new TCP
3462 standby connections until there are N connections
3463 available and then replenishes the standby pool as
3464 opened connections are used up for requests. A used
3465 connection never goes back to the standby pool, but
3466 may go to the regular idle persistent connection pool
3467 shared by all peers and origin servers.
3469 Squid never opens multiple new standby connections
3470 concurrently. This one-at-a-time approach minimizes
3471 flooding-like effect on peers. Furthermore, just a few
3472 standby connections should be sufficient in most cases
3473 to supply most new requests with a ready-to-use
3476 Standby connections obey server_idle_pconn_timeout.
3477 For the feature to work as intended, the peer must be
3478 configured to accept and keep them open longer than
3479 the idle timeout at the connecting Squid, to minimize
3480 race conditions typical to idle used persistent
3481 connections. Default request_timeout and
3482 server_idle_pconn_timeout values ensure such a
3485 name=xxx Unique name for the peer.
3486 Required if you have multiple peers on the same host
3487 but different ports.
3488 This name can be used in cache_peer_access and similar
3489 directives to dentify the peer.
3490 Can be used by outgoing access controls through the
3493 no-tproxy Do not use the client-spoof TPROXY support when forwarding
3494 requests to this peer. Use normal address selection instead.
3495 This overrides the spoof_client_ip ACL.
3497 proxy-only objects fetched from the peer will not be stored locally.
3501 NAME: cache_peer_access
3506 Use to limit the requests for which a neighbor proxy will be
3507 queried. Peers with no restrictions are queried for all requests.
3510 cache_peer_access cache-host allow|deny [!]aclname ...
3512 The syntax is identical to 'http_access' and the other lists of
3513 ACL elements. See the comments for 'http_access', or the
3514 Squid FAQ (http://wiki.squid-cache.org/SquidFaq/SquidAcl).
3517 NAME: neighbor_type_domain
3518 TYPE: hostdomaintype
3520 DEFAULT_DOC: The peer type from cache_peer directive is used for all requests to that peer.
3523 Modify the cache_peer neighbor type when passing requests
3524 about specific domains to the peer.
3527 neighbor_type_domain neighbor parent|sibling domain domain ...
3530 cache_peer foo.example.com parent 3128 3130
3531 neighbor_type_domain foo.example.com sibling .au .de
3533 The above configuration treats all requests to foo.example.com as a
3534 parent proxy unless the request is for a .au or .de ccTLD domain name.
3537 NAME: dead_peer_timeout
3541 LOC: Config.Timeout.deadPeer
3543 This controls how long Squid waits to declare a peer cache
3544 as "dead." If there are no ICP replies received in this
3545 amount of time, Squid will declare the peer dead and not
3546 expect to receive any further ICP replies. However, it
3547 continues to send ICP queries, and will mark the peer as
3548 alive upon receipt of the first subsequent ICP reply.
3550 This timeout also affects when Squid expects to receive ICP
3551 replies from peers. If more than 'dead_peer' seconds have
3552 passed since the last ICP reply was received, Squid will not
3553 expect to receive an ICP reply on the next query. Thus, if
3554 your time between requests is greater than this timeout, you
3555 will see a lot of requests sent DIRECT to origin servers
3556 instead of to your parents.
3559 NAME: forward_max_tries
3562 LOC: Config.forward_max_tries
3564 Controls how many different forward paths Squid will try
3565 before giving up. See also forward_timeout.
3567 NOTE: connect_retries (default: none) can make each of these
3568 possible forwarding paths be tried multiple times.
3572 MEMORY CACHE OPTIONS
3573 -----------------------------------------------------------------------------
3580 LOC: Config.memMaxSize
3582 NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS SIZE.
3583 IT ONLY PLACES A LIMIT ON HOW MUCH ADDITIONAL MEMORY SQUID WILL
3584 USE AS A MEMORY CACHE OF OBJECTS. SQUID USES MEMORY FOR OTHER
3585 THINGS AS WELL. SEE THE SQUID FAQ SECTION 8 FOR DETAILS.
3587 'cache_mem' specifies the ideal amount of memory to be used
3589 * In-Transit objects
3591 * Negative-Cached objects
3593 Data for these objects are stored in 4 KB blocks. This
3594 parameter specifies the ideal upper limit on the total size of
3595 4 KB blocks allocated. In-Transit objects take the highest
3598 In-transit objects have priority over the others. When
3599 additional space is needed for incoming data, negative-cached
3600 and hot objects will be released. In other words, the
3601 negative-cached and hot objects will fill up any unused space
3602 not needed for in-transit objects.
3604 If circumstances require, this limit will be exceeded.
3605 Specifically, if your incoming request rate requires more than
3606 'cache_mem' of memory to hold in-transit objects, Squid will
3607 exceed this limit to satisfy the new requests. When the load
3608 decreases, blocks will be freed until the high-water mark is
3609 reached. Thereafter, blocks will be used to store hot
3612 If shared memory caching is enabled, Squid does not use the shared
3613 cache space for in-transit objects, but they still consume as much
3614 local memory as they need. For more details about the shared memory
3615 cache, see memory_cache_shared.
3618 NAME: maximum_object_size_in_memory
3622 LOC: Config.Store.maxInMemObjSize
3624 Objects greater than this size will not be attempted to kept in
3625 the memory cache. This should be set high enough to keep objects
3626 accessed frequently in memory to improve performance whilst low
3627 enough to keep larger objects from hoarding cache_mem.
3630 NAME: memory_cache_shared
3633 LOC: Config.memShared
3635 DEFAULT_DOC: "on" where supported if doing memory caching with multiple SMP workers.
3637 Controls whether the memory cache is shared among SMP workers.
3639 The shared memory cache is meant to occupy cache_mem bytes and replace
3640 the non-shared memory cache, although some entities may still be
3641 cached locally by workers for now (e.g., internal and in-transit
3642 objects may be served from a local memory cache even if shared memory
3643 caching is enabled).
3645 By default, the memory cache is shared if and only if all of the
3646 following conditions are satisfied: Squid runs in SMP mode with
3647 multiple workers, cache_mem is positive, and Squid environment
3648 supports required IPC primitives (e.g., POSIX shared memory segments
3649 and GCC-style atomic operations).
3651 To avoid blocking locks, shared memory uses opportunistic algorithms
3652 that do not guarantee that every cachable entity that could have been
3653 shared among SMP workers will actually be shared.
3655 Currently, entities exceeding 32KB in size cannot be shared.
3658 NAME: memory_cache_mode
3662 DEFAULT_DOC: Keep the most recently fetched objects in memory
3664 Controls which objects to keep in the memory cache (cache_mem)
3666 always Keep most recently fetched objects in memory (default)
3668 disk Only disk cache hits are kept in memory, which means
3669 an object must first be cached on disk and then hit
3670 a second time before cached in memory.
3672 network Only objects fetched from network is kept in memory
3675 NAME: memory_replacement_policy
3677 LOC: Config.memPolicy
3680 The memory replacement policy parameter determines which
3681 objects are purged from memory when memory space is needed.
3683 See cache_replacement_policy for details on algorithms.
3688 -----------------------------------------------------------------------------
3691 NAME: cache_replacement_policy
3693 LOC: Config.replPolicy
3696 The cache replacement policy parameter determines which
3697 objects are evicted (replaced) when disk space is needed.
3699 lru : Squid's original list based LRU policy
3700 heap GDSF : Greedy-Dual Size Frequency
3701 heap LFUDA: Least Frequently Used with Dynamic Aging
3702 heap LRU : LRU policy implemented using a heap
3704 Applies to any cache_dir lines listed below this directive.
3706 The LRU policies keeps recently referenced objects.
3708 The heap GDSF policy optimizes object hit rate by keeping smaller
3709 popular objects in cache so it has a better chance of getting a
3710 hit. It achieves a lower byte hit rate than LFUDA though since
3711 it evicts larger (possibly popular) objects.
3713 The heap LFUDA policy keeps popular objects in cache regardless of
3714 their size and thus optimizes byte hit rate at the expense of
3715 hit rate since one large, popular object will prevent many
3716 smaller, slightly less popular objects from being cached.
3718 Both policies utilize a dynamic aging mechanism that prevents
3719 cache pollution that can otherwise occur with frequency-based
3720 replacement policies.
3722 NOTE: if using the LFUDA replacement policy you should increase
3723 the value of maximum_object_size above its default of 4 MB to
3724 to maximize the potential byte hit rate improvement of LFUDA.
3726 For more information about the GDSF and LFUDA cache replacement
3727 policies see http://www.hpl.hp.com/techreports/1999/HPL-1999-69.html
3728 and http://fog.hpl.external.hp.com/techreports/98/HPL-98-173.html.
3731 NAME: minimum_object_size
3735 DEFAULT_DOC: no limit
3736 LOC: Config.Store.minObjectSize
3738 Objects smaller than this size will NOT be saved on disk. The
3739 value is specified in bytes, and the default is 0 KB, which
3740 means all responses can be stored.
3743 NAME: maximum_object_size
3747 LOC: Config.Store.maxObjectSize
3749 Set the default value for max-size parameter on any cache_dir.
3750 The value is specified in bytes, and the default is 4 MB.
3752 If you wish to get a high BYTES hit ratio, you should probably
3753 increase this (one 32 MB object hit counts for 3200 10KB
3756 If you wish to increase hit ratio more than you want to
3757 save bandwidth you should leave this low.
3759 NOTE: if using the LFUDA replacement policy you should increase
3760 this value to maximize the byte hit rate improvement of LFUDA!
3761 See cache_replacement_policy for a discussion of this policy.
3767 DEFAULT_DOC: No disk cache. Store cache ojects only in memory.
3768 LOC: Config.cacheSwap
3771 cache_dir Type Directory-Name Fs-specific-data [options]
3773 You can specify multiple cache_dir lines to spread the
3774 cache among different disk partitions.
3776 Type specifies the kind of storage system to use. Only "ufs"
3777 is built by default. To enable any of the other storage systems
3778 see the --enable-storeio configure option.
3780 'Directory' is a top-level directory where cache swap
3781 files will be stored. If you want to use an entire disk
3782 for caching, this can be the mount-point directory.
3783 The directory must exist and be writable by the Squid
3784 process. Squid will NOT create this directory for you.
3786 In SMP configurations, cache_dir must not precede the workers option
3787 and should use configuration macros or conditionals to give each
3788 worker interested in disk caching a dedicated cache directory.
3791 ==== The ufs store type ====
3793 "ufs" is the old well-known Squid storage format that has always
3797 cache_dir ufs Directory-Name Mbytes L1 L2 [options]
3799 'Mbytes' is the amount of disk space (MB) to use under this
3800 directory. The default is 100 MB. Change this to suit your
3801 configuration. Do NOT put the size of your disk drive here.
3802 Instead, if you want Squid to use the entire disk drive,
3803 subtract 20% and use that value.
3805 'L1' is the number of first-level subdirectories which
3806 will be created under the 'Directory'. The default is 16.
3808 'L2' is the number of second-level subdirectories which
3809 will be created under each first-level directory. The default
3813 ==== The aufs store type ====
3815 "aufs" uses the same storage format as "ufs", utilizing
3816 POSIX-threads to avoid blocking the main Squid process on
3817 disk-I/O. This was formerly known in Squid as async-io.
3820 cache_dir aufs Directory-Name Mbytes L1 L2 [options]
3822 see argument descriptions under ufs above
3825 ==== The diskd store type ====
3827 "diskd" uses the same storage format as "ufs", utilizing a
3828 separate process to avoid blocking the main Squid process on
3832 cache_dir diskd Directory-Name Mbytes L1 L2 [options] [Q1=n] [Q2=n]
3834 see argument descriptions under ufs above
3836 Q1 specifies the number of unacknowledged I/O requests when Squid
3837 stops opening new files. If this many messages are in the queues,
3838 Squid won't open new files. Default is 64
3840 Q2 specifies the number of unacknowledged messages when Squid
3841 starts blocking. If this many messages are in the queues,
3842 Squid blocks until it receives some replies. Default is 72
3844 When Q1 < Q2 (the default), the cache directory is optimized
3845 for lower response time at the expense of a decrease in hit
3846 ratio. If Q1 > Q2, the cache directory is optimized for
3847 higher hit ratio at the expense of an increase in response
3851 ==== The rock store type ====
3854 cache_dir rock Directory-Name Mbytes [options]
3856 The Rock Store type is a database-style storage. All cached
3857 entries are stored in a "database" file, using fixed-size slots.
3858 A single entry occupies one or more slots.
3860 If possible, Squid using Rock Store creates a dedicated kid
3861 process called "disker" to avoid blocking Squid worker(s) on disk
3862 I/O. One disker kid is created for each rock cache_dir. Diskers
3863 are created only when Squid, running in daemon mode, has support
3864 for the IpcIo disk I/O module.
3866 swap-timeout=msec: Squid will not start writing a miss to or
3867 reading a hit from disk if it estimates that the swap operation
3868 will take more than the specified number of milliseconds. By
3869 default and when set to zero, disables the disk I/O time limit
3870 enforcement. Ignored when using blocking I/O module because
3871 blocking synchronous I/O does not allow Squid to estimate the
3872 expected swap wait time.
3874 max-swap-rate=swaps/sec: Artificially limits disk access using
3875 the specified I/O rate limit. Swap out requests that
3876 would cause the average I/O rate to exceed the limit are
3877 delayed. Individual swap in requests (i.e., hits or reads) are
3878 not delayed, but they do contribute to measured swap rate and
3879 since they are placed in the same FIFO queue as swap out
3880 requests, they may wait longer if max-swap-rate is smaller.
3881 This is necessary on file systems that buffer "too
3882 many" writes and then start blocking Squid and other processes
3883 while committing those writes to disk. Usually used together
3884 with swap-timeout to avoid excessive delays and queue overflows
3885 when disk demand exceeds available disk "bandwidth". By default
3886 and when set to zero, disables the disk I/O rate limit
3887 enforcement. Currently supported by IpcIo module only.
3889 slot-size=bytes: The size of a database "record" used for
3890 storing cached responses. A cached response occupies at least
3891 one slot and all database I/O is done using individual slots so
3892 increasing this parameter leads to more disk space waste while
3893 decreasing it leads to more disk I/O overheads. Should be a
3894 multiple of your operating system I/O page size. Defaults to
3895 16KBytes. A housekeeping header is stored with each slot and
3896 smaller slot-sizes will be rejected. The header is smaller than
3900 ==== COMMON OPTIONS ====
3902 no-store no new objects should be stored to this cache_dir.
3904 min-size=n the minimum object size in bytes this cache_dir
3905 will accept. It's used to restrict a cache_dir
3906 to only store large objects (e.g. AUFS) while
3907 other stores are optimized for smaller objects
3911 max-size=n the maximum object size in bytes this cache_dir
3913 The value in maximum_object_size directive sets
3914 the default unless more specific details are
3915 available (ie a small store capacity).
3917 Note: To make optimal use of the max-size limits you should order
3918 the cache_dir lines with the smallest max-size value first.
3922 # Uncomment and adjust the following to add a disk cache directory.
3923 #cache_dir ufs @DEFAULT_SWAP_DIR@ 100 16 256
3927 NAME: store_dir_select_algorithm
3929 LOC: Config.store_dir_select_algorithm
3932 How Squid selects which cache_dir to use when the response
3933 object will fit into more than one.
3935 Regardless of which algorithm is used the cache_dir min-size
3936 and max-size parameters are obeyed. As such they can affect
3937 the selection algorithm by limiting the set of considered
3944 This algorithm is suited to caches with similar cache_dir
3945 sizes and disk speeds.
3947 The disk with the least I/O pending is selected.
3948 When there are multiple disks with the same I/O load ranking
3949 the cache_dir with most available capacity is selected.
3951 When a mix of cache_dir sizes are configured the faster disks
3952 have a naturally lower I/O loading and larger disks have more
3953 capacity. So space used to store objects and data throughput
3954 may be very unbalanced towards larger disks.
3959 This algorithm is suited to caches with unequal cache_dir
3962 Each cache_dir is selected in a rotation. The next suitable
3965 Available cache_dir capacity is only considered in relation
3966 to whether the object will fit and meets the min-size and
3967 max-size parameters.
3969 Disk I/O loading is only considered to prevent overload on slow
3970 disks. This algorithm does not spread objects by size, so any
3971 I/O loading per-disk may appear very unbalanced and volatile.
3973 If several cache_dirs use similar min-size, max-size, or other
3974 limits to to reject certain responses, then do not group such
3975 cache_dir lines together, to avoid round-robin selection bias
3976 towards the first cache_dir after the group. Instead, interleave
3977 cache_dir lines from different groups. For example:
3979 store_dir_select_algorithm round-robin
3980 cache_dir rock /hdd1 ... min-size=100000
3981 cache_dir rock /ssd1 ... max-size=99999
3982 cache_dir rock /hdd2 ... min-size=100000
3983 cache_dir rock /ssd2 ... max-size=99999
3984 cache_dir rock /hdd3 ... min-size=100000
3985 cache_dir rock /ssd3 ... max-size=99999
3988 NAME: max_open_disk_fds
3990 LOC: Config.max_open_disk_fds
3992 DEFAULT_DOC: no limit
3994 To avoid having disk as the I/O bottleneck Squid can optionally
3995 bypass the on-disk cache if more than this amount of disk file
3996 descriptors are open.
3998 A value of 0 indicates no limit.
4001 NAME: cache_swap_low
4002 COMMENT: (percent, 0-100)
4005 LOC: Config.Swap.lowWaterMark
4007 The low-water mark for cache object replacement.
4008 Replacement begins when the swap (disk) usage is above the
4009 low-water mark and attempts to maintain utilization near the
4010 low-water mark. As swap utilization gets close to high-water
4011 mark object eviction becomes more aggressive. If utilization is
4012 close to the low-water mark less replacement is done each time.
4014 Defaults are 90% and 95%. If you have a large cache, 5% could be
4015 hundreds of MB. If this is the case you may wish to set these
4016 numbers closer together.
4018 See also cache_swap_high
4021 NAME: cache_swap_high
4022 COMMENT: (percent, 0-100)
4025 LOC: Config.Swap.highWaterMark
4027 The high-water mark for cache object replacement.
4028 Replacement begins when the swap (disk) usage is above the
4029 low-water mark and attempts to maintain utilization near the
4030 low-water mark. As swap utilization gets close to high-water
4031 mark object eviction becomes more aggressive. If utilization is
4032 close to the low-water mark less replacement is done each time.
4034 Defaults are 90% and 95%. If you have a large cache, 5% could be
4035 hundreds of MB. If this is the case you may wish to set these
4036 numbers closer together.
4038 See also cache_swap_low
4043 -----------------------------------------------------------------------------
4050 DEFAULT_DOC: The format definitions squid, common, combined, referrer, useragent are built in.
4054 logformat <name> <format specification>
4056 Defines an access log format.
4058 The <format specification> is a string with embedded % format codes
4060 % format codes all follow the same basic structure where all but
4061 the formatcode is optional. Output strings are automatically escaped
4062 as required according to their context and the output format
4063 modifiers are usually not needed, but can be specified if an explicit
4064 output format is desired.
4066 % ["|[|'|#] [-] [[0]width] [{argument}] formatcode
4068 " output in quoted string format
4069 [ output in squid text log format as used by log_mime_hdrs
4070 # output in URL quoted format
4075 width minimum and/or maximum field width:
4076 [width_min][.width_max]
4077 When minimum starts with 0, the field is zero-padded.
4078 String values exceeding maximum width are truncated.
4080 {arg} argument such as header name etc
4084 % a literal % character
4085 sn Unique sequence number per log line entry
4086 err_code The ID of an error response served by Squid or
4087 a similar internal error identifier.
4088 err_detail Additional err_code-dependent error information.
4089 note The annotation specified by the argument. Also
4090 logs the adaptation meta headers set by the
4091 adaptation_meta configuration parameter.
4092 If no argument given all annotations logged.
4093 The argument may include a separator to use with
4096 By default, multiple note values are separated with ","
4097 and multiple notes are separated with "\r\n".
4098 When logging named notes with %{name}note, the
4099 explicitly configured separator is used between note
4100 values. When logging all notes with %note, the
4101 explicitly configured separator is used between
4102 individual notes. There is currently no way to
4103 specify both value and notes separators when logging
4104 all notes with %note.
4106 Connection related format codes:
4108 >a Client source IP address
4110 >p Client source port
4111 >eui Client source EUI (MAC address, EUI-48 or EUI-64 identifier)
4112 >la Local IP address the client connected to
4113 >lp Local port number the client connected to
4114 >qos Client connection TOS/DSCP value set by Squid
4115 >nfmark Client connection netfilter mark set by Squid
4117 la Local listening IP address the client connection was connected to.
4118 lp Local listening port number the client connection was connected to.
4120 <a Server IP address of the last server or peer connection
4121 <A Server FQDN or peer name
4122 <p Server port number of the last server or peer connection
4123 <la Local IP address of the last server or peer connection
4124 <lp Local port number of the last server or peer connection
4125 <qos Server connection TOS/DSCP value set by Squid
4126 <nfmark Server connection netfilter mark set by Squid
4128 Time related format codes:
4130 ts Seconds since epoch
4131 tu subsecond time (milliseconds)
4132 tl Local time. Optional strftime format argument
4133 default %d/%b/%Y:%H:%M:%S %z
4134 tg GMT time. Optional strftime format argument
4135 default %d/%b/%Y:%H:%M:%S %z
4136 tr Response time (milliseconds)
4137 dt Total time spent making DNS lookups (milliseconds)
4138 tS Approximate master transaction start time in
4139 <full seconds since epoch>.<fractional seconds> format.
4140 Currently, Squid considers the master transaction
4141 started when a complete HTTP request header initiating
4142 the transaction is received from the client. This is
4143 the same value that Squid uses to calculate transaction
4144 response time when logging %tr to access.log. Currently,
4145 Squid uses millisecond resolution for %tS values,
4146 similar to the default access.log "current time" field
4149 Access Control related format codes:
4151 et Tag returned by external acl
4152 ea Log string returned by external acl
4153 un User name (any available)
4154 ul User name from authentication
4155 ue User name from external acl helper
4156 ui User name from ident
4157 us User name from SSL
4158 un A user name. Expands to the first available name
4159 from the following list of information sources:
4160 - authenticated user name, like %ul
4161 - user name supplied by an external ACL, like %ue
4162 - SSL client name, like %us
4163 - ident user name, like %ui
4164 credentials Client credentials. The exact meaning depends on
4165 the authentication scheme: For Basic authentication,
4166 it is the password; for Digest, the realm sent by the
4167 client; for NTLM and Negotiate, the client challenge
4168 or client credentials prefixed with "YR " or "KK ".
4170 HTTP related format codes:
4174 [http::]rm Request method (GET/POST etc)
4175 [http::]>rm Request method from client
4176 [http::]<rm Request method sent to server or peer
4177 [http::]ru Request URL from client (historic, filtered for logging)
4178 [http::]>ru Request URL from client
4179 [http::]<ru Request URL sent to server or peer
4180 [http::]>rs Request URL scheme from client
4181 [http::]<rs Request URL scheme sent to server or peer
4182 [http::]>rd Request URL domain from client
4183 [http::]<rd Request URL domain sent to server or peer
4184 [http::]>rP Request URL port from client
4185 [http::]<rP Request URL port sent to server or peer
4186 [http::]rp Request URL path excluding hostname
4187 [http::]>rp Request URL path excluding hostname from client
4188 [http::]<rp Request URL path excluding hostname sent to server or peer
4189 [http::]rv Request protocol version
4190 [http::]>rv Request protocol version from client
4191 [http::]<rv Request protocol version sent to server or peer
4193 [http::]>h Original received request header.
4194 Usually differs from the request header sent by
4195 Squid, although most fields are often preserved.
4196 Accepts optional header field name/value filter
4197 argument using name[:[separator]element] format.
4198 [http::]>ha Received request header after adaptation and
4199 redirection (pre-cache REQMOD vectoring point).
4200 Usually differs from the request header sent by
4201 Squid, although most fields are often preserved.
4202 Optional header name argument as for >h
4207 [http::]<Hs HTTP status code received from the next hop
4208 [http::]>Hs HTTP status code sent to the client
4210 [http::]<h Reply header. Optional header name argument
4213 [http::]mt MIME content type
4218 [http::]st Total size of request + reply traffic with client
4219 [http::]>st Total size of request received from client.
4220 Excluding chunked encoding bytes.
4221 [http::]<st Total size of reply sent to client (after adaptation)
4223 [http::]>sh Size of request headers received from client
4224 [http::]<sh Size of reply headers sent to client (after adaptation)
4226 [http::]<sH Reply high offset sent
4227 [http::]<sS Upstream object size
4229 [http::]<bs Number of HTTP-equivalent message body bytes
4230 received from the next hop, excluding chunked
4231 transfer encoding and control messages.
4232 Generated FTP/Gopher listings are treated as
4238 [http::]<pt Peer response time in milliseconds. The timer starts
4239 when the last request byte is sent to the next hop
4240 and stops when the last response byte is received.
4241 [http::]<tt Total time in milliseconds. The timer
4242 starts with the first connect request (or write I/O)
4243 sent to the first selected peer. The timer stops
4244 with the last I/O with the last peer.
4246 Squid handling related format codes:
4248 Ss Squid request status (TCP_MISS etc)
4249 Sh Squid hierarchy status (DEFAULT_PARENT etc)
4251 SSL-related format codes:
4253 ssl::bump_mode SslBump decision for the transaction:
4255 For CONNECT requests that initiated bumping of
4256 a connection and for any request received on
4257 an already bumped connection, Squid logs the
4258 corresponding SslBump mode ("server-first" or
4259 "client-first"). See the ssl_bump option for
4260 more information about these modes.
4262 A "none" token is logged for requests that
4263 triggered "ssl_bump" ACL evaluation matching
4264 either a "none" rule or no rules at all.
4266 In all other cases, a single dash ("-") is
4269 ssl::>sni SSL client SNI sent to Squid. Available only
4270 after the peek, stare, or splice SSL bumping
4273 If ICAP is enabled, the following code becomes available (as
4274 well as ICAP log codes documented with the icap_log option):
4276 icap::tt Total ICAP processing time for the HTTP
4277 transaction. The timer ticks when ICAP
4278 ACLs are checked and when ICAP
4279 transaction is in progress.
4281 If adaptation is enabled the following three codes become available:
4283 adapt::<last_h The header of the last ICAP response or
4284 meta-information from the last eCAP
4285 transaction related to the HTTP transaction.
4286 Like <h, accepts an optional header name
4289 adapt::sum_trs Summed adaptation transaction response
4290 times recorded as a comma-separated list in
4291 the order of transaction start time. Each time
4292 value is recorded as an integer number,
4293 representing response time of one or more
4294 adaptation (ICAP or eCAP) transaction in
4295 milliseconds. When a failed transaction is
4296 being retried or repeated, its time is not
4297 logged individually but added to the
4298 replacement (next) transaction. See also:
4301 adapt::all_trs All adaptation transaction response times.
4302 Same as adaptation_strs but response times of
4303 individual transactions are never added
4304 together. Instead, all transaction response
4305 times are recorded individually.
4307 You can prefix adapt::*_trs format codes with adaptation
4308 service name in curly braces to record response time(s) specific
4309 to that service. For example: %{my_service}adapt::sum_trs
4311 If SSL is enabled, the following formating codes become available:
4313 %ssl::>cert_subject The Subject field of the received client
4314 SSL certificate or a dash ('-') if Squid has
4315 received an invalid/malformed certificate or
4316 no certificate at all. Consider encoding the
4317 logged value because Subject often has spaces.
4319 %ssl::>cert_issuer The Issuer field of the received client
4320 SSL certificate or a dash ('-') if Squid has
4321 received an invalid/malformed certificate or
4322 no certificate at all. Consider encoding the
4323 logged value because Issuer often has spaces.
4325 The default formats available (which do not need re-defining) are:
4327 logformat squid %ts.%03tu %6tr %>a %Ss/%03>Hs %<st %rm %ru %[un %Sh/%<a %mt
4328 logformat common %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st %Ss:%Sh
4329 logformat combined %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh
4330 logformat referrer %ts.%03tu %>a %{Referer}>h %ru
4331 logformat useragent %>a [%tl] "%{User-Agent}>h"
4333 NOTE: When the log_mime_hdrs directive is set to ON.
4334 The squid, common and combined formats have a safely encoded copy
4335 of the mime headers appended to each line within a pair of brackets.
4337 NOTE: The common and combined formats are not quite true to the Apache definition.
4338 The logs from Squid contain an extra status and hierarchy code appended.
4342 NAME: access_log cache_access_log
4344 LOC: Config.Log.accesslogs
4345 DEFAULT_IF_NONE: daemon:@DEFAULT_ACCESS_LOG@ squid
4347 Configures whether and how Squid logs HTTP and ICP transactions.
4348 If access logging is enabled, a single line is logged for every
4349 matching HTTP or ICP request. The recommended directive formats are:
4351 access_log <module>:<place> [option ...] [acl acl ...]
4352 access_log none [acl acl ...]
4354 The following directive format is accepted but may be deprecated:
4355 access_log <module>:<place> [<logformat name> [acl acl ...]]
4357 In most cases, the first ACL name must not contain the '=' character
4358 and should not be equal to an existing logformat name. You can always
4359 start with an 'all' ACL to work around those restrictions.
4361 Will log to the specified module:place using the specified format (which
4362 must be defined in a logformat directive) those entries which match
4363 ALL the acl's specified (which must be defined in acl clauses).
4364 If no acl is specified, all requests will be logged to this destination.
4366 ===== Available options for the recommended directive format =====
4368 logformat=name Names log line format (either built-in or
4369 defined by a logformat directive). Defaults
4372 buffer-size=64KB Defines approximate buffering limit for log
4373 records (see buffered_logs). Squid should not
4374 keep more than the specified size and, hence,
4375 should flush records before the buffer becomes
4376 full to avoid overflows under normal
4377 conditions (the exact flushing algorithm is
4378 module-dependent though). The on-error option
4379 controls overflow handling.
4381 on-error=die|drop Defines action on unrecoverable errors. The
4382 'drop' action ignores (i.e., does not log)
4383 affected log records. The default 'die' action
4384 kills the affected worker. The drop action
4385 support has not been tested for modules other
4388 rotate=N Specifies the number of log file rotations to
4389 make when you run 'squid -k rotate'. The default
4390 is to obey the logfile_rotate directive. Setting
4391 rotate=0 will disable the file name rotation,
4392 but the log files are still closed and re-opened.
4393 This will enable you to rename the logfiles
4394 yourself just before sending the rotate signal.
4395 Only supported by the stdio module.
4397 ===== Modules Currently available =====
4399 none Do not log any requests matching these ACL.
4400 Do not specify Place or logformat name.
4402 stdio Write each log line to disk immediately at the completion of
4404 Place: the filename and path to be written.
4406 daemon Very similar to stdio. But instead of writing to disk the log
4407 line is passed to a daemon helper for asychronous handling instead.
4408 Place: varies depending on the daemon.
4410 log_file_daemon Place: the file name and path to be written.
4412 syslog To log each request via syslog facility.
4413 Place: The syslog facility and priority level for these entries.
4414 Place Format: facility.priority
4416 where facility could be any of:
4417 authpriv, daemon, local0 ... local7 or user.
4419 And priority could be any of:
4420 err, warning, notice, info, debug.
4422 udp To send each log line as text data to a UDP receiver.
4423 Place: The destination host name or IP and port.
4424 Place Format: //host:port
4426 tcp To send each log line as text data to a TCP receiver.
4427 Lines may be accumulated before sending (see buffered_logs).
4428 Place: The destination host name or IP and port.
4429 Place Format: //host:port
4432 access_log daemon:@DEFAULT_ACCESS_LOG@ squid
4438 LOC: Config.Log.icaplogs
4441 ICAP log files record ICAP transaction summaries, one line per
4444 The icap_log option format is:
4445 icap_log <filepath> [<logformat name> [acl acl ...]]
4446 icap_log none [acl acl ...]]
4448 Please see access_log option documentation for details. The two
4449 kinds of logs share the overall configuration approach and many
4452 ICAP processing of a single HTTP message or transaction may
4453 require multiple ICAP transactions. In such cases, multiple
4454 ICAP transaction log lines will correspond to a single access
4457 ICAP log uses logformat codes that make sense for an ICAP
4458 transaction. Header-related codes are applied to the HTTP header
4459 embedded in an ICAP server response, with the following caveats:
4460 For REQMOD, there is no HTTP response header unless the ICAP
4461 server performed request satisfaction. For RESPMOD, the HTTP
4462 request header is the header sent to the ICAP server. For
4463 OPTIONS, there are no HTTP headers.
4465 The following format codes are also available for ICAP logs:
4467 icap::<A ICAP server IP address. Similar to <A.
4469 icap::<service_name ICAP service name from the icap_service
4470 option in Squid configuration file.
4472 icap::ru ICAP Request-URI. Similar to ru.
4474 icap::rm ICAP request method (REQMOD, RESPMOD, or
4475 OPTIONS). Similar to existing rm.
4477 icap::>st Bytes sent to the ICAP server (TCP payload
4478 only; i.e., what Squid writes to the socket).
4480 icap::<st Bytes received from the ICAP server (TCP
4481 payload only; i.e., what Squid reads from
4484 icap::<bs Number of message body bytes received from the
4485 ICAP server. ICAP message body, if any, usually
4486 includes encapsulated HTTP message headers and
4487 possibly encapsulated HTTP message body. The
4488 HTTP body part is dechunked before its size is
4491 icap::tr Transaction response time (in
4492 milliseconds). The timer starts when
4493 the ICAP transaction is created and
4494 stops when the transaction is completed.
4497 icap::tio Transaction I/O time (in milliseconds). The
4498 timer starts when the first ICAP request
4499 byte is scheduled for sending. The timers
4500 stops when the last byte of the ICAP response
4503 icap::to Transaction outcome: ICAP_ERR* for all
4504 transaction errors, ICAP_OPT for OPTION
4505 transactions, ICAP_ECHO for 204
4506 responses, ICAP_MOD for message
4507 modification, and ICAP_SAT for request
4508 satisfaction. Similar to Ss.
4510 icap::Hs ICAP response status code. Similar to Hs.
4512 icap::>h ICAP request header(s). Similar to >h.
4514 icap::<h ICAP response header(s). Similar to <h.
4516 The default ICAP log format, which can be used without an explicit
4517 definition, is called icap_squid:
4519 logformat icap_squid %ts.%03tu %6icap::tr %>a %icap::to/%03icap::Hs %icap::<size %icap::rm %icap::ru% %un -/%icap::<A -
4521 See also: logformat, log_icap, and %adapt::<last_h
4524 NAME: logfile_daemon
4526 DEFAULT: @DEFAULT_LOGFILED@
4527 LOC: Log::TheConfig.logfile_daemon
4529 Specify the path to the logfile-writing daemon. This daemon is
4530 used to write the access and store logs, if configured.
4532 Squid sends a number of commands to the log daemon:
4533 L<data>\n - logfile data
4538 r<n>\n - set rotate count to <n>
4539 b<n>\n - 1 = buffer output, 0 = don't buffer output
4541 No responses is expected.
4544 NAME: stats_collection
4546 LOC: Config.accessList.stats_collection
4548 DEFAULT_DOC: Allow logging for all transactions.
4549 COMMENT: allow|deny acl acl...
4551 This options allows you to control which requests gets accounted
4552 in performance counters.
4554 This clause only supports fast acl types.
4555 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
4558 NAME: cache_store_log
4561 LOC: Config.Log.store
4563 Logs the activities of the storage manager. Shows which
4564 objects are ejected from the cache, and which objects are
4565 saved and for how long.
4566 There are not really utilities to analyze this data, so you can safely
4567 disable it (the default).
4569 Store log uses modular logging outputs. See access_log for the list
4570 of modules supported.
4573 cache_store_log stdio:@DEFAULT_STORE_LOG@
4574 cache_store_log daemon:@DEFAULT_STORE_LOG@
4577 NAME: cache_swap_state cache_swap_log
4579 LOC: Config.Log.swap
4581 DEFAULT_DOC: Store the journal inside its cache_dir
4583 Location for the cache "swap.state" file. This index file holds
4584 the metadata of objects saved on disk. It is used to rebuild
4585 the cache during startup. Normally this file resides in each
4586 'cache_dir' directory, but you may specify an alternate
4587 pathname here. Note you must give a full filename, not just
4588 a directory. Since this is the index for the whole object
4589 list you CANNOT periodically rotate it!
4591 If %s can be used in the file name it will be replaced with a
4592 a representation of the cache_dir name where each / is replaced
4593 with '.'. This is needed to allow adding/removing cache_dir
4594 lines when cache_swap_log is being used.
4596 If have more than one 'cache_dir', and %s is not used in the name
4597 these swap logs will have names such as:
4603 The numbered extension (which is added automatically)
4604 corresponds to the order of the 'cache_dir' lines in this
4605 configuration file. If you change the order of the 'cache_dir'
4606 lines in this file, these index files will NOT correspond to
4607 the correct 'cache_dir' entry (unless you manually rename
4608 them). We recommend you do NOT use this option. It is
4609 better to keep these index files in each 'cache_dir' directory.
4612 NAME: logfile_rotate
4615 LOC: Config.Log.rotateNumber
4617 Specifies the default number of logfile rotations to make when you
4618 type 'squid -k rotate'. The default is 10, which will rotate
4619 with extensions 0 through 9. Setting logfile_rotate to 0 will
4620 disable the file name rotation, but the logfiles are still closed
4621 and re-opened. This will enable you to rename the logfiles
4622 yourself just before sending the rotate signal.
4624 Note, from Squid-3.1 this option is only a default for cache.log,
4625 that log can be rotated separately by using debug_options.
4627 Note, from Squid-3.6 this option is only a default for access.log
4628 recorded by stdio: module. Those logs can be rotated separately by
4629 using the rotate=N option on their access_log directive.
4631 Note, the 'squid -k rotate' command normally sends a USR1
4632 signal to the running squid process. In certain situations
4633 (e.g. on Linux with Async I/O), USR1 is used for other
4634 purposes, so -k rotate uses another signal. It is best to get
4635 in the habit of using 'squid -k rotate' instead of 'kill -USR1
4642 DEFAULT: @DEFAULT_MIME_TABLE@
4643 LOC: Config.mimeTablePathname
4645 Path to Squid's icon configuration file.
4647 You shouldn't need to change this, but the default file contains
4648 examples and formatting information if you do.
4654 LOC: Config.onoff.log_mime_hdrs
4657 The Cache can record both the request and the response MIME
4658 headers for each HTTP transaction. The headers are encoded
4659 safely and will appear as two bracketed fields at the end of
4660 the access log (for either the native or httpd-emulated log
4661 formats). To enable this logging set log_mime_hdrs to 'on'.
4666 DEFAULT: @DEFAULT_PID_FILE@
4667 LOC: Config.pidFilename
4669 A filename to write the process-id to. To disable, enter "none".
4672 NAME: client_netmask
4674 LOC: Config.Addrs.client_netmask
4676 DEFAULT_DOC: Log full client IP address
4678 A netmask for client addresses in logfiles and cachemgr output.
4679 Change this to protect the privacy of your cache clients.
4680 A netmask of 255.255.255.0 will log all IP's in that range with
4681 the last digit set to '0'.
4684 NAME: strip_query_terms
4686 LOC: Config.onoff.strip_query_terms
4689 By default, Squid strips query terms from requested URLs before
4690 logging. This protects your user's privacy and reduces log size.
4692 When investigating HIT/MISS or other caching behaviour you
4693 will need to disable this to see the full URL used by Squid.
4700 LOC: Config.onoff.buffered_logs
4702 Whether to write/send access_log records ASAP or accumulate them and
4703 then write/send them in larger chunks. Buffering may improve
4704 performance because it decreases the number of I/Os. However,
4705 buffering increases the delay before log records become available to
4706 the final recipient (e.g., a disk file or logging daemon) and,
4707 hence, increases the risk of log records loss.
4709 Note that even when buffered_logs are off, Squid may have to buffer
4710 records if it cannot write/send them immediately due to pending I/Os
4711 (e.g., the I/O writing the previous log record) or connectivity loss.
4713 Currently honored by 'daemon' and 'tcp' access_log modules only.
4716 NAME: netdb_filename
4718 DEFAULT: stdio:@DEFAULT_NETDB_FILE@
4719 LOC: Config.netdbFilename
4722 Where Squid stores it's netdb journal.
4723 When enabled this journal preserves netdb state between restarts.
4725 To disable, enter "none".
4729 OPTIONS FOR TROUBLESHOOTING
4730 -----------------------------------------------------------------------------
4735 DEFAULT_IF_NONE: @DEFAULT_CACHE_LOG@
4736 LOC: Debug::cache_log
4738 Squid administrative logging file.
4740 This is where general information about Squid behavior goes. You can
4741 increase the amount of data logged to this file and how often it is
4742 rotated with "debug_options"
4748 DEFAULT_DOC: Log all critical and important messages.
4749 LOC: Debug::debugOptions
4751 Logging options are set as section,level where each source file
4752 is assigned a unique section. Lower levels result in less
4753 output, Full debugging (level 9) can result in a very large
4754 log file, so be careful.
4756 The magic word "ALL" sets debugging levels for all sections.
4757 The default is to run with "ALL,1" to record important warnings.
4759 The rotate=N option can be used to keep more or less of these logs
4760 than would otherwise be kept by logfile_rotate.
4761 For most uses a single log should be enough to monitor current
4762 events affecting Squid.
4767 LOC: Config.coredump_dir
4768 DEFAULT_IF_NONE: none
4769 DEFAULT_DOC: Use the directory from where Squid was started.
4771 By default Squid leaves core files in the directory from where
4772 it was started. If you set 'coredump_dir' to a directory
4773 that exists, Squid will chdir() to that directory at startup
4774 and coredump files will be left there.
4778 # Leave coredumps in the first cache dir
4779 coredump_dir @DEFAULT_SWAP_DIR@
4785 OPTIONS FOR FTP GATEWAYING
4786 -----------------------------------------------------------------------------
4792 LOC: Config.Ftp.anon_user
4794 If you want the anonymous login password to be more informative
4795 (and enable the use of picky FTP servers), set this to something
4796 reasonable for your domain, like wwwuser@somewhere.net
4798 The reason why this is domainless by default is the
4799 request can be made on the behalf of a user in any domain,
4800 depending on how the cache is used.
4801 Some FTP server also validate the email address is valid
4802 (for example perl.com).
4808 LOC: Config.Ftp.passive
4810 If your firewall does not allow Squid to use passive
4811 connections, turn off this option.
4813 Use of ftp_epsv_all option requires this to be ON.
4819 LOC: Config.Ftp.epsv_all
4821 FTP Protocol extensions permit the use of a special "EPSV ALL" command.
4823 NATs may be able to put the connection on a "fast path" through the
4824 translator, as the EPRT command will never be used and therefore,
4825 translation of the data portion of the segments will never be needed.
4827 When a client only expects to do two-way FTP transfers this may be
4829 If squid finds that it must do a three-way FTP transfer after issuing
4830 an EPSV ALL command, the FTP session will fail.
4832 If you have any doubts about this option do not use it.
4833 Squid will nicely attempt all other connection methods.
4835 Requires ftp_passive to be ON (default) for any effect.
4841 LOC: Config.accessList.ftp_epsv
4843 FTP Protocol extensions permit the use of a special "EPSV" command.
4845 NATs may be able to put the connection on a "fast path" through the
4846 translator using EPSV, as the EPRT command will never be used
4847 and therefore, translation of the data portion of the segments
4848 will never be needed.
4850 EPSV is often required to interoperate with FTP servers on IPv6
4851 networks. On the other hand, it may break some IPv4 servers.
4853 By default, EPSV may try EPSV with any FTP server. To fine tune
4854 that decision, you may restrict EPSV to certain clients or servers
4857 ftp_epsv allow|deny al1 acl2 ...
4859 WARNING: Disabling EPSV may cause problems with external NAT and IPv6.
4861 Only fast ACLs are supported.
4862 Requires ftp_passive to be ON (default) for any effect.
4868 LOC: Config.Ftp.eprt
4870 FTP Protocol extensions permit the use of a special "EPRT" command.
4872 This extension provides a protocol neutral alternative to the
4873 IPv4-only PORT command. When supported it enables active FTP data
4874 channels over IPv6 and efficient NAT handling.
4876 Turning this OFF will prevent EPRT being attempted and will skip
4877 straight to using PORT for IPv4 servers.
4879 Some devices are known to not handle this extension correctly and
4880 may result in crashes. Devices which suport EPRT enough to fail
4881 cleanly will result in Squid attempting PORT anyway. This directive
4882 should only be disabled when EPRT results in device failures.
4884 WARNING: Doing so will convert Squid back to the old behavior with all
4885 the related problems with external NAT devices/layers and IPv4-only FTP.
4888 NAME: ftp_sanitycheck
4891 LOC: Config.Ftp.sanitycheck
4893 For security and data integrity reasons Squid by default performs
4894 sanity checks of the addresses of FTP data connections ensure the
4895 data connection is to the requested server. If you need to allow
4896 FTP connections to servers using another IP address for the data
4897 connection turn this off.
4900 NAME: ftp_telnet_protocol
4903 LOC: Config.Ftp.telnet
4905 The FTP protocol is officially defined to use the telnet protocol
4906 as transport channel for the control connection. However, many
4907 implementations are broken and does not respect this aspect of
4910 If you have trouble accessing files with ASCII code 255 in the
4911 path or similar problems involving this ASCII code you can
4912 try setting this directive to off. If that helps, report to the
4913 operator of the FTP server in question that their FTP server
4914 is broken and does not follow the FTP standard.
4918 OPTIONS FOR EXTERNAL SUPPORT PROGRAMS
4919 -----------------------------------------------------------------------------
4924 DEFAULT: @DEFAULT_DISKD@
4925 LOC: Config.Program.diskd
4927 Specify the location of the diskd executable.
4928 Note this is only useful if you have compiled in
4929 diskd as one of the store io modules.
4932 NAME: unlinkd_program
4935 DEFAULT: @DEFAULT_UNLINKD@
4936 LOC: Config.Program.unlinkd
4938 Specify the location of the executable for file deletion process.
4941 NAME: pinger_program
4944 DEFAULT: @DEFAULT_PINGER@
4947 Specify the location of the executable for the pinger process.
4956 Control whether the pinger is active at run-time.
4957 Enables turning ICMP pinger on and off with a simple
4958 squid -k reconfigure.
4963 OPTIONS FOR URL REWRITING
4964 -----------------------------------------------------------------------------
4967 NAME: url_rewrite_program redirect_program
4969 LOC: Config.Program.redirect
4972 Specify the location of the executable URL rewriter to use.
4973 Since they can perform almost any function there isn't one included.
4975 For each requested URL, the rewriter will receive on line with the format
4977 [channel-ID <SP>] URL [<SP> extras]<NL>
4979 See url_rewrite_extras on how to send "extras" with optional values to
4981 After processing the request the helper must reply using the following format:
4983 [channel-ID <SP>] result [<SP> kv-pairs]
4985 The result code can be:
4987 OK status=30N url="..."
4988 Redirect the URL to the one supplied in 'url='.
4989 'status=' is optional and contains the status code to send
4990 the client in Squids HTTP response. It must be one of the
4991 HTTP redirect status codes: 301, 302, 303, 307, 308.
4992 When no status is given Squid will use 302.
4994 OK rewrite-url="..."
4995 Rewrite the URL to the one supplied in 'rewrite-url='.
4996 The new URL is fetched directly by Squid and returned to
4997 the client as the response to its request.
5000 When neither of url= and rewrite-url= are sent Squid does
5004 Do not change the URL.
5007 An internal error occurred in the helper, preventing
5008 a result being identified. The 'message=' key name is
5009 reserved for delivering a log message.
5012 In addition to the above kv-pairs Squid also understands the following
5013 optional kv-pairs received from URL rewriters:
5015 Associates a TAG with the client TCP connection.
5016 The TAG is treated as a regular annotation but persists across
5017 future requests on the client connection rather than just the
5018 current request. A helper may update the TAG during subsequent
5019 requests be returning a new kv-pair.
5021 When using the concurrency= option the protocol is changed by
5022 introducing a query channel tag in front of the request/response.
5023 The query channel tag is a number between 0 and concurrency-1.
5024 This value must be echoed back unchanged to Squid as the first part
5025 of the response relating to its request.
5027 WARNING: URL re-writing ability should be avoided whenever possible.
5028 Use the URL redirect form of response instead.
5030 Re-write creates a difference in the state held by the client
5031 and server. Possibly causing confusion when the server response
5032 contains snippets of its view state. Embeded URLs, response
5033 and content Location headers, etc. are not re-written by this
5036 By default, a URL rewriter is not used.
5039 NAME: url_rewrite_children redirect_children
5040 TYPE: HelperChildConfig
5041 DEFAULT: 20 startup=0 idle=1 concurrency=0
5042 LOC: Config.redirectChildren
5044 The maximum number of redirector processes to spawn. If you limit
5045 it too few Squid will have to wait for them to process a backlog of
5046 URLs, slowing it down. If you allow too many they will use RAM
5047 and other system resources noticably.
5049 The startup= and idle= options allow some measure of skew in your
5054 Sets a minimum of how many processes are to be spawned when Squid
5055 starts or reconfigures. When set to zero the first request will
5056 cause spawning of the first child process to handle it.
5058 Starting too few will cause an initial slowdown in traffic as Squid
5059 attempts to simultaneously spawn enough processes to cope.
5063 Sets a minimum of how many processes Squid is to try and keep available
5064 at all times. When traffic begins to rise above what the existing
5065 processes can handle this many more will be spawned up to the maximum
5066 configured. A minimum setting of 1 is required.
5070 The number of requests each redirector helper can handle in
5071 parallel. Defaults to 0 which indicates the redirector
5072 is a old-style single threaded redirector.
5074 When this directive is set to a value >= 1 then the protocol
5075 used to communicate with the helper is modified to include
5076 an ID in front of the request/response. The ID from the request
5077 must be echoed back with the response to that request.
5081 Sets the maximum number of queued requests.
5082 If the queued requests exceed queue size and redirector_bypass
5083 configuration option is set, then redirector is bypassed. Otherwise, if
5084 overloading persists squid may abort its operation.
5085 The default value is set to 2*numberofchildren.
5088 NAME: url_rewrite_host_header redirect_rewrites_host_header
5091 LOC: Config.onoff.redir_rewrites_host
5093 To preserve same-origin security policies in browsers and
5094 prevent Host: header forgery by redirectors Squid rewrites
5095 any Host: header in redirected requests.
5097 If you are running an accelerator this may not be a wanted
5098 effect of a redirector. This directive enables you disable
5099 Host: alteration in reverse-proxy traffic.
5101 WARNING: Entries are cached on the result of the URL rewriting
5102 process, so be careful if you have domain-virtual hosts.
5104 WARNING: Squid and other software verifies the URL and Host
5105 are matching, so be careful not to relay through other proxies
5106 or inspecting firewalls with this disabled.
5109 NAME: url_rewrite_access redirector_access
5112 DEFAULT_DOC: Allow, unless rules exist in squid.conf.
5113 LOC: Config.accessList.redirector
5115 If defined, this access list specifies which requests are
5116 sent to the redirector processes.
5118 This clause supports both fast and slow acl types.
5119 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
5122 NAME: url_rewrite_bypass redirector_bypass
5124 LOC: Config.onoff.redirector_bypass
5127 When this is 'on', a request will not go through the
5128 redirector if all the helpers are busy. If this is 'off'
5129 and the redirector queue grows too large, Squid will exit
5130 with a FATAL error and ask you to increase the number of
5131 redirectors. You should only enable this if the redirectors
5132 are not critical to your caching system. If you use
5133 redirectors for access control, and you enable this option,
5134 users may have access to pages they should not
5135 be allowed to request.
5136 This options sets default queue-size option of the url_rewrite_children
5140 NAME: url_rewrite_extras
5141 TYPE: TokenOrQuotedString
5142 LOC: Config.redirector_extras
5143 DEFAULT: "%>a/%>A %un %>rm myip=%la myport=%lp"
5145 Specifies a string to be append to request line format for the
5146 rewriter helper. "Quoted" format values may contain spaces and
5147 logformat %macros. In theory, any logformat %macro can be used.
5148 In practice, a %macro expands as a dash (-) if the helper request is
5149 sent before the required macro information is available to Squid.
5152 NAME: url_rewrite_timeout
5153 TYPE: UrlHelperTimeout
5154 LOC: Config.onUrlRewriteTimeout
5156 DEFAULT_DOC: Squid waits for the helper response forever
5158 Squid times active requests to redirector. The timeout value and Squid
5159 reaction to a timed out request are configurable using the following
5162 url_rewrite_timeout timeout time-units on_timeout=<action> [response=<quoted-response>]
5164 supported timeout actions:
5165 fail Squid return a ERR_GATEWAY_FAILURE error page
5167 bypass Do not re-write the URL
5169 retry Send the lookup to the helper again
5171 use_configured_response
5172 Use the <quoted-response> as helper response
5176 OPTIONS FOR STORE ID
5177 -----------------------------------------------------------------------------
5180 NAME: store_id_program storeurl_rewrite_program
5182 LOC: Config.Program.store_id
5185 Specify the location of the executable StoreID helper to use.
5186 Since they can perform almost any function there isn't one included.
5188 For each requested URL, the helper will receive one line with the format
5190 [channel-ID <SP>] URL [<SP> extras]<NL>
5193 After processing the request the helper must reply using the following format:
5195 [channel-ID <SP>] result [<SP> kv-pairs]
5197 The result code can be:
5200 Use the StoreID supplied in 'store-id='.
5203 The default is to use HTTP request URL as the store ID.
5206 An internal error occured in the helper, preventing
5207 a result being identified.
5209 In addition to the above kv-pairs Squid also understands the following
5210 optional kv-pairs received from URL rewriters:
5212 Associates a TAG with the client TCP connection.
5213 Please see url_rewrite_program related documentation for this
5216 Helper programs should be prepared to receive and possibly ignore
5217 additional whitespace-separated tokens on each input line.
5219 When using the concurrency= option the protocol is changed by
5220 introducing a query channel tag in front of the request/response.
5221 The query channel tag is a number between 0 and concurrency-1.
5222 This value must be echoed back unchanged to Squid as the first part
5223 of the response relating to its request.
5225 NOTE: when using StoreID refresh_pattern will apply to the StoreID
5226 returned from the helper and not the URL.
5228 WARNING: Wrong StoreID value returned by a careless helper may result
5229 in the wrong cached response returned to the user.
5231 By default, a StoreID helper is not used.
5234 NAME: store_id_extras
5235 TYPE: TokenOrQuotedString
5236 LOC: Config.storeId_extras
5237 DEFAULT: "%>a/%>A %un %>rm myip=%la myport=%lp"
5239 Specifies a string to be append to request line format for the
5240 StoreId helper. "Quoted" format values may contain spaces and
5241 logformat %macros. In theory, any logformat %macro can be used.
5242 In practice, a %macro expands as a dash (-) if the helper request is
5243 sent before the required macro information is available to Squid.
5246 NAME: store_id_children storeurl_rewrite_children
5247 TYPE: HelperChildConfig
5248 DEFAULT: 20 startup=0 idle=1 concurrency=0
5249 LOC: Config.storeIdChildren
5251 The maximum number of StoreID helper processes to spawn. If you limit
5252 it too few Squid will have to wait for them to process a backlog of
5253 requests, slowing it down. If you allow too many they will use RAM
5254 and other system resources noticably.
5256 The startup= and idle= options allow some measure of skew in your
5261 Sets a minimum of how many processes are to be spawned when Squid
5262 starts or reconfigures. When set to zero the first request will
5263 cause spawning of the first child process to handle it.
5265 Starting too few will cause an initial slowdown in traffic as Squid
5266 attempts to simultaneously spawn enough processes to cope.
5270 Sets a minimum of how many processes Squid is to try and keep available
5271 at all times. When traffic begins to rise above what the existing
5272 processes can handle this many more will be spawned up to the maximum
5273 configured. A minimum setting of 1 is required.
5277 The number of requests each storeID helper can handle in
5278 parallel. Defaults to 0 which indicates the helper
5279 is a old-style single threaded program.
5281 When this directive is set to a value >= 1 then the protocol
5282 used to communicate with the helper is modified to include
5283 an ID in front of the request/response. The ID from the request
5284 must be echoed back with the response to that request.
5288 Sets the maximum number of queued requests.
5289 If the queued requests exceed queue size and store_id_bypass
5290 configuration option is set, then storeID helper is bypassed. Otherwise,
5291 if overloading persists squid may abort its operation.
5292 The default value is set to 2*numberofchildren.
5295 NAME: store_id_access storeurl_rewrite_access
5298 DEFAULT_DOC: Allow, unless rules exist in squid.conf.
5299 LOC: Config.accessList.store_id
5301 If defined, this access list specifies which requests are
5302 sent to the StoreID processes. By default all requests
5305 This clause supports both fast and slow acl types.
5306 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
5309 NAME: store_id_bypass storeurl_rewrite_bypass
5311 LOC: Config.onoff.store_id_bypass
5314 When this is 'on', a request will not go through the
5315 helper if all helpers are busy. If this is 'off'
5316 and the helper queue grows too large, Squid will exit
5317 with a FATAL error and ask you to increase the number of
5318 helpers. You should only enable this if the helperss
5319 are not critical to your caching system. If you use
5320 helpers for critical caching components, and you enable this
5321 option, users may not get objects from cache.
5322 This options sets default queue-size option of the store_id_children
5327 OPTIONS FOR TUNING THE CACHE
5328 -----------------------------------------------------------------------------
5331 NAME: cache no_cache
5334 DEFAULT_DOC: By default, this directive is unused and has no effect.
5335 LOC: Config.accessList.noCache
5337 Requests denied by this directive will not be served from the cache
5338 and their responses will not be stored in the cache. This directive
5339 has no effect on other transactions and on already cached responses.
5341 This clause supports both fast and slow acl types.
5342 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
5344 This and the two other similar caching directives listed below are
5345 checked at different transaction processing stages, have different
5346 access to response information, affect different cache operations,
5347 and differ in slow ACLs support:
5349 * cache: Checked before Squid makes a hit/miss determination.
5350 No access to reply information!
5351 Denies both serving a hit and storing a miss.
5352 Supports both fast and slow ACLs.
5353 * send_hit: Checked after a hit was detected.
5354 Has access to reply (hit) information.
5355 Denies serving a hit only.
5356 Supports fast ACLs only.
5357 * store_miss: Checked before storing a cachable miss.
5358 Has access to reply (miss) information.
5359 Denies storing a miss only.
5360 Supports fast ACLs only.
5362 If you are not sure which of the three directives to use, apply the
5363 following decision logic:
5365 * If your ACL(s) are of slow type _and_ need response info, redesign.
5366 Squid does not support that particular combination at this time.
5368 * If your directive ACL(s) are of slow type, use "cache"; and/or
5369 * if your directive ACL(s) need no response info, use "cache".
5371 * If you do not want the response cached, use store_miss; and/or
5372 * if you do not want a hit on a cached response, use send_hit.
5378 DEFAULT_DOC: By default, this directive is unused and has no effect.
5379 LOC: Config.accessList.sendHit
5381 Responses denied by this directive will not be served from the cache
5382 (but may still be cached, see store_miss). This directive has no
5383 effect on the responses it allows and on the cached objects.
5385 Please see the "cache" directive for a summary of differences among
5386 store_miss, send_hit, and cache directives.
5388 Unlike the "cache" directive, send_hit only supports fast acl
5389 types. See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
5393 # apply custom Store ID mapping to some URLs
5394 acl MapMe dstdomain .c.example.com
5395 store_id_program ...
5396 store_id_access allow MapMe
5398 # but prevent caching of special responses
5399 # such as 302 redirects that cause StoreID loops
5400 acl Ordinary http_status 200-299
5401 store_miss deny MapMe !Ordinary
5403 # and do not serve any previously stored special responses
5404 # from the cache (in case they were already cached before
5405 # the above store_miss rule was in effect).
5406 send_hit deny MapMe !Ordinary
5412 DEFAULT_DOC: By default, this directive is unused and has no effect.
5413 LOC: Config.accessList.storeMiss
5415 Responses denied by this directive will not be cached (but may still
5416 be served from the cache, see send_hit). This directive has no
5417 effect on the responses it allows and on the already cached responses.
5419 Please see the "cache" directive for a summary of differences among
5420 store_miss, send_hit, and cache directives. See the
5421 send_hit directive for a usage example.
5423 Unlike the "cache" directive, store_miss only supports fast acl
5424 types. See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
5430 LOC: Config.maxStale
5433 This option puts an upper limit on how stale content Squid
5434 will serve from the cache if cache validation fails.
5435 Can be overriden by the refresh_pattern max-stale option.
5438 NAME: refresh_pattern
5439 TYPE: refreshpattern
5443 usage: refresh_pattern [-i] regex min percent max [options]
5445 By default, regular expressions are CASE-SENSITIVE. To make
5446 them case-insensitive, use the -i option.
5448 'Min' is the time (in minutes) an object without an explicit
5449 expiry time should be considered fresh. The recommended
5450 value is 0, any higher values may cause dynamic applications
5451 to be erroneously cached unless the application designer
5452 has taken the appropriate actions.
5454 'Percent' is a percentage of the objects age (time since last
5455 modification age) an object without explicit expiry time
5456 will be considered fresh.
5458 'Max' is an upper limit on how long objects without an explicit
5459 expiry time will be considered fresh.
5461 options: override-expire
5471 override-expire enforces min age even if the server
5472 sent an explicit expiry time (e.g., with the
5473 Expires: header or Cache-Control: max-age). Doing this
5474 VIOLATES the HTTP standard. Enabling this feature
5475 could make you liable for problems which it causes.
5477 Note: override-expire does not enforce staleness - it only extends
5478 freshness / min. If the server returns a Expires time which
5479 is longer than your max time, Squid will still consider
5480 the object fresh for that period of time.
5482 override-lastmod enforces min age even on objects
5483 that were modified recently.
5485 reload-into-ims changes a client no-cache or ``reload''
5486 request for a cached entry into a conditional request using
5487 If-Modified-Since and/or If-None-Match headers, provided the
5488 cached entry has a Last-Modified and/or a strong ETag header.
5489 Doing this VIOLATES the HTTP standard. Enabling this feature
5490 could make you liable for problems which it causes.
5492 ignore-reload ignores a client no-cache or ``reload''
5493 header. Doing this VIOLATES the HTTP standard. Enabling
5494 this feature could make you liable for problems which
5497 ignore-no-store ignores any ``Cache-control: no-store''
5498 headers received from a server. Doing this VIOLATES
5499 the HTTP standard. Enabling this feature could make you
5500 liable for problems which it causes.
5502 ignore-private ignores any ``Cache-control: private''
5503 headers received from a server. Doing this VIOLATES
5504 the HTTP standard. Enabling this feature could make you
5505 liable for problems which it causes.
5507 refresh-ims causes squid to contact the origin server
5508 when a client issues an If-Modified-Since request. This
5509 ensures that the client will receive an updated version
5510 if one is available.
5512 store-stale stores responses even if they don't have explicit
5513 freshness or a validator (i.e., Last-Modified or an ETag)
5514 present, or if they're already stale. By default, Squid will
5515 not cache such responses because they usually can't be
5516 reused. Note that such responses will be stale by default.
5518 max-stale=NN provide a maximum staleness factor. Squid won't
5519 serve objects more stale than this even if it failed to
5520 validate the object. Default: use the max_stale global limit.
5522 Basically a cached object is:
5524 FRESH if expires < now, else STALE
5526 FRESH if lm-factor < percent, else STALE
5530 The refresh_pattern lines are checked in the order listed here.
5531 The first entry which matches is used. If none of the entries
5532 match the default will be used.
5534 Note, you must uncomment all the default lines if you want
5535 to change one. The default setting is only active if none is
5541 # Add any of your own refresh_pattern entries above these.
5543 refresh_pattern ^ftp: 1440 20% 10080
5544 refresh_pattern ^gopher: 1440 0% 1440
5545 refresh_pattern -i (/cgi-bin/|\?) 0 0% 0
5546 refresh_pattern . 0 20% 4320
5550 NAME: quick_abort_min
5554 LOC: Config.quickAbort.min
5557 NAME: quick_abort_max
5561 LOC: Config.quickAbort.max
5564 NAME: quick_abort_pct
5568 LOC: Config.quickAbort.pct
5570 The cache by default continues downloading aborted requests
5571 which are almost completed (less than 16 KB remaining). This
5572 may be undesirable on slow (e.g. SLIP) links and/or very busy
5573 caches. Impatient users may tie up file descriptors and
5574 bandwidth by repeatedly requesting and immediately aborting
5577 When the user aborts a request, Squid will check the
5578 quick_abort values to the amount of data transferred until
5581 If the transfer has less than 'quick_abort_min' KB remaining,
5582 it will finish the retrieval.
5584 If the transfer has more than 'quick_abort_max' KB remaining,
5585 it will abort the retrieval.
5587 If more than 'quick_abort_pct' of the transfer has completed,
5588 it will finish the retrieval.
5590 If you do not want any retrieval to continue after the client
5591 has aborted, set both 'quick_abort_min' and 'quick_abort_max'
5594 If you want retrievals to always continue if they are being
5595 cached set 'quick_abort_min' to '-1 KB'.
5598 NAME: read_ahead_gap
5599 COMMENT: buffer-size
5601 LOC: Config.readAheadGap
5604 The amount of data the cache will buffer ahead of what has been
5605 sent to the client when retrieving an object from another server.
5609 IFDEF: USE_HTTP_VIOLATIONS
5612 LOC: Config.negativeTtl
5615 Set the Default Time-to-Live (TTL) for failed requests.
5616 Certain types of failures (such as "connection refused" and
5617 "404 Not Found") are able to be negatively-cached for a short time.
5618 Modern web servers should provide Expires: header, however if they
5619 do not this can provide a minimum TTL.
5620 The default is not to cache errors with unknown expiry details.
5622 Note that this is different from negative caching of DNS lookups.
5624 WARNING: Doing this VIOLATES the HTTP standard. Enabling
5625 this feature could make you liable for problems which it
5629 NAME: positive_dns_ttl
5632 LOC: Config.positiveDnsTtl
5635 Upper limit on how long Squid will cache positive DNS responses.
5636 Default is 6 hours (360 minutes). This directive must be set
5637 larger than negative_dns_ttl.
5640 NAME: negative_dns_ttl
5643 LOC: Config.negativeDnsTtl
5646 Time-to-Live (TTL) for negative caching of failed DNS lookups.
5647 This also sets the lower cache limit on positive lookups.
5648 Minimum value is 1 second, and it is not recommendable to go
5649 much below 10 seconds.
5652 NAME: range_offset_limit
5653 COMMENT: size [acl acl...]
5655 LOC: Config.rangeOffsetLimit
5658 usage: (size) [units] [[!]aclname]
5660 Sets an upper limit on how far (number of bytes) into the file
5661 a Range request may be to cause Squid to prefetch the whole file.
5662 If beyond this limit, Squid forwards the Range request as it is and
5663 the result is NOT cached.
5665 This is to stop a far ahead range request (lets say start at 17MB)
5666 from making Squid fetch the whole object up to that point before
5667 sending anything to the client.
5669 Multiple range_offset_limit lines may be specified, and they will
5670 be searched from top to bottom on each request until a match is found.
5671 The first match found will be used. If no line matches a request, the
5672 default limit of 0 bytes will be used.
5674 'size' is the limit specified as a number of units.
5676 'units' specifies whether to use bytes, KB, MB, etc.
5677 If no units are specified bytes are assumed.
5679 A size of 0 causes Squid to never fetch more than the
5680 client requested. (default)
5682 A size of 'none' causes Squid to always fetch the object from the
5683 beginning so it may cache the result. (2.0 style)
5685 'aclname' is the name of a defined ACL.
5687 NP: Using 'none' as the byte value here will override any quick_abort settings
5688 that may otherwise apply to the range request. The range request will
5689 be fully fetched from start to finish regardless of the client
5690 actions. This affects bandwidth usage.
5693 NAME: minimum_expiry_time
5696 LOC: Config.minimum_expiry_time
5699 The minimum caching time according to (Expires - Date)
5700 headers Squid honors if the object can't be revalidated.
5701 The default is 60 seconds.
5703 In reverse proxy environments it might be desirable to honor
5704 shorter object lifetimes. It is most likely better to make
5705 your server return a meaningful Last-Modified header however.
5707 In ESI environments where page fragments often have short
5708 lifetimes, this will often be best set to 0.
5711 NAME: store_avg_object_size
5715 LOC: Config.Store.avgObjectSize
5717 Average object size, used to estimate number of objects your
5718 cache can hold. The default is 13 KB.
5720 This is used to pre-seed the cache index memory allocation to
5721 reduce expensive reallocate operations while handling clients
5722 traffic. Too-large values may result in memory allocation during
5723 peak traffic, too-small values will result in wasted memory.
5725 Check the cache manager 'info' report metrics for the real
5726 object sizes seen by your Squid before tuning this.
5729 NAME: store_objects_per_bucket
5732 LOC: Config.Store.objectsPerBucket
5734 Target number of objects per bucket in the store hash table.
5735 Lowering this value increases the total number of buckets and
5736 also the storage maintenance rate. The default is 20.
5741 -----------------------------------------------------------------------------
5744 NAME: request_header_max_size
5748 LOC: Config.maxRequestHeaderSize
5750 This specifies the maximum size for HTTP headers in a request.
5751 Request headers are usually relatively small (about 512 bytes).
5752 Placing a limit on the request header size will catch certain
5753 bugs (for example with persistent connections) and possibly
5754 buffer-overflow or denial-of-service attacks.
5757 NAME: reply_header_max_size
5761 LOC: Config.maxReplyHeaderSize
5763 This specifies the maximum size for HTTP headers in a reply.
5764 Reply headers are usually relatively small (about 512 bytes).
5765 Placing a limit on the reply header size will catch certain
5766 bugs (for example with persistent connections) and possibly
5767 buffer-overflow or denial-of-service attacks.
5770 NAME: request_body_max_size
5774 DEFAULT_DOC: No limit.
5775 LOC: Config.maxRequestBodySize
5777 This specifies the maximum size for an HTTP request body.
5778 In other words, the maximum size of a PUT/POST request.
5779 A user who attempts to send a request with a body larger
5780 than this limit receives an "Invalid Request" error message.
5781 If you set this parameter to a zero (the default), there will
5782 be no limit imposed.
5784 See also client_request_buffer_max_size for an alternative
5785 limitation on client uploads which can be configured.
5788 NAME: client_request_buffer_max_size
5792 LOC: Config.maxRequestBufferSize
5794 This specifies the maximum buffer size of a client request.
5795 It prevents squid eating too much memory when somebody uploads
5800 IFDEF: USE_HTTP_VIOLATIONS
5803 DEFAULT_DOC: Obey RFC 2616.
5804 LOC: Config.accessList.brokenPosts
5806 A list of ACL elements which, if matched, causes Squid to send
5807 an extra CRLF pair after the body of a PUT/POST request.
5809 Some HTTP servers has broken implementations of PUT/POST,
5810 and rely on an extra CRLF pair sent by some WWW clients.
5812 Quote from RFC2616 section 4.1 on this matter:
5814 Note: certain buggy HTTP/1.0 client implementations generate an
5815 extra CRLF's after a POST request. To restate what is explicitly
5816 forbidden by the BNF, an HTTP/1.1 client must not preface or follow
5817 a request with an extra CRLF.
5819 This clause only supports fast acl types.
5820 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
5823 acl buggy_server url_regex ^http://....
5824 broken_posts allow buggy_server
5827 NAME: adaptation_uses_indirect_client icap_uses_indirect_client
5830 IFDEF: FOLLOW_X_FORWARDED_FOR&&USE_ADAPTATION
5832 LOC: Adaptation::Config::use_indirect_client
5834 Controls whether the indirect client IP address (instead of the direct
5835 client IP address) is passed to adaptation services.
5837 See also: follow_x_forwarded_for adaptation_send_client_ip
5841 IFDEF: USE_HTTP_VIOLATIONS
5845 LOC: Config.onoff.via
5847 If set (default), Squid will include a Via header in requests and
5848 replies as required by RFC2616.
5854 LOC: Config.onoff.ie_refresh
5857 Microsoft Internet Explorer up until version 5.5 Service
5858 Pack 1 has an issue with transparent proxies, wherein it
5859 is impossible to force a refresh. Turning this on provides
5860 a partial fix to the problem, by causing all IMS-REFRESH
5861 requests from older IE versions to check the origin server
5862 for fresh content. This reduces hit ratio by some amount
5863 (~10% in my experience), but allows users to actually get
5864 fresh content when they want it. Note because Squid
5865 cannot tell if the user is using 5.5 or 5.5SP1, the behavior
5866 of 5.5 is unchanged from old versions of Squid (i.e. a
5867 forced refresh is impossible). Newer versions of IE will,
5868 hopefully, continue to have the new behavior and will be
5869 handled based on that assumption. This option defaults to
5870 the old Squid behavior, which is better for hit ratios but
5871 worse for clients using IE, if they need to be able to
5872 force fresh content.
5875 NAME: vary_ignore_expire
5878 LOC: Config.onoff.vary_ignore_expire
5881 Many HTTP servers supporting Vary gives such objects
5882 immediate expiry time with no cache-control header
5883 when requested by a HTTP/1.0 client. This option
5884 enables Squid to ignore such expiry times until
5885 HTTP/1.1 is fully implemented.
5887 WARNING: If turned on this may eventually cause some
5888 varying objects not intended for caching to get cached.
5891 NAME: request_entities
5893 LOC: Config.onoff.request_entities
5896 Squid defaults to deny GET and HEAD requests with request entities,
5897 as the meaning of such requests are undefined in the HTTP standard
5898 even if not explicitly forbidden.
5900 Set this directive to on if you have clients which insists
5901 on sending request entities in GET or HEAD requests. But be warned
5902 that there is server software (both proxies and web servers) which
5903 can fail to properly process this kind of request which may make you
5904 vulnerable to cache pollution attacks if enabled.
5907 NAME: request_header_access
5908 IFDEF: USE_HTTP_VIOLATIONS
5909 TYPE: http_header_access
5910 LOC: Config.request_header_access
5912 DEFAULT_DOC: No limits.
5914 Usage: request_header_access header_name allow|deny [!]aclname ...
5916 WARNING: Doing this VIOLATES the HTTP standard. Enabling
5917 this feature could make you liable for problems which it
5920 This option replaces the old 'anonymize_headers' and the
5921 older 'http_anonymizer' option with something that is much
5922 more configurable. A list of ACLs for each header name allows
5923 removal of specific header fields under specific conditions.
5925 This option only applies to outgoing HTTP request headers (i.e.,
5926 headers sent by Squid to the next HTTP hop such as a cache peer
5927 or an origin server). The option has no effect during cache hit
5928 detection. The equivalent adaptation vectoring point in ICAP
5929 terminology is post-cache REQMOD.
5931 The option is applied to individual outgoing request header
5932 fields. For each request header field F, Squid uses the first
5933 qualifying sets of request_header_access rules:
5935 1. Rules with header_name equal to F's name.
5936 2. Rules with header_name 'Other', provided F's name is not
5937 on the hard-coded list of commonly used HTTP header names.
5938 3. Rules with header_name 'All'.
5940 Within that qualifying rule set, rule ACLs are checked as usual.
5941 If ACLs of an "allow" rule match, the header field is allowed to
5942 go through as is. If ACLs of a "deny" rule match, the header is
5943 removed and request_header_replace is then checked to identify
5944 if the removed header has a replacement. If no rules within the
5945 set have matching ACLs, the header field is left as is.
5947 For example, to achieve the same behavior as the old
5948 'http_anonymizer standard' option, you should use:
5950 request_header_access From deny all
5951 request_header_access Referer deny all
5952 request_header_access User-Agent deny all
5954 Or, to reproduce the old 'http_anonymizer paranoid' feature
5957 request_header_access Authorization allow all
5958 request_header_access Proxy-Authorization allow all
5959 request_header_access Cache-Control allow all
5960 request_header_access Content-Length allow all
5961 request_header_access Content-Type allow all
5962 request_header_access Date allow all
5963 request_header_access Host allow all
5964 request_header_access If-Modified-Since allow all
5965 request_header_access Pragma allow all
5966 request_header_access Accept allow all
5967 request_header_access Accept-Charset allow all
5968 request_header_access Accept-Encoding allow all
5969 request_header_access Accept-Language allow all
5970 request_header_access Connection allow all
5971 request_header_access All deny all
5973 HTTP reply headers are controlled with the reply_header_access directive.
5975 By default, all headers are allowed (no anonymizing is performed).
5978 NAME: reply_header_access
5979 IFDEF: USE_HTTP_VIOLATIONS
5980 TYPE: http_header_access
5981 LOC: Config.reply_header_access
5983 DEFAULT_DOC: No limits.
5985 Usage: reply_header_access header_name allow|deny [!]aclname ...
5987 WARNING: Doing this VIOLATES the HTTP standard. Enabling
5988 this feature could make you liable for problems which it
5991 This option only applies to reply headers, i.e., from the
5992 server to the client.
5994 This is the same as request_header_access, but in the other
5995 direction. Please see request_header_access for detailed
5998 For example, to achieve the same behavior as the old
5999 'http_anonymizer standard' option, you should use:
6001 reply_header_access Server deny all
6002 reply_header_access WWW-Authenticate deny all
6003 reply_header_access Link deny all
6005 Or, to reproduce the old 'http_anonymizer paranoid' feature
6008 reply_header_access Allow allow all
6009 reply_header_access WWW-Authenticate allow all
6010 reply_header_access Proxy-Authenticate allow all
6011 reply_header_access Cache-Control allow all
6012 reply_header_access Content-Encoding allow all
6013 reply_header_access Content-Length allow all
6014 reply_header_access Content-Type allow all
6015 reply_header_access Date allow all
6016 reply_header_access Expires allow all
6017 reply_header_access Last-Modified allow all
6018 reply_header_access Location allow all
6019 reply_header_access Pragma allow all
6020 reply_header_access Content-Language allow all
6021 reply_header_access Retry-After allow all
6022 reply_header_access Title allow all
6023 reply_header_access Content-Disposition allow all
6024 reply_header_access Connection allow all
6025 reply_header_access All deny all
6027 HTTP request headers are controlled with the request_header_access directive.
6029 By default, all headers are allowed (no anonymizing is
6033 NAME: request_header_replace header_replace
6034 IFDEF: USE_HTTP_VIOLATIONS
6035 TYPE: http_header_replace
6036 LOC: Config.request_header_access
6039 Usage: request_header_replace header_name message
6040 Example: request_header_replace User-Agent Nutscrape/1.0 (CP/M; 8-bit)
6042 This option allows you to change the contents of headers
6043 denied with request_header_access above, by replacing them
6044 with some fixed string.
6046 This only applies to request headers, not reply headers.
6048 By default, headers are removed if denied.
6051 NAME: reply_header_replace
6052 IFDEF: USE_HTTP_VIOLATIONS
6053 TYPE: http_header_replace
6054 LOC: Config.reply_header_access
6057 Usage: reply_header_replace header_name message
6058 Example: reply_header_replace Server Foo/1.0
6060 This option allows you to change the contents of headers
6061 denied with reply_header_access above, by replacing them
6062 with some fixed string.
6064 This only applies to reply headers, not request headers.
6066 By default, headers are removed if denied.
6069 NAME: request_header_add
6070 TYPE: HeaderWithAclList
6071 LOC: Config.request_header_add
6074 Usage: request_header_add field-name field-value acl1 [acl2] ...
6075 Example: request_header_add X-Client-CA "CA=%ssl::>cert_issuer" all
6077 This option adds header fields to outgoing HTTP requests (i.e.,
6078 request headers sent by Squid to the next HTTP hop such as a
6079 cache peer or an origin server). The option has no effect during
6080 cache hit detection. The equivalent adaptation vectoring point
6081 in ICAP terminology is post-cache REQMOD.
6083 Field-name is a token specifying an HTTP header name. If a
6084 standard HTTP header name is used, Squid does not check whether
6085 the new header conflicts with any existing headers or violates
6086 HTTP rules. If the request to be modified already contains a
6087 field with the same name, the old field is preserved but the
6088 header field values are not merged.
6090 Field-value is either a token or a quoted string. If quoted
6091 string format is used, then the surrounding quotes are removed
6092 while escape sequences and %macros are processed.
6094 In theory, all of the logformat codes can be used as %macros.
6095 However, unlike logging (which happens at the very end of
6096 transaction lifetime), the transaction may not yet have enough
6097 information to expand a macro when the new header value is needed.
6098 And some information may already be available to Squid but not yet
6099 committed where the macro expansion code can access it (report
6100 such instances!). The macro will be expanded into a single dash
6101 ('-') in such cases. Not all macros have been tested.
6103 One or more Squid ACLs may be specified to restrict header
6104 injection to matching requests. As always in squid.conf, all
6105 ACLs in an option ACL list must be satisfied for the insertion
6106 to happen. The request_header_add option supports fast ACLs
6115 This option used to log custom information about the master
6116 transaction. For example, an admin may configure Squid to log
6117 which "user group" the transaction belongs to, where "user group"
6118 will be determined based on a set of ACLs and not [just]
6119 authentication information.
6120 Values of key/value pairs can be logged using %{key}note macros:
6122 note key value acl ...
6123 logformat myFormat ... %{key}note ...
6126 NAME: relaxed_header_parser
6127 COMMENT: on|off|warn
6129 LOC: Config.onoff.relaxed_header_parser
6132 In the default "on" setting Squid accepts certain forms
6133 of non-compliant HTTP messages where it is unambiguous
6134 what the sending application intended even if the message
6135 is not correctly formatted. The messages is then normalized
6136 to the correct form when forwarded by Squid.
6138 If set to "warn" then a warning will be emitted in cache.log
6139 each time such HTTP error is encountered.
6141 If set to "off" then such HTTP errors will cause the request
6142 or response to be rejected.
6145 NAME: collapsed_forwarding
6148 LOC: Config.onoff.collapsed_forwarding
6151 This option controls whether Squid is allowed to merge multiple
6152 potentially cachable requests for the same URI before Squid knows
6153 whether the response is going to be cachable.
6155 This feature is disabled by default: Enabling collapsed forwarding
6156 needlessly delays forwarding requests that look cachable (when they are
6157 collapsed) but then need to be forwarded individually anyway because
6158 they end up being for uncachable content. However, in some cases, such
6159 as accelleration of highly cachable content with periodic or groupped
6160 expiration times, the gains from collapsing [large volumes of
6161 simultenous refresh requests] outweigh losses from such delays.
6166 -----------------------------------------------------------------------------
6169 NAME: forward_timeout
6172 LOC: Config.Timeout.forward
6175 This parameter specifies how long Squid should at most attempt in
6176 finding a forwarding path for the request before giving up.
6179 NAME: connect_timeout
6182 LOC: Config.Timeout.connect
6185 This parameter specifies how long to wait for the TCP connect to
6186 the requested server or peer to complete before Squid should
6187 attempt to find another path where to forward the request.
6190 NAME: peer_connect_timeout
6193 LOC: Config.Timeout.peer_connect
6196 This parameter specifies how long to wait for a pending TCP
6197 connection to a peer cache. The default is 30 seconds. You
6198 may also set different timeout values for individual neighbors
6199 with the 'connect-timeout' option on a 'cache_peer' line.
6205 LOC: Config.Timeout.read
6208 Applied on peer server connections.
6210 After each successful read(), the timeout will be extended by this
6211 amount. If no data is read again after this amount of time,
6212 the request is aborted and logged with ERR_READ_TIMEOUT.
6214 The default is 15 minutes.
6220 LOC: Config.Timeout.write
6223 This timeout is tracked for all connections that have data
6224 available for writing and are waiting for the socket to become
6225 ready. After each successful write, the timeout is extended by
6226 the configured amount. If Squid has data to write but the
6227 connection is not ready for the configured duration, the
6228 transaction associated with the connection is terminated. The
6229 default is 15 minutes.
6232 NAME: request_timeout
6234 LOC: Config.Timeout.request
6237 How long to wait for complete HTTP request headers after initial
6238 connection establishment.
6241 NAME: request_start_timeout
6243 LOC: Config.Timeout.request_start_timeout
6246 How long to wait for the first request byte after initial
6247 connection establishment.
6250 NAME: client_idle_pconn_timeout persistent_request_timeout
6252 LOC: Config.Timeout.clientIdlePconn
6255 How long to wait for the next HTTP request on a persistent
6256 client connection after the previous request completes.
6259 NAME: ftp_client_idle_timeout
6261 LOC: Config.Timeout.ftpClientIdle
6264 How long to wait for an FTP request on a connection to Squid ftp_port.
6265 Many FTP clients do not deal with idle connection closures well,
6266 necessitating a longer default timeout than client_idle_pconn_timeout
6267 used for incoming HTTP requests.
6270 NAME: client_lifetime
6273 LOC: Config.Timeout.lifetime
6276 The maximum amount of time a client (browser) is allowed to
6277 remain connected to the cache process. This protects the Cache
6278 from having a lot of sockets (and hence file descriptors) tied up
6279 in a CLOSE_WAIT state from remote clients that go away without
6280 properly shutting down (either because of a network failure or
6281 because of a poor client implementation). The default is one
6284 NOTE: The default value is intended to be much larger than any
6285 client would ever need to be connected to your cache. You
6286 should probably change client_lifetime only as a last resort.
6287 If you seem to have many client connections tying up
6288 filedescriptors, we recommend first tuning the read_timeout,
6289 request_timeout, persistent_request_timeout and quick_abort values.
6292 NAME: pconn_lifetime
6295 LOC: Config.Timeout.pconnLifetime
6298 Desired maximum lifetime of a persistent connection.
6299 When set, Squid will close a now-idle persistent connection that
6300 exceeded configured lifetime instead of moving the connection into
6301 the idle connection pool (or equivalent). No effect on ongoing/active
6302 transactions. Connection lifetime is the time period from the
6303 connection acceptance or opening time until "now".
6305 This limit is useful in environments with long-lived connections
6306 where Squid configuration or environmental factors change during a
6307 single connection lifetime. If unrestricted, some connections may
6308 last for hours and even days, ignoring those changes that should
6309 have affected their behavior or their existence.
6311 Currently, a new lifetime value supplied via Squid reconfiguration
6312 has no effect on already idle connections unless they become busy.
6314 When set to '0' this limit is not used.
6317 NAME: half_closed_clients
6319 LOC: Config.onoff.half_closed_clients
6322 Some clients may shutdown the sending side of their TCP
6323 connections, while leaving their receiving sides open. Sometimes,
6324 Squid can not tell the difference between a half-closed and a
6325 fully-closed TCP connection.
6327 By default, Squid will immediately close client connections when
6328 read(2) returns "no more data to read."
6330 Change this option to 'on' and Squid will keep open connections
6331 until a read(2) or write(2) on the socket returns an error.
6332 This may show some benefits for reverse proxies. But if not
6333 it is recommended to leave OFF.
6336 NAME: server_idle_pconn_timeout pconn_timeout
6338 LOC: Config.Timeout.serverIdlePconn
6341 Timeout for idle persistent connections to servers and other
6348 LOC: Ident::TheConfig.timeout
6351 Maximum time to wait for IDENT lookups to complete.
6353 If this is too high, and you enabled IDENT lookups from untrusted
6354 users, you might be susceptible to denial-of-service by having
6355 many ident requests going at once.
6358 NAME: shutdown_lifetime
6361 LOC: Config.shutdownLifetime
6364 When SIGTERM or SIGHUP is received, the cache is put into
6365 "shutdown pending" mode until all active sockets are closed.
6366 This value is the lifetime to set for all open descriptors
6367 during shutdown mode. Any active clients after this many
6368 seconds will receive a 'timeout' message.
6372 ADMINISTRATIVE PARAMETERS
6373 -----------------------------------------------------------------------------
6379 LOC: Config.adminEmail
6381 Email-address of local cache manager who will receive
6382 mail if the cache dies. The default is "webmaster".
6388 LOC: Config.EmailFrom
6390 From: email-address for mail sent when the cache dies.
6391 The default is to use 'squid@unique_hostname'.
6393 See also: unique_hostname directive.
6399 LOC: Config.EmailProgram
6401 Email program used to send mail if the cache dies.
6402 The default is "mail". The specified program must comply
6403 with the standard Unix mail syntax:
6404 mail-program recipient < mailfile
6406 Optional command line options can be specified.
6409 NAME: cache_effective_user
6411 DEFAULT: @DEFAULT_CACHE_EFFECTIVE_USER@
6412 LOC: Config.effectiveUser
6414 If you start Squid as root, it will change its effective/real
6415 UID/GID to the user specified below. The default is to change
6416 to UID of @DEFAULT_CACHE_EFFECTIVE_USER@.
6417 see also; cache_effective_group
6420 NAME: cache_effective_group
6423 DEFAULT_DOC: Use system group memberships of the cache_effective_user account
6424 LOC: Config.effectiveGroup
6426 Squid sets the GID to the effective user's default group ID
6427 (taken from the password file) and supplementary group list
6428 from the groups membership.
6430 If you want Squid to run with a specific GID regardless of
6431 the group memberships of the effective user then set this
6432 to the group (or GID) you want Squid to run as. When set
6433 all other group privileges of the effective user are ignored
6434 and only this GID is effective. If Squid is not started as
6435 root the user starting Squid MUST be member of the specified
6438 This option is not recommended by the Squid Team.
6439 Our preference is for administrators to configure a secure
6440 user account for squid with UID/GID matching system policies.
6443 NAME: httpd_suppress_version_string
6447 LOC: Config.onoff.httpd_suppress_version_string
6449 Suppress Squid version string info in HTTP headers and HTML error pages.
6452 NAME: visible_hostname
6454 LOC: Config.visibleHostname
6456 DEFAULT_DOC: Automatically detect the system host name
6458 If you want to present a special hostname in error messages, etc,
6459 define this. Otherwise, the return value of gethostname()
6460 will be used. If you have multiple caches in a cluster and
6461 get errors about IP-forwarding you must set them to have individual
6462 names with this setting.
6465 NAME: unique_hostname
6467 LOC: Config.uniqueHostname
6469 DEFAULT_DOC: Copy the value from visible_hostname
6471 If you want to have multiple machines with the same
6472 'visible_hostname' you must give each machine a different
6473 'unique_hostname' so forwarding loops can be detected.
6476 NAME: hostname_aliases
6478 LOC: Config.hostnameAliases
6481 A list of other DNS names your cache has.
6489 Minimum umask which should be enforced while the proxy
6490 is running, in addition to the umask set at startup.
6492 For a traditional octal representation of umasks, start
6497 OPTIONS FOR THE CACHE REGISTRATION SERVICE
6498 -----------------------------------------------------------------------------
6500 This section contains parameters for the (optional) cache
6501 announcement service. This service is provided to help
6502 cache administrators locate one another in order to join or
6503 create cache hierarchies.
6505 An 'announcement' message is sent (via UDP) to the registration
6506 service by Squid. By default, the announcement message is NOT
6507 SENT unless you enable it with 'announce_period' below.
6509 The announcement message includes your hostname, plus the
6510 following information from this configuration file:
6516 All current information is processed regularly and made
6517 available on the Web at http://www.ircache.net/Cache/Tracker/.
6520 NAME: announce_period
6522 LOC: Config.Announce.period
6524 DEFAULT_DOC: Announcement messages disabled.
6526 This is how frequently to send cache announcements.
6528 To enable announcing your cache, just set an announce period.
6531 announce_period 1 day
6536 DEFAULT: tracker.ircache.net
6537 LOC: Config.Announce.host
6539 Set the hostname where announce registration messages will be sent.
6541 See also announce_port and announce_file
6547 LOC: Config.Announce.file
6549 The contents of this file will be included in the announce
6550 registration messages.
6556 LOC: Config.Announce.port
6558 Set the port where announce registration messages will be sent.
6560 See also announce_host and announce_file
6564 HTTPD-ACCELERATOR OPTIONS
6565 -----------------------------------------------------------------------------
6568 NAME: httpd_accel_surrogate_id
6571 DEFAULT_DOC: visible_hostname is used if no specific ID is set.
6572 LOC: Config.Accel.surrogate_id
6574 Surrogates (http://www.esi.org/architecture_spec_1.0.html)
6575 need an identification token to allow control targeting. Because
6576 a farm of surrogates may all perform the same tasks, they may share
6577 an identification token.
6580 NAME: http_accel_surrogate_remote
6584 LOC: Config.onoff.surrogate_is_remote
6586 Remote surrogates (such as those in a CDN) honour the header
6587 "Surrogate-Control: no-store-remote".
6589 Set this to on to have squid behave as a remote surrogate.
6593 IFDEF: USE_SQUID_ESI
6594 COMMENT: libxml2|expat|custom
6596 LOC: ESIParser::Type
6599 ESI markup is not strictly XML compatible. The custom ESI parser
6600 will give higher performance, but cannot handle non ASCII character
6605 DELAY POOL PARAMETERS
6606 -----------------------------------------------------------------------------
6610 TYPE: delay_pool_count
6612 IFDEF: USE_DELAY_POOLS
6615 This represents the number of delay pools to be used. For example,
6616 if you have one class 2 delay pool and one class 3 delays pool, you
6617 have a total of 2 delay pools.
6619 See also delay_parameters, delay_class, delay_access for pool
6620 configuration details.
6624 TYPE: delay_pool_class
6626 IFDEF: USE_DELAY_POOLS
6629 This defines the class of each delay pool. There must be exactly one
6630 delay_class line for each delay pool. For example, to define two
6631 delay pools, one of class 2 and one of class 3, the settings above
6635 delay_pools 4 # 4 delay pools
6636 delay_class 1 2 # pool 1 is a class 2 pool
6637 delay_class 2 3 # pool 2 is a class 3 pool
6638 delay_class 3 4 # pool 3 is a class 4 pool
6639 delay_class 4 5 # pool 4 is a class 5 pool
6641 The delay pool classes are:
6643 class 1 Everything is limited by a single aggregate
6646 class 2 Everything is limited by a single aggregate
6647 bucket as well as an "individual" bucket chosen
6648 from bits 25 through 32 of the IPv4 address.
6650 class 3 Everything is limited by a single aggregate
6651 bucket as well as a "network" bucket chosen
6652 from bits 17 through 24 of the IP address and a
6653 "individual" bucket chosen from bits 17 through
6654 32 of the IPv4 address.
6656 class 4 Everything in a class 3 delay pool, with an
6657 additional limit on a per user basis. This
6658 only takes effect if the username is established
6659 in advance - by forcing authentication in your
6662 class 5 Requests are grouped according their tag (see
6663 external_acl's tag= reply).
6666 Each pool also requires a delay_parameters directive to configure the pool size
6667 and speed limits used whenever the pool is applied to a request. Along with
6668 a set of delay_access directives to determine when it is used.
6670 NOTE: If an IP address is a.b.c.d
6671 -> bits 25 through 32 are "d"
6672 -> bits 17 through 24 are "c"
6673 -> bits 17 through 32 are "c * 256 + d"
6675 NOTE-2: Due to the use of bitmasks in class 2,3,4 pools they only apply to
6676 IPv4 traffic. Class 1 and 5 pools may be used with IPv6 traffic.
6678 This clause only supports fast acl types.
6679 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
6681 See also delay_parameters and delay_access.
6685 TYPE: delay_pool_access
6687 DEFAULT_DOC: Deny using the pool, unless allow rules exist in squid.conf for the pool.
6688 IFDEF: USE_DELAY_POOLS
6691 This is used to determine which delay pool a request falls into.
6693 delay_access is sorted per pool and the matching starts with pool 1,
6694 then pool 2, ..., and finally pool N. The first delay pool where the
6695 request is allowed is selected for the request. If it does not allow
6696 the request to any pool then the request is not delayed (default).
6698 For example, if you want some_big_clients in delay
6699 pool 1 and lotsa_little_clients in delay pool 2:
6701 delay_access 1 allow some_big_clients
6702 delay_access 1 deny all
6703 delay_access 2 allow lotsa_little_clients
6704 delay_access 2 deny all
6705 delay_access 3 allow authenticated_clients
6707 See also delay_parameters and delay_class.
6711 NAME: delay_parameters
6712 TYPE: delay_pool_rates
6714 IFDEF: USE_DELAY_POOLS
6717 This defines the parameters for a delay pool. Each delay pool has
6718 a number of "buckets" associated with it, as explained in the
6719 description of delay_class.
6721 For a class 1 delay pool, the syntax is:
6723 delay_parameters pool aggregate
6725 For a class 2 delay pool:
6727 delay_parameters pool aggregate individual
6729 For a class 3 delay pool:
6731 delay_parameters pool aggregate network individual
6733 For a class 4 delay pool:
6735 delay_parameters pool aggregate network individual user
6737 For a class 5 delay pool:
6739 delay_parameters pool tagrate
6741 The option variables are:
6743 pool a pool number - ie, a number between 1 and the
6744 number specified in delay_pools as used in
6747 aggregate the speed limit parameters for the aggregate bucket
6750 individual the speed limit parameters for the individual
6751 buckets (class 2, 3).
6753 network the speed limit parameters for the network buckets
6756 user the speed limit parameters for the user buckets
6759 tagrate the speed limit parameters for the tag buckets
6762 A pair of delay parameters is written restore/maximum, where restore is
6763 the number of bytes (not bits - modem and network speeds are usually
6764 quoted in bits) per second placed into the bucket, and maximum is the
6765 maximum number of bytes which can be in the bucket at any time.
6767 There must be one delay_parameters line for each delay pool.
6770 For example, if delay pool number 1 is a class 2 delay pool as in the
6771 above example, and is being used to strictly limit each host to 64Kbit/sec
6772 (plus overheads), with no overall limit, the line is:
6774 delay_parameters 1 none 8000/8000
6776 Note that 8 x 8000 KByte/sec -> 64Kbit/sec.
6778 Note that the word 'none' is used to represent no limit.
6781 And, if delay pool number 2 is a class 3 delay pool as in the above
6782 example, and you want to limit it to a total of 256Kbit/sec (strict limit)
6783 with each 8-bit network permitted 64Kbit/sec (strict limit) and each
6784 individual host permitted 4800bit/sec with a bucket maximum size of 64Kbits
6785 to permit a decent web page to be downloaded at a decent speed
6786 (if the network is not being limited due to overuse) but slow down
6787 large downloads more significantly:
6789 delay_parameters 2 32000/32000 8000/8000 600/8000
6791 Note that 8 x 32000 KByte/sec -> 256Kbit/sec.
6792 8 x 8000 KByte/sec -> 64Kbit/sec.
6793 8 x 600 Byte/sec -> 4800bit/sec.
6796 Finally, for a class 4 delay pool as in the example - each user will
6797 be limited to 128Kbits/sec no matter how many workstations they are logged into.:
6799 delay_parameters 4 32000/32000 8000/8000 600/64000 16000/16000
6802 See also delay_class and delay_access.
6806 NAME: delay_initial_bucket_level
6807 COMMENT: (percent, 0-100)
6810 IFDEF: USE_DELAY_POOLS
6811 LOC: Config.Delay.initial
6813 The initial bucket percentage is used to determine how much is put
6814 in each bucket when squid starts, is reconfigured, or first notices
6815 a host accessing it (in class 2 and class 3, individual hosts and
6816 networks only have buckets associated with them once they have been
6821 CLIENT DELAY POOL PARAMETERS
6822 -----------------------------------------------------------------------------
6825 NAME: client_delay_pools
6826 TYPE: client_delay_pool_count
6828 IFDEF: USE_DELAY_POOLS
6829 LOC: Config.ClientDelay
6831 This option specifies the number of client delay pools used. It must
6832 preceed other client_delay_* options.
6835 client_delay_pools 2
6837 See also client_delay_parameters and client_delay_access.
6840 NAME: client_delay_initial_bucket_level
6841 COMMENT: (percent, 0-no_limit)
6844 IFDEF: USE_DELAY_POOLS
6845 LOC: Config.ClientDelay.initial
6847 This option determines the initial bucket size as a percentage of
6848 max_bucket_size from client_delay_parameters. Buckets are created
6849 at the time of the "first" connection from the matching IP. Idle
6850 buckets are periodically deleted up.
6852 You can specify more than 100 percent but note that such "oversized"
6853 buckets are not refilled until their size goes down to max_bucket_size
6854 from client_delay_parameters.
6857 client_delay_initial_bucket_level 50
6860 NAME: client_delay_parameters
6861 TYPE: client_delay_pool_rates
6863 IFDEF: USE_DELAY_POOLS
6864 LOC: Config.ClientDelay
6867 This option configures client-side bandwidth limits using the
6870 client_delay_parameters pool speed_limit max_bucket_size
6872 pool is an integer ID used for client_delay_access matching.
6874 speed_limit is bytes added to the bucket per second.
6876 max_bucket_size is the maximum size of a bucket, enforced after any
6877 speed_limit additions.
6879 Please see the delay_parameters option for more information and
6883 client_delay_parameters 1 1024 2048
6884 client_delay_parameters 2 51200 16384
6886 See also client_delay_access.
6890 NAME: client_delay_access
6891 TYPE: client_delay_pool_access
6893 DEFAULT_DOC: Deny use of the pool, unless allow rules exist in squid.conf for the pool.
6894 IFDEF: USE_DELAY_POOLS
6895 LOC: Config.ClientDelay
6897 This option determines the client-side delay pool for the
6900 client_delay_access pool_ID allow|deny acl_name
6902 All client_delay_access options are checked in their pool ID
6903 order, starting with pool 1. The first checked pool with allowed
6904 request is selected for the request. If no ACL matches or there
6905 are no client_delay_access options, the request bandwidth is not
6908 The ACL-selected pool is then used to find the
6909 client_delay_parameters for the request. Client-side pools are
6910 not used to aggregate clients. Clients are always aggregated
6911 based on their source IP addresses (one bucket per source IP).
6913 This clause only supports fast acl types.
6914 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
6915 Additionally, only the client TCP connection details are available.
6916 ACLs testing HTTP properties will not work.
6918 Please see delay_access for more examples.
6921 client_delay_access 1 allow low_rate_network
6922 client_delay_access 2 allow vips_network
6925 See also client_delay_parameters and client_delay_pools.
6929 WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS
6930 -----------------------------------------------------------------------------
6935 LOC: Config.Wccp.router
6937 DEFAULT_DOC: WCCP disabled.
6940 Use this option to define your WCCP ``home'' router for
6943 wccp_router supports a single WCCP(v1) router
6945 wccp2_router supports multiple WCCPv2 routers
6947 only one of the two may be used at the same time and defines
6948 which version of WCCP to use.
6952 TYPE: IpAddress_list
6953 LOC: Config.Wccp2.router
6955 DEFAULT_DOC: WCCPv2 disabled.
6958 Use this option to define your WCCP ``home'' router for
6961 wccp_router supports a single WCCP(v1) router
6963 wccp2_router supports multiple WCCPv2 routers
6965 only one of the two may be used at the same time and defines
6966 which version of WCCP to use.
6971 LOC: Config.Wccp.version
6975 This directive is only relevant if you need to set up WCCP(v1)
6976 to some very old and end-of-life Cisco routers. In all other
6977 setups it must be left unset or at the default setting.
6978 It defines an internal version in the WCCP(v1) protocol,
6979 with version 4 being the officially documented protocol.
6981 According to some users, Cisco IOS 11.2 and earlier only
6982 support WCCP version 3. If you're using that or an earlier
6983 version of IOS, you may need to change this value to 3, otherwise
6984 do not specify this parameter.
6987 NAME: wccp2_rebuild_wait
6989 LOC: Config.Wccp2.rebuildwait
6993 If this is enabled Squid will wait for the cache dir rebuild to finish
6994 before sending the first wccp2 HereIAm packet
6997 NAME: wccp2_forwarding_method
6999 LOC: Config.Wccp2.forwarding_method
7003 WCCP2 allows the setting of forwarding methods between the
7004 router/switch and the cache. Valid values are as follows:
7006 gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
7007 l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting)
7009 Currently (as of IOS 12.4) cisco routers only support GRE.
7010 Cisco switches only support the L2 redirect assignment method.
7013 NAME: wccp2_return_method
7015 LOC: Config.Wccp2.return_method
7019 WCCP2 allows the setting of return methods between the
7020 router/switch and the cache for packets that the cache
7021 decides not to handle. Valid values are as follows:
7023 gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
7024 l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting)
7026 Currently (as of IOS 12.4) cisco routers only support GRE.
7027 Cisco switches only support the L2 redirect assignment.
7029 If the "ip wccp redirect exclude in" command has been
7030 enabled on the cache interface, then it is still safe for
7031 the proxy server to use a l2 redirect method even if this
7032 option is set to GRE.
7035 NAME: wccp2_assignment_method
7037 LOC: Config.Wccp2.assignment_method
7041 WCCP2 allows the setting of methods to assign the WCCP hash
7042 Valid values are as follows:
7044 hash - Hash assignment
7045 mask - Mask assignment
7047 As a general rule, cisco routers support the hash assignment method
7048 and cisco switches support the mask assignment method.
7053 LOC: Config.Wccp2.info
7054 DEFAULT_IF_NONE: standard 0
7055 DEFAULT_DOC: Use the 'web-cache' standard service.
7058 WCCP2 allows for multiple traffic services. There are two
7059 types: "standard" and "dynamic". The standard type defines
7060 one service id - http (id 0). The dynamic service ids can be from
7061 51 to 255 inclusive. In order to use a dynamic service id
7062 one must define the type of traffic to be redirected; this is done
7063 using the wccp2_service_info option.
7065 The "standard" type does not require a wccp2_service_info option,
7066 just specifying the service id will suffice.
7068 MD5 service authentication can be enabled by adding
7069 "password=<password>" to the end of this service declaration.
7073 wccp2_service standard 0 # for the 'web-cache' standard service
7074 wccp2_service dynamic 80 # a dynamic service type which will be
7075 # fleshed out with subsequent options.
7076 wccp2_service standard 0 password=foo
7079 NAME: wccp2_service_info
7080 TYPE: wccp2_service_info
7081 LOC: Config.Wccp2.info
7085 Dynamic WCCPv2 services require further information to define the
7086 traffic you wish to have diverted.
7090 wccp2_service_info <id> protocol=<protocol> flags=<flag>,<flag>..
7091 priority=<priority> ports=<port>,<port>..
7093 The relevant WCCPv2 flags:
7094 + src_ip_hash, dst_ip_hash
7095 + source_port_hash, dst_port_hash
7096 + src_ip_alt_hash, dst_ip_alt_hash
7097 + src_port_alt_hash, dst_port_alt_hash
7100 The port list can be one to eight entries.
7104 wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source
7105 priority=240 ports=80
7107 Note: the service id must have been defined by a previous
7108 'wccp2_service dynamic <id>' entry.
7113 LOC: Config.Wccp2.weight
7117 Each cache server gets assigned a set of the destination
7118 hash proportional to their weight.
7123 LOC: Config.Wccp.address
7125 DEFAULT_DOC: Address selected by the operating system.
7128 Use this option if you require WCCPv2 to use a specific
7131 The default behavior is to not bind to any specific address.
7136 LOC: Config.Wccp2.address
7138 DEFAULT_DOC: Address selected by the operating system.
7141 Use this option if you require WCCP to use a specific
7144 The default behavior is to not bind to any specific address.
7148 PERSISTENT CONNECTION HANDLING
7149 -----------------------------------------------------------------------------
7151 Also see "pconn_timeout" in the TIMEOUTS section
7154 NAME: client_persistent_connections
7156 LOC: Config.onoff.client_pconns
7159 Persistent connection support for clients.
7160 Squid uses persistent connections (when allowed). You can use
7161 this option to disable persistent connections with clients.
7164 NAME: server_persistent_connections
7166 LOC: Config.onoff.server_pconns
7169 Persistent connection support for servers.
7170 Squid uses persistent connections (when allowed). You can use
7171 this option to disable persistent connections with servers.
7174 NAME: persistent_connection_after_error
7176 LOC: Config.onoff.error_pconns
7179 With this directive the use of persistent connections after
7180 HTTP errors can be disabled. Useful if you have clients
7181 who fail to handle errors on persistent connections proper.
7184 NAME: detect_broken_pconn
7186 LOC: Config.onoff.detect_broken_server_pconns
7189 Some servers have been found to incorrectly signal the use
7190 of HTTP/1.0 persistent connections even on replies not
7191 compatible, causing significant delays. This server problem
7192 has mostly been seen on redirects.
7194 By enabling this directive Squid attempts to detect such
7195 broken replies and automatically assume the reply is finished
7196 after 10 seconds timeout.
7200 CACHE DIGEST OPTIONS
7201 -----------------------------------------------------------------------------
7204 NAME: digest_generation
7205 IFDEF: USE_CACHE_DIGESTS
7207 LOC: Config.onoff.digest_generation
7210 This controls whether the server will generate a Cache Digest
7211 of its contents. By default, Cache Digest generation is
7212 enabled if Squid is compiled with --enable-cache-digests defined.
7215 NAME: digest_bits_per_entry
7216 IFDEF: USE_CACHE_DIGESTS
7218 LOC: Config.digest.bits_per_entry
7221 This is the number of bits of the server's Cache Digest which
7222 will be associated with the Digest entry for a given HTTP
7223 Method and URL (public key) combination. The default is 5.
7226 NAME: digest_rebuild_period
7227 IFDEF: USE_CACHE_DIGESTS
7230 LOC: Config.digest.rebuild_period
7233 This is the wait time between Cache Digest rebuilds.
7236 NAME: digest_rewrite_period
7238 IFDEF: USE_CACHE_DIGESTS
7240 LOC: Config.digest.rewrite_period
7243 This is the wait time between Cache Digest writes to
7247 NAME: digest_swapout_chunk_size
7250 IFDEF: USE_CACHE_DIGESTS
7251 LOC: Config.digest.swapout_chunk_size
7254 This is the number of bytes of the Cache Digest to write to
7255 disk at a time. It defaults to 4096 bytes (4KB), the Squid
7259 NAME: digest_rebuild_chunk_percentage
7260 COMMENT: (percent, 0-100)
7261 IFDEF: USE_CACHE_DIGESTS
7263 LOC: Config.digest.rebuild_chunk_percentage
7266 This is the percentage of the Cache Digest to be scanned at a
7267 time. By default it is set to 10% of the Cache Digest.
7272 -----------------------------------------------------------------------------
7277 LOC: Config.Port.snmp
7279 DEFAULT_DOC: SNMP disabled.
7282 The port number where Squid listens for SNMP requests. To enable
7283 SNMP support set this to a suitable port number. Port number
7284 3401 is often used for the Squid SNMP agent. By default it's
7285 set to "0" (disabled)
7293 LOC: Config.accessList.snmp
7295 DEFAULT_DOC: Deny, unless rules exist in squid.conf.
7298 Allowing or denying access to the SNMP port.
7300 All access to the agent is denied by default.
7303 snmp_access allow|deny [!]aclname ...
7305 This clause only supports fast acl types.
7306 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
7309 snmp_access allow snmppublic localhost
7310 snmp_access deny all
7313 NAME: snmp_incoming_address
7315 LOC: Config.Addrs.snmp_incoming
7317 DEFAULT_DOC: Accept SNMP packets from all machine interfaces.
7320 Just like 'udp_incoming_address', but for the SNMP port.
7322 snmp_incoming_address is used for the SNMP socket receiving
7323 messages from SNMP agents.
7325 The default snmp_incoming_address is to listen on all
7326 available network interfaces.
7329 NAME: snmp_outgoing_address
7331 LOC: Config.Addrs.snmp_outgoing
7333 DEFAULT_DOC: Use snmp_incoming_address or an address selected by the operating system.
7336 Just like 'udp_outgoing_address', but for the SNMP port.
7338 snmp_outgoing_address is used for SNMP packets returned to SNMP
7341 If snmp_outgoing_address is not set it will use the same socket
7342 as snmp_incoming_address. Only change this if you want to have
7343 SNMP replies sent using another address than where this Squid
7344 listens for SNMP queries.
7346 NOTE, snmp_incoming_address and snmp_outgoing_address can not have
7347 the same value since they both use the same port.
7352 -----------------------------------------------------------------------------
7355 NAME: icp_port udp_port
7358 DEFAULT_DOC: ICP disabled.
7359 LOC: Config.Port.icp
7361 The port number where Squid sends and receives ICP queries to
7362 and from neighbor caches. The standard UDP port for ICP is 3130.
7365 icp_port @DEFAULT_ICP_PORT@
7372 DEFAULT_DOC: HTCP disabled.
7373 LOC: Config.Port.htcp
7375 The port number where Squid sends and receives HTCP queries to
7376 and from neighbor caches. To turn it on you want to set it to
7383 NAME: log_icp_queries
7387 LOC: Config.onoff.log_udp
7389 If set, ICP queries are logged to access.log. You may wish
7390 do disable this if your ICP load is VERY high to speed things
7391 up or to simplify log analysis.
7394 NAME: udp_incoming_address
7396 LOC:Config.Addrs.udp_incoming
7398 DEFAULT_DOC: Accept packets from all machine interfaces.
7400 udp_incoming_address is used for UDP packets received from other
7403 The default behavior is to not bind to any specific address.
7405 Only change this if you want to have all UDP queries received on
7406 a specific interface/address.
7408 NOTE: udp_incoming_address is used by the ICP, HTCP, and DNS
7409 modules. Altering it will affect all of them in the same manner.
7411 see also; udp_outgoing_address
7413 NOTE, udp_incoming_address and udp_outgoing_address can not
7414 have the same value since they both use the same port.
7417 NAME: udp_outgoing_address
7419 LOC: Config.Addrs.udp_outgoing
7421 DEFAULT_DOC: Use udp_incoming_address or an address selected by the operating system.
7423 udp_outgoing_address is used for UDP packets sent out to other
7426 The default behavior is to not bind to any specific address.
7428 Instead it will use the same socket as udp_incoming_address.
7429 Only change this if you want to have UDP queries sent using another
7430 address than where this Squid listens for UDP queries from other
7433 NOTE: udp_outgoing_address is used by the ICP, HTCP, and DNS
7434 modules. Altering it will affect all of them in the same manner.
7436 see also; udp_incoming_address
7438 NOTE, udp_incoming_address and udp_outgoing_address can not
7439 have the same value since they both use the same port.
7446 LOC: Config.onoff.icp_hit_stale
7448 If you want to return ICP_HIT for stale cache objects, set this
7449 option to 'on'. If you have sibling relationships with caches
7450 in other administrative domains, this should be 'off'. If you only
7451 have sibling relationships with caches under your control,
7452 it is probably okay to set this to 'on'.
7453 If set to 'on', your siblings should use the option "allow-miss"
7454 on their cache_peer lines for connecting to you.
7457 NAME: minimum_direct_hops
7460 LOC: Config.minDirectHops
7462 If using the ICMP pinging stuff, do direct fetches for sites
7463 which are no more than this many hops away.
7466 NAME: minimum_direct_rtt
7470 LOC: Config.minDirectRtt
7472 If using the ICMP pinging stuff, do direct fetches for sites
7473 which are no more than this many rtt milliseconds away.
7479 LOC: Config.Netdb.low
7481 The low water mark for the ICMP measurement database.
7483 Note: high watermark controlled by netdb_high directive.
7485 These watermarks are counts, not percents. The defaults are
7486 (low) 900 and (high) 1000. When the high water mark is
7487 reached, database entries will be deleted until the low
7494 LOC: Config.Netdb.high
7496 The high water mark for the ICMP measurement database.
7498 Note: low watermark controlled by netdb_low directive.
7500 These watermarks are counts, not percents. The defaults are
7501 (low) 900 and (high) 1000. When the high water mark is
7502 reached, database entries will be deleted until the low
7506 NAME: netdb_ping_period
7508 LOC: Config.Netdb.period
7511 The minimum period for measuring a site. There will be at
7512 least this much delay between successive pings to the same
7513 network. The default is five minutes.
7520 LOC: Config.onoff.query_icmp
7522 If you want to ask your peers to include ICMP data in their ICP
7523 replies, enable this option.
7525 If your peer has configured Squid (during compilation) with
7526 '--enable-icmp' that peer will send ICMP pings to origin server
7527 sites of the URLs it receives. If you enable this option the
7528 ICP replies from that peer will include the ICMP data (if available).
7529 Then, when choosing a parent cache, Squid will choose the parent with
7530 the minimal RTT to the origin server. When this happens, the
7531 hierarchy field of the access.log will be
7532 "CLOSEST_PARENT_MISS". This option is off by default.
7535 NAME: test_reachability
7539 LOC: Config.onoff.test_reachability
7541 When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH
7542 instead of ICP_MISS if the target host is NOT in the ICMP
7543 database, or has a zero RTT.
7546 NAME: icp_query_timeout
7549 DEFAULT_DOC: Dynamic detection.
7551 LOC: Config.Timeout.icp_query
7553 Normally Squid will automatically determine an optimal ICP
7554 query timeout value based on the round-trip-time of recent ICP
7555 queries. If you want to override the value determined by
7556 Squid, set this 'icp_query_timeout' to a non-zero value. This
7557 value is specified in MILLISECONDS, so, to use a 2-second
7558 timeout (the old default), you would write:
7560 icp_query_timeout 2000
7563 NAME: maximum_icp_query_timeout
7567 LOC: Config.Timeout.icp_query_max
7569 Normally the ICP query timeout is determined dynamically. But
7570 sometimes it can lead to very large values (say 5 seconds).
7571 Use this option to put an upper limit on the dynamic timeout
7572 value. Do NOT use this option to always use a fixed (instead
7573 of a dynamic) timeout value. To set a fixed timeout see the
7574 'icp_query_timeout' directive.
7577 NAME: minimum_icp_query_timeout
7581 LOC: Config.Timeout.icp_query_min
7583 Normally the ICP query timeout is determined dynamically. But
7584 sometimes it can lead to very small timeouts, even lower than
7585 the normal latency variance on your link due to traffic.
7586 Use this option to put an lower limit on the dynamic timeout
7587 value. Do NOT use this option to always use a fixed (instead
7588 of a dynamic) timeout value. To set a fixed timeout see the
7589 'icp_query_timeout' directive.
7592 NAME: background_ping_rate
7596 LOC: Config.backgroundPingRate
7598 Controls how often the ICP pings are sent to siblings that
7599 have background-ping set.
7603 MULTICAST ICP OPTIONS
7604 -----------------------------------------------------------------------------
7609 LOC: Config.mcast_group_list
7612 This tag specifies a list of multicast groups which your server
7613 should join to receive multicasted ICP queries.
7615 NOTE! Be very careful what you put here! Be sure you
7616 understand the difference between an ICP _query_ and an ICP
7617 _reply_. This option is to be set only if you want to RECEIVE
7618 multicast queries. Do NOT set this option to SEND multicast
7619 ICP (use cache_peer for that). ICP replies are always sent via
7620 unicast, so this option does not affect whether or not you will
7621 receive replies from multicast group members.
7623 You must be very careful to NOT use a multicast address which
7624 is already in use by another group of caches.
7626 If you are unsure about multicast, please read the Multicast
7627 chapter in the Squid FAQ (http://www.squid-cache.org/FAQ/).
7629 Usage: mcast_groups 239.128.16.128 224.0.1.20
7631 By default, Squid doesn't listen on any multicast groups.
7634 NAME: mcast_miss_addr
7635 IFDEF: MULTICAST_MISS_STREAM
7637 LOC: Config.mcast_miss.addr
7639 DEFAULT_DOC: disabled.
7641 If you enable this option, every "cache miss" URL will
7642 be sent out on the specified multicast address.
7644 Do not enable this option unless you are are absolutely
7645 certain you understand what you are doing.
7648 NAME: mcast_miss_ttl
7649 IFDEF: MULTICAST_MISS_STREAM
7651 LOC: Config.mcast_miss.ttl
7654 This is the time-to-live value for packets multicasted
7655 when multicasting off cache miss URLs is enabled. By
7656 default this is set to 'site scope', i.e. 16.
7659 NAME: mcast_miss_port
7660 IFDEF: MULTICAST_MISS_STREAM
7662 LOC: Config.mcast_miss.port
7665 This is the port number to be used in conjunction with
7669 NAME: mcast_miss_encode_key
7670 IFDEF: MULTICAST_MISS_STREAM
7672 LOC: Config.mcast_miss.encode_key
7673 DEFAULT: XXXXXXXXXXXXXXXX
7675 The URLs that are sent in the multicast miss stream are
7676 encrypted. This is the encryption key.
7679 NAME: mcast_icp_query_timeout
7683 LOC: Config.Timeout.mcast_icp_query
7685 For multicast peers, Squid regularly sends out ICP "probes" to
7686 count how many other peers are listening on the given multicast
7687 address. This value specifies how long Squid should wait to
7688 count all the replies. The default is 2000 msec, or 2
7693 INTERNAL ICON OPTIONS
7694 -----------------------------------------------------------------------------
7697 NAME: icon_directory
7699 LOC: Config.icons.directory
7700 DEFAULT: @DEFAULT_ICON_DIR@
7702 Where the icons are stored. These are normally kept in
7706 NAME: global_internal_static
7708 LOC: Config.onoff.global_internal_static
7711 This directive controls is Squid should intercept all requests for
7712 /squid-internal-static/ no matter which host the URL is requesting
7713 (default on setting), or if nothing special should be done for
7714 such URLs (off setting). The purpose of this directive is to make
7715 icons etc work better in complex cache hierarchies where it may
7716 not always be possible for all corners in the cache mesh to reach
7717 the server generating a directory listing.
7720 NAME: short_icon_urls
7722 LOC: Config.icons.use_short_names
7725 If this is enabled Squid will use short URLs for icons.
7726 If disabled it will revert to the old behavior of including
7727 it's own name and port in the URL.
7729 If you run a complex cache hierarchy with a mix of Squid and
7730 other proxies you may need to disable this directive.
7735 -----------------------------------------------------------------------------
7738 NAME: error_directory
7740 LOC: Config.errorDirectory
7742 DEFAULT_DOC: Send error pages in the clients preferred language
7744 If you wish to create your own versions of the default
7745 error files to customize them to suit your company copy
7746 the error/template files to another directory and point
7749 WARNING: This option will disable multi-language support
7750 on error pages if used.
7752 The squid developers are interested in making squid available in
7753 a wide variety of languages. If you are making translations for a
7754 language that Squid does not currently provide please consider
7755 contributing your translation back to the project.
7756 http://wiki.squid-cache.org/Translations
7758 The squid developers working on translations are happy to supply drop-in
7759 translated error files in exchange for any new language contributions.
7762 NAME: error_default_language
7763 IFDEF: USE_ERR_LOCALES
7765 LOC: Config.errorDefaultLanguage
7767 DEFAULT_DOC: Generate English language pages.
7769 Set the default language which squid will send error pages in
7770 if no existing translation matches the clients language
7773 If unset (default) generic English will be used.
7775 The squid developers are interested in making squid available in
7776 a wide variety of languages. If you are interested in making
7777 translations for any language see the squid wiki for details.
7778 http://wiki.squid-cache.org/Translations
7781 NAME: error_log_languages
7782 IFDEF: USE_ERR_LOCALES
7784 LOC: Config.errorLogMissingLanguages
7787 Log to cache.log what languages users are attempting to
7788 auto-negotiate for translations.
7790 Successful negotiations are not logged. Only failures
7791 have meaning to indicate that Squid may need an upgrade
7792 of its error page translations.
7795 NAME: err_page_stylesheet
7797 LOC: Config.errorStylesheet
7798 DEFAULT: @DEFAULT_CONFIG_DIR@/errorpage.css
7800 CSS Stylesheet to pattern the display of Squid default error pages.
7802 For information on CSS see http://www.w3.org/Style/CSS/
7807 LOC: Config.errHtmlText
7810 HTML text to include in error messages. Make this a "mailto"
7811 URL to your admin address, or maybe just a link to your
7812 organizations Web page.
7814 To include this in your error messages, you must rewrite
7815 the error template files (found in the "errors" directory).
7816 Wherever you want the 'err_html_text' line to appear,
7817 insert a %L tag in the error template file.
7820 NAME: email_err_data
7823 LOC: Config.onoff.emailErrData
7826 If enabled, information about the occurred error will be
7827 included in the mailto links of the ERR pages (if %W is set)
7828 so that the email body contains the data.
7829 Syntax is <A HREF="mailto:%w%W">%w</A>
7834 LOC: Config.denyInfoList
7837 Usage: deny_info err_page_name acl
7838 or deny_info http://... acl
7839 or deny_info TCP_RESET acl
7841 This can be used to return a ERR_ page for requests which
7842 do not pass the 'http_access' rules. Squid remembers the last
7843 acl it evaluated in http_access, and if a 'deny_info' line exists
7844 for that ACL Squid returns a corresponding error page.
7846 The acl is typically the last acl on the http_access deny line which
7847 denied access. The exceptions to this rule are:
7848 - When Squid needs to request authentication credentials. It's then
7849 the first authentication related acl encountered
7850 - When none of the http_access lines matches. It's then the last
7851 acl processed on the last http_access line.
7852 - When the decision to deny access was made by an adaptation service,
7853 the acl name is the corresponding eCAP or ICAP service_name.
7855 NP: If providing your own custom error pages with error_directory
7856 you may also specify them by your custom file name:
7857 Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys
7859 By defaut Squid will send "403 Forbidden". A different 4xx or 5xx
7860 may be specified by prefixing the file name with the code and a colon.
7861 e.g. 404:ERR_CUSTOM_ACCESS_DENIED
7863 Alternatively you can tell Squid to reset the TCP connection
7864 by specifying TCP_RESET.
7866 Or you can specify an error URL or URL pattern. The browsers will
7867 get redirected to the specified URL after formatting tags have
7868 been replaced. Redirect will be done with 302 or 307 according to
7869 HTTP/1.1 specs. A different 3xx code may be specified by prefixing
7870 the URL. e.g. 303:http://example.com/
7873 %a - username (if available. Password NOT included)
7876 %E - Error description
7878 %H - Request domain name
7879 %i - Client IP Address
7881 %o - Message result from external ACL helper
7882 %p - Request Port number
7883 %P - Request Protocol name
7884 %R - Request URL path
7885 %T - Timestamp in RFC 1123 format
7886 %U - Full canonical URL from client
7887 (HTTPS URLs terminate with *)
7888 %u - Full canonical URL from client
7889 %w - Admin email from squid.conf
7891 %% - Literal percent (%) code
7896 OPTIONS INFLUENCING REQUEST FORWARDING
7897 -----------------------------------------------------------------------------
7900 NAME: nonhierarchical_direct
7902 LOC: Config.onoff.nonhierarchical_direct
7905 By default, Squid will send any non-hierarchical requests
7906 (not cacheable request type) direct to origin servers.
7908 When this is set to "off", Squid will prefer to send these
7909 requests to parents.
7911 Note that in most configurations, by turning this off you will only
7912 add latency to these request without any improvement in global hit
7915 This option only sets a preference. If the parent is unavailable a
7916 direct connection to the origin server may still be attempted. To
7917 completely prevent direct connections use never_direct.
7922 LOC: Config.onoff.prefer_direct
7925 Normally Squid tries to use parents for most requests. If you for some
7926 reason like it to first try going direct and only use a parent if
7927 going direct fails set this to on.
7929 By combining nonhierarchical_direct off and prefer_direct on you
7930 can set up Squid to use a parent as a backup path if going direct
7933 Note: If you want Squid to use parents for all requests see
7934 the never_direct directive. prefer_direct only modifies how Squid
7935 acts on cacheable requests.
7938 NAME: cache_miss_revalidate
7942 LOC: Config.onoff.cache_miss_revalidate
7944 RFC 7232 defines a conditional request mechanism to prevent
7945 response objects being unnecessarily transferred over the network.
7946 If that mechanism is used by the client and a cache MISS occurs
7947 it can prevent new cache entries being created.
7949 This option determines whether Squid on cache MISS will pass the
7950 client revalidation request to the server or tries to fetch new
7951 content for caching. It can be useful while the cache is mostly
7952 empty to more quickly have the cache populated by generating
7953 non-conditional GETs.
7955 When set to 'on' (default), Squid will pass all client If-* headers
7956 to the server. This permits server responses without a cacheable
7957 payload to be delivered and on MISS no new cache entry is created.
7959 When set to 'off' and if the request is cacheable, Squid will
7960 remove the clients If-Modified-Since and If-None-Match headers from
7961 the request sent to the server. This requests a 200 status response
7962 from the server to create a new cache entry with.
7967 LOC: Config.accessList.AlwaysDirect
7969 DEFAULT_DOC: Prevent any cache_peer being used for this request.
7971 Usage: always_direct allow|deny [!]aclname ...
7973 Here you can use ACL elements to specify requests which should
7974 ALWAYS be forwarded by Squid to the origin servers without using
7975 any peers. For example, to always directly forward requests for
7976 local servers ignoring any parents or siblings you may have use
7979 acl local-servers dstdomain my.domain.net
7980 always_direct allow local-servers
7982 To always forward FTP requests directly, use
7985 always_direct allow FTP
7987 NOTE: There is a similar, but opposite option named
7988 'never_direct'. You need to be aware that "always_direct deny
7989 foo" is NOT the same thing as "never_direct allow foo". You
7990 may need to use a deny rule to exclude a more-specific case of
7991 some other rule. Example:
7993 acl local-external dstdomain external.foo.net
7994 acl local-servers dstdomain .foo.net
7995 always_direct deny local-external
7996 always_direct allow local-servers
7998 NOTE: If your goal is to make the client forward the request
7999 directly to the origin server bypassing Squid then this needs
8000 to be done in the client configuration. Squid configuration
8001 can only tell Squid how Squid should fetch the object.
8003 NOTE: This directive is not related to caching. The replies
8004 is cached as usual even if you use always_direct. To not cache
8005 the replies see the 'cache' directive.
8007 This clause supports both fast and slow acl types.
8008 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
8013 LOC: Config.accessList.NeverDirect
8015 DEFAULT_DOC: Allow DNS results to be used for this request.
8017 Usage: never_direct allow|deny [!]aclname ...
8019 never_direct is the opposite of always_direct. Please read
8020 the description for always_direct if you have not already.
8022 With 'never_direct' you can use ACL elements to specify
8023 requests which should NEVER be forwarded directly to origin
8024 servers. For example, to force the use of a proxy for all
8025 requests, except those in your local domain use something like:
8027 acl local-servers dstdomain .foo.net
8028 never_direct deny local-servers
8029 never_direct allow all
8031 or if Squid is inside a firewall and there are local intranet
8032 servers inside the firewall use something like:
8034 acl local-intranet dstdomain .foo.net
8035 acl local-external dstdomain external.foo.net
8036 always_direct deny local-external
8037 always_direct allow local-intranet
8038 never_direct allow all
8040 This clause supports both fast and slow acl types.
8041 See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
8045 ADVANCED NETWORKING OPTIONS
8046 -----------------------------------------------------------------------------
8049 NAME: incoming_udp_average incoming_icp_average
8052 LOC: Config.comm_incoming.udp.average
8054 Heavy voodoo here. I can't even believe you are reading this.
8055 Are you crazy? Don't even think about adjusting these unless
8056 you understand the algorithms in comm_select.c first!
8059 NAME: incoming_tcp_average incoming_http_average
8062 LOC: Config.comm_incoming.tcp.average
8064 Heavy voodoo here. I can't even believe you are reading this.
8065 Are you crazy? Don't even think about adjusting these unless
8066 you understand the algorithms in comm_select.c first!
8069 NAME: incoming_dns_average
8072 LOC: Config.comm_incoming.dns.average
8074 Heavy voodoo here. I can't even believe you are reading this.
8075 Are you crazy? Don't even think about adjusting these unless
8076 you understand the algorithms in comm_select.c first!
8079 NAME: min_udp_poll_cnt min_icp_poll_cnt
8082 LOC: Config.comm_incoming.udp.min_poll
8084 Heavy voodoo here. I can't even believe you are reading this.
8085 Are you crazy? Don't even think about adjusting these unless
8086 you understand the algorithms in comm_select.c first!
8089 NAME: min_dns_poll_cnt
8092 LOC: Config.comm_incoming.dns.min_poll
8094 Heavy voodoo here. I can't even believe you are reading this.
8095 Are you crazy? Don't even think about adjusting these unless
8096 you understand the algorithms in comm_select.c first!
8099 NAME: min_tcp_poll_cnt min_http_poll_cnt
8102 LOC: Config.comm_incoming.tcp.min_poll
8104 Heavy voodoo here. I can't even believe you are reading this.
8105 Are you crazy? Don't even think about adjusting these unless
8106 you understand the algorithms in comm_select.c first!
8112 LOC: Config.accept_filter
8116 The name of an accept(2) filter to install on Squid's
8117 listen socket(s). This feature is perhaps specific to
8118 FreeBSD and requires support in the kernel.
8120 The 'httpready' filter delays delivering new connections
8121 to Squid until a full HTTP request has been received.
8122 See the accf_http(9) man page for details.
8124 The 'dataready' filter delays delivering new connections
8125 to Squid until there is some data to process.
8126 See the accf_dataready(9) man page for details.
8130 The 'data' filter delays delivering of new connections
8131 to Squid until there is some data to process by TCP_ACCEPT_DEFER.
8132 You may optionally specify a number of seconds to wait by
8133 'data=N' where N is the number of seconds. Defaults to 30
8134 if not specified. See the tcp(7) man page for details.
8137 accept_filter httpready
8142 NAME: client_ip_max_connections
8144 LOC: Config.client_ip_max_connections
8146 DEFAULT_DOC: No limit.
8148 Set an absolute limit on the number of connections a single
8149 client IP can use. Any more than this and Squid will begin to drop
8150 new connections from the client until it closes some links.
8152 Note that this is a global limit. It affects all HTTP, HTCP, Gopher and FTP
8153 connections from the client. For finer control use the ACL access controls.
8155 Requires client_db to be enabled (the default).
8157 WARNING: This may noticably slow down traffic received via external proxies
8158 or NAT devices and cause them to rebound error messages back to their clients.
8161 NAME: tcp_recv_bufsize
8165 DEFAULT_DOC: Use operating system TCP defaults.
8166 LOC: Config.tcpRcvBufsz
8168 Size of receive buffer to set for TCP sockets. Probably just
8169 as easy to change your kernel's default.
8170 Omit from squid.conf to use the default buffer size.
8175 -----------------------------------------------------------------------------
8182 LOC: Adaptation::Icap::TheConfig.onoff
8185 If you want to enable the ICAP module support, set this to on.
8188 NAME: icap_connect_timeout
8191 LOC: Adaptation::Icap::TheConfig.connect_timeout_raw
8194 This parameter specifies how long to wait for the TCP connect to
8195 the requested ICAP server to complete before giving up and either
8196 terminating the HTTP transaction or bypassing the failure.
8198 The default for optional services is peer_connect_timeout.
8199 The default for essential services is connect_timeout.
8200 If this option is explicitly set, its value applies to all services.
8203 NAME: icap_io_timeout
8207 DEFAULT_DOC: Use read_timeout.
8208 LOC: Adaptation::Icap::TheConfig.io_timeout_raw
8211 This parameter specifies how long to wait for an I/O activity on
8212 an established, active ICAP connection before giving up and
8213 either terminating the HTTP transaction or bypassing the
8217 NAME: icap_service_failure_limit
8218 COMMENT: limit [in memory-depth time-units]
8219 TYPE: icap_service_failure_limit
8221 LOC: Adaptation::Icap::TheConfig
8224 The limit specifies the number of failures that Squid tolerates
8225 when establishing a new TCP connection with an ICAP service. If
8226 the number of failures exceeds the limit, the ICAP service is
8227 not used for new ICAP requests until it is time to refresh its
8230 A negative value disables the limit. Without the limit, an ICAP
8231 service will not be considered down due to connectivity failures
8232 between ICAP OPTIONS requests.
8234 Squid forgets ICAP service failures older than the specified
8235 value of memory-depth. The memory fading algorithm
8236 is approximate because Squid does not remember individual
8237 errors but groups them instead, splitting the option
8238 value into ten time slots of equal length.
8240 When memory-depth is 0 and by default this option has no
8241 effect on service failure expiration.
8243 Squid always forgets failures when updating service settings
8244 using an ICAP OPTIONS transaction, regardless of this option
8248 # suspend service usage after 10 failures in 5 seconds:
8249 icap_service_failure_limit 10 in 5 seconds
8252 NAME: icap_service_revival_delay
8255 LOC: Adaptation::Icap::TheConfig.service_revival_delay
8258 The delay specifies the number of seconds to wait after an ICAP
8259 OPTIONS request failure before requesting the options again. The
8260 failed ICAP service is considered "down" until fresh OPTIONS are
8263 The actual delay cannot be smaller than the hardcoded minimum
8264 delay of 30 seconds.
8267 NAME: icap_preview_enable
8271 LOC: Adaptation::Icap::TheConfig.preview_enable
8274 The ICAP Preview feature allows the ICAP server to handle the
8275 HTTP message by looking only at the beginning of the message body
8276 or even without receiving the body at all. In some environments,
8277 previews greatly speedup ICAP processing.
8279 During an ICAP OPTIONS transaction, the server may tell Squid what
8280 HTTP messages should be previewed and how big the preview should be.
8281 Squid will not use Preview if the server did not request one.
8283 To disable ICAP Preview for all ICAP services, regardless of
8284 individual ICAP server OPTIONS responses, set this option to "off".
8286 icap_preview_enable off
8289 NAME: icap_preview_size
8292 LOC: Adaptation::Icap::TheConfig.preview_size
8294 DEFAULT_DOC: No preview sent.
8296 The default size of preview data to be sent to the ICAP server.
8297 This value might be overwritten on a per server basis by OPTIONS requests.
8300 NAME: icap_206_enable
8304 LOC: Adaptation::Icap::TheConfig.allow206_enable
8307 206 (Partial Content) responses is an ICAP extension that allows the
8308 ICAP agents to optionally combine adapted and original HTTP message
8309 content. The decision to combine is postponed until the end of the
8310 ICAP response. Squid supports Partial Content extension by default.
8312 Activation of the Partial Content extension is negotiated with each
8313 ICAP service during OPTIONS exchange. Most ICAP servers should handle
8314 negotation correctly even if they do not support the extension, but
8315 some might fail. To disable Partial Content support for all ICAP
8316 services and to avoid any negotiation, set this option to "off".
8322 NAME: icap_default_options_ttl
8325 LOC: Adaptation::Icap::TheConfig.default_options_ttl
8328 The default TTL value for ICAP OPTIONS responses that don't have
8329 an Options-TTL header.
8332 NAME: icap_persistent_connections
8336 LOC: Adaptation::Icap::TheConfig.reuse_connections
8339 Whether or not Squid should use persistent connections to
8343 NAME: adaptation_send_client_ip icap_send_client_ip
8345 IFDEF: USE_ADAPTATION
8347 LOC: Adaptation::Config::send_client_ip
8350 If enabled, Squid shares HTTP client IP information with adaptation
8351 services. For ICAP, Squid adds the X-Client-IP header to ICAP requests.
8352 For eCAP, Squid sets the libecap::metaClientIp transaction option.
8354 See also: adaptation_uses_indirect_client
8357 NAME: adaptation_send_username icap_send_client_username
8359 IFDEF: USE_ADAPTATION
8361 LOC: Adaptation::Config::send_username
8364 This sends authenticated HTTP client username (if available) to
8365 the adaptation service.
8367 For ICAP, the username value is encoded based on the
8368 icap_client_username_encode option and is sent using the header
8369 specified by the icap_client_username_header option.
8372 NAME: icap_client_username_header
8375 LOC: Adaptation::Icap::TheConfig.client_username_header
8376 DEFAULT: X-Client-Username
8378 ICAP request header name to use for adaptation_send_username.
8381 NAME: icap_client_username_encode
8385 LOC: Adaptation::Icap::TheConfig.client_username_encode
8388 Whether to base64 encode the authenticated client username.
8392 TYPE: icap_service_type
8394 LOC: Adaptation::Icap::TheConfig
8397 Defines a single ICAP service using the following format:
8399 icap_service id vectoring_point uri [option ...]
8402 an opaque identifier or name which is used to direct traffic to
8403 this specific service. Must be unique among all adaptation
8404 services in squid.conf.
8406 vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
8407 This specifies at which point of transaction processing the
8408 ICAP service should be activated. *_postcache vectoring points
8409 are not yet supported.
8411 uri: icap://servername:port/servicepath
8412 ICAP server and service location.
8413 icaps://servername:port/servicepath
8414 The "icap:" URI scheme is used for traditional ICAP server and
8415 service location (default port is 1344, connections are not
8416 encrypted). The "icaps:" URI scheme is for Secure ICAP
8417 services that use SSL/TLS-encrypted ICAP connections (by
8418 default, on port 11344).
8420 ICAP does not allow a single service to handle both REQMOD and RESPMOD
8421 transactions. Squid does not enforce that requirement. You can specify
8422 services with the same service_url and different vectoring_points. You
8423 can even specify multiple identical services as long as their
8424 service_names differ.
8426 To activate a service, use the adaptation_access directive. To group
8427 services, use adaptation_service_chain and adaptation_service_set.
8429 Service options are separated by white space. ICAP services support
8430 the following name=value options:
8433 If set to 'on' or '1', the ICAP service is treated as
8434 optional. If the service cannot be reached or malfunctions,
8435 Squid will try to ignore any errors and process the message as
8436 if the service was not enabled. No all ICAP errors can be
8437 bypassed. If set to 0, the ICAP service is treated as
8438 essential and all ICAP errors will result in an error page
8439 returned to the HTTP client.
8441 Bypass is off by default: services are treated as essential.
8444 If set to 'on' or '1', the ICAP service is allowed to
8445 dynamically change the current message adaptation plan by
8446 returning a chain of services to be used next. The services
8447 are specified using the X-Next-Services ICAP response header
8448 value, formatted as a comma-separated list of service names.
8449 Each named service should be configured in squid.conf. Other
8450 services are ignored. An empty X-Next-Services value results
8451 in an empty plan which ends the current adaptation.
8453 Dynamic adaptation plan may cross or cover multiple supported
8454 vectoring points in their natural processing order.
8456 Routing is not allowed by default: the ICAP X-Next-Services
8457 response header is ignored.
8460 Only has effect on split-stack systems. The default on those systems
8461 is to use IPv4-only connections. When set to 'on' this option will
8462 make Squid use IPv6-only connections to contact this ICAP service.
8464 on-overload=block|bypass|wait|force
8465 If the service Max-Connections limit has been reached, do
8466 one of the following for each new ICAP transaction:
8467 * block: send an HTTP error response to the client
8468 * bypass: ignore the "over-connected" ICAP service
8469 * wait: wait (in a FIFO queue) for an ICAP connection slot
8470 * force: proceed, ignoring the Max-Connections limit
8472 In SMP mode with N workers, each worker assumes the service
8473 connection limit is Max-Connections/N, even though not all
8474 workers may use a given service.
8476 The default value is "bypass" if service is bypassable,
8477 otherwise it is set to "wait".
8481 Use the given number as the Max-Connections limit, regardless
8482 of the Max-Connections value given by the service, if any.
8484 ==== SSL / ICAPS / TLS OPTIONS ====
8486 These options are used for Secure ICAP (icaps://....) services only.
8488 sslcert=/path/to/ssl/certificate
8489 A client SSL certificate to use when connecting to
8492 sslkey=/path/to/ssl/key
8493 The private SSL key corresponding to sslcert above.
8494 If 'sslkey' is not specified 'sslcert' is assumed to
8495 reference a combined file containing both the
8496 certificate and the key.
8498 sslcipher=... The list of valid SSL ciphers to use when connecting
8499 to this icap server.
8502 The minimum TLS protocol version to permit. To control
8503 SSLv3 use the ssloptions= parameter.
8504 Supported Values: 1.0 (default), 1.1, 1.2
8506 ssloptions=... Specify various SSL implementation options:
8508 NO_SSLv3 Disallow the use of SSLv3
8509 NO_TLSv1 Disallow the use of TLSv1.0
8510 NO_TLSv1_1 Disallow the use of TLSv1.1
8511 NO_TLSv1_2 Disallow the use of TLSv1.2
8513 Always create a new key when using
8514 temporary/ephemeral DH key exchanges
8515 ALL Enable various bug workarounds
8516 suggested as "harmless" by OpenSSL
8517 Be warned that this reduces SSL/TLS
8518 strength to some attacks.
8520 See the OpenSSL SSL_CTX_set_options documentation for a
8523 sslcafile=... A file containing additional CA certificates to use
8524 when verifying the icap server certificate.
8526 sslcapath=... A directory containing additional CA certificates to
8527 use when verifying the icap server certificate.
8529 sslcrlfile=... A certificate revocation list file to use when
8530 verifying the icap server certificate.
8532 sslflags=... Specify various flags modifying the SSL implementation:
8535 Accept certificates even if they fail to
8538 Don't use the default CA list built in
8541 Don't verify the icap server certificate
8542 matches the server name
8544 ssldomain= The icap server name as advertised in it's certificate.
8545 Used for verifying the correctness of the received icap
8546 server certificate. If not specified the icap server
8547 hostname extracted from ICAP URI will be used.
8549 Older icap_service format without optional named parameters is
8550 deprecated but supported for backward compatibility.
8553 icap_service svcBlocker reqmod_precache icap://icap1.mydomain.net:1344/reqmod bypass=0
8554 icap_service svcLogger reqmod_precache icaps://icap2.mydomain.net:11344/reqmod routing=on
8558 TYPE: icap_class_type
8563 This deprecated option was documented to define an ICAP service
8564 chain, even though it actually defined a set of similar, redundant
8565 services, and the chains were not supported.
8567 To define a set of redundant services, please use the
8568 adaptation_service_set directive. For service chains, use
8569 adaptation_service_chain.
8573 TYPE: icap_access_type
8578 This option is deprecated. Please use adaptation_access, which
8579 has the same ICAP functionality, but comes with better
8580 documentation, and eCAP support.
8585 -----------------------------------------------------------------------------
8592 LOC: Adaptation::Ecap::TheConfig.onoff
8595 Controls whether eCAP support is enabled.
8599 TYPE: ecap_service_type
8601 LOC: Adaptation::Ecap::TheConfig
8604 Defines a single eCAP service
8606 ecap_service id vectoring_point uri [option ...]
8609 an opaque identifier or name which is used to direct traffic to
8610 this specific service. Must be unique among all adaptation
8611 services in squid.conf.
8613 vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
8614 This specifies at which point of transaction processing the
8615 eCAP service should be activated. *_postcache vectoring points
8616 are not yet supported.
8618 uri: ecap://vendor/service_name?custom&cgi=style¶meters=optional
8619 Squid uses the eCAP service URI to match this configuration
8620 line with one of the dynamically loaded services. Each loaded
8621 eCAP service must have a unique URI. Obtain the right URI from
8622 the service provider.
8624 To activate a service, use the adaptation_access directive. To group
8625 services, use adaptation_service_chain and adaptation_service_set.
8627 Service options are separated by white space. eCAP services support
8628 the following name=value options:
8631 If set to 'on' or '1', the eCAP service is treated as optional.
8632 If the service cannot be reached or malfunctions, Squid will try
8633 to ignore any errors and process the message as if the service
8634 was not enabled. No all eCAP errors can be bypassed.
8635 If set to 'off' or '0', the eCAP service is treated as essential
8636 and all eCAP errors will result in an error page returned to the
8639 Bypass is off by default: services are treated as essential.
8642 If set to 'on' or '1', the eCAP service is allowed to
8643 dynamically change the current message adaptation plan by
8644 returning a chain of services to be used next.
8646 Dynamic adaptation plan may cross or cover multiple supported
8647 vectoring points in their natural processing order.
8649 Routing is not allowed by default.
8651 Older ecap_service format without optional named parameters is
8652 deprecated but supported for backward compatibility.
8656 ecap_service s1 reqmod_precache ecap://filters.R.us/leakDetector?on_error=block bypass=off
8657 ecap_service s2 respmod_precache ecap://filters.R.us/virusFilter config=/etc/vf.cfg bypass=on
8660 NAME: loadable_modules
8662 IFDEF: USE_LOADABLE_MODULES
8663 LOC: Config.loadable_module_names
8666 Instructs Squid to load the specified dynamic module(s) or activate
8667 preloaded module(s).
8669 loadable_modules @DEFAULT_PREFIX@/lib/MinimalAdapter.so
8673 MESSAGE ADAPTATION OPTIONS
8674 -----------------------------------------------------------------------------
8677 NAME: adaptation_service_set
8678 TYPE: adaptation_service_set_type
8679 IFDEF: USE_ADAPTATION
8684 Configures an ordered set of similar, redundant services. This is
8685 useful when hot standby or backup adaptation servers are available.
8687 adaptation_service_set set_name service_name1 service_name2 ...
8689 The named services are used in the set declaration order. The first
8690 applicable adaptation service from the set is used first. The next
8691 applicable service is tried if and only if the transaction with the
8692 previous service fails and the message waiting to be adapted is still
8695 When adaptation starts, broken services are ignored as if they were
8696 not a part of the set. A broken service is a down optional service.
8698 The services in a set must be attached to the same vectoring point
8699 (e.g., pre-cache) and use the same adaptation method (e.g., REQMOD).
8701 If all services in a set are optional then adaptation failures are
8702 bypassable. If all services in the set are essential, then a
8703 transaction failure with one service may still be retried using
8704 another service from the set, but when all services fail, the master
8705 transaction fails as well.
8707 A set may contain a mix of optional and essential services, but that
8708 is likely to lead to surprising results because broken services become
8709 ignored (see above), making previously bypassable failures fatal.
8710 Technically, it is the bypassability of the last failed service that
8713 See also: adaptation_access adaptation_service_chain
8716 adaptation_service_set svcBlocker urlFilterPrimary urlFilterBackup
8717 adaptation service_set svcLogger loggerLocal loggerRemote
8720 NAME: adaptation_service_chain
8721 TYPE: adaptation_service_chain_type
8722 IFDEF: USE_ADAPTATION
8727 Configures a list of complementary services that will be applied
8728 one-by-one, forming an adaptation chain or pipeline. This is useful
8729 when Squid must perform different adaptations on the same message.
8731 adaptation_service_chain chain_name service_name1 svc_name2 ...
8733 The named services are used in the chain declaration order. The first
8734 applicable adaptation service from the chain is used first. The next
8735 applicable service is applied to the successful adaptation results of
8736 the previous service in the chain.
8738 When adaptation starts, broken services are ignored as if they were
8739 not a part of the chain. A broken service is a down optional service.
8741 Request satisfaction terminates the adaptation chain because Squid
8742 does not currently allow declaration of RESPMOD services at the
8743 "reqmod_precache" vectoring point (see icap_service or ecap_service).
8745 The services in a chain must be attached to the same vectoring point
8746 (e.g., pre-cache) and use the same adaptation method (e.g., REQMOD).
8748 A chain may contain a mix of optional and essential services. If an
8749 essential adaptation fails (or the failure cannot be bypassed for
8750 other reasons), the master transaction fails. Otherwise, the failure
8751 is bypassed as if the failed adaptation service was not in the chain.
8753 See also: adaptation_access adaptation_service_set
8756 adaptation_service_chain svcRequest requestLogger urlFilter leakDetector
8759 NAME: adaptation_access
8760 TYPE: adaptation_access_type
8761 IFDEF: USE_ADAPTATION
8764 DEFAULT_DOC: Allow, unless rules exist in squid.conf.
8766 Sends an HTTP transaction to an ICAP or eCAP adaptation service.
8768 adaptation_access service_name allow|deny [!]aclname...
8769 adaptation_access set_name allow|deny [!]aclname...
8771 At each supported vectoring point, the adaptation_access
8772 statements are processed in the order they appear in this
8773 configuration file. Statements pointing to the following services
8774 are ignored (i.e., skipped without checking their ACL):
8776 - services serving different vectoring points
8777 - "broken-but-bypassable" services
8778 - "up" services configured to ignore such transactions
8779 (e.g., based on the ICAP Transfer-Ignore header).
8781 When a set_name is used, all services in the set are checked
8782 using the same rules, to find the first applicable one. See
8783 adaptation_service_set for details.
8785 If an access list is checked and there is a match, the
8786 processing stops: For an "allow" rule, the corresponding
8787 adaptation service is used for the transaction. For a "deny"
8788 rule, no adaptation service is activated.
8790 It is currently not possible to apply more than one adaptation
8791 service at the same vectoring point to the same HTTP transaction.
8793 See also: icap_service and ecap_service
8796 adaptation_access service_1 allow all
8799 NAME: adaptation_service_iteration_limit
8801 IFDEF: USE_ADAPTATION
8802 LOC: Adaptation::Config::service_iteration_limit
8805 Limits the number of iterations allowed when applying adaptation
8806 services to a message. If your longest adaptation set or chain
8807 may have more than 16 services, increase the limit beyond its
8808 default value of 16. If detecting infinite iteration loops sooner
8809 is critical, make the iteration limit match the actual number
8810 of services in your longest adaptation set or chain.
8812 Infinite adaptation loops are most likely with routing services.
8814 See also: icap_service routing=1
8817 NAME: adaptation_masterx_shared_names
8819 IFDEF: USE_ADAPTATION
8820 LOC: Adaptation::Config::masterx_shared_name
8823 For each master transaction (i.e., the HTTP request and response
8824 sequence, including all related ICAP and eCAP exchanges), Squid
8825 maintains a table of metadata. The table entries are (name, value)
8826 pairs shared among eCAP and ICAP exchanges. The table is destroyed
8827 with the master transaction.
8829 This option specifies the table entry names that Squid must accept
8830 from and forward to the adaptation transactions.
8832 An ICAP REQMOD or RESPMOD transaction may set an entry in the
8833 shared table by returning an ICAP header field with a name
8834 specified in adaptation_masterx_shared_names.
8836 An eCAP REQMOD or RESPMOD transaction may set an entry in the
8837 shared table by implementing the libecap::visitEachOption() API
8838 to provide an option with a name specified in
8839 adaptation_masterx_shared_names.
8841 Squid will store and forward the set entry to subsequent adaptation
8842 transactions within the same master transaction scope.
8844 Only one shared entry name is supported at this time.
8847 # share authentication information among ICAP services
8848 adaptation_masterx_shared_names X-Subscriber-ID
8851 NAME: adaptation_meta
8853 IFDEF: USE_ADAPTATION
8854 LOC: Adaptation::Config::metaHeaders
8857 This option allows Squid administrator to add custom ICAP request
8858 headers or eCAP options to Squid ICAP requests or eCAP transactions.
8859 Use it to pass custom authentication tokens and other
8860 transaction-state related meta information to an ICAP/eCAP service.
8862 The addition of a meta header is ACL-driven:
8863 adaptation_meta name value [!]aclname ...
8865 Processing for a given header name stops after the first ACL list match.
8866 Thus, it is impossible to add two headers with the same name. If no ACL
8867 lists match for a given header name, no such header is added. For
8870 # do not debug transactions except for those that need debugging
8871 adaptation_meta X-Debug 1 needs_debugging
8873 # log all transactions except for those that must remain secret
8874 adaptation_meta X-Log 1 !keep_secret
8876 # mark transactions from users in the "G 1" group
8877 adaptation_meta X-Authenticated-Groups "G 1" authed_as_G1
8879 The "value" parameter may be a regular squid.conf token or a "double
8880 quoted string". Within the quoted string, use backslash (\) to escape
8881 any character, which is currently only useful for escaping backslashes
8882 and double quotes. For example,
8883 "this string has one backslash (\\) and two \"quotes\""
8885 Used adaptation_meta header values may be logged via %note
8886 logformat code. If multiple adaptation_meta headers with the same name
8887 are used during master transaction lifetime, the header values are
8888 logged in the order they were used and duplicate values are ignored
8889 (only the first repeated value will be logged).
8895 LOC: Adaptation::Icap::TheConfig.repeat
8896 DEFAULT_IF_NONE: deny all
8898 This ACL determines which retriable ICAP transactions are
8899 retried. Transactions that received a complete ICAP response
8900 and did not have to consume or produce HTTP bodies to receive
8901 that response are usually retriable.
8903 icap_retry allow|deny [!]aclname ...
8905 Squid automatically retries some ICAP I/O timeouts and errors
8906 due to persistent connection race conditions.
8908 See also: icap_retry_limit
8911 NAME: icap_retry_limit
8914 LOC: Adaptation::Icap::TheConfig.repeat_limit
8916 DEFAULT_DOC: No retries are allowed.
8918 Limits the number of retries allowed.
8920 Communication errors due to persistent connection race
8921 conditions are unavoidable, automatically retried, and do not
8922 count against this limit.
8924 See also: icap_retry
8930 -----------------------------------------------------------------------------
8933 NAME: check_hostnames
8936 LOC: Config.onoff.check_hostnames
8938 For security and stability reasons Squid can check
8939 hostnames for Internet standard RFC compliance. If you want
8940 Squid to perform these checks turn this directive on.
8943 NAME: allow_underscore
8946 LOC: Config.onoff.allow_underscore
8948 Underscore characters is not strictly allowed in Internet hostnames
8949 but nevertheless used by many sites. Set this to off if you want
8950 Squid to be strict about the standard.
8951 This check is performed only when check_hostnames is set to on.
8954 NAME: dns_retransmit_interval
8957 LOC: Config.Timeout.idns_retransmit
8959 Initial retransmit interval for DNS queries. The interval is
8960 doubled each time all configured DNS servers have been tried.
8966 LOC: Config.Timeout.idns_query
8968 DNS Query timeout. If no response is received to a DNS query
8969 within this time all DNS servers for the queried domain
8970 are assumed to be unavailable.
8973 NAME: dns_packet_max
8975 DEFAULT_DOC: EDNS disabled
8977 LOC: Config.dns.packet_max
8979 Maximum number of bytes packet size to advertise via EDNS.
8980 Set to "none" to disable EDNS large packet support.
8982 For legacy reasons DNS UDP replies will default to 512 bytes which
8983 is too small for many responses. EDNS provides a means for Squid to
8984 negotiate receiving larger responses back immediately without having
8985 to failover with repeat requests. Responses larger than this limit
8986 will retain the old behaviour of failover to TCP DNS.
8988 Squid has no real fixed limit internally, but allowing packet sizes
8989 over 1500 bytes requires network jumbogram support and is usually not
8992 WARNING: The RFC also indicates that some older resolvers will reply
8993 with failure of the whole request if the extension is added. Some
8994 resolvers have already been identified which will reply with mangled
8995 EDNS response on occasion. Usually in response to many-KB jumbogram
8996 sizes being advertised by Squid.
8997 Squid will currently treat these both as an unable-to-resolve domain
8998 even if it would be resolvable without EDNS.
9005 DEFAULT_DOC: Search for single-label domain names is disabled.
9006 LOC: Config.onoff.res_defnames
9008 Normally the RES_DEFNAMES resolver option is disabled
9009 (see res_init(3)). This prevents caches in a hierarchy
9010 from interpreting single-component hostnames locally. To allow
9011 Squid to handle single-component names, enable this option.
9014 NAME: dns_multicast_local
9018 DEFAULT_DOC: Search for .local and .arpa names is disabled.
9019 LOC: Config.onoff.dns_mdns
9021 When set to on, Squid sends multicast DNS lookups on the local
9022 network for domains ending in .local and .arpa.
9023 This enables local servers and devices to be contacted in an
9024 ad-hoc or zero-configuration network environment.
9027 NAME: dns_nameservers
9030 DEFAULT_DOC: Use operating system definitions
9031 LOC: Config.dns_nameservers
9033 Use this if you want to specify a list of DNS name servers
9034 (IP addresses) to use instead of those given in your
9035 /etc/resolv.conf file.
9037 On Windows platforms, if no value is specified here or in
9038 the /etc/resolv.conf file, the list of DNS name servers are
9039 taken from the Windows registry, both static and dynamic DHCP
9040 configurations are supported.
9042 Example: dns_nameservers 10.0.0.1 192.172.0.4
9047 DEFAULT: @DEFAULT_HOSTS@
9048 LOC: Config.etcHostsPath
9050 Location of the host-local IP name-address associations
9051 database. Most Operating Systems have such a file on different
9053 - Un*X & Linux: /etc/hosts
9054 - Windows NT/2000: %SystemRoot%\system32\drivers\etc\hosts
9055 (%SystemRoot% value install default is c:\winnt)
9056 - Windows XP/2003: %SystemRoot%\system32\drivers\etc\hosts
9057 (%SystemRoot% value install default is c:\windows)
9058 - Windows 9x/Me: %windir%\hosts
9059 (%windir% value is usually c:\windows)
9060 - Cygwin: /etc/hosts
9062 The file contains newline-separated definitions, in the
9063 form ip_address_in_dotted_form name [name ...] names are
9064 whitespace-separated. Lines beginning with an hash (#)
9065 character are comments.
9067 The file is checked at startup and upon configuration.
9068 If set to 'none', it won't be checked.
9069 If append_domain is used, that domain will be added to
9070 domain-local (i.e. not containing any dot character) host
9076 LOC: Config.appendDomain
9078 DEFAULT_DOC: Use operating system definitions
9080 Appends local domain name to hostnames without any dots in
9081 them. append_domain must begin with a period.
9083 Be warned there are now Internet names with no dots in
9084 them using only top-domain names, so setting this may
9085 cause some Internet sites to become unavailable.
9088 append_domain .yourdomain.com
9091 NAME: ignore_unknown_nameservers
9093 LOC: Config.onoff.ignore_unknown_nameservers
9096 By default Squid checks that DNS responses are received
9097 from the same IP addresses they are sent to. If they
9098 don't match, Squid ignores the response and writes a warning
9099 message to cache.log. You can allow responses from unknown
9100 nameservers by setting this option to 'off'.
9106 LOC: Config.dns.v4_first
9108 With the IPv6 Internet being as fast or faster than IPv4 Internet
9109 for most networks Squid prefers to contact websites over IPv6.
9111 This option reverses the order of preference to make Squid contact
9112 dual-stack websites over IPv4 first. Squid will still perform both
9113 IPv6 and IPv4 DNS lookups before connecting.
9116 This option will restrict the situations under which IPv6
9117 connectivity is used (and tested). Hiding network problems
9118 which would otherwise be detected and warned about.
9122 COMMENT: (number of entries)
9125 LOC: Config.ipcache.size
9127 Maximum number of DNS IP cache entries.
9134 LOC: Config.ipcache.low
9141 LOC: Config.ipcache.high
9143 The size, low-, and high-water marks for the IP cache.
9146 NAME: fqdncache_size
9147 COMMENT: (number of entries)
9150 LOC: Config.fqdncache.size
9152 Maximum number of FQDN cache entries.
9157 -----------------------------------------------------------------------------
9160 NAME: configuration_includes_quoted_values
9162 TYPE: configuration_includes_quoted_values
9164 LOC: ConfigParser::RecognizeQuotedValues
9166 If set, Squid will recognize each "quoted string" after a configuration
9167 directive as a single parameter. The quotes are stripped before the
9168 parameter value is interpreted or used.
9169 See "Values with spaces, quotes, and other special characters"
9170 section for more details.
9177 LOC: Config.onoff.mem_pools
9179 If set, Squid will keep pools of allocated (but unused) memory
9180 available for future use. If memory is a premium on your
9181 system and you believe your malloc library outperforms Squid
9182 routines, disable this.
9185 NAME: memory_pools_limit
9189 LOC: Config.MemPools.limit
9191 Used only with memory_pools on:
9192 memory_pools_limit 50 MB
9194 If set to a non-zero value, Squid will keep at most the specified
9195 limit of allocated (but unused) memory in memory pools. All free()
9196 requests that exceed this limit will be handled by your malloc
9197 library. Squid does not pre-allocate any memory, just safe-keeps
9198 objects that otherwise would be free()d. Thus, it is safe to set
9199 memory_pools_limit to a reasonably high value even if your
9200 configuration will use less memory.
9202 If set to none, Squid will keep all memory it can. That is, there
9203 will be no limit on the total amount of memory used for safe-keeping.
9205 To disable memory allocation optimization, do not set
9206 memory_pools_limit to 0 or none. Set memory_pools to "off" instead.
9208 An overhead for maintaining memory pools is not taken into account
9209 when the limit is checked. This overhead is close to four bytes per
9210 object kept. However, pools may actually _save_ memory because of
9211 reduced memory thrashing in your malloc library.
9215 COMMENT: on|off|transparent|truncate|delete
9218 LOC: opt_forwarded_for
9220 If set to "on", Squid will append your client's IP address
9221 in the HTTP requests it forwards. By default it looks like:
9223 X-Forwarded-For: 192.1.2.3
9225 If set to "off", it will appear as
9227 X-Forwarded-For: unknown
9229 If set to "transparent", Squid will not alter the
9230 X-Forwarded-For header in any way.
9232 If set to "delete", Squid will delete the entire
9233 X-Forwarded-For header.
9235 If set to "truncate", Squid will remove all existing
9236 X-Forwarded-For entries, and place the client IP as the sole entry.
9239 NAME: cachemgr_passwd
9240 TYPE: cachemgrpasswd
9242 DEFAULT_DOC: No password. Actions which require password are denied.
9243 LOC: Config.passwd_list
9245 Specify passwords for cachemgr operations.
9247 Usage: cachemgr_passwd password action action ...
9249 Some valid actions are (see cache manager menu for a full list):
9289 * Indicates actions which will not be performed without a
9290 valid password, others can be performed if not listed here.
9292 To disable an action, set the password to "disable".
9293 To allow performing an action without a password, set the
9296 Use the keyword "all" to set the same password for all actions.
9299 cachemgr_passwd secret shutdown
9300 cachemgr_passwd lesssssssecret info stats/objects
9301 cachemgr_passwd disable all
9308 LOC: Config.onoff.client_db
9310 If you want to disable collecting per-client statistics,
9311 turn off client_db here.
9314 NAME: refresh_all_ims
9318 LOC: Config.onoff.refresh_all_ims
9320 When you enable this option, squid will always check
9321 the origin server for an update when a client sends an
9322 If-Modified-Since request. Many browsers use IMS
9323 requests when the user requests a reload, and this
9324 ensures those clients receive the latest version.
9326 By default (off), squid may return a Not Modified response
9327 based on the age of the cached version.
9330 NAME: reload_into_ims
9331 IFDEF: USE_HTTP_VIOLATIONS
9335 LOC: Config.onoff.reload_into_ims
9337 When you enable this option, client no-cache or ``reload''
9338 requests will be changed to If-Modified-Since requests.
9339 Doing this VIOLATES the HTTP standard. Enabling this
9340 feature could make you liable for problems which it
9343 see also refresh_pattern for a more selective approach.
9346 NAME: connect_retries
9348 LOC: Config.connect_retries
9350 DEFAULT_DOC: Do not retry failed connections.
9352 This sets the maximum number of connection attempts made for each
9353 TCP connection. The connect_retries attempts must all still
9354 complete within the connection timeout period.
9356 The default is not to re-try if the first connection attempt fails.
9357 The (not recommended) maximum is 10 tries.
9359 A warning message will be generated if it is set to a too-high
9360 value and the configured value will be over-ridden.
9362 Note: These re-tries are in addition to forward_max_tries
9363 which limit how many different addresses may be tried to find
9367 NAME: retry_on_error
9369 LOC: Config.retry.onerror
9372 If set to ON Squid will automatically retry requests when
9373 receiving an error response with status 403 (Forbidden),
9374 500 (Internal Error), 501 or 503 (Service not available).
9375 Status 502 and 504 (Gateway errors) are always retried.
9377 This is mainly useful if you are in a complex cache hierarchy to
9378 work around access control errors.
9380 NOTE: This retry will attempt to find another working destination.
9381 Which is different from the server which just failed.
9384 NAME: as_whois_server
9386 LOC: Config.as_whois_server
9387 DEFAULT: whois.ra.net
9389 WHOIS server to query for AS numbers. NOTE: AS numbers are
9390 queried only when Squid starts up, not for every request.
9395 LOC: Config.onoff.offline
9398 Enable this option and Squid will never try to validate cached
9402 NAME: uri_whitespace
9403 TYPE: uri_whitespace
9404 LOC: Config.uri_whitespace
9407 What to do with requests that have whitespace characters in the
9410 strip: The whitespace characters are stripped out of the URL.
9411 This is the behavior recommended by RFC2396 and RFC3986
9412 for tolerant handling of generic URI.
9413 NOTE: This is one difference between generic URI and HTTP URLs.
9415 deny: The request is denied. The user receives an "Invalid
9417 This is the behaviour recommended by RFC2616 for safe
9418 handling of HTTP request URL.
9420 allow: The request is allowed and the URI is not changed. The
9421 whitespace characters remain in the URI. Note the
9422 whitespace is passed to redirector processes if they
9424 Note this may be considered a violation of RFC2616
9425 request parsing where whitespace is prohibited in the
9428 encode: The request is allowed and the whitespace characters are
9429 encoded according to RFC1738.
9431 chop: The request is allowed and the URI is chopped at the
9435 NOTE the current Squid implementation of encode and chop violates
9436 RFC2616 by not using a 301 redirect after altering the URL.
9441 LOC: Config.chroot_dir
9444 Specifies a directory where Squid should do a chroot() while
9445 initializing. This also causes Squid to fully drop root
9446 privileges after initializing. This means, for example, if you
9447 use a HTTP port less than 1024 and try to reconfigure, you may
9448 get an error saying that Squid can not open the port.
9451 NAME: balance_on_multiple_ip
9453 LOC: Config.onoff.balance_on_multiple_ip
9456 Modern IP resolvers in squid sort lookup results by preferred access.
9457 By default squid will use these IP in order and only rotates to
9458 the next listed when the most preffered fails.
9460 Some load balancing servers based on round robin DNS have been
9461 found not to preserve user session state across requests
9462 to different IP addresses.
9464 Enabling this directive Squid rotates IP's per request.
9467 NAME: pipeline_prefetch
9468 TYPE: pipelinePrefetch
9469 LOC: Config.pipeline_max_prefetch
9471 DEFAULT_DOC: Do not pre-parse pipelined requests.
9473 HTTP clients may send a pipeline of 1+N requests to Squid using a
9474 single connection, without waiting for Squid to respond to the first
9475 of those requests. This option limits the number of concurrent
9476 requests Squid will try to handle in parallel. If set to N, Squid
9477 will try to receive and process up to 1+N requests on the same
9478 connection concurrently.
9480 Defaults to 0 (off) for bandwidth management and access logging
9483 NOTE: pipelining requires persistent connections to clients.
9485 WARNING: pipelining breaks NTLM and Negotiate/Kerberos authentication.
9488 NAME: high_response_time_warning
9491 LOC: Config.warnings.high_rptm
9493 DEFAULT_DOC: disabled.
9495 If the one-minute median response time exceeds this value,
9496 Squid prints a WARNING with debug level 0 to get the
9497 administrators attention. The value is in milliseconds.
9500 NAME: high_page_fault_warning
9502 LOC: Config.warnings.high_pf
9504 DEFAULT_DOC: disabled.
9506 If the one-minute average page fault rate exceeds this
9507 value, Squid prints a WARNING with debug level 0 to get
9508 the administrators attention. The value is in page faults
9512 NAME: high_memory_warning
9514 LOC: Config.warnings.high_memory
9515 IFDEF: HAVE_MSTATS&&HAVE_GNUMALLOC_H
9517 DEFAULT_DOC: disabled.
9519 If the memory usage (as determined by gnumalloc, if available and used)
9520 exceeds this amount, Squid prints a WARNING with debug level 0 to get
9521 the administrators attention.
9523 # TODO: link high_memory_warning to mempools?
9525 NAME: sleep_after_fork
9526 COMMENT: (microseconds)
9528 LOC: Config.sleep_after_fork
9531 When this is set to a non-zero value, the main Squid process
9532 sleeps the specified number of microseconds after a fork()
9533 system call. This sleep may help the situation where your
9534 system reports fork() failures due to lack of (virtual)
9535 memory. Note, however, if you have a lot of child
9536 processes, these sleep delays will add up and your
9537 Squid will not service requests for some amount of time
9538 until all the child processes have been started.
9539 On Windows value less then 1000 (1 milliseconds) are
9543 NAME: windows_ipaddrchangemonitor
9544 IFDEF: _SQUID_WINDOWS_
9548 LOC: Config.onoff.WIN32_IpAddrChangeMonitor
9550 On Windows Squid by default will monitor IP address changes and will
9551 reconfigure itself after any detected event. This is very useful for
9552 proxies connected to internet with dial-up interfaces.
9553 In some cases (a Proxy server acting as VPN gateway is one) it could be
9554 desiderable to disable this behaviour setting this to 'off'.
9555 Note: after changing this, Squid service must be restarted.
9560 IFDEF: USE_SQUID_EUI
9562 LOC: Eui::TheConfig.euiLookup
9564 Whether to lookup the EUI or MAC address of a connected client.
9567 NAME: max_filedescriptors max_filedesc
9570 DEFAULT_DOC: Use operating system limits set by ulimit.
9571 LOC: Config.max_filedescriptors
9573 Reduce the maximum number of filedescriptors supported below
9574 the usual operating system defaults.
9576 Remove from squid.conf to inherit the current ulimit setting.
9578 Note: Changing this requires a restart of Squid. Also
9579 not all I/O types supports large values (eg on Windows).
9582 NAME: force_request_body_continuation
9584 LOC: Config.accessList.forceRequestBodyContinuation
9586 DEFAULT_DOC: Deny, unless rules exist in squid.conf.
9588 This option controls how Squid handles data upload requests from HTTP
9589 and FTP agents that require a "Please Continue" control message response
9590 to actually send the request body to Squid. It is mostly useful in
9591 adaptation environments.
9593 When Squid receives an HTTP request with an "Expect: 100-continue"
9594 header or an FTP upload command (e.g., STOR), Squid normally sends the
9595 request headers or FTP command information to an adaptation service (or
9596 peer) and waits for a response. Most adaptation services (and some
9597 broken peers) may not respond to Squid at that stage because they may
9598 decide to wait for the HTTP request body or FTP data transfer. However,
9599 that request body or data transfer may never come because Squid has not
9600 responded with the HTTP 100 or FTP 150 (Please Continue) control message
9601 to the request sender yet!
9603 An allow match tells Squid to respond with the HTTP 100 or FTP 150
9604 (Please Continue) control message on its own, before forwarding the
9605 request to an adaptation service or peer. Such a response usually forces
9606 the request sender to proceed with sending the body. A deny match tells
9607 Squid to delay that control response until the origin server confirms
9608 that the request body is needed. Delaying is the default behavior.
projects / thirdparty / squid.git / blob