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