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