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