· 9 years ago · Feb 23, 2017, 07:26 PM
1# WELCOME TO SQUID 3.4.8
2# ----------------------------
3#
4# This is the documentation for the Squid configuration file.
5# This documentation can also be found online at:
6# http://www.squid-cache.org/Doc/config/
7#
8# You may wish to look at the Squid home page and wiki for the
9# FAQ and other documentation:
10# http://www.squid-cache.org/
11# http://wiki.squid-cache.org/SquidFaq
12# http://wiki.squid-cache.org/ConfigExamples
13#
14# This documentation shows what the defaults for various directives
15# happen to be. If you don't need to change the default, you should
16# leave the line out of your squid.conf in most cases.
17#
18# In some cases "none" refers to no default setting at all,
19# while in other cases it refers to the value of the option
20# - the comments for that keyword indicate if this is the case.
21#
22
23# Configuration options can be included using the "include" directive.
24# Include takes a list of files to include. Quoting and wildcards are
25# supported.
26#
27# For example,
28#
29# include /path/to/included/file/squid.acl.config
30#
31# Includes can be nested up to a hard-coded depth of 16 levels.
32# This arbitrary restriction is to prevent recursive include references
33# from causing Squid entering an infinite loop whilst trying to load
34# configuration files.
35#
36# Values with byte units
37#
38# Squid accepts size units on some size related directives. All
39# such directives are documented with a default value displaying
40# a unit.
41#
42# Units accepted by Squid are:
43# bytes - byte
44# KB - Kilobyte (1024 bytes)
45# MB - Megabyte
46# GB - Gigabyte
47#
48# Values with spaces, quotes, and other special characters
49#
50# Squid supports directive parameters with spaces, quotes, and other
51# special characters. Surround such parameters with "double quotes". Use
52# the configuration_includes_quoted_values directive to enable or
53# disable that support.
54#
55# For example;
56#
57# configuration_includes_quoted_values on
58# acl group external groupCheck Administrators "Internet Users" Guest
59# configuration_includes_quoted_values off
60#
61#
62# Conditional configuration
63#
64# If-statements can be used to make configuration directives
65# depend on conditions:
66#
67# if <CONDITION>
68# ... regular configuration directives ...
69# [else
70# ... regular configuration directives ...]
71# endif
72#
73# The else part is optional. The keywords "if", "else", and "endif"
74# must be typed on their own lines, as if they were regular
75# configuration directives.
76#
77# NOTE: An else-if condition is not supported.
78#
79# These individual conditions types are supported:
80#
81# true
82# Always evaluates to true.
83# false
84# Always evaluates to false.
85# <integer> = <integer>
86# Equality comparison of two integer numbers.
87#
88#
89# SMP-Related Macros
90#
91# The following SMP-related preprocessor macros can be used.
92#
93# ${process_name} expands to the current Squid process "name"
94# (e.g., squid1, squid2, or cache1).
95#
96# ${process_number} expands to the current Squid process
97# identifier, which is an integer number (e.g., 1, 2, 3) unique
98# across all Squid processes.
99
100# TAG: broken_vary_encoding
101# This option is not yet supported by Squid-3.
102#Default:
103# none
104
105# TAG: cache_vary
106# This option is not yet supported by Squid-3.
107#Default:
108# none
109
110# TAG: collapsed_forwarding
111# This option is not yet supported by Squid-3. see http://bugs.squid-cache.org/show_bug.cgi?id=3495
112#Default:
113# none
114
115# TAG: error_map
116# This option is not yet supported by Squid-3.
117#Default:
118# none
119
120# TAG: external_refresh_check
121# This option is not yet supported by Squid-3.
122#Default:
123# none
124
125# TAG: location_rewrite_program
126# This option is not yet supported by Squid-3.
127#Default:
128# none
129
130# TAG: refresh_stale_hit
131# This option is not yet supported by Squid-3.
132#Default:
133# none
134
135# TAG: ignore_ims_on_miss
136# Remove this line. The HTTP/1.1 feature is now configured by 'cache_miss_revalidate'.
137#Default:
138# none
139
140# TAG: ignore_expect_100
141# Remove this line. The HTTP/1.1 feature is now fully supported by default.
142#Default:
143# none
144
145# TAG: dns_v4_fallback
146# Remove this line. Squid performs a 'Happy Eyeballs' algorithm, the 'fallback' algorithm is no longer relevant.
147#Default:
148# none
149
150# TAG: ftp_list_width
151# Remove this line. Configure FTP page display using the CSS controls in errorpages.css instead.
152#Default:
153# none
154
155# TAG: maximum_single_addr_tries
156# Replaced by connect_retries. The behaviour has changed, please read the documentation before altering.
157#Default:
158# none
159
160# TAG: update_headers
161# Remove this line. The feature is supported by default in storage types where update is implemented.
162#Default:
163# none
164
165# TAG: url_rewrite_concurrency
166# Remove this line. Set the 'concurrency=' option of url_rewrite_children instead.
167#Default:
168# none
169
170# TAG: dns_testnames
171# Remove this line. DNS is no longer tested on startup.
172#Default:
173# none
174
175# TAG: extension_methods
176# Remove this line. All valid methods for HTTP are accepted by default.
177#Default:
178# none
179
180# TAG: zero_buffers
181#Default:
182# none
183
184# TAG: incoming_rate
185#Default:
186# none
187
188# TAG: server_http11
189# Remove this line. HTTP/1.1 is supported by default.
190#Default:
191# none
192
193# TAG: upgrade_http0.9
194# Remove this line. ICY/1.0 streaming protocol is supported by default.
195#Default:
196# none
197
198# TAG: zph_local
199# Alter these entries. Use the qos_flows directive instead.
200#Default:
201# none
202
203# TAG: header_access
204# Since squid-3.0 replace with request_header_access or reply_header_access
205# depending on whether you wish to match client requests or server replies.
206#Default:
207# none
208
209# TAG: httpd_accel_no_pmtu_disc
210# Since squid-3.0 use the 'disable-pmtu-discovery' flag on http_port instead.
211#Default:
212# none
213
214# TAG: wais_relay_host
215# Replace this line with 'cache_peer' configuration.
216#Default:
217# none
218
219# TAG: wais_relay_port
220# Replace this line with 'cache_peer' configuration.
221#Default:
222# none
223
224# OPTIONS FOR AUTHENTICATION
225# -----------------------------------------------------------------------------
226
227# TAG: auth_param
228# This is used to define parameters for the various authentication
229# schemes supported by Squid.
230#
231# format: auth_param scheme parameter [setting]
232#
233# The order in which authentication schemes are presented to the client is
234# dependent on the order the scheme first appears in config file. IE
235# has a bug (it's not RFC 2617 compliant) in that it will use the basic
236# scheme if basic is the first entry presented, even if more secure
237# schemes are presented. For now use the order in the recommended
238# settings section below. If other browsers have difficulties (don't
239# recognize the schemes offered even if you are using basic) either
240# put basic first, or disable the other schemes (by commenting out their
241# program entry).
242#
243# Once an authentication scheme is fully configured, it can only be
244# shutdown by shutting squid down and restarting. Changes can be made on
245# the fly and activated with a reconfigure. I.E. You can change to a
246# different helper, but not unconfigure the helper completely.
247#
248# Please note that while this directive defines how Squid processes
249# authentication it does not automatically activate authentication.
250# To use authentication you must in addition make use of ACLs based
251# on login name in http_access (proxy_auth, proxy_auth_regex or
252# external with %LOGIN used in the format tag). The browser will be
253# challenged for authentication on the first such acl encountered
254# in http_access processing and will also be re-challenged for new
255# login credentials if the request is being denied by a proxy_auth
256# type acl.
257#
258# WARNING: authentication can't be used in a transparently intercepting
259# proxy as the client then thinks it is talking to an origin server and
260# not the proxy. This is a limitation of bending the TCP/IP protocol to
261# transparently intercepting port 80, not a limitation in Squid.
262# Ports flagged 'transparent', 'intercept', or 'tproxy' have
263# authentication disabled.
264#
265# === Parameters for the basic scheme follow. ===
266#
267# "program" cmdline
268# Specify the command for the external authenticator. Such a program
269# reads a line containing "username password" and replies with one of
270# three results:
271#
272# OK
273# the user exists.
274#
275# ERR
276# the user does not exist.
277#
278# BH
279# An internal error occurred in the helper, preventing
280# a result being identified.
281#
282# "ERR" and "BH" results may optionally be followed by message="..."
283# containing a description available as %m in the returned error page.
284#
285# If you use an authenticator, make sure you have 1 acl of type
286# proxy_auth.
287#
288# By default, the basic authentication scheme is not used unless a
289# program is specified.
290#
291# If you want to use the traditional NCSA proxy authentication, set
292# this line to something like
293#
294# auth_param basic program /usr/lib/squid3/basic_ncsa_auth /usr/etc/passwd
295#
296# "utf8" on|off
297# HTTP uses iso-latin-1 as character set, while some authentication
298# backends such as LDAP expects UTF-8. If this is set to on Squid will
299# translate the HTTP iso-latin-1 charset to UTF-8 before sending the
300# username & password to the helper.
301#
302# "children" numberofchildren [startup=N] [idle=N] [concurrency=N]
303# The maximum number of authenticator processes to spawn. If you start too few
304# Squid will have to wait for them to process a backlog of credential
305# verifications, slowing it down. When password verifications are
306# done via a (slow) network you are likely to need lots of
307# authenticator processes.
308#
309# The startup= and idle= options permit some skew in the exact amount
310# run. A minimum of startup=N will begin during startup and reconfigure.
311# Squid will start more in groups of up to idle=N in an attempt to meet
312# traffic needs and to keep idle=N free above those traffic needs up to
313# the maximum.
314#
315# The concurrency= option sets the number of concurrent requests the
316# helper can process. The default of 0 is used for helpers who only
317# supports one request at a time. Setting this to a number greater than
318# 0 changes the protocol used to include a channel number first on the
319# request/response line, allowing multiple requests to be sent to the
320# same helper in parallel without waiting for the response.
321# Must not be set unless it's known the helper supports this.
322#
323# auth_param basic children 20 startup=0 idle=1
324#
325# "realm" realmstring
326# Specifies the realm name which is to be reported to the
327# client for the basic proxy authentication scheme (part of
328# the text the user will see when prompted their username and
329# password). There is no default.
330# auth_param basic realm Squid proxy-caching web server
331#
332# "credentialsttl" timetolive
333# Specifies how long squid assumes an externally validated
334# username:password pair is valid for - in other words how
335# often the helper program is called for that user. Set this
336# low to force revalidation with short lived passwords. Note
337# setting this high does not impact your susceptibility
338# to replay attacks unless you are using an one-time password
339# system (such as SecureID). If you are using such a system,
340# you will be vulnerable to replay attacks unless you also
341# use the max_user_ip ACL in an http_access rule.
342#
343# "casesensitive" on|off
344# Specifies if usernames are case sensitive. Most user databases are
345# case insensitive allowing the same username to be spelled using both
346# lower and upper case letters, but some are case sensitive. This
347# makes a big difference for user_max_ip ACL processing and similar.
348# auth_param basic casesensitive off
349#
350# === Parameters for the digest scheme follow ===
351#
352# "program" cmdline
353# Specify the command for the external authenticator. Such
354# a program reads a line containing "username":"realm" and
355# replies with one of three results:
356#
357# OK ha1="..."
358# the user exists. The ha1= key is mandatory and
359# contains the appropriate H(A1) value, hex encoded.
360# See rfc 2616 for the definition of H(A1).
361#
362# ERR
363# the user does not exist.
364#
365# BH
366# An internal error occurred in the helper, preventing
367# a result being identified.
368#
369# "ERR" and "BH" results may optionally be followed by message="..."
370# containing a description available as %m in the returned error page.
371#
372# By default, the digest authentication scheme is not used unless a
373# program is specified.
374#
375# If you want to use a digest authenticator, set this line to
376# something like
377#
378# auth_param digest program /usr/lib/squid3/digest_pw_auth /usr/etc/digpass
379#
380# "utf8" on|off
381# HTTP uses iso-latin-1 as character set, while some authentication
382# backends such as LDAP expects UTF-8. If this is set to on Squid will
383# translate the HTTP iso-latin-1 charset to UTF-8 before sending the
384# username & password to the helper.
385#
386# "children" numberofchildren [startup=N] [idle=N] [concurrency=N]
387# The maximum number of authenticator processes to spawn (default 5).
388# If you start too few Squid will have to wait for them to
389# process a backlog of H(A1) calculations, slowing it down.
390# When the H(A1) calculations are done via a (slow) network
391# you are likely to need lots of authenticator processes.
392#
393# The startup= and idle= options permit some skew in the exact amount
394# run. A minimum of startup=N will begin during startup and reconfigure.
395# Squid will start more in groups of up to idle=N in an attempt to meet
396# traffic needs and to keep idle=N free above those traffic needs up to
397# the maximum.
398#
399# The concurrency= option sets the number of concurrent requests the
400# helper can process. The default of 0 is used for helpers who only
401# supports one request at a time. Setting this to a number greater than
402# 0 changes the protocol used to include a channel number first on the
403# request/response line, allowing multiple requests to be sent to the
404# same helper in parallel without waiting for the response.
405# Must not be set unless it's known the helper supports this.
406#
407# auth_param digest children 20 startup=0 idle=1
408#
409# "realm" realmstring
410# Specifies the realm name which is to be reported to the
411# client for the digest proxy authentication scheme (part of
412# the text the user will see when prompted their username and
413# password). There is no default.
414# auth_param digest realm Squid proxy-caching web server
415#
416# "nonce_garbage_interval" timeinterval
417# Specifies the interval that nonces that have been issued
418# to client_agent's are checked for validity.
419#
420# "nonce_max_duration" timeinterval
421# Specifies the maximum length of time a given nonce will be
422# valid for.
423#
424# "nonce_max_count" number
425# Specifies the maximum number of times a given nonce can be
426# used.
427#
428# "nonce_strictness" on|off
429# Determines if squid requires strict increment-by-1 behavior
430# for nonce counts, or just incrementing (off - for use when
431# user agents generate nonce counts that occasionally miss 1
432# (ie, 1,2,4,6)). Default off.
433#
434# "check_nonce_count" on|off
435# This directive if set to off can disable the nonce count check
436# completely to work around buggy digest qop implementations in
437# certain mainstream browser versions. Default on to check the
438# nonce count to protect from authentication replay attacks.
439#
440# "post_workaround" on|off
441# This is a workaround to certain buggy browsers who sends
442# an incorrect request digest in POST requests when reusing
443# the same nonce as acquired earlier on a GET request.
444#
445# === NTLM scheme options follow ===
446#
447# "program" cmdline
448# Specify the command for the external NTLM authenticator.
449# Such a program reads exchanged NTLMSSP packets with
450# the browser via Squid until authentication is completed.
451# If you use an NTLM authenticator, make sure you have 1 acl
452# of type proxy_auth. By default, the NTLM authenticator program
453# is not used.
454#
455# NOTE: In Debian the ntlm_auth program is distributed in the winbindd package
456# which is required for this auth scheme to work
457#
458# auth_param ntlm program /usr/bin/ntlm_auth
459#
460# "children" numberofchildren [startup=N] [idle=N]
461# The maximum number of authenticator processes to spawn (default 5).
462# If you start too few Squid will have to wait for them to
463# process a backlog of credential verifications, slowing it
464# down. When credential verifications are done via a (slow)
465# network you are likely to need lots of authenticator
466# processes.
467#
468# The startup= and idle= options permit some skew in the exact amount
469# run. A minimum of startup=N will begin during startup and reconfigure.
470# Squid will start more in groups of up to idle=N in an attempt to meet
471# traffic needs and to keep idle=N free above those traffic needs up to
472# the maximum.
473#
474# auth_param ntlm children 20 startup=0 idle=1
475#
476# "keep_alive" on|off
477# If you experience problems with PUT/POST requests when using the
478# Negotiate authentication scheme then you can try setting this to
479# off. This will cause Squid to forcibly close the connection on
480# the initial requests where the browser asks which schemes are
481# supported by the proxy.
482#
483# auth_param ntlm keep_alive on
484#
485# === Options for configuring the NEGOTIATE auth-scheme follow ===
486#
487# "program" cmdline
488# Specify the command for the external Negotiate authenticator.
489# This protocol is used in Microsoft Active-Directory enabled setups with
490# the Microsoft Internet Explorer or Mozilla Firefox browsers.
491# Its main purpose is to exchange credentials with the Squid proxy
492# using the Kerberos mechanisms.
493# If you use a Negotiate authenticator, make sure you have at least
494# one acl of type proxy_auth active. By default, the negotiate
495# authenticator program is not used.
496# The only supported program for this role is the ntlm_auth
497# program distributed as part of Samba, version 4 or later.
498#
499# NOTE: In Debian the ntlm_auth program is distributed in the winbindd package
500# which is required for this auth scheme to work
501#
502# auth_param negotiate program /usr/bin/ntlm_auth --helper-protocol=gss-spnego
503#
504# "children" numberofchildren [startup=N] [idle=N]
505# The maximum number of authenticator processes to spawn (default 5).
506# If you start too few Squid will have to wait for them to
507# process a backlog of credential verifications, slowing it
508# down. When credential verifications are done via a (slow)
509# network you are likely to need lots of authenticator
510# processes.
511#
512# The startup= and idle= options permit some skew in the exact amount
513# run. A minimum of startup=N will begin during startup and reconfigure.
514# Squid will start more in groups of up to idle=N in an attempt to meet
515# traffic needs and to keep idle=N free above those traffic needs up to
516# the maximum.
517#
518# auth_param negotiate children 20 startup=0 idle=1
519#
520# "keep_alive" on|off
521# If you experience problems with PUT/POST requests when using the
522# Negotiate authentication scheme then you can try setting this to
523# off. This will cause Squid to forcibly close the connection on
524# the initial requests where the browser asks which schemes are
525# supported by the proxy.
526#
527# auth_param negotiate keep_alive on
528#
529#
530# Examples:
531#
532##Recommended minimum configuration per scheme:
533##auth_param negotiate program <uncomment and complete this line to activate>
534##auth_param negotiate children 20 startup=0 idle=1
535##auth_param negotiate keep_alive on
536##
537##auth_param ntlm program <uncomment and complete this line to activate>
538##auth_param ntlm children 20 startup=0 idle=1
539##auth_param ntlm keep_alive on
540##
541##auth_param digest program <uncomment and complete this line>
542##auth_param digest children 20 startup=0 idle=1
543##auth_param digest realm Squid proxy-caching web server
544##auth_param digest nonce_garbage_interval 5 minutes
545##auth_param digest nonce_max_duration 30 minutes
546##auth_param digest nonce_max_count 50
547##
548##auth_param basic program <uncomment and complete this line>
549##auth_param basic children 5 startup=5 idle=1
550##auth_param basic realm Squid proxy-caching web server
551##auth_param basic credentialsttl 2 hours
552#Default:
553# none
554
555# TAG: authenticate_cache_garbage_interval
556# The time period between garbage collection across the username cache.
557# This is a trade-off between memory utilization (long intervals - say
558# 2 days) and CPU (short intervals - say 1 minute). Only change if you
559# have good reason to.
560#Default:
561# authenticate_cache_garbage_interval 1 hour
562
563# TAG: authenticate_ttl
564# The time a user & their credentials stay in the logged in
565# user cache since their last request. When the garbage
566# interval passes, all user credentials that have passed their
567# TTL are removed from memory.
568#Default:
569# authenticate_ttl 1 hour
570
571# TAG: authenticate_ip_ttl
572# If you use proxy authentication and the 'max_user_ip' ACL,
573# this directive controls how long Squid remembers the IP
574# addresses associated with each user. Use a small value
575# (e.g., 60 seconds) if your users might change addresses
576# quickly, as is the case with dialup. You might be safe
577# using a larger value (e.g., 2 hours) in a corporate LAN
578# environment with relatively static address assignments.
579#Default:
580# authenticate_ip_ttl 1 second
581
582# ACCESS CONTROLS
583# -----------------------------------------------------------------------------
584
585# TAG: external_acl_type
586# This option defines external acl classes using a helper program
587# to look up the status
588#
589# external_acl_type name [options] FORMAT.. /path/to/helper [helper arguments..]
590#
591# Options:
592#
593# ttl=n TTL in seconds for cached results (defaults to 3600
594# for 1 hour)
595# negative_ttl=n
596# TTL for cached negative lookups (default same
597# as ttl)
598# children-max=n
599# Maximum number of acl helper processes spawned to service
600# external acl lookups of this type. (default 20)
601# children-startup=n
602# Minimum number of acl helper processes to spawn during
603# startup and reconfigure to service external acl lookups
604# of this type. (default 0)
605# children-idle=n
606# Number of acl helper processes to keep ahead of traffic
607# loads. Squid will spawn this many at once whenever load
608# rises above the capabilities of existing processes.
609# Up to the value of children-max. (default 1)
610# concurrency=n concurrency level per process. Only used with helpers
611# capable of processing more than one query at a time.
612# cache=n limit the result cache size, default is 262144.
613# grace=n Percentage remaining of TTL where a refresh of a
614# cached entry should be initiated without needing to
615# wait for a new reply. (default is for no grace period)
616# protocol=2.5 Compatibility mode for Squid-2.5 external acl helpers
617# ipv4 / ipv6 IP protocol used to communicate with this helper.
618# The default is to auto-detect IPv6 and use it when available.
619#
620# FORMAT specifications
621#
622# %LOGIN Authenticated user login name
623# %EXT_USER Username from previous external acl
624# %EXT_LOG Log details from previous external acl
625# %EXT_TAG Tag from previous external acl
626# %IDENT Ident user name
627# %SRC Client IP
628# %SRCPORT Client source port
629# %URI Requested URI
630# %DST Requested host
631# %PROTO Requested protocol
632# %PORT Requested port
633# %PATH Requested URL path
634# %METHOD Request method
635# %MYADDR Squid interface address
636# %MYPORT Squid http_port number
637# %PATH Requested URL-path (including query-string if any)
638# %USER_CERT SSL User certificate in PEM format
639# %USER_CERTCHAIN SSL User certificate chain in PEM format
640# %USER_CERT_xx SSL User certificate subject attribute xx
641# %USER_CA_CERT_xx SSL User certificate issuer attribute xx
642#
643# %>{Header} HTTP request header "Header"
644# %>{Hdr:member}
645# HTTP request header "Hdr" list member "member"
646# %>{Hdr:;member}
647# HTTP request header list member using ; as
648# list separator. ; can be any non-alphanumeric
649# character.
650#
651# %<{Header} HTTP reply header "Header"
652# %<{Hdr:member}
653# HTTP reply header "Hdr" list member "member"
654# %<{Hdr:;member}
655# HTTP reply header list member using ; as
656# list separator. ; can be any non-alphanumeric
657# character.
658#
659# %ACL The name of the ACL being tested.
660# %DATA The ACL arguments. If not used then any arguments
661# is automatically added at the end of the line
662# sent to the helper.
663# NOTE: this will encode the arguments as one token,
664# whereas the default will pass each separately.
665#
666# %% The percent sign. Useful for helpers which need
667# an unchanging input format.
668#
669#
670# General request syntax:
671#
672# [channel-ID] FORMAT-values [acl-values ...]
673#
674#
675# FORMAT-values consists of transaction details expanded with
676# whitespace separation per the config file FORMAT specification
677# using the FORMAT macros listed above.
678#
679# acl-values consists of any string specified in the referencing
680# config 'acl ... external' line. see the "acl external" directive.
681#
682# Request values sent to the helper are URL escaped to protect
683# each value in requests against whitespaces.
684#
685# If using protocol=2.5 then the request sent to the helper is not
686# URL escaped to protect against whitespace.
687#
688# NOTE: protocol=3.0 is deprecated as no longer necessary.
689#
690# When using the concurrency= option the protocol is changed by
691# introducing a query channel tag in front of the request/response.
692# The query channel tag is a number between 0 and concurrency-1.
693# This value must be echoed back unchanged to Squid as the first part
694# of the response relating to its request.
695#
696#
697# The helper receives lines expanded per the above format specification
698# and for each input line returns 1 line starting with OK/ERR/BH result
699# code and optionally followed by additional keywords with more details.
700#
701#
702# General result syntax:
703#
704# [channel-ID] result keyword=value ...
705#
706# Result consists of one of the codes:
707#
708# OK
709# the ACL test produced a match.
710#
711# ERR
712# the ACL test does not produce a match.
713#
714# BH
715# An internal error occurred in the helper, preventing
716# a result being identified.
717#
718# The meaning of 'a match' is determined by your squid.conf
719# access control configuration. See the Squid wiki for details.
720#
721# Defined keywords:
722#
723# user= The users name (login)
724#
725# password= The users password (for login= cache_peer option)
726#
727# message= Message describing the reason for this response.
728# Available as %o in error pages.
729# Useful on (ERR and BH results).
730#
731# tag= Apply a tag to a request. Only sets a tag once,
732# does not alter existing tags.
733#
734# log= String to be logged in access.log. Available as
735# %ea in logformat specifications.
736#
737# Any keywords may be sent on any response whether OK, ERR or BH.
738#
739# All response keyword values need to be a single token with URL
740# escaping, or enclosed in double quotes (") and escaped using \ on
741# any double quotes or \ characters within the value. The wrapping
742# double quotes are removed before the value is interpreted by Squid.
743# \r and \n are also replace by CR and LF.
744#
745# Some example key values:
746#
747# user=John%20Smith
748# user="John Smith"
749# user="J. \"Bob\" Smith"
750#Default:
751# none
752
753# TAG: acl
754# Defining an Access List
755#
756# Every access list definition must begin with an aclname and acltype,
757# followed by either type-specific arguments or a quoted filename that
758# they are read from.
759#
760# acl aclname acltype argument ...
761# acl aclname acltype "file" ...
762#
763# When using "file", the file should contain one item per line.
764#
765# Some acl types supports options which changes their default behaviour.
766# The available options are:
767#
768# -i,+i By default, regular expressions are CASE-SENSITIVE. To make them
769# case-insensitive, use the -i option. To return case-sensitive
770# use the +i option between patterns, or make a new ACL line
771# without -i.
772#
773# -n Disable lookups and address type conversions. If lookup or
774# conversion is required because the parameter type (IP or
775# domain name) does not match the message address type (domain
776# name or IP), then the ACL would immediately declare a mismatch
777# without any warnings or lookups.
778#
779# -- Used to stop processing all options, in the case the first acl
780# value has '-' character as first character (for example the '-'
781# is a valid domain name)
782#
783# Some acl types require suspending the current request in order
784# to access some external data source.
785# Those which do are marked with the tag [slow], those which
786# don't are marked as [fast].
787# See http://wiki.squid-cache.org/SquidFaq/SquidAcl
788# for further information
789#
790# ***** ACL TYPES AVAILABLE *****
791#
792# acl aclname src ip-address/mask ... # clients IP address [fast]
793# acl aclname src addr1-addr2/mask ... # range of addresses [fast]
794# acl aclname dst [-n] ip-address/mask ... # URL host's IP address [slow]
795# acl aclname localip ip-address/mask ... # IP address the client connected to [fast]
796#
797# acl aclname arp mac-address ... (xx:xx:xx:xx:xx:xx notation)
798# # The arp ACL requires the special configure option --enable-arp-acl.
799# # Furthermore, the ARP ACL code is not portable to all operating systems.
800# # It works on Linux, Solaris, Windows, FreeBSD, and some
801# # other *BSD variants.
802# # [fast]
803# #
804# # NOTE: Squid can only determine the MAC address for clients that are on
805# # the same subnet. If the client is on a different subnet,
806# # then Squid cannot find out its MAC address.
807#
808# acl aclname srcdomain .foo.com ...
809# # reverse lookup, from client IP [slow]
810# acl aclname dstdomain [-n] .foo.com ...
811# # Destination server from URL [fast]
812# acl aclname srcdom_regex [-i] \.foo\.com ...
813# # regex matching client name [slow]
814# acl aclname dstdom_regex [-n] [-i] \.foo\.com ...
815# # regex matching server [fast]
816# #
817# # For dstdomain and dstdom_regex a reverse lookup is tried if a IP
818# # based URL is used and no match is found. The name "none" is used
819# # if the reverse lookup fails.
820#
821# acl aclname src_as number ...
822# acl aclname dst_as number ...
823# # [fast]
824# # Except for access control, AS numbers can be used for
825# # routing of requests to specific caches. Here's an
826# # example for routing all requests for AS#1241 and only
827# # those to mycache.mydomain.net:
828# # acl asexample dst_as 1241
829# # cache_peer_access mycache.mydomain.net allow asexample
830# # cache_peer_access mycache_mydomain.net deny all
831#
832# acl aclname peername myPeer ...
833# # [fast]
834# # match against a named cache_peer entry
835# # set unique name= on cache_peer lines for reliable use.
836#
837# acl aclname time [day-abbrevs] [h1:m1-h2:m2]
838# # [fast]
839# # day-abbrevs:
840# # S - Sunday
841# # M - Monday
842# # T - Tuesday
843# # W - Wednesday
844# # H - Thursday
845# # F - Friday
846# # A - Saturday
847# # h1:m1 must be less than h2:m2
848#
849# acl aclname url_regex [-i] ^http:// ...
850# # regex matching on whole URL [fast]
851# acl aclname urllogin [-i] [^a-zA-Z0-9] ...
852# # regex matching on URL login field
853# acl aclname urlpath_regex [-i] \.gif$ ...
854# # regex matching on URL path [fast]
855#
856# acl aclname port 80 70 21 0-1024... # destination TCP port [fast]
857# # ranges are alloed
858# acl aclname localport 3128 ... # TCP port the client connected to [fast]
859# # NP: for interception mode this is usually '80'
860#
861# acl aclname myportname 3128 ... # http(s)_port name [fast]
862#
863# acl aclname proto HTTP FTP ... # request protocol [fast]
864#
865# acl aclname method GET POST ... # HTTP request method [fast]
866#
867# acl aclname http_status 200 301 500- 400-403 ...
868# # status code in reply [fast]
869#
870# acl aclname browser [-i] regexp ...
871# # pattern match on User-Agent header (see also req_header below) [fast]
872#
873# acl aclname referer_regex [-i] regexp ...
874# # pattern match on Referer header [fast]
875# # Referer is highly unreliable, so use with care
876#
877# acl aclname ident username ...
878# acl aclname ident_regex [-i] pattern ...
879# # string match on ident output [slow]
880# # use REQUIRED to accept any non-null ident.
881#
882# acl aclname proxy_auth [-i] username ...
883# acl aclname proxy_auth_regex [-i] pattern ...
884# # perform http authentication challenge to the client and match against
885# # supplied credentials [slow]
886# #
887# # takes a list of allowed usernames.
888# # use REQUIRED to accept any valid username.
889# #
890# # Will use proxy authentication in forward-proxy scenarios, and plain
891# # http authenticaiton in reverse-proxy scenarios
892# #
893# # NOTE: when a Proxy-Authentication header is sent but it is not
894# # needed during ACL checking the username is NOT logged
895# # in access.log.
896# #
897# # NOTE: proxy_auth requires a EXTERNAL authentication program
898# # to check username/password combinations (see
899# # auth_param directive).
900# #
901# # NOTE: proxy_auth can't be used in a transparent/intercepting proxy
902# # as the browser needs to be configured for using a proxy in order
903# # to respond to proxy authentication.
904#
905# acl aclname snmp_community string ...
906# # A community string to limit access to your SNMP Agent [fast]
907# # Example:
908# #
909# # acl snmppublic snmp_community public
910#
911# acl aclname maxconn number
912# # This will be matched when the client's IP address has
913# # more than <number> TCP connections established. [fast]
914# # NOTE: This only measures direct TCP links so X-Forwarded-For
915# # indirect clients are not counted.
916#
917# acl aclname max_user_ip [-s] number
918# # This will be matched when the user attempts to log in from more
919# # than <number> different ip addresses. The authenticate_ip_ttl
920# # parameter controls the timeout on the ip entries. [fast]
921# # If -s is specified the limit is strict, denying browsing
922# # from any further IP addresses until the ttl has expired. Without
923# # -s Squid will just annoy the user by "randomly" denying requests.
924# # (the counter is reset each time the limit is reached and a
925# # request is denied)
926# # NOTE: in acceleration mode or where there is mesh of child proxies,
927# # clients may appear to come from multiple addresses if they are
928# # going through proxy farms, so a limit of 1 may cause user problems.
929#
930# acl aclname random probability
931# # Pseudo-randomly match requests. Based on the probability given.
932# # Probability may be written as a decimal (0.333), fraction (1/3)
933# # or ratio of matches:non-matches (3:5).
934#
935# acl aclname req_mime_type [-i] mime-type ...
936# # regex match against the mime type of the request generated
937# # by the client. Can be used to detect file upload or some
938# # types HTTP tunneling requests [fast]
939# # NOTE: This does NOT match the reply. You cannot use this
940# # to match the returned file type.
941#
942# acl aclname req_header header-name [-i] any\.regex\.here
943# # regex match against any of the known request headers. May be
944# # thought of as a superset of "browser", "referer" and "mime-type"
945# # ACL [fast]
946#
947# acl aclname rep_mime_type [-i] mime-type ...
948# # regex match against the mime type of the reply received by
949# # squid. Can be used to detect file download or some
950# # types HTTP tunneling requests. [fast]
951# # NOTE: This has no effect in http_access rules. It only has
952# # effect in rules that affect the reply data stream such as
953# # http_reply_access.
954#
955# acl aclname rep_header header-name [-i] any\.regex\.here
956# # regex match against any of the known reply headers. May be
957# # thought of as a superset of "browser", "referer" and "mime-type"
958# # ACLs [fast]
959#
960# acl aclname external class_name [arguments...]
961# # external ACL lookup via a helper class defined by the
962# # external_acl_type directive [slow]
963#
964# acl aclname user_cert attribute values...
965# # match against attributes in a user SSL certificate
966# # attribute is one of DN/C/O/CN/L/ST [fast]
967#
968# acl aclname ca_cert attribute values...
969# # match against attributes a users issuing CA SSL certificate
970# # attribute is one of DN/C/O/CN/L/ST [fast]
971#
972# acl aclname ext_user username ...
973# acl aclname ext_user_regex [-i] pattern ...
974# # string match on username returned by external acl helper [slow]
975# # use REQUIRED to accept any non-null user name.
976#
977# acl aclname tag tagvalue ...
978# # string match on tag returned by external acl helper [slow]
979#
980# acl aclname hier_code codename ...
981# # string match against squid hierarchy code(s); [fast]
982# # e.g., DIRECT, PARENT_HIT, NONE, etc.
983# #
984# # NOTE: This has no effect in http_access rules. It only has
985# # effect in rules that affect the reply data stream such as
986# # http_reply_access.
987#
988# acl aclname note name [value ...]
989# # match transaction annotation [fast]
990# # Without values, matches any annotation with a given name.
991# # With value(s), matches any annotation with a given name that
992# # also has one of the given values.
993# # Names and values are compared using a string equality test.
994# # Annotation sources include note and adaptation_meta directives
995# # as well as helper and eCAP responses.
996#
997# acl aclname any-of acl1 acl2 ...
998# # match any one of the acls [fast or slow]
999# # The first matching ACL stops further ACL evaluation.
1000# #
1001# # ACLs from multiple any-of lines with the same name are ORed.
1002# # For example, A = (a1 or a2) or (a3 or a4) can be written as
1003# # acl A any-of a1 a2
1004# # acl A any-of a3 a4
1005# #
1006# # This group ACL is fast if all evaluated ACLs in the group are fast
1007# # and slow otherwise.
1008#
1009# acl aclname all-of acl1 acl2 ...
1010# # match all of the acls [fast or slow]
1011# # The first mismatching ACL stops further ACL evaluation.
1012# #
1013# # ACLs from multiple all-of lines with the same name are ORed.
1014# # For example, B = (b1 and b2) or (b3 and b4) can be written as
1015# # acl B all-of b1 b2
1016# # acl B all-of b3 b4
1017# #
1018# # This group ACL is fast if all evaluated ACLs in the group are fast
1019# # and slow otherwise.
1020#
1021# Examples:
1022# acl macaddress arp 09:00:2b:23:45:67
1023# acl myexample dst_as 1241
1024# acl password proxy_auth REQUIRED
1025# acl fileupload req_mime_type -i ^multipart/form-data$
1026# acl javascript rep_mime_type -i ^application/x-javascript$
1027#
1028#Default:
1029# ACLs all, manager, localhost, and to_localhost are predefined.
1030#
1031#
1032# Recommended minimum configuration:
1033#
1034
1035# Example rule allowing access from your local networks.
1036# Adapt to list your (internal) IP networks from where browsing
1037# should be allowed
1038#acl localnet src 10.0.0.0/8 # RFC1918 possible internal network
1039#acl localnet src 172.16.0.0/12 # RFC1918 possible internal network
1040#acl localnet src 192.168.0.0/16 # RFC1918 possible internal network
1041#acl localnet src fc00::/7 # RFC 4193 local private network range
1042#acl localnet src fe80::/10 # RFC 4291 link-local (directly plugged) machines
1043
1044acl SSL_ports port 443
1045acl Safe_ports port 80 # http
1046acl Safe_ports port 21 # ftp
1047acl Safe_ports port 443 # https
1048acl Safe_ports port 70 # gopher
1049acl Safe_ports port 210 # wais
1050acl Safe_ports port 1025-65535 # unregistered ports
1051acl Safe_ports port 280 # http-mgmt
1052acl Safe_ports port 488 # gss-http
1053acl Safe_ports port 591 # filemaker
1054acl Safe_ports port 777 # multiling http
1055acl Safe_ports port 8080
1056acl CONNECT method CONNECT
1057
1058# TAG: follow_x_forwarded_for
1059# Allowing or Denying the X-Forwarded-For header to be followed to
1060# find the original source of a request.
1061#
1062# Requests may pass through a chain of several other proxies
1063# before reaching us. The X-Forwarded-For header will contain a
1064# comma-separated list of the IP addresses in the chain, with the
1065# rightmost address being the most recent.
1066#
1067# If a request reaches us from a source that is allowed by this
1068# configuration item, then we consult the X-Forwarded-For header
1069# to see where that host received the request from. If the
1070# X-Forwarded-For header contains multiple addresses, we continue
1071# backtracking until we reach an address for which we are not allowed
1072# to follow the X-Forwarded-For header, or until we reach the first
1073# address in the list. For the purpose of ACL used in the
1074# follow_x_forwarded_for directive the src ACL type always matches
1075# the address we are testing and srcdomain matches its rDNS.
1076#
1077# The end result of this process is an IP address that we will
1078# refer to as the indirect client address. This address may
1079# be treated as the client address for access control, ICAP, delay
1080# pools and logging, depending on the acl_uses_indirect_client,
1081# icap_uses_indirect_client, delay_pool_uses_indirect_client,
1082# log_uses_indirect_client and tproxy_uses_indirect_client options.
1083#
1084# This clause only supports fast acl types.
1085# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1086#
1087# SECURITY CONSIDERATIONS:
1088#
1089# Any host for which we follow the X-Forwarded-For header
1090# can place incorrect information in the header, and Squid
1091# will use the incorrect information as if it were the
1092# source address of the request. This may enable remote
1093# hosts to bypass any access control restrictions that are
1094# based on the client's source addresses.
1095#
1096# For example:
1097#
1098# acl localhost src 127.0.0.1
1099# acl my_other_proxy srcdomain .proxy.example.com
1100# follow_x_forwarded_for allow localhost
1101# follow_x_forwarded_for allow my_other_proxy
1102#Default:
1103# X-Forwarded-For header will be ignored.
1104
1105# TAG: acl_uses_indirect_client on|off
1106# Controls whether the indirect client address
1107# (see follow_x_forwarded_for) is used instead of the
1108# direct client address in acl matching.
1109#
1110# NOTE: maxconn ACL considers direct TCP links and indirect
1111# clients will always have zero. So no match.
1112#Default:
1113# acl_uses_indirect_client on
1114
1115# TAG: delay_pool_uses_indirect_client on|off
1116# Controls whether the indirect client address
1117# (see follow_x_forwarded_for) is used instead of the
1118# direct client address in delay pools.
1119#Default:
1120# delay_pool_uses_indirect_client on
1121
1122# TAG: log_uses_indirect_client on|off
1123# Controls whether the indirect client address
1124# (see follow_x_forwarded_for) is used instead of the
1125# direct client address in the access log.
1126#Default:
1127# log_uses_indirect_client on
1128
1129# TAG: tproxy_uses_indirect_client on|off
1130# Controls whether the indirect client address
1131# (see follow_x_forwarded_for) is used instead of the
1132# direct client address when spoofing the outgoing client.
1133#
1134# This has no effect on requests arriving in non-tproxy
1135# mode ports.
1136#
1137# SECURITY WARNING: Usage of this option is dangerous
1138# and should not be used trivially. Correct configuration
1139# of follow_x_forewarded_for with a limited set of trusted
1140# sources is required to prevent abuse of your proxy.
1141#Default:
1142# tproxy_uses_indirect_client off
1143
1144# TAG: spoof_client_ip
1145# Control client IP address spoofing of TPROXY traffic based on
1146# defined access lists.
1147#
1148# spoof_client_ip allow|deny [!]aclname ...
1149#
1150# If there are no "spoof_client_ip" lines present, the default
1151# is to "allow" spoofing of any suitable request.
1152#
1153# Note that the cache_peer "no-tproxy" option overrides this ACL.
1154#
1155# This clause supports fast acl types.
1156# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1157#Default:
1158# Allow spoofing on all TPROXY traffic.
1159
1160# TAG: http_access
1161# Allowing or Denying access based on defined access lists
1162#
1163# Access to the HTTP port:
1164# http_access allow|deny [!]aclname ...
1165#
1166# NOTE on default values:
1167#
1168# If there are no "access" lines present, the default is to deny
1169# the request.
1170#
1171# If none of the "access" lines cause a match, the default is the
1172# opposite of the last line in the list. If the last line was
1173# deny, the default is allow. Conversely, if the last line
1174# is allow, the default will be deny. For these reasons, it is a
1175# good idea to have an "deny all" entry at the end of your access
1176# lists to avoid potential confusion.
1177#
1178# This clause supports both fast and slow acl types.
1179# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1180#
1181#Default:
1182# Deny, unless rules exist in squid.conf.
1183#
1184
1185#
1186# Recommended minimum Access Permission configuration:
1187#
1188# Deny requests to certain unsafe ports
1189http_access allow Safe_ports
1190
1191# Deny CONNECT to other than secure SSL ports
1192#http_access deny CONNECT !SSL_ports
1193
1194# Only allow cachemgr access from localhost
1195http_access allow localhost manager
1196#http_access deny manager
1197
1198# We strongly recommend the following be uncommented to protect innocent
1199# web applications running on the proxy server who think the only
1200# one who can access services on "localhost" is a local user
1201#http_access deny to_localhost
1202
1203#
1204# INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS
1205#
1206
1207# Example rule allowing access from your local networks.
1208# Adapt localnet in the ACL section to list your (internal) IP networks
1209# from where browsing should be allowed
1210#http_access allow localnet
1211http_access allow localhost
1212
1213# And finally deny all other access to this proxy
1214http_access allow all
1215
1216# TAG: adapted_http_access
1217# Allowing or Denying access based on defined access lists
1218#
1219# Essentially identical to http_access, but runs after redirectors
1220# and ICAP/eCAP adaptation. Allowing access control based on their
1221# output.
1222#
1223# If not set then only http_access is used.
1224#Default:
1225# Allow, unless rules exist in squid.conf.
1226
1227# TAG: http_reply_access
1228# Allow replies to client requests. This is complementary to http_access.
1229#
1230# http_reply_access allow|deny [!] aclname ...
1231#
1232# NOTE: if there are no access lines present, the default is to allow
1233# all replies.
1234#
1235# If none of the access lines cause a match the opposite of the
1236# last line will apply. Thus it is good practice to end the rules
1237# with an "allow all" or "deny all" entry.
1238#
1239# This clause supports both fast and slow acl types.
1240# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1241#Default:
1242# Allow, unless rules exist in squid.conf.
1243
1244# TAG: icp_access
1245# Allowing or Denying access to the ICP port based on defined
1246# access lists
1247#
1248# icp_access allow|deny [!]aclname ...
1249#
1250# NOTE: The default if no icp_access lines are present is to
1251# deny all traffic. This default may cause problems with peers
1252# using ICP.
1253#
1254# This clause only supports fast acl types.
1255# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1256#
1257## Allow ICP queries from local networks only
1258##icp_access allow localnet
1259##icp_access deny all
1260#Default:
1261# Deny, unless rules exist in squid.conf.
1262
1263# TAG: htcp_access
1264# Allowing or Denying access to the HTCP port based on defined
1265# access lists
1266#
1267# htcp_access allow|deny [!]aclname ...
1268#
1269# See also htcp_clr_access for details on access control for
1270# cache purge (CLR) HTCP messages.
1271#
1272# NOTE: The default if no htcp_access lines are present is to
1273# deny all traffic. This default may cause problems with peers
1274# using the htcp option.
1275#
1276# This clause only supports fast acl types.
1277# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1278#
1279## Allow HTCP queries from local networks only
1280##htcp_access allow localnet
1281##htcp_access deny all
1282#Default:
1283# Deny, unless rules exist in squid.conf.
1284
1285# TAG: htcp_clr_access
1286# Allowing or Denying access to purge content using HTCP based
1287# on defined access lists.
1288# See htcp_access for details on general HTCP access control.
1289#
1290# htcp_clr_access allow|deny [!]aclname ...
1291#
1292# This clause only supports fast acl types.
1293# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1294#
1295## Allow HTCP CLR requests from trusted peers
1296#acl htcp_clr_peer src 192.0.2.2 2001:DB8::2
1297#htcp_clr_access allow htcp_clr_peer
1298#htcp_clr_access deny all
1299#Default:
1300# Deny, unless rules exist in squid.conf.
1301
1302# TAG: miss_access
1303# Determins whether network access is permitted when satisfying a request.
1304#
1305# For example;
1306# to force your neighbors to use you as a sibling instead of
1307# a parent.
1308#
1309# acl localclients src 192.0.2.0/24 2001:DB8::a:0/64
1310# miss_access deny !localclients
1311# miss_access allow all
1312#
1313# This means only your local clients are allowed to fetch relayed/MISS
1314# replies from the network and all other clients can only fetch cached
1315# objects (HITs).
1316#
1317# The default for this setting allows all clients who passed the
1318# http_access rules to relay via this proxy.
1319#
1320# This clause only supports fast acl types.
1321# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1322#Default:
1323# Allow, unless rules exist in squid.conf.
1324
1325# TAG: ident_lookup_access
1326# A list of ACL elements which, if matched, cause an ident
1327# (RFC 931) lookup to be performed for this request. For
1328# example, you might choose to always perform ident lookups
1329# for your main multi-user Unix boxes, but not for your Macs
1330# and PCs. By default, ident lookups are not performed for
1331# any requests.
1332#
1333# To enable ident lookups for specific client addresses, you
1334# can follow this example:
1335#
1336# acl ident_aware_hosts src 198.168.1.0/24
1337# ident_lookup_access allow ident_aware_hosts
1338# ident_lookup_access deny all
1339#
1340# Only src type ACL checks are fully supported. A srcdomain
1341# ACL might work at times, but it will not always provide
1342# the correct result.
1343#
1344# This clause only supports fast acl types.
1345# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1346#Default:
1347# Unless rules exist in squid.conf, IDENT is not fetched.
1348
1349# TAG: reply_body_max_size size [acl acl...]
1350# This option specifies the maximum size of a reply body. It can be
1351# used to prevent users from downloading very large files, such as
1352# MP3's and movies. When the reply headers are received, the
1353# reply_body_max_size lines are processed, and the first line where
1354# all (if any) listed ACLs are true is used as the maximum body size
1355# for this reply.
1356#
1357# This size is checked twice. First when we get the reply headers,
1358# we check the content-length value. If the content length value exists
1359# and is larger than the allowed size, the request is denied and the
1360# user receives an error message that says "the request or reply
1361# is too large." If there is no content-length, and the reply
1362# size exceeds this limit, the client's connection is just closed
1363# and they will receive a partial reply.
1364#
1365# WARNING: downstream caches probably can not detect a partial reply
1366# if there is no content-length header, so they will cache
1367# partial responses and give them out as hits. You should NOT
1368# use this option if you have downstream caches.
1369#
1370# WARNING: A maximum size smaller than the size of squid's error messages
1371# will cause an infinite loop and crash squid. Ensure that the smallest
1372# non-zero value you use is greater that the maximum header size plus
1373# the size of your largest error page.
1374#
1375# If you set this parameter none (the default), there will be
1376# no limit imposed.
1377#
1378# Configuration Format is:
1379# reply_body_max_size SIZE UNITS [acl ...]
1380# ie.
1381# reply_body_max_size 10 MB
1382#
1383#Default:
1384# No limit is applied.
1385
1386# NETWORK OPTIONS
1387# -----------------------------------------------------------------------------
1388
1389# TAG: http_port
1390# Usage: port [mode] [options]
1391# hostname:port [mode] [options]
1392# 1.2.3.4:port [mode] [options]
1393#
1394# The socket addresses where Squid will listen for HTTP client
1395# requests. You may specify multiple socket addresses.
1396# There are three forms: port alone, hostname with port, and
1397# IP address with port. If you specify a hostname or IP
1398# address, Squid binds the socket to that specific
1399# address. Most likely, you do not need to bind to a specific
1400# address, so you can use the port number alone.
1401#
1402# If you are running Squid in accelerator mode, you
1403# probably want to listen on port 80 also, or instead.
1404#
1405# The -a command line option may be used to specify additional
1406# port(s) where Squid listens for proxy request. Such ports will
1407# be plain proxy ports with no options.
1408#
1409# You may specify multiple socket addresses on multiple lines.
1410#
1411# Modes:
1412#
1413# intercept Support for IP-Layer interception of
1414# outgoing requests without browser settings.
1415# NP: disables authentication and IPv6 on the port.
1416#
1417# tproxy Support Linux TPROXY for spoofing outgoing
1418# connections using the client IP address.
1419# NP: disables authentication and maybe IPv6 on the port.
1420#
1421# accel Accelerator / reverse proxy mode
1422#
1423# ssl-bump For each CONNECT request allowed by ssl_bump ACLs,
1424# establish secure connection with the client and with
1425# the server, decrypt HTTPS messages as they pass through
1426# Squid, and treat them as unencrypted HTTP messages,
1427# becoming the man-in-the-middle.
1428#
1429# The ssl_bump option is required to fully enable
1430# bumping of CONNECT requests.
1431#
1432# Omitting the mode flag causes default forward proxy mode to be used.
1433#
1434#
1435# Accelerator Mode Options:
1436#
1437# defaultsite=domainname
1438# What to use for the Host: header if it is not present
1439# in a request. Determines what site (not origin server)
1440# accelerators should consider the default.
1441#
1442# no-vhost Disable using HTTP/1.1 Host header for virtual domain support.
1443#
1444# protocol= Protocol to reconstruct accelerated requests with.
1445# Defaults to http for http_port and https for
1446# https_port
1447#
1448# vport Virtual host port support. Using the http_port number
1449# instead of the port passed on Host: headers.
1450#
1451# vport=NN Virtual host port support. Using the specified port
1452# number instead of the port passed on Host: headers.
1453#
1454# act-as-origin
1455# Act as if this Squid is the origin server.
1456# This currently means generate new Date: and Expires:
1457# headers on HIT instead of adding Age:.
1458#
1459# ignore-cc Ignore request Cache-Control headers.
1460#
1461# WARNING: This option violates HTTP specifications if
1462# used in non-accelerator setups.
1463#
1464# allow-direct Allow direct forwarding in accelerator mode. Normally
1465# accelerated requests are denied direct forwarding as if
1466# never_direct was used.
1467#
1468# WARNING: this option opens accelerator mode to security
1469# vulnerabilities usually only affecting in interception
1470# mode. Make sure to protect forwarding with suitable
1471# http_access rules when using this.
1472#
1473#
1474# SSL Bump Mode Options:
1475# In addition to these options ssl-bump requires TLS/SSL options.
1476#
1477# generate-host-certificates[=<on|off>]
1478# Dynamically create SSL server certificates for the
1479# destination hosts of bumped CONNECT requests.When
1480# enabled, the cert and key options are used to sign
1481# generated certificates. Otherwise generated
1482# certificate will be selfsigned.
1483# If there is a CA certificate lifetime of the generated
1484# certificate equals lifetime of the CA certificate. If
1485# generated certificate is selfsigned lifetime is three
1486# years.
1487# This option is enabled by default when ssl-bump is used.
1488# See the ssl-bump option above for more information.
1489#
1490# dynamic_cert_mem_cache_size=SIZE
1491# Approximate total RAM size spent on cached generated
1492# certificates. If set to zero, caching is disabled. The
1493# default value is 4MB.
1494#
1495# TLS / SSL Options:
1496#
1497# cert= Path to SSL certificate (PEM format).
1498#
1499# key= Path to SSL private key file (PEM format)
1500# if not specified, the certificate file is
1501# assumed to be a combined certificate and
1502# key file.
1503#
1504# version= The version of SSL/TLS supported
1505# 1 automatic (default)
1506# 2 SSLv2 only
1507# 3 SSLv3 only
1508# 4 TLSv1.0 only
1509# 5 TLSv1.1 only
1510# 6 TLSv1.2 only
1511#
1512# cipher= Colon separated list of supported ciphers.
1513# NOTE: some ciphers such as EDH ciphers depend on
1514# additional settings. If those settings are
1515# omitted the ciphers may be silently ignored
1516# by the OpenSSL library.
1517#
1518# options= Various SSL implementation options. The most important
1519# being:
1520# NO_SSLv2 Disallow the use of SSLv2
1521# NO_SSLv3 Disallow the use of SSLv3
1522# NO_TLSv1 Disallow the use of TLSv1.0
1523# NO_TLSv1_1 Disallow the use of TLSv1.1
1524# NO_TLSv1_2 Disallow the use of TLSv1.2
1525# SINGLE_DH_USE Always create a new key when using
1526# temporary/ephemeral DH key exchanges
1527# ALL Enable various bug workarounds
1528# suggested as "harmless" by OpenSSL
1529# Be warned that this reduces SSL/TLS
1530# strength to some attacks.
1531# See OpenSSL SSL_CTX_set_options documentation for a
1532# complete list of options.
1533#
1534# clientca= File containing the list of CAs to use when
1535# requesting a client certificate.
1536#
1537# cafile= File containing additional CA certificates to
1538# use when verifying client certificates. If unset
1539# clientca will be used.
1540#
1541# capath= Directory containing additional CA certificates
1542# and CRL lists to use when verifying client certificates.
1543#
1544# crlfile= File of additional CRL lists to use when verifying
1545# the client certificate, in addition to CRLs stored in
1546# the capath. Implies VERIFY_CRL flag below.
1547#
1548# dhparams= File containing DH parameters for temporary/ephemeral
1549# DH key exchanges. See OpenSSL documentation for details
1550# on how to create this file.
1551# WARNING: EDH ciphers will be silently disabled if this
1552# option is not set.
1553#
1554# sslflags= Various flags modifying the use of SSL:
1555# DELAYED_AUTH
1556# Don't request client certificates
1557# immediately, but wait until acl processing
1558# requires a certificate (not yet implemented).
1559# NO_DEFAULT_CA
1560# Don't use the default CA lists built in
1561# to OpenSSL.
1562# NO_SESSION_REUSE
1563# Don't allow for session reuse. Each connection
1564# will result in a new SSL session.
1565# VERIFY_CRL
1566# Verify CRL lists when accepting client
1567# certificates.
1568# VERIFY_CRL_ALL
1569# Verify CRL lists for all certificates in the
1570# client certificate chain.
1571#
1572# sslcontext= SSL session ID context identifier.
1573#
1574# Other Options:
1575#
1576# connection-auth[=on|off]
1577# use connection-auth=off to tell Squid to prevent
1578# forwarding Microsoft connection oriented authentication
1579# (NTLM, Negotiate and Kerberos)
1580#
1581# disable-pmtu-discovery=
1582# Control Path-MTU discovery usage:
1583# off lets OS decide on what to do (default).
1584# transparent disable PMTU discovery when transparent
1585# support is enabled.
1586# always disable always PMTU discovery.
1587#
1588# In many setups of transparently intercepting proxies
1589# Path-MTU discovery can not work on traffic towards the
1590# clients. This is the case when the intercepting device
1591# does not fully track connections and fails to forward
1592# ICMP must fragment messages to the cache server. If you
1593# have such setup and experience that certain clients
1594# sporadically hang or never complete requests set
1595# disable-pmtu-discovery option to 'transparent'.
1596#
1597# name= Specifies a internal name for the port. Defaults to
1598# the port specification (port or addr:port)
1599#
1600# tcpkeepalive[=idle,interval,timeout]
1601# Enable TCP keepalive probes of idle connections.
1602# In seconds; idle is the initial time before TCP starts
1603# probing the connection, interval how often to probe, and
1604# timeout the time before giving up.
1605#
1606# If you run Squid on a dual-homed machine with an internal
1607# and an external interface we recommend you to specify the
1608# internal address:port in http_port. This way Squid will only be
1609# visible on the internal address.
1610#
1611#
1612
1613# Squid normally listens to port 3128
1614http_port 3128
1615
1616# TAG: https_port
1617# Note: This option is only available if Squid is rebuilt with the
1618# --enable-ssl
1619#
1620# Usage: [ip:]port cert=certificate.pem [key=key.pem] [mode] [options...]
1621#
1622# The socket address where Squid will listen for client requests made
1623# over TLS or SSL connections. Commonly referred to as HTTPS.
1624#
1625# This is most useful for situations where you are running squid in
1626# accelerator mode and you want to do the SSL work at the accelerator level.
1627#
1628# You may specify multiple socket addresses on multiple lines,
1629# each with their own SSL certificate and/or options.
1630#
1631# Modes:
1632#
1633# accel Accelerator / reverse proxy mode
1634#
1635# intercept Support for IP-Layer interception of
1636# outgoing requests without browser settings.
1637# NP: disables authentication and IPv6 on the port.
1638#
1639# tproxy Support Linux TPROXY for spoofing outgoing
1640# connections using the client IP address.
1641# NP: disables authentication and maybe IPv6 on the port.
1642#
1643# ssl-bump For each intercepted connection allowed by ssl_bump
1644# ACLs, establish a secure connection with the client and with
1645# the server, decrypt HTTPS messages as they pass through
1646# Squid, and treat them as unencrypted HTTP messages,
1647# becoming the man-in-the-middle.
1648#
1649# An "ssl_bump server-first" match is required to
1650# fully enable bumping of intercepted SSL connections.
1651#
1652# Requires tproxy or intercept.
1653#
1654# Omitting the mode flag causes default forward proxy mode to be used.
1655#
1656#
1657# See http_port for a list of generic options
1658#
1659#
1660# SSL Options:
1661#
1662# cert= Path to SSL certificate (PEM format).
1663#
1664# key= Path to SSL private key file (PEM format)
1665# if not specified, the certificate file is
1666# assumed to be a combined certificate and
1667# key file.
1668#
1669# version= The version of SSL/TLS supported
1670# 1 automatic (default)
1671# 2 SSLv2 only
1672# 3 SSLv3 only
1673# 4 TLSv1 only
1674#
1675# cipher= Colon separated list of supported ciphers.
1676#
1677# options= Various SSL engine options. The most important
1678# being:
1679# NO_SSLv2 Disallow the use of SSLv2
1680# NO_SSLv3 Disallow the use of SSLv3
1681# NO_TLSv1 Disallow the use of TLSv1
1682# SINGLE_DH_USE Always create a new key when using
1683# temporary/ephemeral DH key exchanges
1684# See src/ssl_support.c or OpenSSL SSL_CTX_set_options
1685# documentation for a complete list of options.
1686#
1687# clientca= File containing the list of CAs to use when
1688# requesting a client certificate.
1689#
1690# cafile= File containing additional CA certificates to
1691# use when verifying client certificates. If unset
1692# clientca will be used.
1693#
1694# capath= Directory containing additional CA certificates
1695# and CRL lists to use when verifying client certificates.
1696#
1697# crlfile= File of additional CRL lists to use when verifying
1698# the client certificate, in addition to CRLs stored in
1699# the capath. Implies VERIFY_CRL flag below.
1700#
1701# dhparams= File containing DH parameters for temporary/ephemeral
1702# DH key exchanges.
1703#
1704# sslflags= Various flags modifying the use of SSL:
1705# DELAYED_AUTH
1706# Don't request client certificates
1707# immediately, but wait until acl processing
1708# requires a certificate (not yet implemented).
1709# NO_DEFAULT_CA
1710# Don't use the default CA lists built in
1711# to OpenSSL.
1712# NO_SESSION_REUSE
1713# Don't allow for session reuse. Each connection
1714# will result in a new SSL session.
1715# VERIFY_CRL
1716# Verify CRL lists when accepting client
1717# certificates.
1718# VERIFY_CRL_ALL
1719# Verify CRL lists for all certificates in the
1720# client certificate chain.
1721#
1722# sslcontext= SSL session ID context identifier.
1723#
1724# generate-host-certificates[=<on|off>]
1725# Dynamically create SSL server certificates for the
1726# destination hosts of bumped SSL requests.When
1727# enabled, the cert and key options are used to sign
1728# generated certificates. Otherwise generated
1729# certificate will be selfsigned.
1730# If there is CA certificate life time of generated
1731# certificate equals lifetime of CA certificate. If
1732# generated certificate is selfsigned lifetime is three
1733# years.
1734# This option is enabled by default when SslBump is used.
1735# See the sslBump option above for more information.
1736#
1737# dynamic_cert_mem_cache_size=SIZE
1738# Approximate total RAM size spent on cached generated
1739# certificates. If set to zero, caching is disabled. The
1740# default value is 4MB.
1741#
1742# See http_port for a list of available options.
1743#Default:
1744# none
1745
1746# TAG: tcp_outgoing_tos
1747# Allows you to select a TOS/Diffserv value for packets outgoing
1748# on the server side, based on an ACL.
1749#
1750# tcp_outgoing_tos ds-field [!]aclname ...
1751#
1752# Example where normal_service_net uses the TOS value 0x00
1753# and good_service_net uses 0x20
1754#
1755# acl normal_service_net src 10.0.0.0/24
1756# acl good_service_net src 10.0.1.0/24
1757# tcp_outgoing_tos 0x00 normal_service_net
1758# tcp_outgoing_tos 0x20 good_service_net
1759#
1760# TOS/DSCP values really only have local significance - so you should
1761# know what you're specifying. For more information, see RFC2474,
1762# RFC2475, and RFC3260.
1763#
1764# The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or
1765# "default" to use whatever default your host has. Note that in
1766# practice often only multiples of 4 is usable as the two rightmost bits
1767# have been redefined for use by ECN (RFC 3168 section 23.1).
1768#
1769# Processing proceeds in the order specified, and stops at first fully
1770# matching line.
1771#Default:
1772# none
1773
1774# TAG: clientside_tos
1775# Allows you to select a TOS/Diffserv value for packets being transmitted
1776# on the client-side, based on an ACL.
1777#
1778# clientside_tos ds-field [!]aclname ...
1779#
1780# Example where normal_service_net uses the TOS value 0x00
1781# and good_service_net uses 0x20
1782#
1783# acl normal_service_net src 10.0.0.0/24
1784# acl good_service_net src 10.0.1.0/24
1785# clientside_tos 0x00 normal_service_net
1786# clientside_tos 0x20 good_service_net
1787#
1788# Note: This feature is incompatible with qos_flows. Any TOS values set here
1789# will be overwritten by TOS values in qos_flows.
1790#Default:
1791# none
1792
1793# TAG: tcp_outgoing_mark
1794# Note: This option is only available if Squid is rebuilt with the
1795# Packet MARK (Linux)
1796#
1797# Allows you to apply a Netfilter mark value to outgoing packets
1798# on the server side, based on an ACL.
1799#
1800# tcp_outgoing_mark mark-value [!]aclname ...
1801#
1802# Example where normal_service_net uses the mark value 0x00
1803# and good_service_net uses 0x20
1804#
1805# acl normal_service_net src 10.0.0.0/24
1806# acl good_service_net src 10.0.1.0/24
1807# tcp_outgoing_mark 0x00 normal_service_net
1808# tcp_outgoing_mark 0x20 good_service_net
1809#Default:
1810# none
1811
1812# TAG: clientside_mark
1813# Note: This option is only available if Squid is rebuilt with the
1814# Packet MARK (Linux)
1815#
1816# Allows you to apply a Netfilter mark value to packets being transmitted
1817# on the client-side, based on an ACL.
1818#
1819# clientside_mark mark-value [!]aclname ...
1820#
1821# Example where normal_service_net uses the mark value 0x00
1822# and good_service_net uses 0x20
1823#
1824# acl normal_service_net src 10.0.0.0/24
1825# acl good_service_net src 10.0.1.0/24
1826# clientside_mark 0x00 normal_service_net
1827# clientside_mark 0x20 good_service_net
1828#
1829# Note: This feature is incompatible with qos_flows. Any mark values set here
1830# will be overwritten by mark values in qos_flows.
1831#Default:
1832# none
1833
1834# TAG: qos_flows
1835# Allows you to select a TOS/DSCP value to mark outgoing
1836# connections to the client, based on where the reply was sourced.
1837# For platforms using netfilter, allows you to set a netfilter mark
1838# value instead of, or in addition to, a TOS value.
1839#
1840# By default this functionality is disabled. To enable it with the default
1841# settings simply use "qos_flows mark" or "qos_flows tos". Default
1842# settings will result in the netfilter mark or TOS value being copied
1843# from the upstream connection to the client. Note that it is the connection
1844# CONNMARK value not the packet MARK value that is copied.
1845#
1846# It is not currently possible to copy the mark or TOS value from the
1847# client to the upstream connection request.
1848#
1849# TOS values really only have local significance - so you should
1850# know what you're specifying. For more information, see RFC2474,
1851# RFC2475, and RFC3260.
1852#
1853# The TOS/DSCP byte must be exactly that - a octet value 0 - 255. Note that
1854# in practice often only multiples of 4 is usable as the two rightmost bits
1855# have been redefined for use by ECN (RFC 3168 section 23.1).
1856#
1857# Mark values can be any unsigned 32-bit integer value.
1858#
1859# This setting is configured by setting the following values:
1860#
1861# tos|mark Whether to set TOS or netfilter mark values
1862#
1863# local-hit=0xFF Value to mark local cache hits.
1864#
1865# sibling-hit=0xFF Value to mark hits from sibling peers.
1866#
1867# parent-hit=0xFF Value to mark hits from parent peers.
1868#
1869# miss=0xFF[/mask] Value to mark cache misses. Takes precedence
1870# over the preserve-miss feature (see below), unless
1871# mask is specified, in which case only the bits
1872# specified in the mask are written.
1873#
1874# The TOS variant of the following features are only possible on Linux
1875# and require your kernel to be patched with the TOS preserving ZPH
1876# patch, available from http://zph.bratcheda.org
1877# No patch is needed to preserve the netfilter mark, which will work
1878# with all variants of netfilter.
1879#
1880# disable-preserve-miss
1881# This option disables the preservation of the TOS or netfilter
1882# mark. By default, the existing TOS or netfilter mark value of
1883# the response coming from the remote server will be retained
1884# and masked with miss-mark.
1885# NOTE: in the case of a netfilter mark, the mark must be set on
1886# the connection (using the CONNMARK target) not on the packet
1887# (MARK target).
1888#
1889# miss-mask=0xFF
1890# Allows you to mask certain bits in the TOS or mark value
1891# received from the remote server, before copying the value to
1892# the TOS sent towards clients.
1893# Default for tos: 0xFF (TOS from server is not changed).
1894# Default for mark: 0xFFFFFFFF (mark from server is not changed).
1895#
1896# All of these features require the --enable-zph-qos compilation flag
1897# (enabled by default). Netfilter marking also requires the
1898# libnetfilter_conntrack libraries (--with-netfilter-conntrack) and
1899# libcap 2.09+ (--with-libcap).
1900#
1901#Default:
1902# none
1903
1904# TAG: tcp_outgoing_address
1905# Allows you to map requests to different outgoing IP addresses
1906# based on the username or source address of the user making
1907# the request.
1908#
1909# tcp_outgoing_address ipaddr [[!]aclname] ...
1910#
1911# For example;
1912# Forwarding clients with dedicated IPs for certain subnets.
1913#
1914# acl normal_service_net src 10.0.0.0/24
1915# acl good_service_net src 10.0.2.0/24
1916#
1917# tcp_outgoing_address 2001:db8::c001 good_service_net
1918# tcp_outgoing_address 10.1.0.2 good_service_net
1919#
1920# tcp_outgoing_address 2001:db8::beef normal_service_net
1921# tcp_outgoing_address 10.1.0.1 normal_service_net
1922#
1923# tcp_outgoing_address 2001:db8::1
1924# tcp_outgoing_address 10.1.0.3
1925#
1926# Processing proceeds in the order specified, and stops at first fully
1927# matching line.
1928#
1929# Squid will add an implicit IP version test to each line.
1930# Requests going to IPv4 websites will use the outgoing 10.1.0.* addresses.
1931# Requests going to IPv6 websites will use the outgoing 2001:db8:* addresses.
1932#
1933#
1934# NOTE: The use of this directive using client dependent ACLs is
1935# incompatible with the use of server side persistent connections. To
1936# ensure correct results it is best to set server_persistent_connections
1937# to off when using this directive in such configurations.
1938#
1939# NOTE: The use of this directive to set a local IP on outgoing TCP links
1940# is incompatible with using TPROXY to set client IP out outbound TCP links.
1941# When needing to contact peers use the no-tproxy cache_peer option and the
1942# client_dst_passthru directive re-enable normal forwarding such as this.
1943#
1944#Default:
1945# Address selection is performed by the operating system.
1946
1947# TAG: host_verify_strict
1948# Regardless of this option setting, when dealing with intercepted
1949# traffic, Squid always verifies that the destination IP address matches
1950# the Host header domain or IP (called 'authority form URL').
1951#
1952# This enforcement is performed to satisfy a MUST-level requirement in
1953# RFC 2616 section 14.23: "The Host field value MUST represent the naming
1954# authority of the origin server or gateway given by the original URL".
1955#
1956# When set to ON:
1957# Squid always responds with an HTTP 409 (Conflict) error
1958# page and logs a security warning if there is no match.
1959#
1960# Squid verifies that the destination IP address matches
1961# the Host header for forward-proxy and reverse-proxy traffic
1962# as well. For those traffic types, Squid also enables the
1963# following checks, comparing the corresponding Host header
1964# and Request-URI components:
1965#
1966# * The host names (domain or IP) must be identical,
1967# but valueless or missing Host header disables all checks.
1968# For the two host names to match, both must be either IP
1969# or FQDN.
1970#
1971# * Port numbers must be identical, but if a port is missing
1972# the scheme-default port is assumed.
1973#
1974#
1975# When set to OFF (the default):
1976# Squid allows suspicious requests to continue but logs a
1977# security warning and blocks caching of the response.
1978#
1979# * Forward-proxy traffic is not checked at all.
1980#
1981# * Reverse-proxy traffic is not checked at all.
1982#
1983# * Intercepted traffic which passes verification is handled
1984# according to client_dst_passthru.
1985#
1986# * Intercepted requests which fail verification are sent
1987# to the client original destination instead of DIRECT.
1988# This overrides 'client_dst_passthru off'.
1989#
1990# For now suspicious intercepted CONNECT requests are always
1991# responded to with an HTTP 409 (Conflict) error page.
1992#
1993#
1994# SECURITY NOTE:
1995#
1996# As described in CVE-2009-0801 when the Host: header alone is used
1997# to determine the destination of a request it becomes trivial for
1998# malicious scripts on remote websites to bypass browser same-origin
1999# security policy and sandboxing protections.
2000#
2001# The cause of this is that such applets are allowed to perform their
2002# own HTTP stack, in which case the same-origin policy of the browser
2003# sandbox only verifies that the applet tries to contact the same IP
2004# as from where it was loaded at the IP level. The Host: header may
2005# be different from the connected IP and approved origin.
2006#
2007#Default:
2008# host_verify_strict off
2009
2010# TAG: client_dst_passthru
2011# With NAT or TPROXY intercepted traffic Squid may pass the request
2012# directly to the original client destination IP or seek a faster
2013# source using the HTTP Host header.
2014#
2015# Using Host to locate alternative servers can provide faster
2016# connectivity with a range of failure recovery options.
2017# But can also lead to connectivity trouble when the client and
2018# server are attempting stateful interactions unaware of the proxy.
2019#
2020# This option (on by default) prevents alternative DNS entries being
2021# located to send intercepted traffic DIRECT to an origin server.
2022# The clients original destination IP and port will be used instead.
2023#
2024# Regardless of this option setting, when dealing with intercepted
2025# traffic Squid will verify the Host: header and any traffic which
2026# fails Host verification will be treated as if this option were ON.
2027#
2028# see host_verify_strict for details on the verification process.
2029#Default:
2030# client_dst_passthru on
2031
2032# SSL OPTIONS
2033# -----------------------------------------------------------------------------
2034
2035# TAG: ssl_unclean_shutdown
2036# Note: This option is only available if Squid is rebuilt with the
2037# --enable-ssl
2038#
2039# Some browsers (especially MSIE) bugs out on SSL shutdown
2040# messages.
2041#Default:
2042# ssl_unclean_shutdown off
2043
2044# TAG: ssl_engine
2045# Note: This option is only available if Squid is rebuilt with the
2046# --enable-ssl
2047#
2048# The OpenSSL engine to use. You will need to set this if you
2049# would like to use hardware SSL acceleration for example.
2050#Default:
2051# none
2052
2053# TAG: sslproxy_client_certificate
2054# Note: This option is only available if Squid is rebuilt with the
2055# --enable-ssl
2056#
2057# Client SSL Certificate to use when proxying https:// URLs
2058#Default:
2059# none
2060
2061# TAG: sslproxy_client_key
2062# Note: This option is only available if Squid is rebuilt with the
2063# --enable-ssl
2064#
2065# Client SSL Key to use when proxying https:// URLs
2066#Default:
2067# none
2068
2069# TAG: sslproxy_version
2070# Note: This option is only available if Squid is rebuilt with the
2071# --enable-ssl
2072#
2073# SSL version level to use when proxying https:// URLs
2074#
2075# The versions of SSL/TLS supported:
2076#
2077# 1 automatic (default)
2078# 2 SSLv2 only
2079# 3 SSLv3 only
2080# 4 TLSv1.0 only
2081# 5 TLSv1.1 only
2082# 6 TLSv1.2 only
2083#Default:
2084# automatic SSL/TLS version negotiation
2085
2086# TAG: sslproxy_options
2087# Note: This option is only available if Squid is rebuilt with the
2088# --enable-ssl
2089#
2090# SSL implementation options to use when proxying https:// URLs
2091#
2092# The most important being:
2093#
2094# NO_SSLv2 Disallow the use of SSLv2
2095# NO_SSLv3 Disallow the use of SSLv3
2096# NO_TLSv1 Disallow the use of TLSv1.0
2097# NO_TLSv1_1 Disallow the use of TLSv1.1
2098# NO_TLSv1_2 Disallow the use of TLSv1.2
2099# SINGLE_DH_USE
2100# Always create a new key when using temporary/ephemeral
2101# DH key exchanges
2102# SSL_OP_NO_TICKET
2103# Disable use of RFC5077 session tickets. Some servers
2104# may have problems understanding the TLS extension due
2105# to ambiguous specification in RFC4507.
2106# ALL Enable various bug workarounds suggested as "harmless"
2107# by OpenSSL. Be warned that this may reduce SSL/TLS
2108# strength to some attacks.
2109#
2110# See the OpenSSL SSL_CTX_set_options documentation for a
2111# complete list of possible options.
2112#Default:
2113# none
2114
2115# TAG: sslproxy_cipher
2116# Note: This option is only available if Squid is rebuilt with the
2117# --enable-ssl
2118#
2119# SSL cipher list to use when proxying https:// URLs
2120#
2121# Colon separated list of supported ciphers.
2122#Default:
2123# none
2124
2125# TAG: sslproxy_cafile
2126# Note: This option is only available if Squid is rebuilt with the
2127# --enable-ssl
2128#
2129# file containing CA certificates to use when verifying server
2130# certificates while proxying https:// URLs
2131#Default:
2132# none
2133
2134# TAG: sslproxy_capath
2135# Note: This option is only available if Squid is rebuilt with the
2136# --enable-ssl
2137#
2138# directory containing CA certificates to use when verifying
2139# server certificates while proxying https:// URLs
2140#Default:
2141# none
2142
2143# TAG: ssl_bump
2144# Note: This option is only available if Squid is rebuilt with the
2145# --enable-ssl
2146#
2147# This option is consulted when a CONNECT request is received on
2148# an http_port (or a new connection is intercepted at an
2149# https_port), provided that port was configured with an ssl-bump
2150# flag. The subsequent data on the connection is either treated as
2151# HTTPS and decrypted OR tunneled at TCP level without decryption,
2152# depending on the first bumping "mode" which ACLs match.
2153#
2154# ssl_bump <mode> [!]acl ...
2155#
2156# The following bumping modes are supported:
2157#
2158# client-first
2159# Allow bumping of the connection. Establish a secure connection
2160# with the client first, then connect to the server. This old mode
2161# does not allow Squid to mimic server SSL certificate and does
2162# not work with intercepted SSL connections.
2163#
2164# server-first
2165# Allow bumping of the connection. Establish a secure connection
2166# with the server first, then establish a secure connection with
2167# the client, using a mimicked server certificate. Works with both
2168# CONNECT requests and intercepted SSL connections.
2169#
2170# none
2171# Become a TCP tunnel without decoding the connection.
2172# Works with both CONNECT requests and intercepted SSL
2173# connections. This is the default behavior when no
2174# ssl_bump option is given or no ssl_bump ACLs match.
2175#
2176# By default, no connections are bumped.
2177#
2178# The first matching ssl_bump option wins. If no ACLs match, the
2179# connection is not bumped. Unlike most allow/deny ACL lists, ssl_bump
2180# does not have an implicit "negate the last given option" rule. You
2181# must make that rule explicit if you convert old ssl_bump allow/deny
2182# rules that rely on such an implicit rule.
2183#
2184# This clause supports both fast and slow acl types.
2185# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
2186#
2187# See also: http_port ssl-bump, https_port ssl-bump
2188#
2189#
2190# # Example: Bump all requests except those originating from
2191# # localhost or those going to example.com.
2192#
2193# acl broken_sites dstdomain .example.com
2194# ssl_bump none localhost
2195# ssl_bump none broken_sites
2196# ssl_bump server-first all
2197#Default:
2198# Does not bump unless rules are present in squid.conf
2199
2200# TAG: sslproxy_flags
2201# Note: This option is only available if Squid is rebuilt with the
2202# --enable-ssl
2203#
2204# Various flags modifying the use of SSL while proxying https:// URLs:
2205# DONT_VERIFY_PEER Accept certificates that fail verification.
2206# For refined control, see sslproxy_cert_error.
2207# NO_DEFAULT_CA Don't use the default CA list built in
2208# to OpenSSL.
2209#Default:
2210# none
2211
2212# TAG: sslproxy_cert_error
2213# Note: This option is only available if Squid is rebuilt with the
2214# --enable-ssl
2215#
2216# Use this ACL to bypass server certificate validation errors.
2217#
2218# For example, the following lines will bypass all validation errors
2219# when talking to servers for example.com. All other
2220# validation errors will result in ERR_SECURE_CONNECT_FAIL error.
2221#
2222# acl BrokenButTrustedServers dstdomain example.com
2223# sslproxy_cert_error allow BrokenButTrustedServers
2224# sslproxy_cert_error deny all
2225#
2226# This clause only supports fast acl types.
2227# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
2228# Using slow acl types may result in server crashes
2229#
2230# Without this option, all server certificate validation errors
2231# terminate the transaction to protect Squid and the client.
2232#
2233# SQUID_X509_V_ERR_INFINITE_VALIDATION error cannot be bypassed
2234# but should not happen unless your OpenSSL library is buggy.
2235#
2236# SECURITY WARNING:
2237# Bypassing validation errors is dangerous because an
2238# error usually implies that the server cannot be trusted
2239# and the connection may be insecure.
2240#
2241# See also: sslproxy_flags and DONT_VERIFY_PEER.
2242#Default:
2243# Server certificate errors terminate the transaction.
2244
2245# TAG: sslproxy_cert_sign
2246# Note: This option is only available if Squid is rebuilt with the
2247# --enable-ssl
2248#
2249#
2250# sslproxy_cert_sign <signing algorithm> acl ...
2251#
2252# The following certificate signing algorithms are supported:
2253#
2254# signTrusted
2255# Sign using the configured CA certificate which is usually
2256# placed in and trusted by end-user browsers. This is the
2257# default for trusted origin server certificates.
2258#
2259# signUntrusted
2260# Sign to guarantee an X509_V_ERR_CERT_UNTRUSTED browser error.
2261# This is the default for untrusted origin server certificates
2262# that are not self-signed (see ssl::certUntrusted).
2263#
2264# signSelf
2265# Sign using a self-signed certificate with the right CN to
2266# generate a X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT error in the
2267# browser. This is the default for self-signed origin server
2268# certificates (see ssl::certSelfSigned).
2269#
2270# This clause only supports fast acl types.
2271#
2272# When sslproxy_cert_sign acl(s) match, Squid uses the corresponding
2273# signing algorithm to generate the certificate and ignores all
2274# subsequent sslproxy_cert_sign options (the first match wins). If no
2275# acl(s) match, the default signing algorithm is determined by errors
2276# detected when obtaining and validating the origin server certificate.
2277#
2278# WARNING: SQUID_X509_V_ERR_DOMAIN_MISMATCH and ssl:certDomainMismatch can
2279# be used with sslproxy_cert_adapt, but if and only if Squid is bumping a
2280# CONNECT request that carries a domain name. In all other cases (CONNECT
2281# to an IP address or an intercepted SSL connection), Squid cannot detect
2282# the domain mismatch at certificate generation time when
2283# bump-server-first is used.
2284#Default:
2285# none
2286
2287# TAG: sslproxy_cert_adapt
2288# Note: This option is only available if Squid is rebuilt with the
2289# --enable-ssl
2290#
2291#
2292# sslproxy_cert_adapt <adaptation algorithm> acl ...
2293#
2294# The following certificate adaptation algorithms are supported:
2295#
2296# setValidAfter
2297# Sets the "Not After" property to the "Not After" property of
2298# the CA certificate used to sign generated certificates.
2299#
2300# setValidBefore
2301# Sets the "Not Before" property to the "Not Before" property of
2302# the CA certificate used to sign generated certificates.
2303#
2304# setCommonName or setCommonName{CN}
2305# Sets Subject.CN property to the host name specified as a
2306# CN parameter or, if no explicit CN parameter was specified,
2307# extracted from the CONNECT request. It is a misconfiguration
2308# to use setCommonName without an explicit parameter for
2309# intercepted or tproxied SSL connections.
2310#
2311# This clause only supports fast acl types.
2312#
2313# Squid first groups sslproxy_cert_adapt options by adaptation algorithm.
2314# Within a group, when sslproxy_cert_adapt acl(s) match, Squid uses the
2315# corresponding adaptation algorithm to generate the certificate and
2316# ignores all subsequent sslproxy_cert_adapt options in that algorithm's
2317# group (i.e., the first match wins within each algorithm group). If no
2318# acl(s) match, the default mimicking action takes place.
2319#
2320# WARNING: SQUID_X509_V_ERR_DOMAIN_MISMATCH and ssl:certDomainMismatch can
2321# be used with sslproxy_cert_adapt, but if and only if Squid is bumping a
2322# CONNECT request that carries a domain name. In all other cases (CONNECT
2323# to an IP address or an intercepted SSL connection), Squid cannot detect
2324# the domain mismatch at certificate generation time when
2325# bump-server-first is used.
2326#Default:
2327# none
2328
2329# TAG: sslpassword_program
2330# Note: This option is only available if Squid is rebuilt with the
2331# --enable-ssl
2332#
2333# Specify a program used for entering SSL key passphrases
2334# when using encrypted SSL certificate keys. If not specified
2335# keys must either be unencrypted, or Squid started with the -N
2336# option to allow it to query interactively for the passphrase.
2337#
2338# The key file name is given as argument to the program allowing
2339# selection of the right password if you have multiple encrypted
2340# keys.
2341#Default:
2342# none
2343
2344# OPTIONS RELATING TO EXTERNAL SSL_CRTD
2345# -----------------------------------------------------------------------------
2346
2347# TAG: sslcrtd_program
2348# Note: This option is only available if Squid is rebuilt with the
2349# --enable-ssl-crtd
2350#
2351# Specify the location and options of the executable for ssl_crtd process.
2352# /usr/lib/squid3/ssl_crtd program requires -s and -M parameters
2353# For more information use:
2354# /usr/lib/squid3/ssl_crtd -h
2355#Default:
2356# sslcrtd_program /usr/lib/squid3/ssl_crtd -s /var/lib/ssl_db -M 4MB
2357
2358# TAG: sslcrtd_children
2359# Note: This option is only available if Squid is rebuilt with the
2360# --enable-ssl-crtd
2361#
2362# The maximum number of processes spawn to service ssl server.
2363# The maximum this may be safely set to is 32.
2364#
2365# The startup= and idle= options allow some measure of skew in your
2366# tuning.
2367#
2368# startup=N
2369#
2370# Sets the minimum number of processes to spawn when Squid
2371# starts or reconfigures. When set to zero the first request will
2372# cause spawning of the first child process to handle it.
2373#
2374# Starting too few children temporary slows Squid under load while it
2375# tries to spawn enough additional processes to cope with traffic.
2376#
2377# idle=N
2378#
2379# Sets a minimum of how many processes Squid is to try and keep available
2380# at all times. When traffic begins to rise above what the existing
2381# processes can handle this many more will be spawned up to the maximum
2382# configured. A minimum setting of 1 is required.
2383#
2384# You must have at least one ssl_crtd process.
2385#Default:
2386# sslcrtd_children 32 startup=5 idle=1
2387
2388# TAG: sslcrtvalidator_program
2389# Note: This option is only available if Squid is rebuilt with the
2390# --enable-ssl
2391#
2392# Specify the location and options of the executable for ssl_crt_validator
2393# process.
2394#
2395# Usage: sslcrtvalidator_program [ttl=n] [cache=n] path ...
2396#
2397# Options:
2398# ttl=n TTL in seconds for cached results. The default is 60 secs
2399# cache=n limit the result cache size. The default value is 2048
2400#Default:
2401# none
2402
2403# TAG: sslcrtvalidator_children
2404# Note: This option is only available if Squid is rebuilt with the
2405# --enable-ssl
2406#
2407# The maximum number of processes spawn to service SSL server.
2408# The maximum this may be safely set to is 32.
2409#
2410# The startup= and idle= options allow some measure of skew in your
2411# tuning.
2412#
2413# startup=N
2414#
2415# Sets the minimum number of processes to spawn when Squid
2416# starts or reconfigures. When set to zero the first request will
2417# cause spawning of the first child process to handle it.
2418#
2419# Starting too few children temporary slows Squid under load while it
2420# tries to spawn enough additional processes to cope with traffic.
2421#
2422# idle=N
2423#
2424# Sets a minimum of how many processes Squid is to try and keep available
2425# at all times. When traffic begins to rise above what the existing
2426# processes can handle this many more will be spawned up to the maximum
2427# configured. A minimum setting of 1 is required.
2428#
2429# concurrency=
2430#
2431# The number of requests each certificate validator helper can handle in
2432# parallel. A value of 0 indicates the certficate validator does not
2433# support concurrency. Defaults to 1.
2434#
2435# When this directive is set to a value >= 1 then the protocol
2436# used to communicate with the helper is modified to include
2437# a request ID in front of the request/response. The request
2438# ID from the request must be echoed back with the response
2439# to that request.
2440#
2441# You must have at least one ssl_crt_validator process.
2442#Default:
2443# sslcrtvalidator_children 32 startup=5 idle=1 concurrency=1
2444
2445# OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM
2446# -----------------------------------------------------------------------------
2447
2448# TAG: cache_peer
2449# To specify other caches in a hierarchy, use the format:
2450#
2451# cache_peer hostname type http-port icp-port [options]
2452#
2453# For example,
2454#
2455# # proxy icp
2456# # hostname type port port options
2457# # -------------------- -------- ----- ----- -----------
2458# cache_peer parent.foo.net parent 3128 3130 default
2459# cache_peer sib1.foo.net sibling 3128 3130 proxy-only
2460# cache_peer sib2.foo.net sibling 3128 3130 proxy-only
2461# cache_peer example.com parent 80 0 default
2462# cache_peer cdn.example.com sibling 3128 0
2463#
2464# type: either 'parent', 'sibling', or 'multicast'.
2465#
2466# proxy-port: The port number where the peer accept HTTP requests.
2467# For other Squid proxies this is usually 3128
2468# For web servers this is usually 80
2469#
2470# icp-port: Used for querying neighbor caches about objects.
2471# Set to 0 if the peer does not support ICP or HTCP.
2472# See ICP and HTCP options below for additional details.
2473#
2474#
2475# ==== ICP OPTIONS ====
2476#
2477# You MUST also set icp_port and icp_access explicitly when using these options.
2478# The defaults will prevent peer traffic using ICP.
2479#
2480#
2481# no-query Disable ICP queries to this neighbor.
2482#
2483# multicast-responder
2484# Indicates the named peer is a member of a multicast group.
2485# ICP queries will not be sent directly to the peer, but ICP
2486# replies will be accepted from it.
2487#
2488# closest-only Indicates that, for ICP_OP_MISS replies, we'll only forward
2489# CLOSEST_PARENT_MISSes and never FIRST_PARENT_MISSes.
2490#
2491# background-ping
2492# To only send ICP queries to this neighbor infrequently.
2493# This is used to keep the neighbor round trip time updated
2494# and is usually used in conjunction with weighted-round-robin.
2495#
2496#
2497# ==== HTCP OPTIONS ====
2498#
2499# You MUST also set htcp_port and htcp_access explicitly when using these options.
2500# The defaults will prevent peer traffic using HTCP.
2501#
2502#
2503# htcp Send HTCP, instead of ICP, queries to the neighbor.
2504# You probably also want to set the "icp-port" to 4827
2505# instead of 3130. This directive accepts a comma separated
2506# list of options described below.
2507#
2508# htcp=oldsquid Send HTCP to old Squid versions (2.5 or earlier).
2509#
2510# htcp=no-clr Send HTCP to the neighbor but without
2511# sending any CLR requests. This cannot be used with
2512# only-clr.
2513#
2514# htcp=only-clr Send HTCP to the neighbor but ONLY CLR requests.
2515# This cannot be used with no-clr.
2516#
2517# htcp=no-purge-clr
2518# Send HTCP to the neighbor including CLRs but only when
2519# they do not result from PURGE requests.
2520#
2521# htcp=forward-clr
2522# Forward any HTCP CLR requests this proxy receives to the peer.
2523#
2524#
2525# ==== PEER SELECTION METHODS ====
2526#
2527# The default peer selection method is ICP, with the first responding peer
2528# being used as source. These options can be used for better load balancing.
2529#
2530#
2531# default This is a parent cache which can be used as a "last-resort"
2532# if a peer cannot be located by any of the peer-selection methods.
2533# If specified more than once, only the first is used.
2534#
2535# round-robin Load-Balance parents which should be used in a round-robin
2536# fashion in the absence of any ICP queries.
2537# weight=N can be used to add bias.
2538#
2539# weighted-round-robin
2540# Load-Balance parents which should be used in a round-robin
2541# fashion with the frequency of each parent being based on the
2542# round trip time. Closer parents are used more often.
2543# Usually used for background-ping parents.
2544# weight=N can be used to add bias.
2545#
2546# carp Load-Balance parents which should be used as a CARP array.
2547# The requests will be distributed among the parents based on the
2548# CARP load balancing hash function based on their weight.
2549#
2550# userhash Load-balance parents based on the client proxy_auth or ident username.
2551#
2552# sourcehash Load-balance parents based on the client source IP.
2553#
2554# multicast-siblings
2555# To be used only for cache peers of type "multicast".
2556# ALL members of this multicast group have "sibling"
2557# relationship with it, not "parent". This is to a multicast
2558# group when the requested object would be fetched only from
2559# a "parent" cache, anyway. It's useful, e.g., when
2560# configuring a pool of redundant Squid proxies, being
2561# members of the same multicast group.
2562#
2563#
2564# ==== PEER SELECTION OPTIONS ====
2565#
2566# weight=N use to affect the selection of a peer during any weighted
2567# peer-selection mechanisms.
2568# The weight must be an integer; default is 1,
2569# larger weights are favored more.
2570# This option does not affect parent selection if a peering
2571# protocol is not in use.
2572#
2573# basetime=N Specify a base amount to be subtracted from round trip
2574# times of parents.
2575# It is subtracted before division by weight in calculating
2576# which parent to fectch from. If the rtt is less than the
2577# base time the rtt is set to a minimal value.
2578#
2579# ttl=N Specify a TTL to use when sending multicast ICP queries
2580# to this address.
2581# Only useful when sending to a multicast group.
2582# Because we don't accept ICP replies from random
2583# hosts, you must configure other group members as
2584# peers with the 'multicast-responder' option.
2585#
2586# no-delay To prevent access to this neighbor from influencing the
2587# delay pools.
2588#
2589# digest-url=URL Tell Squid to fetch the cache digest (if digests are
2590# enabled) for this host from the specified URL rather
2591# than the Squid default location.
2592#
2593#
2594# ==== CARP OPTIONS ====
2595#
2596# carp-key=key-specification
2597# use a different key than the full URL to hash against the peer.
2598# the key-specification is a comma-separated list of the keywords
2599# scheme, host, port, path, params
2600# Order is not important.
2601#
2602# ==== ACCELERATOR / REVERSE-PROXY OPTIONS ====
2603#
2604# originserver Causes this parent to be contacted as an origin server.
2605# Meant to be used in accelerator setups when the peer
2606# is a web server.
2607#
2608# forceddomain=name
2609# Set the Host header of requests forwarded to this peer.
2610# Useful in accelerator setups where the server (peer)
2611# expects a certain domain name but clients may request
2612# others. ie example.com or www.example.com
2613#
2614# no-digest Disable request of cache digests.
2615#
2616# no-netdb-exchange
2617# Disables requesting ICMP RTT database (NetDB).
2618#
2619#
2620# ==== AUTHENTICATION OPTIONS ====
2621#
2622# login=user:password
2623# If this is a personal/workgroup proxy and your parent
2624# requires proxy authentication.
2625#
2626# Note: The string can include URL escapes (i.e. %20 for
2627# spaces). This also means % must be written as %%.
2628#
2629# login=PASSTHRU
2630# Send login details received from client to this peer.
2631# Both Proxy- and WWW-Authorization headers are passed
2632# without alteration to the peer.
2633# Authentication is not required by Squid for this to work.
2634#
2635# Note: This will pass any form of authentication but
2636# only Basic auth will work through a proxy unless the
2637# connection-auth options are also used.
2638#
2639# login=PASS Send login details received from client to this peer.
2640# Authentication is not required by this option.
2641#
2642# If there are no client-provided authentication headers
2643# to pass on, but username and password are available
2644# from an external ACL user= and password= result tags
2645# they may be sent instead.
2646#
2647# Note: To combine this with proxy_auth both proxies must
2648# share the same user database as HTTP only allows for
2649# a single login (one for proxy, one for origin server).
2650# Also be warned this will expose your users proxy
2651# password to the peer. USE WITH CAUTION
2652#
2653# login=*:password
2654# Send the username to the upstream cache, but with a
2655# fixed password. This is meant to be used when the peer
2656# is in another administrative domain, but it is still
2657# needed to identify each user.
2658# The star can optionally be followed by some extra
2659# information which is added to the username. This can
2660# be used to identify this proxy to the peer, similar to
2661# the login=username:password option above.
2662#
2663# login=NEGOTIATE
2664# If this is a personal/workgroup proxy and your parent
2665# requires a secure proxy authentication.
2666# The first principal from the default keytab or defined by
2667# the environment variable KRB5_KTNAME will be used.
2668#
2669# WARNING: The connection may transmit requests from multiple
2670# clients. Negotiate often assumes end-to-end authentication
2671# and a single-client. Which is not strictly true here.
2672#
2673# login=NEGOTIATE:principal_name
2674# If this is a personal/workgroup proxy and your parent
2675# requires a secure proxy authentication.
2676# The principal principal_name from the default keytab or
2677# defined by the environment variable KRB5_KTNAME will be
2678# used.
2679#
2680# WARNING: The connection may transmit requests from multiple
2681# clients. Negotiate often assumes end-to-end authentication
2682# and a single-client. Which is not strictly true here.
2683#
2684# connection-auth=on|off
2685# Tell Squid that this peer does or not support Microsoft
2686# connection oriented authentication, and any such
2687# challenges received from there should be ignored.
2688# Default is auto to automatically determine the status
2689# of the peer.
2690#
2691#
2692# ==== SSL / HTTPS / TLS OPTIONS ====
2693#
2694# ssl Encrypt connections to this peer with SSL/TLS.
2695#
2696# sslcert=/path/to/ssl/certificate
2697# A client SSL certificate to use when connecting to
2698# this peer.
2699#
2700# sslkey=/path/to/ssl/key
2701# The private SSL key corresponding to sslcert above.
2702# If 'sslkey' is not specified 'sslcert' is assumed to
2703# reference a combined file containing both the
2704# certificate and the key.
2705#
2706# sslversion=1|2|3|4|5|6
2707# The SSL version to use when connecting to this peer
2708# 1 = automatic (default)
2709# 2 = SSL v2 only
2710# 3 = SSL v3 only
2711# 4 = TLS v1.0 only
2712# 5 = TLS v1.1 only
2713# 6 = TLS v1.2 only
2714#
2715# sslcipher=... The list of valid SSL ciphers to use when connecting
2716# to this peer.
2717#
2718# ssloptions=... Specify various SSL implementation options:
2719#
2720# NO_SSLv2 Disallow the use of SSLv2
2721# NO_SSLv3 Disallow the use of SSLv3
2722# NO_TLSv1 Disallow the use of TLSv1.0
2723# NO_TLSv1_1 Disallow the use of TLSv1.1
2724# NO_TLSv1_2 Disallow the use of TLSv1.2
2725# SINGLE_DH_USE
2726# Always create a new key when using
2727# temporary/ephemeral DH key exchanges
2728# ALL Enable various bug workarounds
2729# suggested as "harmless" by OpenSSL
2730# Be warned that this reduces SSL/TLS
2731# strength to some attacks.
2732#
2733# See the OpenSSL SSL_CTX_set_options documentation for a
2734# more complete list.
2735#
2736# sslcafile=... A file containing additional CA certificates to use
2737# when verifying the peer certificate.
2738#
2739# sslcapath=... A directory containing additional CA certificates to
2740# use when verifying the peer certificate.
2741#
2742# sslcrlfile=... A certificate revocation list file to use when
2743# verifying the peer certificate.
2744#
2745# sslflags=... Specify various flags modifying the SSL implementation:
2746#
2747# DONT_VERIFY_PEER
2748# Accept certificates even if they fail to
2749# verify.
2750# NO_DEFAULT_CA
2751# Don't use the default CA list built in
2752# to OpenSSL.
2753# DONT_VERIFY_DOMAIN
2754# Don't verify the peer certificate
2755# matches the server name
2756#
2757# ssldomain= The peer name as advertised in it's certificate.
2758# Used for verifying the correctness of the received peer
2759# certificate. If not specified the peer hostname will be
2760# used.
2761#
2762# front-end-https
2763# Enable the "Front-End-Https: On" header needed when
2764# using Squid as a SSL frontend in front of Microsoft OWA.
2765# See MS KB document Q307347 for details on this header.
2766# If set to auto the header will only be added if the
2767# request is forwarded as a https:// URL.
2768#
2769#
2770# ==== GENERAL OPTIONS ====
2771#
2772# connect-timeout=N
2773# A peer-specific connect timeout.
2774# Also see the peer_connect_timeout directive.
2775#
2776# connect-fail-limit=N
2777# How many times connecting to a peer must fail before
2778# it is marked as down. Default is 10.
2779#
2780# allow-miss Disable Squid's use of only-if-cached when forwarding
2781# requests to siblings. This is primarily useful when
2782# icp_hit_stale is used by the sibling. To extensive use
2783# of this option may result in forwarding loops, and you
2784# should avoid having two-way peerings with this option.
2785# For example to deny peer usage on requests from peer
2786# by denying cache_peer_access if the source is a peer.
2787#
2788# max-conn=N Limit the amount of connections Squid may open to this
2789# peer. see also
2790#
2791# name=xxx Unique name for the peer.
2792# Required if you have multiple peers on the same host
2793# but different ports.
2794# This name can be used in cache_peer_access and similar
2795# directives to dentify the peer.
2796# Can be used by outgoing access controls through the
2797# peername ACL type.
2798#
2799# no-tproxy Do not use the client-spoof TPROXY support when forwarding
2800# requests to this peer. Use normal address selection instead.
2801# This overrides the spoof_client_ip ACL.
2802#
2803# proxy-only objects fetched from the peer will not be stored locally.
2804#
2805#Default:
2806# none
2807
2808# TAG: cache_peer_domain
2809# Use to limit the domains for which a neighbor cache will be
2810# queried.
2811#
2812# Usage:
2813# cache_peer_domain cache-host domain [domain ...]
2814# cache_peer_domain cache-host !domain
2815#
2816# For example, specifying
2817#
2818# cache_peer_domain parent.foo.net .edu
2819#
2820# has the effect such that UDP query packets are sent to
2821# 'bigserver' only when the requested object exists on a
2822# server in the .edu domain. Prefixing the domainname
2823# with '!' means the cache will be queried for objects
2824# NOT in that domain.
2825#
2826# NOTE: * Any number of domains may be given for a cache-host,
2827# either on the same or separate lines.
2828# * When multiple domains are given for a particular
2829# cache-host, the first matched domain is applied.
2830# * Cache hosts with no domain restrictions are queried
2831# for all requests.
2832# * There are no defaults.
2833# * There is also a 'cache_peer_access' tag in the ACL
2834# section.
2835#Default:
2836# none
2837
2838# TAG: cache_peer_access
2839# Similar to 'cache_peer_domain' but provides more flexibility by
2840# using ACL elements.
2841#
2842# Usage:
2843# cache_peer_access cache-host allow|deny [!]aclname ...
2844#
2845# The syntax is identical to 'http_access' and the other lists of
2846# ACL elements. See the comments for 'http_access' below, or
2847# the Squid FAQ (http://wiki.squid-cache.org/SquidFaq/SquidAcl).
2848#Default:
2849# none
2850
2851# TAG: neighbor_type_domain
2852# Modify the cache_peer neighbor type when passing requests
2853# about specific domains to the peer.
2854#
2855# Usage:
2856# neighbor_type_domain neighbor parent|sibling domain domain ...
2857#
2858# For example:
2859# cache_peer foo.example.com parent 3128 3130
2860# neighbor_type_domain foo.example.com sibling .au .de
2861#
2862# The above configuration treats all requests to foo.example.com as a
2863# parent proxy unless the request is for a .au or .de ccTLD domain name.
2864#Default:
2865# The peer type from cache_peer directive is used for all requests to that peer.
2866
2867# TAG: dead_peer_timeout (seconds)
2868# This controls how long Squid waits to declare a peer cache
2869# as "dead." If there are no ICP replies received in this
2870# amount of time, Squid will declare the peer dead and not
2871# expect to receive any further ICP replies. However, it
2872# continues to send ICP queries, and will mark the peer as
2873# alive upon receipt of the first subsequent ICP reply.
2874#
2875# This timeout also affects when Squid expects to receive ICP
2876# replies from peers. If more than 'dead_peer' seconds have
2877# passed since the last ICP reply was received, Squid will not
2878# expect to receive an ICP reply on the next query. Thus, if
2879# your time between requests is greater than this timeout, you
2880# will see a lot of requests sent DIRECT to origin servers
2881# instead of to your parents.
2882#Default:
2883# dead_peer_timeout 10 seconds
2884
2885# TAG: forward_max_tries
2886# Controls how many different forward paths Squid will try
2887# before giving up. See also forward_timeout.
2888#
2889# NOTE: connect_retries (default: none) can make each of these
2890# possible forwarding paths be tried multiple times.
2891#Default:
2892# forward_max_tries 10
2893
2894# TAG: hierarchy_stoplist
2895# A list of words which, if found in a URL, cause the object to
2896# be handled directly by this cache. In other words, use this
2897# to not query neighbor caches for certain objects. You may
2898# list this option multiple times.
2899#
2900# Example:
2901# hierarchy_stoplist cgi-bin ?
2902#
2903# Note: never_direct overrides this option.
2904#Default:
2905# none
2906
2907# MEMORY CACHE OPTIONS
2908# -----------------------------------------------------------------------------
2909
2910# TAG: cache_mem (bytes)
2911# NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS SIZE.
2912# IT ONLY PLACES A LIMIT ON HOW MUCH ADDITIONAL MEMORY SQUID WILL
2913# USE AS A MEMORY CACHE OF OBJECTS. SQUID USES MEMORY FOR OTHER
2914# THINGS AS WELL. SEE THE SQUID FAQ SECTION 8 FOR DETAILS.
2915#
2916# 'cache_mem' specifies the ideal amount of memory to be used
2917# for:
2918# * In-Transit objects
2919# * Hot Objects
2920# * Negative-Cached objects
2921#
2922# Data for these objects are stored in 4 KB blocks. This
2923# parameter specifies the ideal upper limit on the total size of
2924# 4 KB blocks allocated. In-Transit objects take the highest
2925# priority.
2926#
2927# In-transit objects have priority over the others. When
2928# additional space is needed for incoming data, negative-cached
2929# and hot objects will be released. In other words, the
2930# negative-cached and hot objects will fill up any unused space
2931# not needed for in-transit objects.
2932#
2933# If circumstances require, this limit will be exceeded.
2934# Specifically, if your incoming request rate requires more than
2935# 'cache_mem' of memory to hold in-transit objects, Squid will
2936# exceed this limit to satisfy the new requests. When the load
2937# decreases, blocks will be freed until the high-water mark is
2938# reached. Thereafter, blocks will be used to store hot
2939# objects.
2940#
2941# If shared memory caching is enabled, Squid does not use the shared
2942# cache space for in-transit objects, but they still consume as much
2943# local memory as they need. For more details about the shared memory
2944# cache, see memory_cache_shared.
2945#Default:
2946# cache_mem 256 MB
2947
2948# TAG: maximum_object_size_in_memory (bytes)
2949# Objects greater than this size will not be attempted to kept in
2950# the memory cache. This should be set high enough to keep objects
2951# accessed frequently in memory to improve performance whilst low
2952# enough to keep larger objects from hoarding cache_mem.
2953#Default:
2954# maximum_object_size_in_memory 512 KB
2955
2956# TAG: memory_cache_shared on|off
2957# Controls whether the memory cache is shared among SMP workers.
2958#
2959# The shared memory cache is meant to occupy cache_mem bytes and replace
2960# the non-shared memory cache, although some entities may still be
2961# cached locally by workers for now (e.g., internal and in-transit
2962# objects may be served from a local memory cache even if shared memory
2963# caching is enabled).
2964#
2965# By default, the memory cache is shared if and only if all of the
2966# following conditions are satisfied: Squid runs in SMP mode with
2967# multiple workers, cache_mem is positive, and Squid environment
2968# supports required IPC primitives (e.g., POSIX shared memory segments
2969# and GCC-style atomic operations).
2970#
2971# To avoid blocking locks, shared memory uses opportunistic algorithms
2972# that do not guarantee that every cachable entity that could have been
2973# shared among SMP workers will actually be shared.
2974#
2975# Currently, entities exceeding 32KB in size cannot be shared.
2976#Default:
2977# "on" where supported if doing memory caching with multiple SMP workers.
2978
2979# TAG: memory_cache_mode
2980# Controls which objects to keep in the memory cache (cache_mem)
2981#
2982# always Keep most recently fetched objects in memory (default)
2983#
2984# disk Only disk cache hits are kept in memory, which means
2985# an object must first be cached on disk and then hit
2986# a second time before cached in memory.
2987#
2988# network Only objects fetched from network is kept in memory
2989#Default:
2990# Keep the most recently fetched objects in memory
2991
2992# TAG: memory_replacement_policy
2993# The memory replacement policy parameter determines which
2994# objects are purged from memory when memory space is needed.
2995#
2996# See cache_replacement_policy for details on algorithms.
2997#Default:
2998# memory_replacement_policy lru
2999
3000# DISK CACHE OPTIONS
3001# -----------------------------------------------------------------------------
3002
3003# TAG: cache_replacement_policy
3004# The cache replacement policy parameter determines which
3005# objects are evicted (replaced) when disk space is needed.
3006#
3007# lru : Squid's original list based LRU policy
3008# heap GDSF : Greedy-Dual Size Frequency
3009# heap LFUDA: Least Frequently Used with Dynamic Aging
3010# heap LRU : LRU policy implemented using a heap
3011#
3012# Applies to any cache_dir lines listed below this directive.
3013#
3014# The LRU policies keeps recently referenced objects.
3015#
3016# The heap GDSF policy optimizes object hit rate by keeping smaller
3017# popular objects in cache so it has a better chance of getting a
3018# hit. It achieves a lower byte hit rate than LFUDA though since
3019# it evicts larger (possibly popular) objects.
3020#
3021# The heap LFUDA policy keeps popular objects in cache regardless of
3022# their size and thus optimizes byte hit rate at the expense of
3023# hit rate since one large, popular object will prevent many
3024# smaller, slightly less popular objects from being cached.
3025#
3026# Both policies utilize a dynamic aging mechanism that prevents
3027# cache pollution that can otherwise occur with frequency-based
3028# replacement policies.
3029#
3030# NOTE: if using the LFUDA replacement policy you should increase
3031# the value of maximum_object_size above its default of 4 MB to
3032# to maximize the potential byte hit rate improvement of LFUDA.
3033#
3034# For more information about the GDSF and LFUDA cache replacement
3035# policies see http://www.hpl.hp.com/techreports/1999/HPL-1999-69.html
3036# and http://fog.hpl.external.hp.com/techreports/98/HPL-98-173.html.
3037#Default:
3038# cache_replacement_policy lru
3039
3040# TAG: minimum_object_size (bytes)
3041# Objects smaller than this size will NOT be saved on disk. The
3042# value is specified in bytes, and the default is 0 KB, which
3043# means all responses can be stored.
3044#Default:
3045# no limit
3046
3047# TAG: maximum_object_size (bytes)
3048# Set the default value for max-size parameter on any cache_dir.
3049# The value is specified in bytes, and the default is 4 MB.
3050#
3051# If you wish to get a high BYTES hit ratio, you should probably
3052# increase this (one 32 MB object hit counts for 3200 10KB
3053# hits).
3054#
3055# If you wish to increase hit ratio more than you want to
3056# save bandwidth you should leave this low.
3057#
3058# NOTE: if using the LFUDA replacement policy you should increase
3059# this value to maximize the byte hit rate improvement of LFUDA!
3060# See cache_replacement_policy for a discussion of this policy.
3061#Default:
3062# maximum_object_size 4 MB
3063
3064# TAG: cache_dir
3065# Format:
3066# cache_dir Type Directory-Name Fs-specific-data [options]
3067#
3068# You can specify multiple cache_dir lines to spread the
3069# cache among different disk partitions.
3070#
3071# Type specifies the kind of storage system to use. Only "ufs"
3072# is built by default. To enable any of the other storage systems
3073# see the --enable-storeio configure option.
3074#
3075# 'Directory' is a top-level directory where cache swap
3076# files will be stored. If you want to use an entire disk
3077# for caching, this can be the mount-point directory.
3078# The directory must exist and be writable by the Squid
3079# process. Squid will NOT create this directory for you.
3080#
3081# In SMP configurations, cache_dir must not precede the workers option
3082# and should use configuration macros or conditionals to give each
3083# worker interested in disk caching a dedicated cache directory.
3084#
3085#
3086# ==== The ufs store type ====
3087#
3088# "ufs" is the old well-known Squid storage format that has always
3089# been there.
3090#
3091# Usage:
3092# cache_dir ufs Directory-Name Mbytes L1 L2 [options]
3093#
3094# 'Mbytes' is the amount of disk space (MB) to use under this
3095# directory. The default is 100 MB. Change this to suit your
3096# configuration. Do NOT put the size of your disk drive here.
3097# Instead, if you want Squid to use the entire disk drive,
3098# subtract 20% and use that value.
3099#
3100# 'L1' is the number of first-level subdirectories which
3101# will be created under the 'Directory'. The default is 16.
3102#
3103# 'L2' is the number of second-level subdirectories which
3104# will be created under each first-level directory. The default
3105# is 256.
3106#
3107#
3108# ==== The aufs store type ====
3109#
3110# "aufs" uses the same storage format as "ufs", utilizing
3111# POSIX-threads to avoid blocking the main Squid process on
3112# disk-I/O. This was formerly known in Squid as async-io.
3113#
3114# Usage:
3115# cache_dir aufs Directory-Name Mbytes L1 L2 [options]
3116#
3117# see argument descriptions under ufs above
3118#
3119#
3120# ==== The diskd store type ====
3121#
3122# "diskd" uses the same storage format as "ufs", utilizing a
3123# separate process to avoid blocking the main Squid process on
3124# disk-I/O.
3125#
3126# Usage:
3127# cache_dir diskd Directory-Name Mbytes L1 L2 [options] [Q1=n] [Q2=n]
3128#
3129# see argument descriptions under ufs above
3130#
3131# Q1 specifies the number of unacknowledged I/O requests when Squid
3132# stops opening new files. If this many messages are in the queues,
3133# Squid won't open new files. Default is 64
3134#
3135# Q2 specifies the number of unacknowledged messages when Squid
3136# starts blocking. If this many messages are in the queues,
3137# Squid blocks until it receives some replies. Default is 72
3138#
3139# When Q1 < Q2 (the default), the cache directory is optimized
3140# for lower response time at the expense of a decrease in hit
3141# ratio. If Q1 > Q2, the cache directory is optimized for
3142# higher hit ratio at the expense of an increase in response
3143# time.
3144#
3145#
3146# ==== The rock store type ====
3147#
3148# Usage:
3149# cache_dir rock Directory-Name Mbytes <max-size=bytes> [options]
3150#
3151# The Rock Store type is a database-style storage. All cached
3152# entries are stored in a "database" file, using fixed-size slots,
3153# one entry per slot. The database size is specified in MB. The
3154# slot size is specified in bytes using the max-size option. See
3155# below for more info on the max-size option.
3156#
3157# If possible, Squid using Rock Store creates a dedicated kid
3158# process called "disker" to avoid blocking Squid worker(s) on disk
3159# I/O. One disker kid is created for each rock cache_dir. Diskers
3160# are created only when Squid, running in daemon mode, has support
3161# for the IpcIo disk I/O module.
3162#
3163# swap-timeout=msec: Squid will not start writing a miss to or
3164# reading a hit from disk if it estimates that the swap operation
3165# will take more than the specified number of milliseconds. By
3166# default and when set to zero, disables the disk I/O time limit
3167# enforcement. Ignored when using blocking I/O module because
3168# blocking synchronous I/O does not allow Squid to estimate the
3169# expected swap wait time.
3170#
3171# max-swap-rate=swaps/sec: Artificially limits disk access using
3172# the specified I/O rate limit. Swap out requests that
3173# would cause the average I/O rate to exceed the limit are
3174# delayed. Individual swap in requests (i.e., hits or reads) are
3175# not delayed, but they do contribute to measured swap rate and
3176# since they are placed in the same FIFO queue as swap out
3177# requests, they may wait longer if max-swap-rate is smaller.
3178# This is necessary on file systems that buffer "too
3179# many" writes and then start blocking Squid and other processes
3180# while committing those writes to disk. Usually used together
3181# with swap-timeout to avoid excessive delays and queue overflows
3182# when disk demand exceeds available disk "bandwidth". By default
3183# and when set to zero, disables the disk I/O rate limit
3184# enforcement. Currently supported by IpcIo module only.
3185#
3186#
3187# ==== The coss store type ====
3188#
3189# NP: COSS filesystem in Squid-3 has been deemed too unstable for
3190# production use and has thus been removed from this release.
3191# We hope that it can be made usable again soon.
3192#
3193# block-size=n defines the "block size" for COSS cache_dir's.
3194# Squid uses file numbers as block numbers. Since file numbers
3195# are limited to 24 bits, the block size determines the maximum
3196# size of the COSS partition. The default is 512 bytes, which
3197# leads to a maximum cache_dir size of 512<<24, or 8 GB. Note
3198# you should not change the coss block size after Squid
3199# has written some objects to the cache_dir.
3200#
3201# The coss file store has changed from 2.5. Now it uses a file
3202# called 'stripe' in the directory names in the config - and
3203# this will be created by squid -z.
3204#
3205#
3206# ==== COMMON OPTIONS ====
3207#
3208# no-store no new objects should be stored to this cache_dir.
3209#
3210# min-size=n the minimum object size in bytes this cache_dir
3211# will accept. It's used to restrict a cache_dir
3212# to only store large objects (e.g. AUFS) while
3213# other stores are optimized for smaller objects
3214# (e.g. COSS).
3215# Defaults to 0.
3216#
3217# max-size=n the maximum object size in bytes this cache_dir
3218# supports.
3219# The value in maximum_object_size directive sets
3220# the default unless more specific details are
3221# available (ie a small store capacity).
3222#
3223# Note: To make optimal use of the max-size limits you should order
3224# the cache_dir lines with the smallest max-size value first.
3225#
3226# Note for coss, max-size must be less than COSS_MEMBUF_SZ,
3227# which can be changed with the --with-coss-membuf-size=N configure
3228# option.
3229#
3230#Default:
3231# No disk cache. Store cache ojects only in memory.
3232#
3233
3234# Uncomment and adjust the following to add a disk cache directory.
3235#cache_dir ufs /var/spool/squid3 100 16 256
3236
3237# TAG: store_dir_select_algorithm
3238# How Squid selects which cache_dir to use when the response
3239# object will fit into more than one.
3240#
3241# Regardless of which algorithm is used the cache_dir min-size
3242# and max-size parameters are obeyed. As such they can affect
3243# the selection algorithm by limiting the set of considered
3244# cache_dir.
3245#
3246# Algorithms:
3247#
3248# least-load
3249#
3250# This algorithm is suited to caches with similar cache_dir
3251# sizes and disk speeds.
3252#
3253# The disk with the least I/O pending is selected.
3254# When there are multiple disks with the same I/O load ranking
3255# the cache_dir with most available capacity is selected.
3256#
3257# When a mix of cache_dir sizes are configured the faster disks
3258# have a naturally lower I/O loading and larger disks have more
3259# capacity. So space used to store objects and data throughput
3260# may be very unbalanced towards larger disks.
3261#
3262#
3263# round-robin
3264#
3265# This algorithm is suited to caches with unequal cache_dir
3266# disk sizes.
3267#
3268# Each cache_dir is selected in a rotation. The next suitable
3269# cache_dir is used.
3270#
3271# Available cache_dir capacity is only considered in relation
3272# to whether the object will fit and meets the min-size and
3273# max-size parameters.
3274#
3275# Disk I/O loading is only considered to prevent overload on slow
3276# disks. This algorithm does not spread objects by size, so any
3277# I/O loading per-disk may appear very unbalanced and volatile.
3278#
3279#Default:
3280# store_dir_select_algorithm least-load
3281
3282# TAG: max_open_disk_fds
3283# To avoid having disk as the I/O bottleneck Squid can optionally
3284# bypass the on-disk cache if more than this amount of disk file
3285# descriptors are open.
3286#
3287# A value of 0 indicates no limit.
3288#Default:
3289# no limit
3290
3291# TAG: cache_swap_low (percent, 0-100)
3292# The low-water mark for cache object replacement.
3293# Replacement begins when the swap (disk) usage is above the
3294# low-water mark and attempts to maintain utilization near the
3295# low-water mark. As swap utilization gets close to high-water
3296# mark object eviction becomes more aggressive. If utilization is
3297# close to the low-water mark less replacement is done each time.
3298#
3299# Defaults are 90% and 95%. If you have a large cache, 5% could be
3300# hundreds of MB. If this is the case you may wish to set these
3301# numbers closer together.
3302#
3303# See also cache_swap_high
3304#Default:
3305# cache_swap_low 90
3306
3307# TAG: cache_swap_high (percent, 0-100)
3308# The high-water mark for cache object replacement.
3309# Replacement begins when the swap (disk) usage is above the
3310# low-water mark and attempts to maintain utilization near the
3311# low-water mark. As swap utilization gets close to high-water
3312# mark object eviction becomes more aggressive. If utilization is
3313# close to the low-water mark less replacement is done each time.
3314#
3315# Defaults are 90% and 95%. If you have a large cache, 5% could be
3316# hundreds of MB. If this is the case you may wish to set these
3317# numbers closer together.
3318#
3319# See also cache_swap_low
3320#Default:
3321# cache_swap_high 95
3322
3323# LOGFILE OPTIONS
3324# -----------------------------------------------------------------------------
3325
3326# TAG: logformat
3327# Usage:
3328#
3329# logformat <name> <format specification>
3330#
3331# Defines an access log format.
3332#
3333# The <format specification> is a string with embedded % format codes
3334#
3335# % format codes all follow the same basic structure where all but
3336# the formatcode is optional. Output strings are automatically escaped
3337# as required according to their context and the output format
3338# modifiers are usually not needed, but can be specified if an explicit
3339# output format is desired.
3340#
3341# % ["|[|'|#] [-] [[0]width] [{argument}] formatcode
3342#
3343# " output in quoted string format
3344# [ output in squid text log format as used by log_mime_hdrs
3345# # output in URL quoted format
3346# ' output as-is
3347#
3348# - left aligned
3349#
3350# width minimum and/or maximum field width:
3351# [width_min][.width_max]
3352# When minimum starts with 0, the field is zero-padded.
3353# String values exceeding maximum width are truncated.
3354#
3355# {arg} argument such as header name etc
3356#
3357# Format codes:
3358#
3359# % a literal % character
3360# sn Unique sequence number per log line entry
3361# err_code The ID of an error response served by Squid or
3362# a similar internal error identifier.
3363# err_detail Additional err_code-dependent error information.
3364# note The annotation specified by the argument. Also
3365# logs the adaptation meta headers set by the
3366# adaptation_meta configuration parameter.
3367# If no argument given all annotations logged.
3368# The argument may include a separator to use with
3369# annotation values:
3370# name[:separator]
3371# By default, multiple note values are separated with ","
3372# and multiple notes are separated with "\r\n".
3373# When logging named notes with %{name}note, the
3374# explicitly configured separator is used between note
3375# values. When logging all notes with %note, the
3376# explicitly configured separator is used between
3377# individual notes. There is currently no way to
3378# specify both value and notes separators when logging
3379# all notes with %note.
3380#
3381# Connection related format codes:
3382#
3383# >a Client source IP address
3384# >A Client FQDN
3385# >p Client source port
3386# >eui Client source EUI (MAC address, EUI-48 or EUI-64 identifier)
3387# >la Local IP address the client connected to
3388# >lp Local port number the client connected to
3389# >qos Client connection TOS/DSCP value set by Squid
3390# >nfmark Client connection netfilter mark set by Squid
3391#
3392# la Local listening IP address the client connection was connected to.
3393# lp Local listening port number the client connection was connected to.
3394#
3395# <a Server IP address of the last server or peer connection
3396# <A Server FQDN or peer name
3397# <p Server port number of the last server or peer connection
3398# <la Local IP address of the last server or peer connection
3399# <lp Local port number of the last server or peer connection
3400# <qos Server connection TOS/DSCP value set by Squid
3401# <nfmark Server connection netfilter mark set by Squid
3402#
3403# Time related format codes:
3404#
3405# ts Seconds since epoch
3406# tu subsecond time (milliseconds)
3407# tl Local time. Optional strftime format argument
3408# default %d/%b/%Y:%H:%M:%S %z
3409# tg GMT time. Optional strftime format argument
3410# default %d/%b/%Y:%H:%M:%S %z
3411# tr Response time (milliseconds)
3412# dt Total time spent making DNS lookups (milliseconds)
3413#
3414# Access Control related format codes:
3415#
3416# et Tag returned by external acl
3417# ea Log string returned by external acl
3418# un User name (any available)
3419# ul User name from authentication
3420# ue User name from external acl helper
3421# ui User name from ident
3422# us User name from SSL
3423#
3424# HTTP related format codes:
3425#
3426# [http::]>h Original received request header.
3427# Usually differs from the request header sent by
3428# Squid, although most fields are often preserved.
3429# Accepts optional header field name/value filter
3430# argument using name[:[separator]element] format.
3431# [http::]>ha Received request header after adaptation and
3432# redirection (pre-cache REQMOD vectoring point).
3433# Usually differs from the request header sent by
3434# Squid, although most fields are often preserved.
3435# Optional header name argument as for >h
3436# [http::]<h Reply header. Optional header name argument
3437# as for >h
3438# [http::]>Hs HTTP status code sent to the client
3439# [http::]<Hs HTTP status code received from the next hop
3440# [http::]<bs Number of HTTP-equivalent message body bytes
3441# received from the next hop, excluding chunked
3442# transfer encoding and control messages.
3443# Generated FTP/Gopher listings are treated as
3444# received bodies.
3445# [http::]mt MIME content type
3446# [http::]rm Request method (GET/POST etc)
3447# [http::]>rm Request method from client
3448# [http::]<rm Request method sent to server or peer
3449# [http::]ru Request URL from client (historic, filtered for logging)
3450# [http::]>ru Request URL from client
3451# [http::]<ru Request URL sent to server or peer
3452# [http::]rp Request URL-Path excluding hostname
3453# [http::]>rp Request URL-Path excluding hostname from client
3454# [http::]<rp Request URL-Path excluding hostname sento to server or peer
3455# [http::]rv Request protocol version
3456# [http::]>rv Request protocol version from client
3457# [http::]<rv Request protocol version sent to server or peer
3458# [http::]<st Sent reply size including HTTP headers
3459# [http::]>st Received request size including HTTP headers. In the
3460# case of chunked requests the chunked encoding metadata
3461# are not included
3462# [http::]>sh Received HTTP request headers size
3463# [http::]<sh Sent HTTP reply headers size
3464# [http::]st Request+Reply size including HTTP headers
3465# [http::]<sH Reply high offset sent
3466# [http::]<sS Upstream object size
3467# [http::]<pt Peer response time in milliseconds. The timer starts
3468# when the last request byte is sent to the next hop
3469# and stops when the last response byte is received.
3470# [http::]<tt Total server-side time in milliseconds. The timer
3471# starts with the first connect request (or write I/O)
3472# sent to the first selected peer. The timer stops
3473# with the last I/O with the last peer.
3474#
3475# Squid handling related format codes:
3476#
3477# Ss Squid request status (TCP_MISS etc)
3478# Sh Squid hierarchy status (DEFAULT_PARENT etc)
3479#
3480# SSL-related format codes:
3481#
3482# ssl::bump_mode SslBump decision for the transaction:
3483#
3484# For CONNECT requests that initiated bumping of
3485# a connection and for any request received on
3486# an already bumped connection, Squid logs the
3487# corresponding SslBump mode ("server-first" or
3488# "client-first"). See the ssl_bump option for
3489# more information about these modes.
3490#
3491# A "none" token is logged for requests that
3492# triggered "ssl_bump" ACL evaluation matching
3493# either a "none" rule or no rules at all.
3494#
3495# In all other cases, a single dash ("-") is
3496# logged.
3497#
3498# If ICAP is enabled, the following code becomes available (as
3499# well as ICAP log codes documented with the icap_log option):
3500#
3501# icap::tt Total ICAP processing time for the HTTP
3502# transaction. The timer ticks when ICAP
3503# ACLs are checked and when ICAP
3504# transaction is in progress.
3505#
3506# If adaptation is enabled the following three codes become available:
3507#
3508# adapt::<last_h The header of the last ICAP response or
3509# meta-information from the last eCAP
3510# transaction related to the HTTP transaction.
3511# Like <h, accepts an optional header name
3512# argument.
3513#
3514# adapt::sum_trs Summed adaptation transaction response
3515# times recorded as a comma-separated list in
3516# the order of transaction start time. Each time
3517# value is recorded as an integer number,
3518# representing response time of one or more
3519# adaptation (ICAP or eCAP) transaction in
3520# milliseconds. When a failed transaction is
3521# being retried or repeated, its time is not
3522# logged individually but added to the
3523# replacement (next) transaction. See also:
3524# adapt::all_trs.
3525#
3526# adapt::all_trs All adaptation transaction response times.
3527# Same as adaptation_strs but response times of
3528# individual transactions are never added
3529# together. Instead, all transaction response
3530# times are recorded individually.
3531#
3532# You can prefix adapt::*_trs format codes with adaptation
3533# service name in curly braces to record response time(s) specific
3534# to that service. For example: %{my_service}adapt::sum_trs
3535#
3536# If SSL is enabled, the following formating codes become available:
3537#
3538# %ssl::>cert_subject The Subject field of the received client
3539# SSL certificate or a dash ('-') if Squid has
3540# received an invalid/malformed certificate or
3541# no certificate at all. Consider encoding the
3542# logged value because Subject often has spaces.
3543#
3544# %ssl::>cert_issuer The Issuer field of the received client
3545# SSL certificate or a dash ('-') if Squid has
3546# received an invalid/malformed certificate or
3547# no certificate at all. Consider encoding the
3548# logged value because Issuer often has spaces.
3549#
3550# The default formats available (which do not need re-defining) are:
3551#
3552#logformat squid %ts.%03tu %6tr %>a %Ss/%03>Hs %<st %rm %ru %[un %Sh/%<a %mt
3553#logformat common %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st %Ss:%Sh
3554#logformat combined %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh
3555#logformat referrer %ts.%03tu %>a %{Referer}>h %ru
3556#logformat useragent %>a [%tl] "%{User-Agent}>h"
3557#
3558# NOTE: When the log_mime_hdrs directive is set to ON.
3559# The squid, common and combined formats have a safely encoded copy
3560# of the mime headers appended to each line within a pair of brackets.
3561#
3562# NOTE: The common and combined formats are not quite true to the Apache definition.
3563# The logs from Squid contain an extra status and hierarchy code appended.
3564#
3565#Default:
3566# The format definitions squid, common, combined, referrer, useragent are built in.
3567
3568# TAG: access_log
3569# Configures whether and how Squid logs HTTP and ICP transactions.
3570# If access logging is enabled, a single line is logged for every
3571# matching HTTP or ICP request. The recommended directive formats are:
3572#
3573# access_log <module>:<place> [option ...] [acl acl ...]
3574# access_log none [acl acl ...]
3575#
3576# The following directive format is accepted but may be deprecated:
3577# access_log <module>:<place> [<logformat name> [acl acl ...]]
3578#
3579# In most cases, the first ACL name must not contain the '=' character
3580# and should not be equal to an existing logformat name. You can always
3581# start with an 'all' ACL to work around those restrictions.
3582#
3583# Will log to the specified module:place using the specified format (which
3584# must be defined in a logformat directive) those entries which match
3585# ALL the acl's specified (which must be defined in acl clauses).
3586# If no acl is specified, all requests will be logged to this destination.
3587#
3588# ===== Available options for the recommended directive format =====
3589#
3590# logformat=name Names log line format (either built-in or
3591# defined by a logformat directive). Defaults
3592# to 'squid'.
3593#
3594# buffer-size=64KB Defines approximate buffering limit for log
3595# records (see buffered_logs). Squid should not
3596# keep more than the specified size and, hence,
3597# should flush records before the buffer becomes
3598# full to avoid overflows under normal
3599# conditions (the exact flushing algorithm is
3600# module-dependent though). The on-error option
3601# controls overflow handling.
3602#
3603# on-error=die|drop Defines action on unrecoverable errors. The
3604# 'drop' action ignores (i.e., does not log)
3605# affected log records. The default 'die' action
3606# kills the affected worker. The drop action
3607# support has not been tested for modules other
3608# than tcp.
3609#
3610# ===== Modules Currently available =====
3611#
3612# none Do not log any requests matching these ACL.
3613# Do not specify Place or logformat name.
3614#
3615# stdio Write each log line to disk immediately at the completion of
3616# each request.
3617# Place: the filename and path to be written.
3618#
3619# daemon Very similar to stdio. But instead of writing to disk the log
3620# line is passed to a daemon helper for asychronous handling instead.
3621# Place: varies depending on the daemon.
3622#
3623# log_file_daemon Place: the file name and path to be written.
3624#
3625# syslog To log each request via syslog facility.
3626# Place: The syslog facility and priority level for these entries.
3627# Place Format: facility.priority
3628#
3629# where facility could be any of:
3630# authpriv, daemon, local0 ... local7 or user.
3631#
3632# And priority could be any of:
3633# err, warning, notice, info, debug.
3634#
3635# udp To send each log line as text data to a UDP receiver.
3636# Place: The destination host name or IP and port.
3637# Place Format: //host:port
3638#
3639# tcp To send each log line as text data to a TCP receiver.
3640# Lines may be accumulated before sending (see buffered_logs).
3641# Place: The destination host name or IP and port.
3642# Place Format: //host:port
3643#
3644# Default:
3645# access_log daemon:/var/log/squid3/access.log squid
3646#Default:
3647 access_log daemon:/var/log/squid3/access.log common
3648
3649# TAG: icap_log
3650# ICAP log files record ICAP transaction summaries, one line per
3651# transaction.
3652#
3653# The icap_log option format is:
3654# icap_log <filepath> [<logformat name> [acl acl ...]]
3655# icap_log none [acl acl ...]]
3656#
3657# Please see access_log option documentation for details. The two
3658# kinds of logs share the overall configuration approach and many
3659# features.
3660#
3661# ICAP processing of a single HTTP message or transaction may
3662# require multiple ICAP transactions. In such cases, multiple
3663# ICAP transaction log lines will correspond to a single access
3664# log line.
3665#
3666# ICAP log uses logformat codes that make sense for an ICAP
3667# transaction. Header-related codes are applied to the HTTP header
3668# embedded in an ICAP server response, with the following caveats:
3669# For REQMOD, there is no HTTP response header unless the ICAP
3670# server performed request satisfaction. For RESPMOD, the HTTP
3671# request header is the header sent to the ICAP server. For
3672# OPTIONS, there are no HTTP headers.
3673#
3674# The following format codes are also available for ICAP logs:
3675#
3676# icap::<A ICAP server IP address. Similar to <A.
3677#
3678# icap::<service_name ICAP service name from the icap_service
3679# option in Squid configuration file.
3680#
3681# icap::ru ICAP Request-URI. Similar to ru.
3682#
3683# icap::rm ICAP request method (REQMOD, RESPMOD, or
3684# OPTIONS). Similar to existing rm.
3685#
3686# icap::>st Bytes sent to the ICAP server (TCP payload
3687# only; i.e., what Squid writes to the socket).
3688#
3689# icap::<st Bytes received from the ICAP server (TCP
3690# payload only; i.e., what Squid reads from
3691# the socket).
3692#
3693# icap::<bs Number of message body bytes received from the
3694# ICAP server. ICAP message body, if any, usually
3695# includes encapsulated HTTP message headers and
3696# possibly encapsulated HTTP message body. The
3697# HTTP body part is dechunked before its size is
3698# computed.
3699#
3700# icap::tr Transaction response time (in
3701# milliseconds). The timer starts when
3702# the ICAP transaction is created and
3703# stops when the transaction is completed.
3704# Similar to tr.
3705#
3706# icap::tio Transaction I/O time (in milliseconds). The
3707# timer starts when the first ICAP request
3708# byte is scheduled for sending. The timers
3709# stops when the last byte of the ICAP response
3710# is received.
3711#
3712# icap::to Transaction outcome: ICAP_ERR* for all
3713# transaction errors, ICAP_OPT for OPTION
3714# transactions, ICAP_ECHO for 204
3715# responses, ICAP_MOD for message
3716# modification, and ICAP_SAT for request
3717# satisfaction. Similar to Ss.
3718#
3719# icap::Hs ICAP response status code. Similar to Hs.
3720#
3721# icap::>h ICAP request header(s). Similar to >h.
3722#
3723# icap::<h ICAP response header(s). Similar to <h.
3724#
3725# The default ICAP log format, which can be used without an explicit
3726# definition, is called icap_squid:
3727#
3728#logformat icap_squid %ts.%03tu %6icap::tr %>a %icap::to/%03icap::Hs %icap::<size %icap::rm %icap::ru% %un -/%icap::<A -
3729#
3730# See also: logformat, log_icap, and %adapt::<last_h
3731#Default:
3732# none
3733
3734# TAG: logfile_daemon
3735# Specify the path to the logfile-writing daemon. This daemon is
3736# used to write the access and store logs, if configured.
3737#
3738# Squid sends a number of commands to the log daemon:
3739# L<data>\n - logfile data
3740# R\n - rotate file
3741# T\n - truncate file
3742# O\n - reopen file
3743# F\n - flush file
3744# r<n>\n - set rotate count to <n>
3745# b<n>\n - 1 = buffer output, 0 = don't buffer output
3746#
3747# No responses is expected.
3748#Default:
3749# logfile_daemon /usr/lib/squid3/log_file_daemon
3750
3751# TAG: log_access
3752# Remove this line. Use acls with access_log directives to control access logging
3753#Default:
3754# none
3755
3756# TAG: log_icap
3757# Remove this line. Use acls with icap_log directives to control icap logging
3758#Default:
3759# none
3760
3761# TAG: stats_collection allow|deny acl acl...
3762# This options allows you to control which requests gets accounted
3763# in performance counters.
3764#
3765# This clause only supports fast acl types.
3766# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
3767#Default:
3768# Allow logging for all transactions.
3769
3770# TAG: cache_store_log
3771# Logs the activities of the storage manager. Shows which
3772# objects are ejected from the cache, and which objects are
3773# saved and for how long.
3774# There are not really utilities to analyze this data, so you can safely
3775# disable it (the default).
3776#
3777# Store log uses modular logging outputs. See access_log for the list
3778# of modules supported.
3779#
3780# Example:
3781# cache_store_log stdio:/var/log/squid3/store.log
3782# cache_store_log daemon:/var/log/squid3/store.log
3783#Default:
3784# none
3785
3786# TAG: cache_swap_state
3787# Location for the cache "swap.state" file. This index file holds
3788# the metadata of objects saved on disk. It is used to rebuild
3789# the cache during startup. Normally this file resides in each
3790# 'cache_dir' directory, but you may specify an alternate
3791# pathname here. Note you must give a full filename, not just
3792# a directory. Since this is the index for the whole object
3793# list you CANNOT periodically rotate it!
3794#
3795# If %s can be used in the file name it will be replaced with a
3796# a representation of the cache_dir name where each / is replaced
3797# with '.'. This is needed to allow adding/removing cache_dir
3798# lines when cache_swap_log is being used.
3799#
3800# If have more than one 'cache_dir', and %s is not used in the name
3801# these swap logs will have names such as:
3802#
3803# cache_swap_log.00
3804# cache_swap_log.01
3805# cache_swap_log.02
3806#
3807# The numbered extension (which is added automatically)
3808# corresponds to the order of the 'cache_dir' lines in this
3809# configuration file. If you change the order of the 'cache_dir'
3810# lines in this file, these index files will NOT correspond to
3811# the correct 'cache_dir' entry (unless you manually rename
3812# them). We recommend you do NOT use this option. It is
3813# better to keep these index files in each 'cache_dir' directory.
3814#Default:
3815# Store the journal inside its cache_dir
3816
3817# TAG: logfile_rotate
3818# Specifies the number of logfile rotations to make when you
3819# type 'squid -k rotate'. The default is 10, which will rotate
3820# with extensions 0 through 9. Setting logfile_rotate to 0 will
3821# disable the file name rotation, but the logfiles are still closed
3822# and re-opened. This will enable you to rename the logfiles
3823# yourself just before sending the rotate signal.
3824#
3825# Note, the 'squid -k rotate' command normally sends a USR1
3826# signal to the running squid process. In certain situations
3827# (e.g. on Linux with Async I/O), USR1 is used for other
3828# purposes, so -k rotate uses another signal. It is best to get
3829# in the habit of using 'squid -k rotate' instead of 'kill -USR1
3830# <pid>'.
3831#
3832# Note, from Squid-3.1 this option is only a default for cache.log,
3833# that log can be rotated separately by using debug_options.
3834#
3835# Note2, for Debian/Linux the default of logfile_rotate is
3836# zero, since it includes external logfile-rotation methods.
3837#Default:
3838# logfile_rotate 0
3839
3840# TAG: emulate_httpd_log
3841# Replace this with an access_log directive using the format 'common' or 'combined'.
3842#Default:
3843# none
3844
3845# TAG: log_ip_on_direct
3846# Remove this option from your config. To log server or peer names use %<A in the log format.
3847#Default:
3848# none
3849
3850# TAG: mime_table
3851# Path to Squid's icon configuration file.
3852#
3853# You shouldn't need to change this, but the default file contains
3854# examples and formatting information if you do.
3855#Default:
3856# mime_table /usr/share/squid3/mime.conf
3857
3858# TAG: log_mime_hdrs on|off
3859# The Cache can record both the request and the response MIME
3860# headers for each HTTP transaction. The headers are encoded
3861# safely and will appear as two bracketed fields at the end of
3862# the access log (for either the native or httpd-emulated log
3863# formats). To enable this logging set log_mime_hdrs to 'on'.
3864#Default:
3865# log_mime_hdrs off
3866
3867# TAG: useragent_log
3868# Replace this with an access_log directive using the format 'useragent'.
3869#Default:
3870# none
3871
3872# TAG: referer_log
3873# Replace this with an access_log directive using the format 'referrer'.
3874#Default:
3875# none
3876
3877# TAG: pid_filename
3878# A filename to write the process-id to. To disable, enter "none".
3879#Default:
3880# pid_filename /var/run/squid3.pid
3881
3882# TAG: log_fqdn
3883# Remove this option from your config. To log FQDN use %>A in the log format.
3884#Default:
3885# none
3886
3887# TAG: client_netmask
3888# A netmask for client addresses in logfiles and cachemgr output.
3889# Change this to protect the privacy of your cache clients.
3890# A netmask of 255.255.255.0 will log all IP's in that range with
3891# the last digit set to '0'.
3892#Default:
3893# Log full client IP address
3894
3895# TAG: forward_log
3896# Use a regular access.log with ACL limiting it to MISS events.
3897#Default:
3898# none
3899
3900# TAG: strip_query_terms
3901# By default, Squid strips query terms from requested URLs before
3902# logging. This protects your user's privacy and reduces log size.
3903#
3904# When investigating HIT/MISS or other caching behaviour you
3905# will need to disable this to see the full URL used by Squid.
3906#Default:
3907# strip_query_terms on
3908
3909# TAG: buffered_logs on|off
3910# Whether to write/send access_log records ASAP or accumulate them and
3911# then write/send them in larger chunks. Buffering may improve
3912# performance because it decreases the number of I/Os. However,
3913# buffering increases the delay before log records become available to
3914# the final recipient (e.g., a disk file or logging daemon) and,
3915# hence, increases the risk of log records loss.
3916#
3917# Note that even when buffered_logs are off, Squid may have to buffer
3918# records if it cannot write/send them immediately due to pending I/Os
3919# (e.g., the I/O writing the previous log record) or connectivity loss.
3920#
3921# Currently honored by 'daemon' and 'tcp' access_log modules only.
3922#Default:
3923# buffered_logs off
3924
3925# TAG: netdb_filename
3926# Where Squid stores it's netdb journal.
3927# When enabled this journal preserves netdb state between restarts.
3928#
3929# To disable, enter "none".
3930#Default:
3931# netdb_filename stdio:/var/log/squid3/netdb.state
3932
3933# OPTIONS FOR TROUBLESHOOTING
3934# -----------------------------------------------------------------------------
3935
3936# TAG: cache_log
3937# Squid administrative logging file.
3938#
3939# This is where general information about Squid behavior goes. You can
3940# increase the amount of data logged to this file and how often it is
3941# rotated with "debug_options"
3942#Default:
3943# cache_log /var/log/squid3/cache.log
3944
3945# TAG: debug_options
3946# Logging options are set as section,level where each source file
3947# is assigned a unique section. Lower levels result in less
3948# output, Full debugging (level 9) can result in a very large
3949# log file, so be careful.
3950#
3951# The magic word "ALL" sets debugging levels for all sections.
3952# The default is to run with "ALL,1" to record important warnings.
3953#
3954# The rotate=N option can be used to keep more or less of these logs
3955# than would otherwise be kept by logfile_rotate.
3956# For most uses a single log should be enough to monitor current
3957# events affecting Squid.
3958#Default:
3959# Log all critical and important messages.
3960
3961# TAG: coredump_dir
3962# By default Squid leaves core files in the directory from where
3963# it was started. If you set 'coredump_dir' to a directory
3964# that exists, Squid will chdir() to that directory at startup
3965# and coredump files will be left there.
3966#
3967#Default:
3968# Use the directory from where Squid was started.
3969#
3970
3971# Leave coredumps in the first cache dir
3972coredump_dir /var/spool/squid3
3973
3974# OPTIONS FOR FTP GATEWAYING
3975# -----------------------------------------------------------------------------
3976
3977# TAG: ftp_user
3978# If you want the anonymous login password to be more informative
3979# (and enable the use of picky FTP servers), set this to something
3980# reasonable for your domain, like wwwuser@somewhere.net
3981#
3982# The reason why this is domainless by default is the
3983# request can be made on the behalf of a user in any domain,
3984# depending on how the cache is used.
3985# Some FTP server also validate the email address is valid
3986# (for example perl.com).
3987#Default:
3988# ftp_user Squid@
3989
3990# TAG: ftp_passive
3991# If your firewall does not allow Squid to use passive
3992# connections, turn off this option.
3993#
3994# Use of ftp_epsv_all option requires this to be ON.
3995#Default:
3996# ftp_passive on
3997
3998# TAG: ftp_epsv_all
3999# FTP Protocol extensions permit the use of a special "EPSV ALL" command.
4000#
4001# NATs may be able to put the connection on a "fast path" through the
4002# translator, as the EPRT command will never be used and therefore,
4003# translation of the data portion of the segments will never be needed.
4004#
4005# When a client only expects to do two-way FTP transfers this may be
4006# useful.
4007# If squid finds that it must do a three-way FTP transfer after issuing
4008# an EPSV ALL command, the FTP session will fail.
4009#
4010# If you have any doubts about this option do not use it.
4011# Squid will nicely attempt all other connection methods.
4012#
4013# Requires ftp_passive to be ON (default) for any effect.
4014#Default:
4015# ftp_epsv_all off
4016
4017# TAG: ftp_epsv
4018# FTP Protocol extensions permit the use of a special "EPSV" command.
4019#
4020# NATs may be able to put the connection on a "fast path" through the
4021# translator using EPSV, as the EPRT command will never be used
4022# and therefore, translation of the data portion of the segments
4023# will never be needed.
4024#
4025# Turning this OFF will prevent EPSV being attempted.
4026# WARNING: Doing so will convert Squid back to the old behavior with all
4027# the related problems with external NAT devices/layers.
4028#
4029# Requires ftp_passive to be ON (default) for any effect.
4030#Default:
4031# ftp_epsv on
4032
4033# TAG: ftp_eprt
4034# FTP Protocol extensions permit the use of a special "EPRT" command.
4035#
4036# This extension provides a protocol neutral alternative to the
4037# IPv4-only PORT command. When supported it enables active FTP data
4038# channels over IPv6 and efficient NAT handling.
4039#
4040# Turning this OFF will prevent EPRT being attempted and will skip
4041# straight to using PORT for IPv4 servers.
4042#
4043# Some devices are known to not handle this extension correctly and
4044# may result in crashes. Devices which suport EPRT enough to fail
4045# cleanly will result in Squid attempting PORT anyway. This directive
4046# should only be disabled when EPRT results in device failures.
4047#
4048# WARNING: Doing so will convert Squid back to the old behavior with all
4049# the related problems with external NAT devices/layers and IPv4-only FTP.
4050#Default:
4051# ftp_eprt on
4052
4053# TAG: ftp_sanitycheck
4054# For security and data integrity reasons Squid by default performs
4055# sanity checks of the addresses of FTP data connections ensure the
4056# data connection is to the requested server. If you need to allow
4057# FTP connections to servers using another IP address for the data
4058# connection turn this off.
4059#Default:
4060# ftp_sanitycheck on
4061
4062# TAG: ftp_telnet_protocol
4063# The FTP protocol is officially defined to use the telnet protocol
4064# as transport channel for the control connection. However, many
4065# implementations are broken and does not respect this aspect of
4066# the FTP protocol.
4067#
4068# If you have trouble accessing files with ASCII code 255 in the
4069# path or similar problems involving this ASCII code you can
4070# try setting this directive to off. If that helps, report to the
4071# operator of the FTP server in question that their FTP server
4072# is broken and does not follow the FTP standard.
4073#Default:
4074# ftp_telnet_protocol on
4075
4076# OPTIONS FOR EXTERNAL SUPPORT PROGRAMS
4077# -----------------------------------------------------------------------------
4078
4079# TAG: diskd_program
4080# Specify the location of the diskd executable.
4081# Note this is only useful if you have compiled in
4082# diskd as one of the store io modules.
4083#Default:
4084# diskd_program /usr/lib/squid3/diskd
4085
4086# TAG: unlinkd_program
4087# Specify the location of the executable for file deletion process.
4088#Default:
4089# unlinkd_program /usr/lib/squid3/unlinkd
4090
4091# TAG: pinger_program
4092# Specify the location of the executable for the pinger process.
4093#Default:
4094# pinger_program /usr/lib/squid3/pinger
4095
4096# TAG: pinger_enable
4097# Control whether the pinger is active at run-time.
4098# Enables turning ICMP pinger on and off with a simple
4099# squid -k reconfigure.
4100#Default:
4101# pinger_enable on
4102
4103# OPTIONS FOR URL REWRITING
4104# -----------------------------------------------------------------------------
4105
4106# TAG: url_rewrite_program
4107# Specify the location of the executable URL rewriter to use.
4108# Since they can perform almost any function there isn't one included.
4109#
4110# For each requested URL, the rewriter will receive on line with the format
4111#
4112# [channel-ID <SP>] URL <SP> client_ip "/" fqdn <SP> user <SP> method [<SP> kv-pairs]<NL>
4113#
4114#
4115# After processing the request the helper must reply using the following format:
4116#
4117# [channel-ID <SP>] result [<SP> kv-pairs]
4118#
4119# The result code can be:
4120#
4121# OK status=30N url="..."
4122# Redirect the URL to the one supplied in 'url='.
4123# 'status=' is optional and contains the status code to send
4124# the client in Squids HTTP response. It must be one of the
4125# HTTP redirect status codes: 301, 302, 303, 307, 308.
4126# When no status is given Squid will use 302.
4127#
4128# OK rewrite-url="..."
4129# Rewrite the URL to the one supplied in 'rewrite-url='.
4130# The new URL is fetched directly by Squid and returned to
4131# the client as the response to its request.
4132#
4133# OK
4134# When neither of url= and rewrite-url= are sent Squid does
4135# not change the URL.
4136#
4137# ERR
4138# Do not change the URL.
4139#
4140# BH
4141# An internal error occurred in the helper, preventing
4142# a result being identified. The 'message=' key name is
4143# reserved for delivering a log message.
4144#
4145#
4146# In the future, the interface protocol will be extended with
4147# key=value pairs ("kv-pairs" shown above). Helper programs
4148# should be prepared to receive and possibly ignore additional
4149# whitespace-separated tokens on each input line.
4150#
4151# When using the concurrency= option the protocol is changed by
4152# introducing a query channel tag in front of the request/response.
4153# The query channel tag is a number between 0 and concurrency-1.
4154# This value must be echoed back unchanged to Squid as the first part
4155# of the response relating to its request.
4156#
4157# WARNING: URL re-writing ability should be avoided whenever possible.
4158# Use the URL redirect form of response instead.
4159#
4160# Re-write creates a difference in the state held by the client
4161# and server. Possibly causing confusion when the server response
4162# contains snippets of its view state. Embeded URLs, response
4163# and content Location headers, etc. are not re-written by this
4164# interface.
4165#
4166# By default, a URL rewriter is not used.
4167#Default:
4168# none
4169
4170# TAG: url_rewrite_children
4171# The maximum number of redirector processes to spawn. If you limit
4172# it too few Squid will have to wait for them to process a backlog of
4173# URLs, slowing it down. If you allow too many they will use RAM
4174# and other system resources noticably.
4175#
4176# The startup= and idle= options allow some measure of skew in your
4177# tuning.
4178#
4179# startup=
4180#
4181# Sets a minimum of how many processes are to be spawned when Squid
4182# starts or reconfigures. When set to zero the first request will
4183# cause spawning of the first child process to handle it.
4184#
4185# Starting too few will cause an initial slowdown in traffic as Squid
4186# attempts to simultaneously spawn enough processes to cope.
4187#
4188# idle=
4189#
4190# Sets a minimum of how many processes Squid is to try and keep available
4191# at all times. When traffic begins to rise above what the existing
4192# processes can handle this many more will be spawned up to the maximum
4193# configured. A minimum setting of 1 is required.
4194#
4195# concurrency=
4196#
4197# The number of requests each redirector helper can handle in
4198# parallel. Defaults to 0 which indicates the redirector
4199# is a old-style single threaded redirector.
4200#
4201# When this directive is set to a value >= 1 then the protocol
4202# used to communicate with the helper is modified to include
4203# an ID in front of the request/response. The ID from the request
4204# must be echoed back with the response to that request.
4205#Default:
4206# url_rewrite_children 20 startup=0 idle=1 concurrency=0
4207
4208# TAG: url_rewrite_host_header
4209# To preserve same-origin security policies in browsers and
4210# prevent Host: header forgery by redirectors Squid rewrites
4211# any Host: header in redirected requests.
4212#
4213# If you are running an accelerator this may not be a wanted
4214# effect of a redirector. This directive enables you disable
4215# Host: alteration in reverse-proxy traffic.
4216#
4217# WARNING: Entries are cached on the result of the URL rewriting
4218# process, so be careful if you have domain-virtual hosts.
4219#
4220# WARNING: Squid and other software verifies the URL and Host
4221# are matching, so be careful not to relay through other proxies
4222# or inspecting firewalls with this disabled.
4223#Default:
4224# url_rewrite_host_header on
4225
4226# TAG: url_rewrite_access
4227# If defined, this access list specifies which requests are
4228# sent to the redirector processes.
4229#
4230# This clause supports both fast and slow acl types.
4231# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
4232#Default:
4233# Allow, unless rules exist in squid.conf.
4234
4235# TAG: url_rewrite_bypass
4236# When this is 'on', a request will not go through the
4237# redirector if all the helpers are busy. If this is 'off'
4238# and the redirector queue grows too large, Squid will exit
4239# with a FATAL error and ask you to increase the number of
4240# redirectors. You should only enable this if the redirectors
4241# are not critical to your caching system. If you use
4242# redirectors for access control, and you enable this option,
4243# users may have access to pages they should not
4244# be allowed to request.
4245#Default:
4246# url_rewrite_bypass off
4247
4248# OPTIONS FOR STORE ID
4249# -----------------------------------------------------------------------------
4250
4251# TAG: store_id_program
4252# Specify the location of the executable StoreID helper to use.
4253# Since they can perform almost any function there isn't one included.
4254#
4255# For each requested URL, the helper will receive one line with the format
4256#
4257# [channel-ID <SP>] URL <SP> client_ip "/" fqdn <SP> user <SP> method [<SP> kv-pairs]<NL>
4258#
4259#
4260# After processing the request the helper must reply using the following format:
4261#
4262# [channel-ID <SP>] result [<SP> kv-pairs]
4263#
4264# The result code can be:
4265#
4266# OK store-id="..."
4267# Use the StoreID supplied in 'store-id='.
4268#
4269# ERR
4270# The default is to use HTTP request URL as the store ID.
4271#
4272# BH
4273# An internal error occured in the helper, preventing
4274# a result being identified.
4275#
4276#
4277# Helper programs should be prepared to receive and possibly ignore additional
4278# kv-pairs with keys they do not support.
4279#
4280# When using the concurrency= option the protocol is changed by
4281# introducing a query channel tag in front of the request/response.
4282# The query channel tag is a number between 0 and concurrency-1.
4283# This value must be echoed back unchanged to Squid as the first part
4284# of the response relating to its request.
4285#
4286# NOTE: when using StoreID refresh_pattern will apply to the StoreID
4287# returned from the helper and not the URL.
4288#
4289# WARNING: Wrong StoreID value returned by a careless helper may result
4290# in the wrong cached response returned to the user.
4291#
4292# By default, a StoreID helper is not used.
4293#Default:
4294# none
4295
4296# TAG: store_id_children
4297# The maximum number of StoreID helper processes to spawn. If you limit
4298# it too few Squid will have to wait for them to process a backlog of
4299# requests, slowing it down. If you allow too many they will use RAM
4300# and other system resources noticably.
4301#
4302# The startup= and idle= options allow some measure of skew in your
4303# tuning.
4304#
4305# startup=
4306#
4307# Sets a minimum of how many processes are to be spawned when Squid
4308# starts or reconfigures. When set to zero the first request will
4309# cause spawning of the first child process to handle it.
4310#
4311# Starting too few will cause an initial slowdown in traffic as Squid
4312# attempts to simultaneously spawn enough processes to cope.
4313#
4314# idle=
4315#
4316# Sets a minimum of how many processes Squid is to try and keep available
4317# at all times. When traffic begins to rise above what the existing
4318# processes can handle this many more will be spawned up to the maximum
4319# configured. A minimum setting of 1 is required.
4320#
4321# concurrency=
4322#
4323# The number of requests each storeID helper can handle in
4324# parallel. Defaults to 0 which indicates the helper
4325# is a old-style single threaded program.
4326#
4327# When this directive is set to a value >= 1 then the protocol
4328# used to communicate with the helper is modified to include
4329# an ID in front of the request/response. The ID from the request
4330# must be echoed back with the response to that request.
4331#Default:
4332# store_id_children 20 startup=0 idle=1 concurrency=0
4333
4334# TAG: store_id_access
4335# If defined, this access list specifies which requests are
4336# sent to the StoreID processes. By default all requests
4337# are sent.
4338#
4339# This clause supports both fast and slow acl types.
4340# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
4341#Default:
4342# Allow, unless rules exist in squid.conf.
4343
4344# TAG: store_id_bypass
4345# When this is 'on', a request will not go through the
4346# helper if all helpers are busy. If this is 'off'
4347# and the helper queue grows too large, Squid will exit
4348# with a FATAL error and ask you to increase the number of
4349# helpers. You should only enable this if the helperss
4350# are not critical to your caching system. If you use
4351# helpers for critical caching components, and you enable this
4352# option, users may not get objects from cache.
4353#Default:
4354# store_id_bypass on
4355
4356# OPTIONS FOR TUNING THE CACHE
4357# -----------------------------------------------------------------------------
4358
4359# TAG: cache
4360# A list of ACL elements which, if matched and denied, cause the request to
4361# not be satisfied from the cache and the reply to not be cached.
4362# In other words, use this to force certain objects to never be cached.
4363#
4364# You must use the words 'allow' or 'deny' to indicate whether items
4365# matching the ACL should be allowed or denied into the cache.
4366#
4367# This clause supports both fast and slow acl types.
4368# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
4369#Default:
4370# Allow caching, unless rules exist in squid.conf.
4371
4372# TAG: max_stale time-units
4373# This option puts an upper limit on how stale content Squid
4374# will serve from the cache if cache validation fails.
4375# Can be overriden by the refresh_pattern max-stale option.
4376#Default:
4377# max_stale 1 week
4378
4379# TAG: refresh_pattern
4380# usage: refresh_pattern [-i] regex min percent max [options]
4381#
4382# By default, regular expressions are CASE-SENSITIVE. To make
4383# them case-insensitive, use the -i option.
4384#
4385# 'Min' is the time (in minutes) an object without an explicit
4386# expiry time should be considered fresh. The recommended
4387# value is 0, any higher values may cause dynamic applications
4388# to be erroneously cached unless the application designer
4389# has taken the appropriate actions.
4390#
4391# 'Percent' is a percentage of the objects age (time since last
4392# modification age) an object without explicit expiry time
4393# will be considered fresh.
4394#
4395# 'Max' is an upper limit on how long objects without an explicit
4396# expiry time will be considered fresh.
4397#
4398# options: override-expire
4399# override-lastmod
4400# reload-into-ims
4401# ignore-reload
4402# ignore-no-store
4403# ignore-must-revalidate
4404# ignore-private
4405# ignore-auth
4406# max-stale=NN
4407# refresh-ims
4408# store-stale
4409#
4410# override-expire enforces min age even if the server
4411# sent an explicit expiry time (e.g., with the
4412# Expires: header or Cache-Control: max-age). Doing this
4413# VIOLATES the HTTP standard. Enabling this feature
4414# could make you liable for problems which it causes.
4415#
4416# Note: override-expire does not enforce staleness - it only extends
4417# freshness / min. If the server returns a Expires time which
4418# is longer than your max time, Squid will still consider
4419# the object fresh for that period of time.
4420#
4421# override-lastmod enforces min age even on objects
4422# that were modified recently.
4423#
4424# reload-into-ims changes a client no-cache or ``reload''
4425# request for a cached entry into a conditional request using
4426# If-Modified-Since and/or If-None-Match headers, provided the
4427# cached entry has a Last-Modified and/or a strong ETag header.
4428# Doing this VIOLATES the HTTP standard. Enabling this feature
4429# could make you liable for problems which it causes.
4430#
4431# ignore-reload ignores a client no-cache or ``reload''
4432# header. Doing this VIOLATES the HTTP standard. Enabling
4433# this feature could make you liable for problems which
4434# it causes.
4435#
4436# ignore-no-store ignores any ``Cache-control: no-store''
4437# headers received from a server. Doing this VIOLATES
4438# the HTTP standard. Enabling this feature could make you
4439# liable for problems which it causes.
4440#
4441# ignore-must-revalidate ignores any ``Cache-Control: must-revalidate``
4442# headers received from a server. Doing this VIOLATES
4443# the HTTP standard. Enabling this feature could make you
4444# liable for problems which it causes.
4445#
4446# ignore-private ignores any ``Cache-control: private''
4447# headers received from a server. Doing this VIOLATES
4448# the HTTP standard. Enabling this feature could make you
4449# liable for problems which it causes.
4450#
4451# ignore-auth caches responses to requests with authorization,
4452# as if the originserver had sent ``Cache-control: public''
4453# in the response header. Doing this VIOLATES the HTTP standard.
4454# Enabling this feature could make you liable for problems which
4455# it causes.
4456#
4457# refresh-ims causes squid to contact the origin server
4458# when a client issues an If-Modified-Since request. This
4459# ensures that the client will receive an updated version
4460# if one is available.
4461#
4462# store-stale stores responses even if they don't have explicit
4463# freshness or a validator (i.e., Last-Modified or an ETag)
4464# present, or if they're already stale. By default, Squid will
4465# not cache such responses because they usually can't be
4466# reused. Note that such responses will be stale by default.
4467#
4468# max-stale=NN provide a maximum staleness factor. Squid won't
4469# serve objects more stale than this even if it failed to
4470# validate the object. Default: use the max_stale global limit.
4471#
4472# Basically a cached object is:
4473#
4474# FRESH if expires < now, else STALE
4475# STALE if age > max
4476# FRESH if lm-factor < percent, else STALE
4477# FRESH if age < min
4478# else STALE
4479#
4480# The refresh_pattern lines are checked in the order listed here.
4481# The first entry which matches is used. If none of the entries
4482# match the default will be used.
4483#
4484# Note, you must uncomment all the default lines if you want
4485# to change one. The default setting is only active if none is
4486# used.
4487#
4488#
4489
4490#
4491# Add any of your own refresh_pattern entries above these.
4492#
4493refresh_pattern ^ftp: 1440 20% 10080
4494refresh_pattern ^gopher: 1440 0% 1440
4495refresh_pattern -i (/cgi-bin/|\?) 0 0% 0
4496refresh_pattern . 0 20% 4320
4497
4498# TAG: quick_abort_min (KB)
4499#Default:
4500# quick_abort_min 16 KB
4501
4502# TAG: quick_abort_max (KB)
4503#Default:
4504# quick_abort_max 16 KB
4505
4506# TAG: quick_abort_pct (percent)
4507# The cache by default continues downloading aborted requests
4508# which are almost completed (less than 16 KB remaining). This
4509# may be undesirable on slow (e.g. SLIP) links and/or very busy
4510# caches. Impatient users may tie up file descriptors and
4511# bandwidth by repeatedly requesting and immediately aborting
4512# downloads.
4513#
4514# When the user aborts a request, Squid will check the
4515# quick_abort values to the amount of data transferred until
4516# then.
4517#
4518# If the transfer has less than 'quick_abort_min' KB remaining,
4519# it will finish the retrieval.
4520#
4521# If the transfer has more than 'quick_abort_max' KB remaining,
4522# it will abort the retrieval.
4523#
4524# If more than 'quick_abort_pct' of the transfer has completed,
4525# it will finish the retrieval.
4526#
4527# If you do not want any retrieval to continue after the client
4528# has aborted, set both 'quick_abort_min' and 'quick_abort_max'
4529# to '0 KB'.
4530#
4531# If you want retrievals to always continue if they are being
4532# cached set 'quick_abort_min' to '-1 KB'.
4533#Default:
4534# quick_abort_pct 95
4535
4536# TAG: read_ahead_gap buffer-size
4537# The amount of data the cache will buffer ahead of what has been
4538# sent to the client when retrieving an object from another server.
4539#Default:
4540# read_ahead_gap 16 KB
4541
4542# TAG: negative_ttl time-units
4543# Set the Default Time-to-Live (TTL) for failed requests.
4544# Certain types of failures (such as "connection refused" and
4545# "404 Not Found") are able to be negatively-cached for a short time.
4546# Modern web servers should provide Expires: header, however if they
4547# do not this can provide a minimum TTL.
4548# The default is not to cache errors with unknown expiry details.
4549#
4550# Note that this is different from negative caching of DNS lookups.
4551#
4552# WARNING: Doing this VIOLATES the HTTP standard. Enabling
4553# this feature could make you liable for problems which it
4554# causes.
4555#Default:
4556# negative_ttl 0 seconds
4557
4558# TAG: positive_dns_ttl time-units
4559# Upper limit on how long Squid will cache positive DNS responses.
4560# Default is 6 hours (360 minutes). This directive must be set
4561# larger than negative_dns_ttl.
4562#Default:
4563# positive_dns_ttl 6 hours
4564
4565# TAG: negative_dns_ttl time-units
4566# Time-to-Live (TTL) for negative caching of failed DNS lookups.
4567# This also sets the lower cache limit on positive lookups.
4568# Minimum value is 1 second, and it is not recommendable to go
4569# much below 10 seconds.
4570#Default:
4571# negative_dns_ttl 1 minutes
4572
4573# TAG: range_offset_limit size [acl acl...]
4574# usage: (size) [units] [[!]aclname]
4575#
4576# Sets an upper limit on how far (number of bytes) into the file
4577# a Range request may be to cause Squid to prefetch the whole file.
4578# If beyond this limit, Squid forwards the Range request as it is and
4579# the result is NOT cached.
4580#
4581# This is to stop a far ahead range request (lets say start at 17MB)
4582# from making Squid fetch the whole object up to that point before
4583# sending anything to the client.
4584#
4585# Multiple range_offset_limit lines may be specified, and they will
4586# be searched from top to bottom on each request until a match is found.
4587# The first match found will be used. If no line matches a request, the
4588# default limit of 0 bytes will be used.
4589#
4590# 'size' is the limit specified as a number of units.
4591#
4592# 'units' specifies whether to use bytes, KB, MB, etc.
4593# If no units are specified bytes are assumed.
4594#
4595# A size of 0 causes Squid to never fetch more than the
4596# client requested. (default)
4597#
4598# A size of 'none' causes Squid to always fetch the object from the
4599# beginning so it may cache the result. (2.0 style)
4600#
4601# 'aclname' is the name of a defined ACL.
4602#
4603# NP: Using 'none' as the byte value here will override any quick_abort settings
4604# that may otherwise apply to the range request. The range request will
4605# be fully fetched from start to finish regardless of the client
4606# actions. This affects bandwidth usage.
4607#Default:
4608# none
4609
4610# TAG: minimum_expiry_time (seconds)
4611# The minimum caching time according to (Expires - Date)
4612# headers Squid honors if the object can't be revalidated.
4613# The default is 60 seconds.
4614#
4615# In reverse proxy environments it might be desirable to honor
4616# shorter object lifetimes. It is most likely better to make
4617# your server return a meaningful Last-Modified header however.
4618#
4619# In ESI environments where page fragments often have short
4620# lifetimes, this will often be best set to 0.
4621#Default:
4622# minimum_expiry_time 60 seconds
4623
4624# TAG: store_avg_object_size (bytes)
4625# Average object size, used to estimate number of objects your
4626# cache can hold. The default is 13 KB.
4627#
4628# This is used to pre-seed the cache index memory allocation to
4629# reduce expensive reallocate operations while handling clients
4630# traffic. Too-large values may result in memory allocation during
4631# peak traffic, too-small values will result in wasted memory.
4632#
4633# Check the cache manager 'info' report metrics for the real
4634# object sizes seen by your Squid before tuning this.
4635#Default:
4636# store_avg_object_size 13 KB
4637
4638# TAG: store_objects_per_bucket
4639# Target number of objects per bucket in the store hash table.
4640# Lowering this value increases the total number of buckets and
4641# also the storage maintenance rate. The default is 20.
4642#Default:
4643# store_objects_per_bucket 20
4644
4645# HTTP OPTIONS
4646# -----------------------------------------------------------------------------
4647
4648# TAG: request_header_max_size (KB)
4649# This specifies the maximum size for HTTP headers in a request.
4650# Request headers are usually relatively small (about 512 bytes).
4651# Placing a limit on the request header size will catch certain
4652# bugs (for example with persistent connections) and possibly
4653# buffer-overflow or denial-of-service attacks.
4654#Default:
4655# request_header_max_size 64 KB
4656
4657# TAG: reply_header_max_size (KB)
4658# This specifies the maximum size for HTTP headers in a reply.
4659# Reply headers are usually relatively small (about 512 bytes).
4660# Placing a limit on the reply header size will catch certain
4661# bugs (for example with persistent connections) and possibly
4662# buffer-overflow or denial-of-service attacks.
4663#Default:
4664# reply_header_max_size 64 KB
4665
4666# TAG: request_body_max_size (bytes)
4667# This specifies the maximum size for an HTTP request body.
4668# In other words, the maximum size of a PUT/POST request.
4669# A user who attempts to send a request with a body larger
4670# than this limit receives an "Invalid Request" error message.
4671# If you set this parameter to a zero (the default), there will
4672# be no limit imposed.
4673#
4674# See also client_request_buffer_max_size for an alternative
4675# limitation on client uploads which can be configured.
4676#Default:
4677# No limit.
4678
4679# TAG: client_request_buffer_max_size (bytes)
4680# This specifies the maximum buffer size of a client request.
4681# It prevents squid eating too much memory when somebody uploads
4682# a large file.
4683#Default:
4684# client_request_buffer_max_size 512 KB
4685
4686# TAG: chunked_request_body_max_size (bytes)
4687# A broken or confused HTTP/1.1 client may send a chunked HTTP
4688# request to Squid. Squid does not have full support for that
4689# feature yet. To cope with such requests, Squid buffers the
4690# entire request and then dechunks request body to create a
4691# plain HTTP/1.0 request with a known content length. The plain
4692# request is then used by the rest of Squid code as usual.
4693#
4694# The option value specifies the maximum size of the buffer used
4695# to hold the request before the conversion. If the chunked
4696# request size exceeds the specified limit, the conversion
4697# fails, and the client receives an "unsupported request" error,
4698# as if dechunking was disabled.
4699#
4700# Dechunking is enabled by default. To disable conversion of
4701# chunked requests, set the maximum to zero.
4702#
4703# Request dechunking feature and this option in particular are a
4704# temporary hack. When chunking requests and responses are fully
4705# supported, there will be no need to buffer a chunked request.
4706#Default:
4707# chunked_request_body_max_size 64 KB
4708
4709# TAG: broken_posts
4710# A list of ACL elements which, if matched, causes Squid to send
4711# an extra CRLF pair after the body of a PUT/POST request.
4712#
4713# Some HTTP servers has broken implementations of PUT/POST,
4714# and rely on an extra CRLF pair sent by some WWW clients.
4715#
4716# Quote from RFC2616 section 4.1 on this matter:
4717#
4718# Note: certain buggy HTTP/1.0 client implementations generate an
4719# extra CRLF's after a POST request. To restate what is explicitly
4720# forbidden by the BNF, an HTTP/1.1 client must not preface or follow
4721# a request with an extra CRLF.
4722#
4723# This clause only supports fast acl types.
4724# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
4725#
4726#Example:
4727# acl buggy_server url_regex ^http://....
4728# broken_posts allow buggy_server
4729#Default:
4730# Obey RFC 2616.
4731
4732# TAG: adaptation_uses_indirect_client on|off
4733# Controls whether the indirect client IP address (instead of the direct
4734# client IP address) is passed to adaptation services.
4735#
4736# See also: follow_x_forwarded_for adaptation_send_client_ip
4737#Default:
4738# adaptation_uses_indirect_client on
4739
4740# TAG: via on|off
4741# If set (default), Squid will include a Via header in requests and
4742# replies as required by RFC2616.
4743#Default:
4744# via on
4745
4746# TAG: ie_refresh on|off
4747# Microsoft Internet Explorer up until version 5.5 Service
4748# Pack 1 has an issue with transparent proxies, wherein it
4749# is impossible to force a refresh. Turning this on provides
4750# a partial fix to the problem, by causing all IMS-REFRESH
4751# requests from older IE versions to check the origin server
4752# for fresh content. This reduces hit ratio by some amount
4753# (~10% in my experience), but allows users to actually get
4754# fresh content when they want it. Note because Squid
4755# cannot tell if the user is using 5.5 or 5.5SP1, the behavior
4756# of 5.5 is unchanged from old versions of Squid (i.e. a
4757# forced refresh is impossible). Newer versions of IE will,
4758# hopefully, continue to have the new behavior and will be
4759# handled based on that assumption. This option defaults to
4760# the old Squid behavior, which is better for hit ratios but
4761# worse for clients using IE, if they need to be able to
4762# force fresh content.
4763#Default:
4764# ie_refresh off
4765
4766# TAG: vary_ignore_expire on|off
4767# Many HTTP servers supporting Vary gives such objects
4768# immediate expiry time with no cache-control header
4769# when requested by a HTTP/1.0 client. This option
4770# enables Squid to ignore such expiry times until
4771# HTTP/1.1 is fully implemented.
4772#
4773# WARNING: If turned on this may eventually cause some
4774# varying objects not intended for caching to get cached.
4775#Default:
4776# vary_ignore_expire off
4777
4778# TAG: request_entities
4779# Squid defaults to deny GET and HEAD requests with request entities,
4780# as the meaning of such requests are undefined in the HTTP standard
4781# even if not explicitly forbidden.
4782#
4783# Set this directive to on if you have clients which insists
4784# on sending request entities in GET or HEAD requests. But be warned
4785# that there is server software (both proxies and web servers) which
4786# can fail to properly process this kind of request which may make you
4787# vulnerable to cache pollution attacks if enabled.
4788#Default:
4789# request_entities off
4790
4791# TAG: request_header_access
4792# Usage: request_header_access header_name allow|deny [!]aclname ...
4793#
4794# WARNING: Doing this VIOLATES the HTTP standard. Enabling
4795# this feature could make you liable for problems which it
4796# causes.
4797#
4798# This option replaces the old 'anonymize_headers' and the
4799# older 'http_anonymizer' option with something that is much
4800# more configurable. A list of ACLs for each header name allows
4801# removal of specific header fields under specific conditions.
4802#
4803# This option only applies to outgoing HTTP request headers (i.e.,
4804# headers sent by Squid to the next HTTP hop such as a cache peer
4805# or an origin server). The option has no effect during cache hit
4806# detection. The equivalent adaptation vectoring point in ICAP
4807# terminology is post-cache REQMOD.
4808#
4809# The option is applied to individual outgoing request header
4810# fields. For each request header field F, Squid uses the first
4811# qualifying sets of request_header_access rules:
4812#
4813# 1. Rules with header_name equal to F's name.
4814# 2. Rules with header_name 'Other', provided F's name is not
4815# on the hard-coded list of commonly used HTTP header names.
4816# 3. Rules with header_name 'All'.
4817#
4818# Within that qualifying rule set, rule ACLs are checked as usual.
4819# If ACLs of an "allow" rule match, the header field is allowed to
4820# go through as is. If ACLs of a "deny" rule match, the header is
4821# removed and request_header_replace is then checked to identify
4822# if the removed header has a replacement. If no rules within the
4823# set have matching ACLs, the header field is left as is.
4824#
4825# For example, to achieve the same behavior as the old
4826# 'http_anonymizer standard' option, you should use:
4827#
4828# request_header_access From deny all
4829# request_header_access Referer deny all
4830# request_header_access User-Agent deny all
4831#
4832# Or, to reproduce the old 'http_anonymizer paranoid' feature
4833# you should use:
4834#
4835# request_header_access Authorization allow all
4836# request_header_access Proxy-Authorization allow all
4837# request_header_access Cache-Control allow all
4838# request_header_access Content-Length allow all
4839# request_header_access Content-Type allow all
4840# request_header_access Date allow all
4841# request_header_access Host allow all
4842# request_header_access If-Modified-Since allow all
4843# request_header_access Pragma allow all
4844# request_header_access Accept allow all
4845# request_header_access Accept-Charset allow all
4846# request_header_access Accept-Encoding allow all
4847# request_header_access Accept-Language allow all
4848# request_header_access Connection allow all
4849# request_header_access All deny all
4850#
4851# HTTP reply headers are controlled with the reply_header_access directive.
4852#
4853# By default, all headers are allowed (no anonymizing is performed).
4854#Default:
4855# No limits.
4856
4857# TAG: reply_header_access
4858# Usage: reply_header_access header_name allow|deny [!]aclname ...
4859#
4860# WARNING: Doing this VIOLATES the HTTP standard. Enabling
4861# this feature could make you liable for problems which it
4862# causes.
4863#
4864# This option only applies to reply headers, i.e., from the
4865# server to the client.
4866#
4867# This is the same as request_header_access, but in the other
4868# direction. Please see request_header_access for detailed
4869# documentation.
4870#
4871# For example, to achieve the same behavior as the old
4872# 'http_anonymizer standard' option, you should use:
4873#
4874# reply_header_access Server deny all
4875# reply_header_access WWW-Authenticate deny all
4876# reply_header_access Link deny all
4877#
4878# Or, to reproduce the old 'http_anonymizer paranoid' feature
4879# you should use:
4880#
4881# reply_header_access Allow allow all
4882# reply_header_access WWW-Authenticate allow all
4883# reply_header_access Proxy-Authenticate allow all
4884# reply_header_access Cache-Control allow all
4885# reply_header_access Content-Encoding allow all
4886# reply_header_access Content-Length allow all
4887# reply_header_access Content-Type allow all
4888# reply_header_access Date allow all
4889# reply_header_access Expires allow all
4890# reply_header_access Last-Modified allow all
4891# reply_header_access Location allow all
4892# reply_header_access Pragma allow all
4893# reply_header_access Content-Language allow all
4894# reply_header_access Retry-After allow all
4895# reply_header_access Title allow all
4896# reply_header_access Content-Disposition allow all
4897# reply_header_access Connection allow all
4898# reply_header_access All deny all
4899#
4900# HTTP request headers are controlled with the request_header_access directive.
4901#
4902# By default, all headers are allowed (no anonymizing is
4903# performed).
4904#Default:
4905# No limits.
4906
4907# TAG: request_header_replace
4908# Usage: request_header_replace header_name message
4909# Example: request_header_replace User-Agent Nutscrape/1.0 (CP/M; 8-bit)
4910#
4911# This option allows you to change the contents of headers
4912# denied with request_header_access above, by replacing them
4913# with some fixed string.
4914#
4915# This only applies to request headers, not reply headers.
4916#
4917# By default, headers are removed if denied.
4918#Default:
4919# none
4920
4921# TAG: reply_header_replace
4922# Usage: reply_header_replace header_name message
4923# Example: reply_header_replace Server Foo/1.0
4924#
4925# This option allows you to change the contents of headers
4926# denied with reply_header_access above, by replacing them
4927# with some fixed string.
4928#
4929# This only applies to reply headers, not request headers.
4930#
4931# By default, headers are removed if denied.
4932#Default:
4933# none
4934
4935# TAG: request_header_add
4936# Usage: request_header_add field-name field-value acl1 [acl2] ...
4937# Example: request_header_add X-Client-CA "CA=%ssl::>cert_issuer" all
4938#
4939# This option adds header fields to outgoing HTTP requests (i.e.,
4940# request headers sent by Squid to the next HTTP hop such as a
4941# cache peer or an origin server). The option has no effect during
4942# cache hit detection. The equivalent adaptation vectoring point
4943# in ICAP terminology is post-cache REQMOD.
4944#
4945# Field-name is a token specifying an HTTP header name. If a
4946# standard HTTP header name is used, Squid does not check whether
4947# the new header conflicts with any existing headers or violates
4948# HTTP rules. If the request to be modified already contains a
4949# field with the same name, the old field is preserved but the
4950# header field values are not merged.
4951#
4952# Field-value is either a token or a quoted string. If quoted
4953# string format is used, then the surrounding quotes are removed
4954# while escape sequences and %macros are processed.
4955#
4956# In theory, all of the logformat codes can be used as %macros.
4957# However, unlike logging (which happens at the very end of
4958# transaction lifetime), the transaction may not yet have enough
4959# information to expand a macro when the new header value is needed.
4960# And some information may already be available to Squid but not yet
4961# committed where the macro expansion code can access it (report
4962# such instances!). The macro will be expanded into a single dash
4963# ('-') in such cases. Not all macros have been tested.
4964#
4965# One or more Squid ACLs may be specified to restrict header
4966# injection to matching requests. As always in squid.conf, all
4967# ACLs in an option ACL list must be satisfied for the insertion
4968# to happen. The request_header_add option supports fast ACLs
4969# only.
4970#Default:
4971# none
4972
4973# TAG: note
4974# This option used to log custom information about the master
4975# transaction. For example, an admin may configure Squid to log
4976# which "user group" the transaction belongs to, where "user group"
4977# will be determined based on a set of ACLs and not [just]
4978# authentication information.
4979# Values of key/value pairs can be logged using %{key}note macros:
4980#
4981# note key value acl ...
4982# logformat myFormat ... %{key}note ...
4983#Default:
4984# none
4985
4986# TAG: relaxed_header_parser on|off|warn
4987# In the default "on" setting Squid accepts certain forms
4988# of non-compliant HTTP messages where it is unambiguous
4989# what the sending application intended even if the message
4990# is not correctly formatted. The messages is then normalized
4991# to the correct form when forwarded by Squid.
4992#
4993# If set to "warn" then a warning will be emitted in cache.log
4994# each time such HTTP error is encountered.
4995#
4996# If set to "off" then such HTTP errors will cause the request
4997# or response to be rejected.
4998#Default:
4999# relaxed_header_parser on
5000
5001# TIMEOUTS
5002# -----------------------------------------------------------------------------
5003
5004# TAG: forward_timeout time-units
5005# This parameter specifies how long Squid should at most attempt in
5006# finding a forwarding path for the request before giving up.
5007#Default:
5008# forward_timeout 4 minutes
5009
5010# TAG: connect_timeout time-units
5011# This parameter specifies how long to wait for the TCP connect to
5012# the requested server or peer to complete before Squid should
5013# attempt to find another path where to forward the request.
5014#Default:
5015# connect_timeout 1 minute
5016
5017# TAG: peer_connect_timeout time-units
5018# This parameter specifies how long to wait for a pending TCP
5019# connection to a peer cache. The default is 30 seconds. You
5020# may also set different timeout values for individual neighbors
5021# with the 'connect-timeout' option on a 'cache_peer' line.
5022#Default:
5023# peer_connect_timeout 30 seconds
5024
5025# TAG: read_timeout time-units
5026# The read_timeout is applied on server-side connections. After
5027# each successful read(), the timeout will be extended by this
5028# amount. If no data is read again after this amount of time,
5029# the request is aborted and logged with ERR_READ_TIMEOUT. The
5030# default is 15 minutes.
5031#Default:
5032# read_timeout 15 minutes
5033
5034# TAG: write_timeout time-units
5035# This timeout is tracked for all connections that have data
5036# available for writing and are waiting for the socket to become
5037# ready. After each successful write, the timeout is extended by
5038# the configured amount. If Squid has data to write but the
5039# connection is not ready for the configured duration, the
5040# transaction associated with the connection is terminated. The
5041# default is 15 minutes.
5042#Default:
5043# write_timeout 15 minutes
5044
5045# TAG: request_timeout
5046# How long to wait for complete HTTP request headers after initial
5047# connection establishment.
5048#Default:
5049# request_timeout 5 minutes
5050
5051# TAG: client_idle_pconn_timeout
5052# How long to wait for the next HTTP request on a persistent
5053# client connection after the previous request completes.
5054#Default:
5055# client_idle_pconn_timeout 2 minutes
5056
5057# TAG: client_lifetime time-units
5058# The maximum amount of time a client (browser) is allowed to
5059# remain connected to the cache process. This protects the Cache
5060# from having a lot of sockets (and hence file descriptors) tied up
5061# in a CLOSE_WAIT state from remote clients that go away without
5062# properly shutting down (either because of a network failure or
5063# because of a poor client implementation). The default is one
5064# day, 1440 minutes.
5065#
5066# NOTE: The default value is intended to be much larger than any
5067# client would ever need to be connected to your cache. You
5068# should probably change client_lifetime only as a last resort.
5069# If you seem to have many client connections tying up
5070# filedescriptors, we recommend first tuning the read_timeout,
5071# request_timeout, persistent_request_timeout and quick_abort values.
5072#Default:
5073# client_lifetime 1 day
5074
5075# TAG: half_closed_clients
5076# Some clients may shutdown the sending side of their TCP
5077# connections, while leaving their receiving sides open. Sometimes,
5078# Squid can not tell the difference between a half-closed and a
5079# fully-closed TCP connection.
5080#
5081# By default, Squid will immediately close client connections when
5082# read(2) returns "no more data to read."
5083#
5084# Change this option to 'on' and Squid will keep open connections
5085# until a read(2) or write(2) on the socket returns an error.
5086# This may show some benefits for reverse proxies. But if not
5087# it is recommended to leave OFF.
5088#Default:
5089# half_closed_clients off
5090
5091# TAG: server_idle_pconn_timeout
5092# Timeout for idle persistent connections to servers and other
5093# proxies.
5094#Default:
5095# server_idle_pconn_timeout 1 minute
5096
5097# TAG: ident_timeout
5098# Maximum time to wait for IDENT lookups to complete.
5099#
5100# If this is too high, and you enabled IDENT lookups from untrusted
5101# users, you might be susceptible to denial-of-service by having
5102# many ident requests going at once.
5103#Default:
5104# ident_timeout 10 seconds
5105
5106# TAG: shutdown_lifetime time-units
5107# When SIGTERM or SIGHUP is received, the cache is put into
5108# "shutdown pending" mode until all active sockets are closed.
5109# This value is the lifetime to set for all open descriptors
5110# during shutdown mode. Any active clients after this many
5111# seconds will receive a 'timeout' message.
5112#Default:
5113# shutdown_lifetime 30 seconds
5114
5115# ADMINISTRATIVE PARAMETERS
5116# -----------------------------------------------------------------------------
5117
5118# TAG: cache_mgr
5119# Email-address of local cache manager who will receive
5120# mail if the cache dies. The default is "webmaster".
5121#Default:
5122# cache_mgr webmaster
5123
5124# TAG: mail_from
5125# From: email-address for mail sent when the cache dies.
5126# The default is to use 'squid@unique_hostname'.
5127#
5128# See also: unique_hostname directive.
5129#Default:
5130# none
5131
5132# TAG: mail_program
5133# Email program used to send mail if the cache dies.
5134# The default is "mail". The specified program must comply
5135# with the standard Unix mail syntax:
5136# mail-program recipient < mailfile
5137#
5138# Optional command line options can be specified.
5139#Default:
5140# mail_program mail
5141
5142# TAG: cache_effective_user
5143# If you start Squid as root, it will change its effective/real
5144# UID/GID to the user specified below. The default is to change
5145# to UID of proxy.
5146# see also; cache_effective_group
5147#Default:
5148# cache_effective_user proxy
5149
5150# TAG: cache_effective_group
5151# Squid sets the GID to the effective user's default group ID
5152# (taken from the password file) and supplementary group list
5153# from the groups membership.
5154#
5155# If you want Squid to run with a specific GID regardless of
5156# the group memberships of the effective user then set this
5157# to the group (or GID) you want Squid to run as. When set
5158# all other group privileges of the effective user are ignored
5159# and only this GID is effective. If Squid is not started as
5160# root the user starting Squid MUST be member of the specified
5161# group.
5162#
5163# This option is not recommended by the Squid Team.
5164# Our preference is for administrators to configure a secure
5165# user account for squid with UID/GID matching system policies.
5166#Default:
5167# Use system group memberships of the cache_effective_user account
5168
5169# TAG: httpd_suppress_version_string on|off
5170# Suppress Squid version string info in HTTP headers and HTML error pages.
5171#Default:
5172# httpd_suppress_version_string off
5173
5174# TAG: visible_hostname
5175# If you want to present a special hostname in error messages, etc,
5176# define this. Otherwise, the return value of gethostname()
5177# will be used. If you have multiple caches in a cluster and
5178# get errors about IP-forwarding you must set them to have individual
5179# names with this setting.
5180#Default:
5181# Automatically detect the system host name
5182
5183# TAG: unique_hostname
5184# If you want to have multiple machines with the same
5185# 'visible_hostname' you must give each machine a different
5186# 'unique_hostname' so forwarding loops can be detected.
5187#Default:
5188# Copy the value from visible_hostname
5189
5190# TAG: hostname_aliases
5191# A list of other DNS names your cache has.
5192#Default:
5193# none
5194
5195# TAG: umask
5196# Minimum umask which should be enforced while the proxy
5197# is running, in addition to the umask set at startup.
5198#
5199# For a traditional octal representation of umasks, start
5200# your value with 0.
5201#Default:
5202# umask 027
5203
5204# OPTIONS FOR THE CACHE REGISTRATION SERVICE
5205# -----------------------------------------------------------------------------
5206#
5207# This section contains parameters for the (optional) cache
5208# announcement service. This service is provided to help
5209# cache administrators locate one another in order to join or
5210# create cache hierarchies.
5211#
5212# An 'announcement' message is sent (via UDP) to the registration
5213# service by Squid. By default, the announcement message is NOT
5214# SENT unless you enable it with 'announce_period' below.
5215#
5216# The announcement message includes your hostname, plus the
5217# following information from this configuration file:
5218#
5219# http_port
5220# icp_port
5221# cache_mgr
5222#
5223# All current information is processed regularly and made
5224# available on the Web at http://www.ircache.net/Cache/Tracker/.
5225
5226# TAG: announce_period
5227# This is how frequently to send cache announcements.
5228#
5229# To enable announcing your cache, just set an announce period.
5230#
5231# Example:
5232# announce_period 1 day
5233#Default:
5234# Announcement messages disabled.
5235
5236# TAG: announce_host
5237# Set the hostname where announce registration messages will be sent.
5238#
5239# See also announce_port and announce_file
5240#Default:
5241# announce_host tracker.ircache.net
5242
5243# TAG: announce_file
5244# The contents of this file will be included in the announce
5245# registration messages.
5246#Default:
5247# none
5248
5249# TAG: announce_port
5250# Set the port where announce registration messages will be sent.
5251#
5252# See also announce_host and announce_file
5253#Default:
5254# announce_port 3131
5255
5256# HTTPD-ACCELERATOR OPTIONS
5257# -----------------------------------------------------------------------------
5258
5259# TAG: httpd_accel_surrogate_id
5260# Surrogates (http://www.esi.org/architecture_spec_1.0.html)
5261# need an identification token to allow control targeting. Because
5262# a farm of surrogates may all perform the same tasks, they may share
5263# an identification token.
5264#Default:
5265# visible_hostname is used if no specific ID is set.
5266
5267# TAG: http_accel_surrogate_remote on|off
5268# Remote surrogates (such as those in a CDN) honour the header
5269# "Surrogate-Control: no-store-remote".
5270#
5271# Set this to on to have squid behave as a remote surrogate.
5272#Default:
5273# http_accel_surrogate_remote off
5274
5275# TAG: esi_parser libxml2|expat|custom
5276# ESI markup is not strictly XML compatible. The custom ESI parser
5277# will give higher performance, but cannot handle non ASCII character
5278# encodings.
5279#Default:
5280# esi_parser custom
5281
5282# DELAY POOL PARAMETERS
5283# -----------------------------------------------------------------------------
5284
5285# TAG: delay_pools
5286# This represents the number of delay pools to be used. For example,
5287# if you have one class 2 delay pool and one class 3 delays pool, you
5288# have a total of 2 delay pools.
5289#
5290# See also delay_parameters, delay_class, delay_access for pool
5291# configuration details.
5292#Default:
5293# delay_pools 0
5294
5295# TAG: delay_class
5296# This defines the class of each delay pool. There must be exactly one
5297# delay_class line for each delay pool. For example, to define two
5298# delay pools, one of class 2 and one of class 3, the settings above
5299# and here would be:
5300#
5301# Example:
5302# delay_pools 4 # 4 delay pools
5303# delay_class 1 2 # pool 1 is a class 2 pool
5304# delay_class 2 3 # pool 2 is a class 3 pool
5305# delay_class 3 4 # pool 3 is a class 4 pool
5306# delay_class 4 5 # pool 4 is a class 5 pool
5307#
5308# The delay pool classes are:
5309#
5310# class 1 Everything is limited by a single aggregate
5311# bucket.
5312#
5313# class 2 Everything is limited by a single aggregate
5314# bucket as well as an "individual" bucket chosen
5315# from bits 25 through 32 of the IPv4 address.
5316#
5317# class 3 Everything is limited by a single aggregate
5318# bucket as well as a "network" bucket chosen
5319# from bits 17 through 24 of the IP address and a
5320# "individual" bucket chosen from bits 17 through
5321# 32 of the IPv4 address.
5322#
5323# class 4 Everything in a class 3 delay pool, with an
5324# additional limit on a per user basis. This
5325# only takes effect if the username is established
5326# in advance - by forcing authentication in your
5327# http_access rules.
5328#
5329# class 5 Requests are grouped according their tag (see
5330# external_acl's tag= reply).
5331#
5332#
5333# Each pool also requires a delay_parameters directive to configure the pool size
5334# and speed limits used whenever the pool is applied to a request. Along with
5335# a set of delay_access directives to determine when it is used.
5336#
5337# NOTE: If an IP address is a.b.c.d
5338# -> bits 25 through 32 are "d"
5339# -> bits 17 through 24 are "c"
5340# -> bits 17 through 32 are "c * 256 + d"
5341#
5342# NOTE-2: Due to the use of bitmasks in class 2,3,4 pools they only apply to
5343# IPv4 traffic. Class 1 and 5 pools may be used with IPv6 traffic.
5344#
5345# This clause only supports fast acl types.
5346# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
5347#
5348# See also delay_parameters and delay_access.
5349#Default:
5350# none
5351
5352# TAG: delay_access
5353# This is used to determine which delay pool a request falls into.
5354#
5355# delay_access is sorted per pool and the matching starts with pool 1,
5356# then pool 2, ..., and finally pool N. The first delay pool where the
5357# request is allowed is selected for the request. If it does not allow
5358# the request to any pool then the request is not delayed (default).
5359#
5360# For example, if you want some_big_clients in delay
5361# pool 1 and lotsa_little_clients in delay pool 2:
5362#
5363# delay_access 1 allow some_big_clients
5364# delay_access 1 deny all
5365# delay_access 2 allow lotsa_little_clients
5366# delay_access 2 deny all
5367# delay_access 3 allow authenticated_clients
5368#
5369# See also delay_parameters and delay_class.
5370#
5371#Default:
5372# Deny using the pool, unless allow rules exist in squid.conf for the pool.
5373
5374# TAG: delay_parameters
5375# This defines the parameters for a delay pool. Each delay pool has
5376# a number of "buckets" associated with it, as explained in the
5377# description of delay_class.
5378#
5379# For a class 1 delay pool, the syntax is:
5380# delay_pools pool 1
5381# delay_parameters pool aggregate
5382#
5383# For a class 2 delay pool:
5384# delay_pools pool 2
5385# delay_parameters pool aggregate individual
5386#
5387# For a class 3 delay pool:
5388# delay_pools pool 3
5389# delay_parameters pool aggregate network individual
5390#
5391# For a class 4 delay pool:
5392# delay_pools pool 4
5393# delay_parameters pool aggregate network individual user
5394#
5395# For a class 5 delay pool:
5396# delay_pools pool 5
5397# delay_parameters pool tagrate
5398#
5399# The option variables are:
5400#
5401# pool a pool number - ie, a number between 1 and the
5402# number specified in delay_pools as used in
5403# delay_class lines.
5404#
5405# aggregate the speed limit parameters for the aggregate bucket
5406# (class 1, 2, 3).
5407#
5408# individual the speed limit parameters for the individual
5409# buckets (class 2, 3).
5410#
5411# network the speed limit parameters for the network buckets
5412# (class 3).
5413#
5414# user the speed limit parameters for the user buckets
5415# (class 4).
5416#
5417# tagrate the speed limit parameters for the tag buckets
5418# (class 5).
5419#
5420# A pair of delay parameters is written restore/maximum, where restore is
5421# the number of bytes (not bits - modem and network speeds are usually
5422# quoted in bits) per second placed into the bucket, and maximum is the
5423# maximum number of bytes which can be in the bucket at any time.
5424#
5425# There must be one delay_parameters line for each delay pool.
5426#
5427#
5428# For example, if delay pool number 1 is a class 2 delay pool as in the
5429# above example, and is being used to strictly limit each host to 64Kbit/sec
5430# (plus overheads), with no overall limit, the line is:
5431#
5432# delay_parameters 1 -1/-1 8000/8000
5433#
5434# Note that 8 x 8000 KByte/sec -> 64Kbit/sec.
5435#
5436# Note that the figure -1 is used to represent "unlimited".
5437#
5438#
5439# And, if delay pool number 2 is a class 3 delay pool as in the above
5440# example, and you want to limit it to a total of 256Kbit/sec (strict limit)
5441# with each 8-bit network permitted 64Kbit/sec (strict limit) and each
5442# individual host permitted 4800bit/sec with a bucket maximum size of 64Kbits
5443# to permit a decent web page to be downloaded at a decent speed
5444# (if the network is not being limited due to overuse) but slow down
5445# large downloads more significantly:
5446#
5447# delay_parameters 2 32000/32000 8000/8000 600/8000
5448#
5449# Note that 8 x 32000 KByte/sec -> 256Kbit/sec.
5450# 8 x 8000 KByte/sec -> 64Kbit/sec.
5451# 8 x 600 Byte/sec -> 4800bit/sec.
5452#
5453#
5454# Finally, for a class 4 delay pool as in the example - each user will
5455# be limited to 128Kbits/sec no matter how many workstations they are logged into.:
5456#
5457# delay_parameters 4 32000/32000 8000/8000 600/64000 16000/16000
5458#
5459#
5460# See also delay_class and delay_access.
5461#
5462#Default:
5463# none
5464
5465# TAG: delay_initial_bucket_level (percent, 0-100)
5466# The initial bucket percentage is used to determine how much is put
5467# in each bucket when squid starts, is reconfigured, or first notices
5468# a host accessing it (in class 2 and class 3, individual hosts and
5469# networks only have buckets associated with them once they have been
5470# "seen" by squid).
5471#Default:
5472# delay_initial_bucket_level 50
5473
5474# CLIENT DELAY POOL PARAMETERS
5475# -----------------------------------------------------------------------------
5476
5477# TAG: client_delay_pools
5478# This option specifies the number of client delay pools used. It must
5479# preceed other client_delay_* options.
5480#
5481# Example:
5482# client_delay_pools 2
5483#
5484# See also client_delay_parameters and client_delay_access.
5485#Default:
5486# client_delay_pools 0
5487
5488# TAG: client_delay_initial_bucket_level (percent, 0-no_limit)
5489# This option determines the initial bucket size as a percentage of
5490# max_bucket_size from client_delay_parameters. Buckets are created
5491# at the time of the "first" connection from the matching IP. Idle
5492# buckets are periodically deleted up.
5493#
5494# You can specify more than 100 percent but note that such "oversized"
5495# buckets are not refilled until their size goes down to max_bucket_size
5496# from client_delay_parameters.
5497#
5498# Example:
5499# client_delay_initial_bucket_level 50
5500#Default:
5501# client_delay_initial_bucket_level 50
5502
5503# TAG: client_delay_parameters
5504#
5505# This option configures client-side bandwidth limits using the
5506# following format:
5507#
5508# client_delay_parameters pool speed_limit max_bucket_size
5509#
5510# pool is an integer ID used for client_delay_access matching.
5511#
5512# speed_limit is bytes added to the bucket per second.
5513#
5514# max_bucket_size is the maximum size of a bucket, enforced after any
5515# speed_limit additions.
5516#
5517# Please see the delay_parameters option for more information and
5518# examples.
5519#
5520# Example:
5521# client_delay_parameters 1 1024 2048
5522# client_delay_parameters 2 51200 16384
5523#
5524# See also client_delay_access.
5525#
5526#Default:
5527# none
5528
5529# TAG: client_delay_access
5530# This option determines the client-side delay pool for the
5531# request:
5532#
5533# client_delay_access pool_ID allow|deny acl_name
5534#
5535# All client_delay_access options are checked in their pool ID
5536# order, starting with pool 1. The first checked pool with allowed
5537# request is selected for the request. If no ACL matches or there
5538# are no client_delay_access options, the request bandwidth is not
5539# limited.
5540#
5541# The ACL-selected pool is then used to find the
5542# client_delay_parameters for the request. Client-side pools are
5543# not used to aggregate clients. Clients are always aggregated
5544# based on their source IP addresses (one bucket per source IP).
5545#
5546# This clause only supports fast acl types.
5547# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
5548# Additionally, only the client TCP connection details are available.
5549# ACLs testing HTTP properties will not work.
5550#
5551# Please see delay_access for more examples.
5552#
5553# Example:
5554# client_delay_access 1 allow low_rate_network
5555# client_delay_access 2 allow vips_network
5556#
5557#
5558# See also client_delay_parameters and client_delay_pools.
5559#Default:
5560# Deny use of the pool, unless allow rules exist in squid.conf for the pool.
5561
5562# WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS
5563# -----------------------------------------------------------------------------
5564
5565# TAG: wccp_router
5566# Use this option to define your WCCP ``home'' router for
5567# Squid.
5568#
5569# wccp_router supports a single WCCP(v1) router
5570#
5571# wccp2_router supports multiple WCCPv2 routers
5572#
5573# only one of the two may be used at the same time and defines
5574# which version of WCCP to use.
5575#Default:
5576# WCCP disabled.
5577
5578# TAG: wccp2_router
5579# Use this option to define your WCCP ``home'' router for
5580# Squid.
5581#
5582# wccp_router supports a single WCCP(v1) router
5583#
5584# wccp2_router supports multiple WCCPv2 routers
5585#
5586# only one of the two may be used at the same time and defines
5587# which version of WCCP to use.
5588#Default:
5589# WCCPv2 disabled.
5590
5591# TAG: wccp_version
5592# This directive is only relevant if you need to set up WCCP(v1)
5593# to some very old and end-of-life Cisco routers. In all other
5594# setups it must be left unset or at the default setting.
5595# It defines an internal version in the WCCP(v1) protocol,
5596# with version 4 being the officially documented protocol.
5597#
5598# According to some users, Cisco IOS 11.2 and earlier only
5599# support WCCP version 3. If you're using that or an earlier
5600# version of IOS, you may need to change this value to 3, otherwise
5601# do not specify this parameter.
5602#Default:
5603# wccp_version 4
5604
5605# TAG: wccp2_rebuild_wait
5606# If this is enabled Squid will wait for the cache dir rebuild to finish
5607# before sending the first wccp2 HereIAm packet
5608#Default:
5609# wccp2_rebuild_wait on
5610
5611# TAG: wccp2_forwarding_method
5612# WCCP2 allows the setting of forwarding methods between the
5613# router/switch and the cache. Valid values are as follows:
5614#
5615# gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
5616# l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting)
5617#
5618# Currently (as of IOS 12.4) cisco routers only support GRE.
5619# Cisco switches only support the L2 redirect assignment method.
5620#Default:
5621# wccp2_forwarding_method gre
5622
5623# TAG: wccp2_return_method
5624# WCCP2 allows the setting of return methods between the
5625# router/switch and the cache for packets that the cache
5626# decides not to handle. Valid values are as follows:
5627#
5628# gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
5629# l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting)
5630#
5631# Currently (as of IOS 12.4) cisco routers only support GRE.
5632# Cisco switches only support the L2 redirect assignment.
5633#
5634# If the "ip wccp redirect exclude in" command has been
5635# enabled on the cache interface, then it is still safe for
5636# the proxy server to use a l2 redirect method even if this
5637# option is set to GRE.
5638#Default:
5639# wccp2_return_method gre
5640
5641# TAG: wccp2_assignment_method
5642# WCCP2 allows the setting of methods to assign the WCCP hash
5643# Valid values are as follows:
5644#
5645# hash - Hash assignment
5646# mask - Mask assignment
5647#
5648# As a general rule, cisco routers support the hash assignment method
5649# and cisco switches support the mask assignment method.
5650#Default:
5651# wccp2_assignment_method hash
5652
5653# TAG: wccp2_service
5654# WCCP2 allows for multiple traffic services. There are two
5655# types: "standard" and "dynamic". The standard type defines
5656# one service id - http (id 0). The dynamic service ids can be from
5657# 51 to 255 inclusive. In order to use a dynamic service id
5658# one must define the type of traffic to be redirected; this is done
5659# using the wccp2_service_info option.
5660#
5661# The "standard" type does not require a wccp2_service_info option,
5662# just specifying the service id will suffice.
5663#
5664# MD5 service authentication can be enabled by adding
5665# "password=<password>" to the end of this service declaration.
5666#
5667# Examples:
5668#
5669# wccp2_service standard 0 # for the 'web-cache' standard service
5670# wccp2_service dynamic 80 # a dynamic service type which will be
5671# # fleshed out with subsequent options.
5672# wccp2_service standard 0 password=foo
5673#Default:
5674# Use the 'web-cache' standard service.
5675
5676# TAG: wccp2_service_info
5677# Dynamic WCCPv2 services require further information to define the
5678# traffic you wish to have diverted.
5679#
5680# The format is:
5681#
5682# wccp2_service_info <id> protocol=<protocol> flags=<flag>,<flag>..
5683# priority=<priority> ports=<port>,<port>..
5684#
5685# The relevant WCCPv2 flags:
5686# + src_ip_hash, dst_ip_hash
5687# + source_port_hash, dst_port_hash
5688# + src_ip_alt_hash, dst_ip_alt_hash
5689# + src_port_alt_hash, dst_port_alt_hash
5690# + ports_source
5691#
5692# The port list can be one to eight entries.
5693#
5694# Example:
5695#
5696# wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source
5697# priority=240 ports=80
5698#
5699# Note: the service id must have been defined by a previous
5700# 'wccp2_service dynamic <id>' entry.
5701#Default:
5702# none
5703
5704# TAG: wccp2_weight
5705# Each cache server gets assigned a set of the destination
5706# hash proportional to their weight.
5707#Default:
5708# wccp2_weight 10000
5709
5710# TAG: wccp_address
5711# Use this option if you require WCCPv2 to use a specific
5712# interface address.
5713#
5714# The default behavior is to not bind to any specific address.
5715#Default:
5716# Address selected by the operating system.
5717
5718# TAG: wccp2_address
5719# Use this option if you require WCCP to use a specific
5720# interface address.
5721#
5722# The default behavior is to not bind to any specific address.
5723#Default:
5724# Address selected by the operating system.
5725
5726# PERSISTENT CONNECTION HANDLING
5727# -----------------------------------------------------------------------------
5728#
5729# Also see "pconn_timeout" in the TIMEOUTS section
5730
5731# TAG: client_persistent_connections
5732# Persistent connection support for clients.
5733# Squid uses persistent connections (when allowed). You can use
5734# this option to disable persistent connections with clients.
5735#Default:
5736# client_persistent_connections on
5737
5738# TAG: server_persistent_connections
5739# Persistent connection support for servers.
5740# Squid uses persistent connections (when allowed). You can use
5741# this option to disable persistent connections with servers.
5742#Default:
5743# server_persistent_connections on
5744
5745# TAG: persistent_connection_after_error
5746# With this directive the use of persistent connections after
5747# HTTP errors can be disabled. Useful if you have clients
5748# who fail to handle errors on persistent connections proper.
5749#Default:
5750# persistent_connection_after_error on
5751
5752# TAG: detect_broken_pconn
5753# Some servers have been found to incorrectly signal the use
5754# of HTTP/1.0 persistent connections even on replies not
5755# compatible, causing significant delays. This server problem
5756# has mostly been seen on redirects.
5757#
5758# By enabling this directive Squid attempts to detect such
5759# broken replies and automatically assume the reply is finished
5760# after 10 seconds timeout.
5761#Default:
5762# detect_broken_pconn off
5763
5764# CACHE DIGEST OPTIONS
5765# -----------------------------------------------------------------------------
5766
5767# TAG: digest_generation
5768# This controls whether the server will generate a Cache Digest
5769# of its contents. By default, Cache Digest generation is
5770# enabled if Squid is compiled with --enable-cache-digests defined.
5771#Default:
5772# digest_generation on
5773
5774# TAG: digest_bits_per_entry
5775# This is the number of bits of the server's Cache Digest which
5776# will be associated with the Digest entry for a given HTTP
5777# Method and URL (public key) combination. The default is 5.
5778#Default:
5779# digest_bits_per_entry 5
5780
5781# TAG: digest_rebuild_period (seconds)
5782# This is the wait time between Cache Digest rebuilds.
5783#Default:
5784# digest_rebuild_period 1 hour
5785
5786# TAG: digest_rewrite_period (seconds)
5787# This is the wait time between Cache Digest writes to
5788# disk.
5789#Default:
5790# digest_rewrite_period 1 hour
5791
5792# TAG: digest_swapout_chunk_size (bytes)
5793# This is the number of bytes of the Cache Digest to write to
5794# disk at a time. It defaults to 4096 bytes (4KB), the Squid
5795# default swap page.
5796#Default:
5797# digest_swapout_chunk_size 4096 bytes
5798
5799# TAG: digest_rebuild_chunk_percentage (percent, 0-100)
5800# This is the percentage of the Cache Digest to be scanned at a
5801# time. By default it is set to 10% of the Cache Digest.
5802#Default:
5803# digest_rebuild_chunk_percentage 10
5804
5805# SNMP OPTIONS
5806# -----------------------------------------------------------------------------
5807
5808# TAG: snmp_port
5809# The port number where Squid listens for SNMP requests. To enable
5810# SNMP support set this to a suitable port number. Port number
5811# 3401 is often used for the Squid SNMP agent. By default it's
5812# set to "0" (disabled)
5813#
5814# Example:
5815# snmp_port 3401
5816#Default:
5817# SNMP disabled.
5818
5819# TAG: snmp_access
5820# Allowing or denying access to the SNMP port.
5821#
5822# All access to the agent is denied by default.
5823# usage:
5824#
5825# snmp_access allow|deny [!]aclname ...
5826#
5827# This clause only supports fast acl types.
5828# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
5829#
5830#Example:
5831# snmp_access allow snmppublic localhost
5832# snmp_access deny all
5833#Default:
5834# Deny, unless rules exist in squid.conf.
5835
5836# TAG: snmp_incoming_address
5837# Just like 'udp_incoming_address', but for the SNMP port.
5838#
5839# snmp_incoming_address is used for the SNMP socket receiving
5840# messages from SNMP agents.
5841#
5842# The default snmp_incoming_address is to listen on all
5843# available network interfaces.
5844#Default:
5845# Accept SNMP packets from all machine interfaces.
5846
5847# TAG: snmp_outgoing_address
5848# Just like 'udp_outgoing_address', but for the SNMP port.
5849#
5850# snmp_outgoing_address is used for SNMP packets returned to SNMP
5851# agents.
5852#
5853# If snmp_outgoing_address is not set it will use the same socket
5854# as snmp_incoming_address. Only change this if you want to have
5855# SNMP replies sent using another address than where this Squid
5856# listens for SNMP queries.
5857#
5858# NOTE, snmp_incoming_address and snmp_outgoing_address can not have
5859# the same value since they both use the same port.
5860#Default:
5861# Use snmp_incoming_address or an address selected by the operating system.
5862
5863# ICP OPTIONS
5864# -----------------------------------------------------------------------------
5865
5866# TAG: icp_port
5867# The port number where Squid sends and receives ICP queries to
5868# and from neighbor caches. The standard UDP port for ICP is 3130.
5869#
5870# Example:
5871# icp_port 3130
5872#Default:
5873# ICP disabled.
5874
5875# TAG: htcp_port
5876# The port number where Squid sends and receives HTCP queries to
5877# and from neighbor caches. To turn it on you want to set it to
5878# 4827.
5879#
5880# Example:
5881# htcp_port 4827
5882#Default:
5883# HTCP disabled.
5884
5885# TAG: log_icp_queries on|off
5886# If set, ICP queries are logged to access.log. You may wish
5887# do disable this if your ICP load is VERY high to speed things
5888# up or to simplify log analysis.
5889#Default:
5890# log_icp_queries on
5891
5892# TAG: udp_incoming_address
5893# udp_incoming_address is used for UDP packets received from other
5894# caches.
5895#
5896# The default behavior is to not bind to any specific address.
5897#
5898# Only change this if you want to have all UDP queries received on
5899# a specific interface/address.
5900#
5901# NOTE: udp_incoming_address is used by the ICP, HTCP, and DNS
5902# modules. Altering it will affect all of them in the same manner.
5903#
5904# see also; udp_outgoing_address
5905#
5906# NOTE, udp_incoming_address and udp_outgoing_address can not
5907# have the same value since they both use the same port.
5908#Default:
5909# Accept packets from all machine interfaces.
5910
5911# TAG: udp_outgoing_address
5912# udp_outgoing_address is used for UDP packets sent out to other
5913# caches.
5914#
5915# The default behavior is to not bind to any specific address.
5916#
5917# Instead it will use the same socket as udp_incoming_address.
5918# Only change this if you want to have UDP queries sent using another
5919# address than where this Squid listens for UDP queries from other
5920# caches.
5921#
5922# NOTE: udp_outgoing_address is used by the ICP, HTCP, and DNS
5923# modules. Altering it will affect all of them in the same manner.
5924#
5925# see also; udp_incoming_address
5926#
5927# NOTE, udp_incoming_address and udp_outgoing_address can not
5928# have the same value since they both use the same port.
5929#Default:
5930# Use udp_incoming_address or an address selected by the operating system.
5931
5932# TAG: icp_hit_stale on|off
5933# If you want to return ICP_HIT for stale cache objects, set this
5934# option to 'on'. If you have sibling relationships with caches
5935# in other administrative domains, this should be 'off'. If you only
5936# have sibling relationships with caches under your control,
5937# it is probably okay to set this to 'on'.
5938# If set to 'on', your siblings should use the option "allow-miss"
5939# on their cache_peer lines for connecting to you.
5940#Default:
5941# icp_hit_stale off
5942
5943# TAG: minimum_direct_hops
5944# If using the ICMP pinging stuff, do direct fetches for sites
5945# which are no more than this many hops away.
5946#Default:
5947# minimum_direct_hops 4
5948
5949# TAG: minimum_direct_rtt (msec)
5950# If using the ICMP pinging stuff, do direct fetches for sites
5951# which are no more than this many rtt milliseconds away.
5952#Default:
5953# minimum_direct_rtt 400
5954
5955# TAG: netdb_low
5956# The low water mark for the ICMP measurement database.
5957#
5958# Note: high watermark controlled by netdb_high directive.
5959#
5960# These watermarks are counts, not percents. The defaults are
5961# (low) 900 and (high) 1000. When the high water mark is
5962# reached, database entries will be deleted until the low
5963# mark is reached.
5964#Default:
5965# netdb_low 900
5966
5967# TAG: netdb_high
5968# The high water mark for the ICMP measurement database.
5969#
5970# Note: low watermark controlled by netdb_low directive.
5971#
5972# These watermarks are counts, not percents. The defaults are
5973# (low) 900 and (high) 1000. When the high water mark is
5974# reached, database entries will be deleted until the low
5975# mark is reached.
5976#Default:
5977# netdb_high 1000
5978
5979# TAG: netdb_ping_period
5980# The minimum period for measuring a site. There will be at
5981# least this much delay between successive pings to the same
5982# network. The default is five minutes.
5983#Default:
5984# netdb_ping_period 5 minutes
5985
5986# TAG: query_icmp on|off
5987# If you want to ask your peers to include ICMP data in their ICP
5988# replies, enable this option.
5989#
5990# If your peer has configured Squid (during compilation) with
5991# '--enable-icmp' that peer will send ICMP pings to origin server
5992# sites of the URLs it receives. If you enable this option the
5993# ICP replies from that peer will include the ICMP data (if available).
5994# Then, when choosing a parent cache, Squid will choose the parent with
5995# the minimal RTT to the origin server. When this happens, the
5996# hierarchy field of the access.log will be
5997# "CLOSEST_PARENT_MISS". This option is off by default.
5998#Default:
5999# query_icmp off
6000
6001# TAG: test_reachability on|off
6002# When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH
6003# instead of ICP_MISS if the target host is NOT in the ICMP
6004# database, or has a zero RTT.
6005#Default:
6006# test_reachability off
6007
6008# TAG: icp_query_timeout (msec)
6009# Normally Squid will automatically determine an optimal ICP
6010# query timeout value based on the round-trip-time of recent ICP
6011# queries. If you want to override the value determined by
6012# Squid, set this 'icp_query_timeout' to a non-zero value. This
6013# value is specified in MILLISECONDS, so, to use a 2-second
6014# timeout (the old default), you would write:
6015#
6016# icp_query_timeout 2000
6017#Default:
6018# Dynamic detection.
6019
6020# TAG: maximum_icp_query_timeout (msec)
6021# Normally the ICP query timeout is determined dynamically. But
6022# sometimes it can lead to very large values (say 5 seconds).
6023# Use this option to put an upper limit on the dynamic timeout
6024# value. Do NOT use this option to always use a fixed (instead
6025# of a dynamic) timeout value. To set a fixed timeout see the
6026# 'icp_query_timeout' directive.
6027#Default:
6028# maximum_icp_query_timeout 2000
6029
6030# TAG: minimum_icp_query_timeout (msec)
6031# Normally the ICP query timeout is determined dynamically. But
6032# sometimes it can lead to very small timeouts, even lower than
6033# the normal latency variance on your link due to traffic.
6034# Use this option to put an lower limit on the dynamic timeout
6035# value. Do NOT use this option to always use a fixed (instead
6036# of a dynamic) timeout value. To set a fixed timeout see the
6037# 'icp_query_timeout' directive.
6038#Default:
6039# minimum_icp_query_timeout 5
6040
6041# TAG: background_ping_rate time-units
6042# Controls how often the ICP pings are sent to siblings that
6043# have background-ping set.
6044#Default:
6045# background_ping_rate 10 seconds
6046
6047# MULTICAST ICP OPTIONS
6048# -----------------------------------------------------------------------------
6049
6050# TAG: mcast_groups
6051# This tag specifies a list of multicast groups which your server
6052# should join to receive multicasted ICP queries.
6053#
6054# NOTE! Be very careful what you put here! Be sure you
6055# understand the difference between an ICP _query_ and an ICP
6056# _reply_. This option is to be set only if you want to RECEIVE
6057# multicast queries. Do NOT set this option to SEND multicast
6058# ICP (use cache_peer for that). ICP replies are always sent via
6059# unicast, so this option does not affect whether or not you will
6060# receive replies from multicast group members.
6061#
6062# You must be very careful to NOT use a multicast address which
6063# is already in use by another group of caches.
6064#
6065# If you are unsure about multicast, please read the Multicast
6066# chapter in the Squid FAQ (http://www.squid-cache.org/FAQ/).
6067#
6068# Usage: mcast_groups 239.128.16.128 224.0.1.20
6069#
6070# By default, Squid doesn't listen on any multicast groups.
6071#Default:
6072# none
6073
6074# TAG: mcast_miss_addr
6075# Note: This option is only available if Squid is rebuilt with the
6076# -DMULTICAST_MISS_STREAM define
6077#
6078# If you enable this option, every "cache miss" URL will
6079# be sent out on the specified multicast address.
6080#
6081# Do not enable this option unless you are are absolutely
6082# certain you understand what you are doing.
6083#Default:
6084# disabled.
6085
6086# TAG: mcast_miss_ttl
6087# Note: This option is only available if Squid is rebuilt with the
6088# -DMULTICAST_MISS_STREAM define
6089#
6090# This is the time-to-live value for packets multicasted
6091# when multicasting off cache miss URLs is enabled. By
6092# default this is set to 'site scope', i.e. 16.
6093#Default:
6094# mcast_miss_ttl 16
6095
6096# TAG: mcast_miss_port
6097# Note: This option is only available if Squid is rebuilt with the
6098# -DMULTICAST_MISS_STREAM define
6099#
6100# This is the port number to be used in conjunction with
6101# 'mcast_miss_addr'.
6102#Default:
6103# mcast_miss_port 3135
6104
6105# TAG: mcast_miss_encode_key
6106# Note: This option is only available if Squid is rebuilt with the
6107# -DMULTICAST_MISS_STREAM define
6108#
6109# The URLs that are sent in the multicast miss stream are
6110# encrypted. This is the encryption key.
6111#Default:
6112# mcast_miss_encode_key XXXXXXXXXXXXXXXX
6113
6114# TAG: mcast_icp_query_timeout (msec)
6115# For multicast peers, Squid regularly sends out ICP "probes" to
6116# count how many other peers are listening on the given multicast
6117# address. This value specifies how long Squid should wait to
6118# count all the replies. The default is 2000 msec, or 2
6119# seconds.
6120#Default:
6121# mcast_icp_query_timeout 2000
6122
6123# INTERNAL ICON OPTIONS
6124# -----------------------------------------------------------------------------
6125
6126# TAG: icon_directory
6127# Where the icons are stored. These are normally kept in
6128# /usr/share/squid3/icons
6129#Default:
6130# icon_directory /usr/share/squid3/icons
6131
6132# TAG: global_internal_static
6133# This directive controls is Squid should intercept all requests for
6134# /squid-internal-static/ no matter which host the URL is requesting
6135# (default on setting), or if nothing special should be done for
6136# such URLs (off setting). The purpose of this directive is to make
6137# icons etc work better in complex cache hierarchies where it may
6138# not always be possible for all corners in the cache mesh to reach
6139# the server generating a directory listing.
6140#Default:
6141# global_internal_static on
6142
6143# TAG: short_icon_urls
6144# If this is enabled Squid will use short URLs for icons.
6145# If disabled it will revert to the old behavior of including
6146# it's own name and port in the URL.
6147#
6148# If you run a complex cache hierarchy with a mix of Squid and
6149# other proxies you may need to disable this directive.
6150#Default:
6151# short_icon_urls on
6152
6153# ERROR PAGE OPTIONS
6154# -----------------------------------------------------------------------------
6155
6156# TAG: error_directory
6157# If you wish to create your own versions of the default
6158# error files to customize them to suit your company copy
6159# the error/template files to another directory and point
6160# this tag at them.
6161#
6162# WARNING: This option will disable multi-language support
6163# on error pages if used.
6164#
6165# The squid developers are interested in making squid available in
6166# a wide variety of languages. If you are making translations for a
6167# language that Squid does not currently provide please consider
6168# contributing your translation back to the project.
6169# http://wiki.squid-cache.org/Translations
6170#
6171# The squid developers working on translations are happy to supply drop-in
6172# translated error files in exchange for any new language contributions.
6173#Default:
6174# Send error pages in the clients preferred language
6175
6176# TAG: error_default_language
6177# Set the default language which squid will send error pages in
6178# if no existing translation matches the clients language
6179# preferences.
6180#
6181# If unset (default) generic English will be used.
6182#
6183# The squid developers are interested in making squid available in
6184# a wide variety of languages. If you are interested in making
6185# translations for any language see the squid wiki for details.
6186# http://wiki.squid-cache.org/Translations
6187#Default:
6188# Generate English language pages.
6189
6190# TAG: error_log_languages
6191# Log to cache.log what languages users are attempting to
6192# auto-negotiate for translations.
6193#
6194# Successful negotiations are not logged. Only failures
6195# have meaning to indicate that Squid may need an upgrade
6196# of its error page translations.
6197#Default:
6198# error_log_languages on
6199
6200# TAG: err_page_stylesheet
6201# CSS Stylesheet to pattern the display of Squid default error pages.
6202#
6203# For information on CSS see http://www.w3.org/Style/CSS/
6204#Default:
6205# err_page_stylesheet /etc/squid3/errorpage.css
6206
6207# TAG: err_html_text
6208# HTML text to include in error messages. Make this a "mailto"
6209# URL to your admin address, or maybe just a link to your
6210# organizations Web page.
6211#
6212# To include this in your error messages, you must rewrite
6213# the error template files (found in the "errors" directory).
6214# Wherever you want the 'err_html_text' line to appear,
6215# insert a %L tag in the error template file.
6216#Default:
6217# none
6218
6219# TAG: email_err_data on|off
6220# If enabled, information about the occurred error will be
6221# included in the mailto links of the ERR pages (if %W is set)
6222# so that the email body contains the data.
6223# Syntax is <A HREF="mailto:%w%W">%w</A>
6224#Default:
6225# email_err_data on
6226
6227# TAG: deny_info
6228# Usage: deny_info err_page_name acl
6229# or deny_info http://... acl
6230# or deny_info TCP_RESET acl
6231#
6232# This can be used to return a ERR_ page for requests which
6233# do not pass the 'http_access' rules. Squid remembers the last
6234# acl it evaluated in http_access, and if a 'deny_info' line exists
6235# for that ACL Squid returns a corresponding error page.
6236#
6237# The acl is typically the last acl on the http_access deny line which
6238# denied access. The exceptions to this rule are:
6239# - When Squid needs to request authentication credentials. It's then
6240# the first authentication related acl encountered
6241# - When none of the http_access lines matches. It's then the last
6242# acl processed on the last http_access line.
6243# - When the decision to deny access was made by an adaptation service,
6244# the acl name is the corresponding eCAP or ICAP service_name.
6245#
6246# NP: If providing your own custom error pages with error_directory
6247# you may also specify them by your custom file name:
6248# Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys
6249#
6250# By defaut Squid will send "403 Forbidden". A different 4xx or 5xx
6251# may be specified by prefixing the file name with the code and a colon.
6252# e.g. 404:ERR_CUSTOM_ACCESS_DENIED
6253#
6254# Alternatively you can tell Squid to reset the TCP connection
6255# by specifying TCP_RESET.
6256#
6257# Or you can specify an error URL or URL pattern. The browsers will
6258# get redirected to the specified URL after formatting tags have
6259# been replaced. Redirect will be done with 302 or 307 according to
6260# HTTP/1.1 specs. A different 3xx code may be specified by prefixing
6261# the URL. e.g. 303:http://example.com/
6262#
6263# URL FORMAT TAGS:
6264# %a - username (if available. Password NOT included)
6265# %B - FTP path URL
6266# %e - Error number
6267# %E - Error description
6268# %h - Squid hostname
6269# %H - Request domain name
6270# %i - Client IP Address
6271# %M - Request Method
6272# %o - Message result from external ACL helper
6273# %p - Request Port number
6274# %P - Request Protocol name
6275# %R - Request URL path
6276# %T - Timestamp in RFC 1123 format
6277# %U - Full canonical URL from client
6278# (HTTPS URLs terminate with *)
6279# %u - Full canonical URL from client
6280# %w - Admin email from squid.conf
6281# %x - Error name
6282# %% - Literal percent (%) code
6283#
6284#Default:
6285# none
6286
6287# OPTIONS INFLUENCING REQUEST FORWARDING
6288# -----------------------------------------------------------------------------
6289
6290# TAG: nonhierarchical_direct
6291# By default, Squid will send any non-hierarchical requests
6292# (matching hierarchy_stoplist or not cacheable request type) direct
6293# to origin servers.
6294#
6295# When this is set to "off", Squid will prefer to send these
6296# requests to parents.
6297#
6298# Note that in most configurations, by turning this off you will only
6299# add latency to these request without any improvement in global hit
6300# ratio.
6301#
6302# This option only sets a preference. If the parent is unavailable a
6303# direct connection to the origin server may still be attempted. To
6304# completely prevent direct connections use never_direct.
6305#Default:
6306# nonhierarchical_direct on
6307
6308# TAG: prefer_direct
6309# Normally Squid tries to use parents for most requests. If you for some
6310# reason like it to first try going direct and only use a parent if
6311# going direct fails set this to on.
6312#
6313# By combining nonhierarchical_direct off and prefer_direct on you
6314# can set up Squid to use a parent as a backup path if going direct
6315# fails.
6316#
6317# Note: If you want Squid to use parents for all requests see
6318# the never_direct directive. prefer_direct only modifies how Squid
6319# acts on cacheable requests.
6320#Default:
6321# prefer_direct off
6322
6323# TAG: cache_miss_revalidate on|off
6324# RFC 7232 defines a conditional request mechanism to prevent
6325# response objects being unnecessarily transferred over the network.
6326# If that mechanism is used by the client and a cache MISS occurs
6327# it can prevent new cache entries being created.
6328#
6329# This option determines whether Squid on cache MISS will pass the
6330# client revalidation request to the server or tries to fetch new
6331# content for caching. It can be useful while the cache is mostly
6332# empty to more quickly have the cache populated by generating
6333# non-conditional GETs.
6334#
6335# When set to 'on' (default), Squid will pass all client If-* headers
6336# to the server. This permits server responses without a cacheable
6337# payload to be delivered and on MISS no new cache entry is created.
6338#
6339# When set to 'off' and if the request is cacheable, Squid will
6340# remove the clients If-Modified-Since and If-None-Match headers from
6341# the request sent to the server. This requests a 200 status response
6342# from the server to create a new cache entry with.
6343#Default:
6344# cache_miss_revalidate on
6345
6346# TAG: always_direct
6347# Usage: always_direct allow|deny [!]aclname ...
6348#
6349# Here you can use ACL elements to specify requests which should
6350# ALWAYS be forwarded by Squid to the origin servers without using
6351# any peers. For example, to always directly forward requests for
6352# local servers ignoring any parents or siblings you may have use
6353# something like:
6354#
6355# acl local-servers dstdomain my.domain.net
6356# always_direct allow local-servers
6357#
6358# To always forward FTP requests directly, use
6359#
6360# acl FTP proto FTP
6361# always_direct allow FTP
6362#
6363# NOTE: There is a similar, but opposite option named
6364# 'never_direct'. You need to be aware that "always_direct deny
6365# foo" is NOT the same thing as "never_direct allow foo". You
6366# may need to use a deny rule to exclude a more-specific case of
6367# some other rule. Example:
6368#
6369# acl local-external dstdomain external.foo.net
6370# acl local-servers dstdomain .foo.net
6371# always_direct deny local-external
6372# always_direct allow local-servers
6373#
6374# NOTE: If your goal is to make the client forward the request
6375# directly to the origin server bypassing Squid then this needs
6376# to be done in the client configuration. Squid configuration
6377# can only tell Squid how Squid should fetch the object.
6378#
6379# NOTE: This directive is not related to caching. The replies
6380# is cached as usual even if you use always_direct. To not cache
6381# the replies see the 'cache' directive.
6382#
6383# This clause supports both fast and slow acl types.
6384# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
6385#Default:
6386# Prevent any cache_peer being used for this request.
6387
6388# TAG: never_direct
6389# Usage: never_direct allow|deny [!]aclname ...
6390#
6391# never_direct is the opposite of always_direct. Please read
6392# the description for always_direct if you have not already.
6393#
6394# With 'never_direct' you can use ACL elements to specify
6395# requests which should NEVER be forwarded directly to origin
6396# servers. For example, to force the use of a proxy for all
6397# requests, except those in your local domain use something like:
6398#
6399# acl local-servers dstdomain .foo.net
6400# never_direct deny local-servers
6401# never_direct allow all
6402#
6403# or if Squid is inside a firewall and there are local intranet
6404# servers inside the firewall use something like:
6405#
6406# acl local-intranet dstdomain .foo.net
6407# acl local-external dstdomain external.foo.net
6408# always_direct deny local-external
6409# always_direct allow local-intranet
6410# never_direct allow all
6411#
6412# This clause supports both fast and slow acl types.
6413# See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
6414#Default:
6415# Allow DNS results to be used for this request.
6416
6417# ADVANCED NETWORKING OPTIONS
6418# -----------------------------------------------------------------------------
6419
6420# TAG: incoming_udp_average
6421# Heavy voodoo here. I can't even believe you are reading this.
6422# Are you crazy? Don't even think about adjusting these unless
6423# you understand the algorithms in comm_select.c first!
6424#Default:
6425# incoming_udp_average 6
6426
6427# TAG: incoming_tcp_average
6428# Heavy voodoo here. I can't even believe you are reading this.
6429# Are you crazy? Don't even think about adjusting these unless
6430# you understand the algorithms in comm_select.c first!
6431#Default:
6432# incoming_tcp_average 4
6433
6434# TAG: incoming_dns_average
6435# Heavy voodoo here. I can't even believe you are reading this.
6436# Are you crazy? Don't even think about adjusting these unless
6437# you understand the algorithms in comm_select.c first!
6438#Default:
6439# incoming_dns_average 4
6440
6441# TAG: min_udp_poll_cnt
6442# Heavy voodoo here. I can't even believe you are reading this.
6443# Are you crazy? Don't even think about adjusting these unless
6444# you understand the algorithms in comm_select.c first!
6445#Default:
6446# min_udp_poll_cnt 8
6447
6448# TAG: min_dns_poll_cnt
6449# Heavy voodoo here. I can't even believe you are reading this.
6450# Are you crazy? Don't even think about adjusting these unless
6451# you understand the algorithms in comm_select.c first!
6452#Default:
6453# min_dns_poll_cnt 8
6454
6455# TAG: min_tcp_poll_cnt
6456# Heavy voodoo here. I can't even believe you are reading this.
6457# Are you crazy? Don't even think about adjusting these unless
6458# you understand the algorithms in comm_select.c first!
6459#Default:
6460# min_tcp_poll_cnt 8
6461
6462# TAG: accept_filter
6463# FreeBSD:
6464#
6465# The name of an accept(2) filter to install on Squid's
6466# listen socket(s). This feature is perhaps specific to
6467# FreeBSD and requires support in the kernel.
6468#
6469# The 'httpready' filter delays delivering new connections
6470# to Squid until a full HTTP request has been received.
6471# See the accf_http(9) man page for details.
6472#
6473# The 'dataready' filter delays delivering new connections
6474# to Squid until there is some data to process.
6475# See the accf_dataready(9) man page for details.
6476#
6477# Linux:
6478#
6479# The 'data' filter delays delivering of new connections
6480# to Squid until there is some data to process by TCP_ACCEPT_DEFER.
6481# You may optionally specify a number of seconds to wait by
6482# 'data=N' where N is the number of seconds. Defaults to 30
6483# if not specified. See the tcp(7) man page for details.
6484#EXAMPLE:
6485## FreeBSD
6486#accept_filter httpready
6487## Linux
6488#accept_filter data
6489#Default:
6490# none
6491
6492# TAG: client_ip_max_connections
6493# Set an absolute limit on the number of connections a single
6494# client IP can use. Any more than this and Squid will begin to drop
6495# new connections from the client until it closes some links.
6496#
6497# Note that this is a global limit. It affects all HTTP, HTCP, Gopher and FTP
6498# connections from the client. For finer control use the ACL access controls.
6499#
6500# Requires client_db to be enabled (the default).
6501#
6502# WARNING: This may noticably slow down traffic received via external proxies
6503# or NAT devices and cause them to rebound error messages back to their clients.
6504#Default:
6505# No limit.
6506
6507# TAG: tcp_recv_bufsize (bytes)
6508# Size of receive buffer to set for TCP sockets. Probably just
6509# as easy to change your kernel's default.
6510# Omit from squid.conf to use the default buffer size.
6511#Default:
6512# Use operating system TCP defaults.
6513
6514# ICAP OPTIONS
6515# -----------------------------------------------------------------------------
6516
6517# TAG: icap_enable on|off
6518# If you want to enable the ICAP module support, set this to on.
6519#Default:
6520# icap_enable off
6521
6522# TAG: icap_connect_timeout
6523# This parameter specifies how long to wait for the TCP connect to
6524# the requested ICAP server to complete before giving up and either
6525# terminating the HTTP transaction or bypassing the failure.
6526#
6527# The default for optional services is peer_connect_timeout.
6528# The default for essential services is connect_timeout.
6529# If this option is explicitly set, its value applies to all services.
6530#Default:
6531# none
6532
6533# TAG: icap_io_timeout time-units
6534# This parameter specifies how long to wait for an I/O activity on
6535# an established, active ICAP connection before giving up and
6536# either terminating the HTTP transaction or bypassing the
6537# failure.
6538#Default:
6539# Use read_timeout.
6540
6541# TAG: icap_service_failure_limit limit [in memory-depth time-units]
6542# The limit specifies the number of failures that Squid tolerates
6543# when establishing a new TCP connection with an ICAP service. If
6544# the number of failures exceeds the limit, the ICAP service is
6545# not used for new ICAP requests until it is time to refresh its
6546# OPTIONS.
6547#
6548# A negative value disables the limit. Without the limit, an ICAP
6549# service will not be considered down due to connectivity failures
6550# between ICAP OPTIONS requests.
6551#
6552# Squid forgets ICAP service failures older than the specified
6553# value of memory-depth. The memory fading algorithm
6554# is approximate because Squid does not remember individual
6555# errors but groups them instead, splitting the option
6556# value into ten time slots of equal length.
6557#
6558# When memory-depth is 0 and by default this option has no
6559# effect on service failure expiration.
6560#
6561# Squid always forgets failures when updating service settings
6562# using an ICAP OPTIONS transaction, regardless of this option
6563# setting.
6564#
6565# For example,
6566# # suspend service usage after 10 failures in 5 seconds:
6567# icap_service_failure_limit 10 in 5 seconds
6568#Default:
6569# icap_service_failure_limit 10
6570
6571# TAG: icap_service_revival_delay
6572# The delay specifies the number of seconds to wait after an ICAP
6573# OPTIONS request failure before requesting the options again. The
6574# failed ICAP service is considered "down" until fresh OPTIONS are
6575# fetched.
6576#
6577# The actual delay cannot be smaller than the hardcoded minimum
6578# delay of 30 seconds.
6579#Default:
6580# icap_service_revival_delay 180
6581
6582# TAG: icap_preview_enable on|off
6583# The ICAP Preview feature allows the ICAP server to handle the
6584# HTTP message by looking only at the beginning of the message body
6585# or even without receiving the body at all. In some environments,
6586# previews greatly speedup ICAP processing.
6587#
6588# During an ICAP OPTIONS transaction, the server may tell Squid what
6589# HTTP messages should be previewed and how big the preview should be.
6590# Squid will not use Preview if the server did not request one.
6591#
6592# To disable ICAP Preview for all ICAP services, regardless of
6593# individual ICAP server OPTIONS responses, set this option to "off".
6594#Example:
6595#icap_preview_enable off
6596#Default:
6597# icap_preview_enable on
6598
6599# TAG: icap_preview_size
6600# The default size of preview data to be sent to the ICAP server.
6601# This value might be overwritten on a per server basis by OPTIONS requests.
6602#Default:
6603# No preview sent.
6604
6605# TAG: icap_206_enable on|off
6606# 206 (Partial Content) responses is an ICAP extension that allows the
6607# ICAP agents to optionally combine adapted and original HTTP message
6608# content. The decision to combine is postponed until the end of the
6609# ICAP response. Squid supports Partial Content extension by default.
6610#
6611# Activation of the Partial Content extension is negotiated with each
6612# ICAP service during OPTIONS exchange. Most ICAP servers should handle
6613# negotation correctly even if they do not support the extension, but
6614# some might fail. To disable Partial Content support for all ICAP
6615# services and to avoid any negotiation, set this option to "off".
6616#
6617# Example:
6618# icap_206_enable off
6619#Default:
6620# icap_206_enable on
6621
6622# TAG: icap_default_options_ttl
6623# The default TTL value for ICAP OPTIONS responses that don't have
6624# an Options-TTL header.
6625#Default:
6626# icap_default_options_ttl 60
6627
6628# TAG: icap_persistent_connections on|off
6629# Whether or not Squid should use persistent connections to
6630# an ICAP server.
6631#Default:
6632# icap_persistent_connections on
6633
6634# TAG: adaptation_send_client_ip on|off
6635# If enabled, Squid shares HTTP client IP information with adaptation
6636# services. For ICAP, Squid adds the X-Client-IP header to ICAP requests.
6637# For eCAP, Squid sets the libecap::metaClientIp transaction option.
6638#
6639# See also: adaptation_uses_indirect_client
6640#Default:
6641# adaptation_send_client_ip off
6642
6643# TAG: adaptation_send_username on|off
6644# This sends authenticated HTTP client username (if available) to
6645# the adaptation service.
6646#
6647# For ICAP, the username value is encoded based on the
6648# icap_client_username_encode option and is sent using the header
6649# specified by the icap_client_username_header option.
6650#Default:
6651# adaptation_send_username off
6652
6653# TAG: icap_client_username_header
6654# ICAP request header name to use for adaptation_send_username.
6655#Default:
6656# icap_client_username_header X-Client-Username
6657
6658# TAG: icap_client_username_encode on|off
6659# Whether to base64 encode the authenticated client username.
6660#Default:
6661# icap_client_username_encode off
6662
6663# TAG: icap_service
6664# Defines a single ICAP service using the following format:
6665#
6666# icap_service id vectoring_point uri [option ...]
6667#
6668# id: ID
6669# an opaque identifier or name which is used to direct traffic to
6670# this specific service. Must be unique among all adaptation
6671# services in squid.conf.
6672#
6673# vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
6674# This specifies at which point of transaction processing the
6675# ICAP service should be activated. *_postcache vectoring points
6676# are not yet supported.
6677#
6678# uri: icap://servername:port/servicepath
6679# ICAP server and service location.
6680#
6681# ICAP does not allow a single service to handle both REQMOD and RESPMOD
6682# transactions. Squid does not enforce that requirement. You can specify
6683# services with the same service_url and different vectoring_points. You
6684# can even specify multiple identical services as long as their
6685# service_names differ.
6686#
6687# To activate a service, use the adaptation_access directive. To group
6688# services, use adaptation_service_chain and adaptation_service_set.
6689#
6690# Service options are separated by white space. ICAP services support
6691# the following name=value options:
6692#
6693# bypass=on|off|1|0
6694# If set to 'on' or '1', the ICAP service is treated as
6695# optional. If the service cannot be reached or malfunctions,
6696# Squid will try to ignore any errors and process the message as
6697# if the service was not enabled. No all ICAP errors can be
6698# bypassed. If set to 0, the ICAP service is treated as
6699# essential and all ICAP errors will result in an error page
6700# returned to the HTTP client.
6701#
6702# Bypass is off by default: services are treated as essential.
6703#
6704# routing=on|off|1|0
6705# If set to 'on' or '1', the ICAP service is allowed to
6706# dynamically change the current message adaptation plan by
6707# returning a chain of services to be used next. The services
6708# are specified using the X-Next-Services ICAP response header
6709# value, formatted as a comma-separated list of service names.
6710# Each named service should be configured in squid.conf. Other
6711# services are ignored. An empty X-Next-Services value results
6712# in an empty plan which ends the current adaptation.
6713#
6714# Dynamic adaptation plan may cross or cover multiple supported
6715# vectoring points in their natural processing order.
6716#
6717# Routing is not allowed by default: the ICAP X-Next-Services
6718# response header is ignored.
6719#
6720# ipv6=on|off
6721# Only has effect on split-stack systems. The default on those systems
6722# is to use IPv4-only connections. When set to 'on' this option will
6723# make Squid use IPv6-only connections to contact this ICAP service.
6724#
6725# on-overload=block|bypass|wait|force
6726# If the service Max-Connections limit has been reached, do
6727# one of the following for each new ICAP transaction:
6728# * block: send an HTTP error response to the client
6729# * bypass: ignore the "over-connected" ICAP service
6730# * wait: wait (in a FIFO queue) for an ICAP connection slot
6731# * force: proceed, ignoring the Max-Connections limit
6732#
6733# In SMP mode with N workers, each worker assumes the service
6734# connection limit is Max-Connections/N, even though not all
6735# workers may use a given service.
6736#
6737# The default value is "bypass" if service is bypassable,
6738# otherwise it is set to "wait".
6739#
6740#
6741# max-conn=number
6742# Use the given number as the Max-Connections limit, regardless
6743# of the Max-Connections value given by the service, if any.
6744#
6745# Older icap_service format without optional named parameters is
6746# deprecated but supported for backward compatibility.
6747#
6748#Example:
6749#icap_service svcBlocker reqmod_precache icap://icap1.mydomain.net:1344/reqmod bypass=0
6750#icap_service svcLogger reqmod_precache icap://icap2.mydomain.net:1344/respmod routing=on
6751#Default:
6752# none
6753
6754# TAG: icap_class
6755# This deprecated option was documented to define an ICAP service
6756# chain, even though it actually defined a set of similar, redundant
6757# services, and the chains were not supported.
6758#
6759# To define a set of redundant services, please use the
6760# adaptation_service_set directive. For service chains, use
6761# adaptation_service_chain.
6762#Default:
6763# none
6764
6765# TAG: icap_access
6766# This option is deprecated. Please use adaptation_access, which
6767# has the same ICAP functionality, but comes with better
6768# documentation, and eCAP support.
6769#Default:
6770# none
6771
6772# eCAP OPTIONS
6773# -----------------------------------------------------------------------------
6774
6775# TAG: ecap_enable on|off
6776# Controls whether eCAP support is enabled.
6777#Default:
6778# ecap_enable off
6779
6780# TAG: ecap_service
6781# Defines a single eCAP service
6782#
6783# ecap_service id vectoring_point uri [option ...]
6784#
6785# id: ID
6786# an opaque identifier or name which is used to direct traffic to
6787# this specific service. Must be unique among all adaptation
6788# services in squid.conf.
6789#
6790# vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
6791# This specifies at which point of transaction processing the
6792# eCAP service should be activated. *_postcache vectoring points
6793# are not yet supported.
6794#
6795# uri: ecap://vendor/service_name?custom&cgi=style¶meters=optional
6796# Squid uses the eCAP service URI to match this configuration
6797# line with one of the dynamically loaded services. Each loaded
6798# eCAP service must have a unique URI. Obtain the right URI from
6799# the service provider.
6800#
6801# To activate a service, use the adaptation_access directive. To group
6802# services, use adaptation_service_chain and adaptation_service_set.
6803#
6804# Service options are separated by white space. eCAP services support
6805# the following name=value options:
6806#
6807# bypass=on|off|1|0
6808# If set to 'on' or '1', the eCAP service is treated as optional.
6809# If the service cannot be reached or malfunctions, Squid will try
6810# to ignore any errors and process the message as if the service
6811# was not enabled. No all eCAP errors can be bypassed.
6812# If set to 'off' or '0', the eCAP service is treated as essential
6813# and all eCAP errors will result in an error page returned to the
6814# HTTP client.
6815#
6816# Bypass is off by default: services are treated as essential.
6817#
6818# routing=on|off|1|0
6819# If set to 'on' or '1', the eCAP service is allowed to
6820# dynamically change the current message adaptation plan by
6821# returning a chain of services to be used next.
6822#
6823# Dynamic adaptation plan may cross or cover multiple supported
6824# vectoring points in their natural processing order.
6825#
6826# Routing is not allowed by default.
6827#
6828# Older ecap_service format without optional named parameters is
6829# deprecated but supported for backward compatibility.
6830#
6831#
6832#Example:
6833#ecap_service s1 reqmod_precache ecap://filters.R.us/leakDetector?on_error=block bypass=off
6834#ecap_service s2 respmod_precache ecap://filters.R.us/virusFilter config=/etc/vf.cfg bypass=on
6835#Default:
6836# none
6837
6838# TAG: loadable_modules
6839# Instructs Squid to load the specified dynamic module(s) or activate
6840# preloaded module(s).
6841#Example:
6842#loadable_modules /usr/lib/MinimalAdapter.so
6843#Default:
6844# none
6845
6846# MESSAGE ADAPTATION OPTIONS
6847# -----------------------------------------------------------------------------
6848
6849# TAG: adaptation_service_set
6850#
6851# Configures an ordered set of similar, redundant services. This is
6852# useful when hot standby or backup adaptation servers are available.
6853#
6854# adaptation_service_set set_name service_name1 service_name2 ...
6855#
6856# The named services are used in the set declaration order. The first
6857# applicable adaptation service from the set is used first. The next
6858# applicable service is tried if and only if the transaction with the
6859# previous service fails and the message waiting to be adapted is still
6860# intact.
6861#
6862# When adaptation starts, broken services are ignored as if they were
6863# not a part of the set. A broken service is a down optional service.
6864#
6865# The services in a set must be attached to the same vectoring point
6866# (e.g., pre-cache) and use the same adaptation method (e.g., REQMOD).
6867#
6868# If all services in a set are optional then adaptation failures are
6869# bypassable. If all services in the set are essential, then a
6870# transaction failure with one service may still be retried using
6871# another service from the set, but when all services fail, the master
6872# transaction fails as well.
6873#
6874# A set may contain a mix of optional and essential services, but that
6875# is likely to lead to surprising results because broken services become
6876# ignored (see above), making previously bypassable failures fatal.
6877# Technically, it is the bypassability of the last failed service that
6878# matters.
6879#
6880# See also: adaptation_access adaptation_service_chain
6881#
6882#Example:
6883#adaptation_service_set svcBlocker urlFilterPrimary urlFilterBackup
6884#adaptation service_set svcLogger loggerLocal loggerRemote
6885#Default:
6886# none
6887
6888# TAG: adaptation_service_chain
6889#
6890# Configures a list of complementary services that will be applied
6891# one-by-one, forming an adaptation chain or pipeline. This is useful
6892# when Squid must perform different adaptations on the same message.
6893#
6894# adaptation_service_chain chain_name service_name1 svc_name2 ...
6895#
6896# The named services are used in the chain declaration order. The first
6897# applicable adaptation service from the chain is used first. The next
6898# applicable service is applied to the successful adaptation results of
6899# the previous service in the chain.
6900#
6901# When adaptation starts, broken services are ignored as if they were
6902# not a part of the chain. A broken service is a down optional service.
6903#
6904# Request satisfaction terminates the adaptation chain because Squid
6905# does not currently allow declaration of RESPMOD services at the
6906# "reqmod_precache" vectoring point (see icap_service or ecap_service).
6907#
6908# The services in a chain must be attached to the same vectoring point
6909# (e.g., pre-cache) and use the same adaptation method (e.g., REQMOD).
6910#
6911# A chain may contain a mix of optional and essential services. If an
6912# essential adaptation fails (or the failure cannot be bypassed for
6913# other reasons), the master transaction fails. Otherwise, the failure
6914# is bypassed as if the failed adaptation service was not in the chain.
6915#
6916# See also: adaptation_access adaptation_service_set
6917#
6918#Example:
6919#adaptation_service_chain svcRequest requestLogger urlFilter leakDetector
6920#Default:
6921# none
6922
6923# TAG: adaptation_access
6924# Sends an HTTP transaction to an ICAP or eCAP adaptation service.
6925#
6926# adaptation_access service_name allow|deny [!]aclname...
6927# adaptation_access set_name allow|deny [!]aclname...
6928#
6929# At each supported vectoring point, the adaptation_access
6930# statements are processed in the order they appear in this
6931# configuration file. Statements pointing to the following services
6932# are ignored (i.e., skipped without checking their ACL):
6933#
6934# - services serving different vectoring points
6935# - "broken-but-bypassable" services
6936# - "up" services configured to ignore such transactions
6937# (e.g., based on the ICAP Transfer-Ignore header).
6938#
6939# When a set_name is used, all services in the set are checked
6940# using the same rules, to find the first applicable one. See
6941# adaptation_service_set for details.
6942#
6943# If an access list is checked and there is a match, the
6944# processing stops: For an "allow" rule, the corresponding
6945# adaptation service is used for the transaction. For a "deny"
6946# rule, no adaptation service is activated.
6947#
6948# It is currently not possible to apply more than one adaptation
6949# service at the same vectoring point to the same HTTP transaction.
6950#
6951# See also: icap_service and ecap_service
6952#
6953#Example:
6954#adaptation_access service_1 allow all
6955#Default:
6956# Allow, unless rules exist in squid.conf.
6957
6958# TAG: adaptation_service_iteration_limit
6959# Limits the number of iterations allowed when applying adaptation
6960# services to a message. If your longest adaptation set or chain
6961# may have more than 16 services, increase the limit beyond its
6962# default value of 16. If detecting infinite iteration loops sooner
6963# is critical, make the iteration limit match the actual number
6964# of services in your longest adaptation set or chain.
6965#
6966# Infinite adaptation loops are most likely with routing services.
6967#
6968# See also: icap_service routing=1
6969#Default:
6970# adaptation_service_iteration_limit 16
6971
6972# TAG: adaptation_masterx_shared_names
6973# For each master transaction (i.e., the HTTP request and response
6974# sequence, including all related ICAP and eCAP exchanges), Squid
6975# maintains a table of metadata. The table entries are (name, value)
6976# pairs shared among eCAP and ICAP exchanges. The table is destroyed
6977# with the master transaction.
6978#
6979# This option specifies the table entry names that Squid must accept
6980# from and forward to the adaptation transactions.
6981#
6982# An ICAP REQMOD or RESPMOD transaction may set an entry in the
6983# shared table by returning an ICAP header field with a name
6984# specified in adaptation_masterx_shared_names.
6985#
6986# An eCAP REQMOD or RESPMOD transaction may set an entry in the
6987# shared table by implementing the libecap::visitEachOption() API
6988# to provide an option with a name specified in
6989# adaptation_masterx_shared_names.
6990#
6991# Squid will store and forward the set entry to subsequent adaptation
6992# transactions within the same master transaction scope.
6993#
6994# Only one shared entry name is supported at this time.
6995#
6996#Example:
6997## share authentication information among ICAP services
6998#adaptation_masterx_shared_names X-Subscriber-ID
6999#Default:
7000# none
7001
7002# TAG: adaptation_meta
7003# This option allows Squid administrator to add custom ICAP request
7004# headers or eCAP options to Squid ICAP requests or eCAP transactions.
7005# Use it to pass custom authentication tokens and other
7006# transaction-state related meta information to an ICAP/eCAP service.
7007#
7008# The addition of a meta header is ACL-driven:
7009# adaptation_meta name value [!]aclname ...
7010#
7011# Processing for a given header name stops after the first ACL list match.
7012# Thus, it is impossible to add two headers with the same name. If no ACL
7013# lists match for a given header name, no such header is added. For
7014# example:
7015#
7016# # do not debug transactions except for those that need debugging
7017# adaptation_meta X-Debug 1 needs_debugging
7018#
7019# # log all transactions except for those that must remain secret
7020# adaptation_meta X-Log 1 !keep_secret
7021#
7022# # mark transactions from users in the "G 1" group
7023# adaptation_meta X-Authenticated-Groups "G 1" authed_as_G1
7024#
7025# The "value" parameter may be a regular squid.conf token or a "double
7026# quoted string". Within the quoted string, use backslash (\) to escape
7027# any character, which is currently only useful for escaping backslashes
7028# and double quotes. For example,
7029# "this string has one backslash (\\) and two \"quotes\""
7030#
7031# Used adaptation_meta header values may be logged via %note
7032# logformat code. If multiple adaptation_meta headers with the same name
7033# are used during master transaction lifetime, the header values are
7034# logged in the order they were used and duplicate values are ignored
7035# (only the first repeated value will be logged).
7036#Default:
7037# none
7038
7039# TAG: icap_retry
7040# This ACL determines which retriable ICAP transactions are
7041# retried. Transactions that received a complete ICAP response
7042# and did not have to consume or produce HTTP bodies to receive
7043# that response are usually retriable.
7044#
7045# icap_retry allow|deny [!]aclname ...
7046#
7047# Squid automatically retries some ICAP I/O timeouts and errors
7048# due to persistent connection race conditions.
7049#
7050# See also: icap_retry_limit
7051#Default:
7052# icap_retry deny all
7053
7054# TAG: icap_retry_limit
7055# Limits the number of retries allowed.
7056#
7057# Communication errors due to persistent connection race
7058# conditions are unavoidable, automatically retried, and do not
7059# count against this limit.
7060#
7061# See also: icap_retry
7062#Default:
7063# No retries are allowed.
7064
7065# DNS OPTIONS
7066# -----------------------------------------------------------------------------
7067
7068# TAG: check_hostnames
7069# For security and stability reasons Squid can check
7070# hostnames for Internet standard RFC compliance. If you want
7071# Squid to perform these checks turn this directive on.
7072#Default:
7073# check_hostnames off
7074
7075# TAG: allow_underscore
7076# Underscore characters is not strictly allowed in Internet hostnames
7077# but nevertheless used by many sites. Set this to off if you want
7078# Squid to be strict about the standard.
7079# This check is performed only when check_hostnames is set to on.
7080#Default:
7081# allow_underscore on
7082
7083# TAG: cache_dns_program
7084# Note: This option is only available if Squid is rebuilt with the
7085# --disable-internal-dns
7086#
7087# Specify the location of the executable for dnslookup process.
7088#Default:
7089# cache_dns_program /usr/lib/squid3/dnsserver
7090
7091# TAG: dns_children
7092# Note: This option is only available if Squid is rebuilt with the
7093# --disable-internal-dns
7094#
7095# The maximum number of processes spawn to service DNS name lookups.
7096# If you limit it too few Squid will have to wait for them to process
7097# a backlog of requests, slowing it down. If you allow too many they
7098# will use RAM and other system resources noticably.
7099# The maximum this may be safely set to is 32.
7100#
7101# The startup= and idle= options allow some measure of skew in your
7102# tuning.
7103#
7104# startup=
7105#
7106# Sets a minimum of how many processes are to be spawned when Squid
7107# starts or reconfigures. When set to zero the first request will
7108# cause spawning of the first child process to handle it.
7109#
7110# Starting too few will cause an initial slowdown in traffic as Squid
7111# attempts to simultaneously spawn enough processes to cope.
7112#
7113# idle=
7114#
7115# Sets a minimum of how many processes Squid is to try and keep available
7116# at all times. When traffic begins to rise above what the existing
7117# processes can handle this many more will be spawned up to the maximum
7118# configured. A minimum setting of 1 is required.
7119#Default:
7120# dns_children 32 startup=1 idle=1
7121
7122# TAG: dns_retransmit_interval
7123# Initial retransmit interval for DNS queries. The interval is
7124# doubled each time all configured DNS servers have been tried.
7125#Default:
7126# dns_retransmit_interval 5 seconds
7127
7128# TAG: dns_timeout
7129# DNS Query timeout. If no response is received to a DNS query
7130# within this time all DNS servers for the queried domain
7131# are assumed to be unavailable.
7132#Default:
7133# dns_timeout 30 seconds
7134
7135# TAG: dns_packet_max
7136# Maximum number of bytes packet size to advertise via EDNS.
7137# Set to "none" to disable EDNS large packet support.
7138#
7139# For legacy reasons DNS UDP replies will default to 512 bytes which
7140# is too small for many responses. EDNS provides a means for Squid to
7141# negotiate receiving larger responses back immediately without having
7142# to failover with repeat requests. Responses larger than this limit
7143# will retain the old behaviour of failover to TCP DNS.
7144#
7145# Squid has no real fixed limit internally, but allowing packet sizes
7146# over 1500 bytes requires network jumbogram support and is usually not
7147# necessary.
7148#
7149# WARNING: The RFC also indicates that some older resolvers will reply
7150# with failure of the whole request if the extension is added. Some
7151# resolvers have already been identified which will reply with mangled
7152# EDNS response on occasion. Usually in response to many-KB jumbogram
7153# sizes being advertised by Squid.
7154# Squid will currently treat these both as an unable-to-resolve domain
7155# even if it would be resolvable without EDNS.
7156#Default:
7157# EDNS disabled
7158
7159# TAG: dns_defnames on|off
7160# Normally the RES_DEFNAMES resolver option is disabled
7161# (see res_init(3)). This prevents caches in a hierarchy
7162# from interpreting single-component hostnames locally. To allow
7163# Squid to handle single-component names, enable this option.
7164#Default:
7165# Search for single-label domain names is disabled.
7166
7167# TAG: dns_multicast_local on|off
7168# When set to on, Squid sends multicast DNS lookups on the local
7169# network for domains ending in .local and .arpa.
7170# This enables local servers and devices to be contacted in an
7171# ad-hoc or zero-configuration network environment.
7172#Default:
7173# Search for .local and .arpa names is disabled.
7174
7175# TAG: dns_nameservers
7176# Use this if you want to specify a list of DNS name servers
7177# (IP addresses) to use instead of those given in your
7178# /etc/resolv.conf file.
7179#
7180# On Windows platforms, if no value is specified here or in
7181# the /etc/resolv.conf file, the list of DNS name servers are
7182# taken from the Windows registry, both static and dynamic DHCP
7183# configurations are supported.
7184#
7185# Example: dns_nameservers 10.0.0.1 192.172.0.4
7186#Default:
7187# Use operating system definitions
7188
7189# TAG: hosts_file
7190# Location of the host-local IP name-address associations
7191# database. Most Operating Systems have such a file on different
7192# default locations:
7193# - Un*X & Linux: /etc/hosts
7194# - Windows NT/2000: %SystemRoot%\system32\drivers\etc\hosts
7195# (%SystemRoot% value install default is c:\winnt)
7196# - Windows XP/2003: %SystemRoot%\system32\drivers\etc\hosts
7197# (%SystemRoot% value install default is c:\windows)
7198# - Windows 9x/Me: %windir%\hosts
7199# (%windir% value is usually c:\windows)
7200# - Cygwin: /etc/hosts
7201#
7202# The file contains newline-separated definitions, in the
7203# form ip_address_in_dotted_form name [name ...] names are
7204# whitespace-separated. Lines beginning with an hash (#)
7205# character are comments.
7206#
7207# The file is checked at startup and upon configuration.
7208# If set to 'none', it won't be checked.
7209# If append_domain is used, that domain will be added to
7210# domain-local (i.e. not containing any dot character) host
7211# definitions.
7212#Default:
7213# hosts_file /etc/hosts
7214
7215# TAG: append_domain
7216# Appends local domain name to hostnames without any dots in
7217# them. append_domain must begin with a period.
7218#
7219# Be warned there are now Internet names with no dots in
7220# them using only top-domain names, so setting this may
7221# cause some Internet sites to become unavailable.
7222#
7223#Example:
7224# append_domain .yourdomain.com
7225#Default:
7226# Use operating system definitions
7227
7228# TAG: ignore_unknown_nameservers
7229# By default Squid checks that DNS responses are received
7230# from the same IP addresses they are sent to. If they
7231# don't match, Squid ignores the response and writes a warning
7232# message to cache.log. You can allow responses from unknown
7233# nameservers by setting this option to 'off'.
7234#Default:
7235# ignore_unknown_nameservers on
7236
7237# TAG: dns_v4_first
7238# With the IPv6 Internet being as fast or faster than IPv4 Internet
7239# for most networks Squid prefers to contact websites over IPv6.
7240#
7241# This option reverses the order of preference to make Squid contact
7242# dual-stack websites over IPv4 first. Squid will still perform both
7243# IPv6 and IPv4 DNS lookups before connecting.
7244#
7245# WARNING:
7246# This option will restrict the situations under which IPv6
7247# connectivity is used (and tested), potentially hiding network
7248# problems which would otherwise be detected and warned about.
7249#Default:
7250# dns_v4_first off
7251
7252# TAG: ipcache_size (number of entries)
7253# Maximum number of DNS IP cache entries.
7254#Default:
7255# ipcache_size 1024
7256
7257# TAG: ipcache_low (percent)
7258#Default:
7259# ipcache_low 90
7260
7261# TAG: ipcache_high (percent)
7262# The size, low-, and high-water marks for the IP cache.
7263#Default:
7264# ipcache_high 95
7265
7266# TAG: fqdncache_size (number of entries)
7267# Maximum number of FQDN cache entries.
7268#Default:
7269# fqdncache_size 1024
7270
7271# MISCELLANEOUS
7272# -----------------------------------------------------------------------------
7273
7274# TAG: configuration_includes_quoted_values on|off
7275# Previous Squid versions have defined "quoted/string" as syntax for
7276# ACL to signifiy the value is an included file containing values and
7277# has treated the " characters in other places of the configuration file
7278# as part of the parameter value it was used for.
7279#
7280# For compatibility with existing installations that behaviour
7281# remains the default.
7282#
7283# If this directive is set to 'on', Squid will start parsing each
7284# "quoted string" as a single configuration directive parameter. The
7285# quotes are stripped before the parameter value is interpreted or use.
7286#
7287# That will continue for all lines until this directive is set to 'off',
7288# where Squid will return to the default configuration parsing.
7289#
7290# For example;
7291#
7292# configuration_includes_quoted_values on
7293# acl group external groupCheck Administrators "Internet Users" Guest
7294# configuration_includes_quoted_values off
7295#
7296#Default:
7297# configuration_includes_quoted_values off
7298
7299# TAG: memory_pools on|off
7300# If set, Squid will keep pools of allocated (but unused) memory
7301# available for future use. If memory is a premium on your
7302# system and you believe your malloc library outperforms Squid
7303# routines, disable this.
7304#Default:
7305# memory_pools on
7306
7307# TAG: memory_pools_limit (bytes)
7308# Used only with memory_pools on:
7309# memory_pools_limit 50 MB
7310#
7311# If set to a non-zero value, Squid will keep at most the specified
7312# limit of allocated (but unused) memory in memory pools. All free()
7313# requests that exceed this limit will be handled by your malloc
7314# library. Squid does not pre-allocate any memory, just safe-keeps
7315# objects that otherwise would be free()d. Thus, it is safe to set
7316# memory_pools_limit to a reasonably high value even if your
7317# configuration will use less memory.
7318#
7319# If set to none, Squid will keep all memory it can. That is, there
7320# will be no limit on the total amount of memory used for safe-keeping.
7321#
7322# To disable memory allocation optimization, do not set
7323# memory_pools_limit to 0 or none. Set memory_pools to "off" instead.
7324#
7325# An overhead for maintaining memory pools is not taken into account
7326# when the limit is checked. This overhead is close to four bytes per
7327# object kept. However, pools may actually _save_ memory because of
7328# reduced memory thrashing in your malloc library.
7329#Default:
7330# memory_pools_limit 5 MB
7331
7332# TAG: forwarded_for on|off|transparent|truncate|delete
7333# If set to "on", Squid will append your client's IP address
7334# in the HTTP requests it forwards. By default it looks like:
7335#
7336# X-Forwarded-For: 192.1.2.3
7337#
7338# If set to "off", it will appear as
7339#
7340# X-Forwarded-For: unknown
7341#
7342# If set to "transparent", Squid will not alter the
7343# X-Forwarded-For header in any way.
7344#
7345# If set to "delete", Squid will delete the entire
7346# X-Forwarded-For header.
7347#
7348# If set to "truncate", Squid will remove all existing
7349# X-Forwarded-For entries, and place the client IP as the sole entry.
7350#Default:
7351# forwarded_for on
7352
7353# TAG: cachemgr_passwd
7354# Specify passwords for cachemgr operations.
7355#
7356# Usage: cachemgr_passwd password action action ...
7357#
7358# Some valid actions are (see cache manager menu for a full list):
7359# 5min
7360# 60min
7361# asndb
7362# authenticator
7363# cbdata
7364# client_list
7365# comm_incoming
7366# config *
7367# counters
7368# delay
7369# digest_stats
7370# dns
7371# events
7372# filedescriptors
7373# fqdncache
7374# histograms
7375# http_headers
7376# info
7377# io
7378# ipcache
7379# mem
7380# menu
7381# netdb
7382# non_peers
7383# objects
7384# offline_toggle *
7385# pconn
7386# peer_select
7387# reconfigure *
7388# redirector
7389# refresh
7390# server_list
7391# shutdown *
7392# store_digest
7393# storedir
7394# utilization
7395# via_headers
7396# vm_objects
7397#
7398# * Indicates actions which will not be performed without a
7399# valid password, others can be performed if not listed here.
7400#
7401# To disable an action, set the password to "disable".
7402# To allow performing an action without a password, set the
7403# password to "none".
7404#
7405# Use the keyword "all" to set the same password for all actions.
7406#
7407#Example:
7408# cachemgr_passwd secret shutdown
7409# cachemgr_passwd lesssssssecret info stats/objects
7410# cachemgr_passwd disable all
7411#Default:
7412# No password. Actions which require password are denied.
7413
7414# TAG: client_db on|off
7415# If you want to disable collecting per-client statistics,
7416# turn off client_db here.
7417#Default:
7418# client_db on
7419
7420# TAG: refresh_all_ims on|off
7421# When you enable this option, squid will always check
7422# the origin server for an update when a client sends an
7423# If-Modified-Since request. Many browsers use IMS
7424# requests when the user requests a reload, and this
7425# ensures those clients receive the latest version.
7426#
7427# By default (off), squid may return a Not Modified response
7428# based on the age of the cached version.
7429#Default:
7430# refresh_all_ims off
7431
7432# TAG: reload_into_ims on|off
7433# When you enable this option, client no-cache or ``reload''
7434# requests will be changed to If-Modified-Since requests.
7435# Doing this VIOLATES the HTTP standard. Enabling this
7436# feature could make you liable for problems which it
7437# causes.
7438#
7439# see also refresh_pattern for a more selective approach.
7440#Default:
7441# reload_into_ims off
7442
7443# TAG: connect_retries
7444# This sets the maximum number of connection attempts made for each
7445# TCP connection. The connect_retries attempts must all still
7446# complete within the connection timeout period.
7447#
7448# The default is not to re-try if the first connection attempt fails.
7449# The (not recommended) maximum is 10 tries.
7450#
7451# A warning message will be generated if it is set to a too-high
7452# value and the configured value will be over-ridden.
7453#
7454# Note: These re-tries are in addition to forward_max_tries
7455# which limit how many different addresses may be tried to find
7456# a useful server.
7457#Default:
7458# Do not retry failed connections.
7459
7460# TAG: retry_on_error
7461# If set to ON Squid will automatically retry requests when
7462# receiving an error response with status 403 (Forbidden),
7463# 500 (Internal Error), 501 or 503 (Service not available).
7464# Status 502 and 504 (Gateway errors) are always retried.
7465#
7466# This is mainly useful if you are in a complex cache hierarchy to
7467# work around access control errors.
7468#
7469# NOTE: This retry will attempt to find another working destination.
7470# Which is different from the server which just failed.
7471#Default:
7472# retry_on_error off
7473
7474# TAG: as_whois_server
7475# WHOIS server to query for AS numbers. NOTE: AS numbers are
7476# queried only when Squid starts up, not for every request.
7477#Default:
7478# as_whois_server whois.ra.net
7479
7480# TAG: offline_mode
7481# Enable this option and Squid will never try to validate cached
7482# objects.
7483#Default:
7484# offline_mode off
7485
7486# TAG: uri_whitespace
7487# What to do with requests that have whitespace characters in the
7488# URI. Options:
7489#
7490# strip: The whitespace characters are stripped out of the URL.
7491# This is the behavior recommended by RFC2396 and RFC3986
7492# for tolerant handling of generic URI.
7493# NOTE: This is one difference between generic URI and HTTP URLs.
7494#
7495# deny: The request is denied. The user receives an "Invalid
7496# Request" message.
7497# This is the behaviour recommended by RFC2616 for safe
7498# handling of HTTP request URL.
7499#
7500# allow: The request is allowed and the URI is not changed. The
7501# whitespace characters remain in the URI. Note the
7502# whitespace is passed to redirector processes if they
7503# are in use.
7504# Note this may be considered a violation of RFC2616
7505# request parsing where whitespace is prohibited in the
7506# URL field.
7507#
7508# encode: The request is allowed and the whitespace characters are
7509# encoded according to RFC1738.
7510#
7511# chop: The request is allowed and the URI is chopped at the
7512# first whitespace.
7513#
7514#
7515# NOTE the current Squid implementation of encode and chop violates
7516# RFC2616 by not using a 301 redirect after altering the URL.
7517#Default:
7518# uri_whitespace strip
7519
7520# TAG: chroot
7521# Specifies a directory where Squid should do a chroot() while
7522# initializing. This also causes Squid to fully drop root
7523# privileges after initializing. This means, for example, if you
7524# use a HTTP port less than 1024 and try to reconfigure, you may
7525# get an error saying that Squid can not open the port.
7526#Default:
7527# none
7528
7529# TAG: balance_on_multiple_ip
7530# Modern IP resolvers in squid sort lookup results by preferred access.
7531# By default squid will use these IP in order and only rotates to
7532# the next listed when the most preffered fails.
7533#
7534# Some load balancing servers based on round robin DNS have been
7535# found not to preserve user session state across requests
7536# to different IP addresses.
7537#
7538# Enabling this directive Squid rotates IP's per request.
7539#Default:
7540# balance_on_multiple_ip off
7541
7542# TAG: pipeline_prefetch
7543# HTTP clients may send a pipeline of 1+N requests to Squid using a
7544# single connection, without waiting for Squid to respond to the first
7545# of those requests. This option limits the number of concurrent
7546# requests Squid will try to handle in parallel. If set to N, Squid
7547# will try to receive and process up to 1+N requests on the same
7548# connection concurrently.
7549#
7550# Defaults to 0 (off) for bandwidth management and access logging
7551# reasons.
7552#
7553# NOTE: pipelining requires persistent connections to clients.
7554#
7555# WARNING: pipelining breaks NTLM and Negotiate/Kerberos authentication.
7556#Default:
7557# Do not pre-parse pipelined requests.
7558
7559# TAG: high_response_time_warning (msec)
7560# If the one-minute median response time exceeds this value,
7561# Squid prints a WARNING with debug level 0 to get the
7562# administrators attention. The value is in milliseconds.
7563#Default:
7564# disabled.
7565
7566# TAG: high_page_fault_warning
7567# If the one-minute average page fault rate exceeds this
7568# value, Squid prints a WARNING with debug level 0 to get
7569# the administrators attention. The value is in page faults
7570# per second.
7571#Default:
7572# disabled.
7573
7574# TAG: high_memory_warning
7575# Note: This option is only available if Squid is rebuilt with the
7576# GNU Malloc with mstats()
7577#
7578# If the memory usage (as determined by mallinfo) exceeds
7579# this amount, Squid prints a WARNING with debug level 0 to get
7580# the administrators attention.
7581#Default:
7582# disabled.
7583
7584# TAG: sleep_after_fork (microseconds)
7585# When this is set to a non-zero value, the main Squid process
7586# sleeps the specified number of microseconds after a fork()
7587# system call. This sleep may help the situation where your
7588# system reports fork() failures due to lack of (virtual)
7589# memory. Note, however, if you have a lot of child
7590# processes, these sleep delays will add up and your
7591# Squid will not service requests for some amount of time
7592# until all the child processes have been started.
7593# On Windows value less then 1000 (1 milliseconds) are
7594# rounded to 1000.
7595#Default:
7596# sleep_after_fork 0
7597
7598# TAG: windows_ipaddrchangemonitor on|off
7599# Note: This option is only available if Squid is rebuilt with the
7600# MS Windows
7601#
7602# On Windows Squid by default will monitor IP address changes and will
7603# reconfigure itself after any detected event. This is very useful for
7604# proxies connected to internet with dial-up interfaces.
7605# In some cases (a Proxy server acting as VPN gateway is one) it could be
7606# desiderable to disable this behaviour setting this to 'off'.
7607# Note: after changing this, Squid service must be restarted.
7608#Default:
7609# windows_ipaddrchangemonitor on
7610
7611# TAG: eui_lookup
7612# Whether to lookup the EUI or MAC address of a connected client.
7613#Default:
7614# eui_lookup on
7615
7616# TAG: max_filedescriptors
7617# Reduce the maximum number of filedescriptors supported below
7618# the usual operating system defaults.
7619#
7620# Remove from squid.conf to inherit the current ulimit setting.
7621#
7622# Note: Changing this requires a restart of Squid. Also
7623# not all I/O types supports large values (eg on Windows).
7624#Default:
7625# Use operating system limits set by ulimit.
7626
7627# TAG: workers
7628# Number of main Squid processes or "workers" to fork and maintain.
7629# 0: "no daemon" mode, like running "squid -N ..."
7630# 1: "no SMP" mode, start one main Squid process daemon (default)
7631# N: start N main Squid process daemons (i.e., SMP mode)
7632#
7633# In SMP mode, each worker does nearly all what a single Squid daemon
7634# does (e.g., listen on http_port and forward HTTP requests).
7635#Default:
7636# SMP support disabled.
7637
7638# TAG: cpu_affinity_map
7639# Usage: cpu_affinity_map process_numbers=P1,P2,... cores=C1,C2,...
7640#
7641# Sets 1:1 mapping between Squid processes and CPU cores. For example,
7642#
7643# cpu_affinity_map process_numbers=1,2,3,4 cores=1,3,5,7
7644#
7645# affects processes 1 through 4 only and places them on the first
7646# four even cores, starting with core #1.
7647#
7648# CPU cores are numbered starting from 1. Requires support for
7649# sched_getaffinity(2) and sched_setaffinity(2) system calls.
7650#
7651# Multiple cpu_affinity_map options are merged.
7652#
7653# See also: workers
7654#Default:
7655# Let operating system decide.