]>
Commit | Line | Data |
---|---|---|
3a278cb8 | 1 | |
9cef6668 | 2 | # |
262a0e14 | 3 | # $Id$ |
9cef6668 | 4 | # |
6845f129 | 5 | # SQUID Web Proxy Cache http://www.squid-cache.org/ |
9cef6668 | 6 | # ---------------------------------------------------------- |
7 | # | |
2b6662ba | 8 | # Squid is the result of efforts by numerous individuals from |
9 | # the Internet community; see the CONTRIBUTORS file for full | |
10 | # details. Many organizations have provided support for Squid's | |
11 | # development; see the SPONSORS file for full details. Squid is | |
12 | # Copyrighted (C) 2000 by the Regents of the University of | |
13 | # California; see the COPYRIGHT file for full details. Squid | |
14 | # incorporates software developed and/or copyrighted by other | |
15 | # sources; see the CREDITS file for full details. | |
9cef6668 | 16 | # |
17 | # This program is free software; you can redistribute it and/or modify | |
18 | # it under the terms of the GNU General Public License as published by | |
19 | # the Free Software Foundation; either version 2 of the License, or | |
20 | # (at your option) any later version. | |
96d88dcb | 21 | # |
9cef6668 | 22 | # This program is distributed in the hope that it will be useful, |
23 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
24 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
25 | # GNU General Public License for more details. | |
96d88dcb | 26 | # |
9cef6668 | 27 | # You should have received a copy of the GNU General Public License |
28 | # along with this program; if not, write to the Free Software | |
29 | # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. | |
30 | # | |
31 | ||
0f74202c | 32 | COMMENT_START |
cccac0a2 | 33 | WELCOME TO SQUID @VERSION@ |
34 | ---------------------------- | |
3a278cb8 | 35 | |
cccac0a2 | 36 | This is the default Squid configuration file. You may wish |
37 | to look at the Squid home page (http://www.squid-cache.org/) | |
38 | for the FAQ and other documentation. | |
3a278cb8 | 39 | |
cccac0a2 | 40 | The default Squid config file shows what the defaults for |
41 | various options happen to be. If you don't need to change the | |
42 | default, you shouldn't uncomment the line. Doing so may cause | |
43 | run-time problems. In some cases "none" refers to no default | |
44 | setting at all, while in other cases it refers to a valid | |
45 | option - the comments for that keyword indicate if this is the | |
46 | case. | |
debd9a31 | 47 | |
cccac0a2 | 48 | COMMENT_END |
3a278cb8 | 49 | |
592a09dc | 50 | COMMENT_START |
51 | Configuration options can be included using the "include" directive. | |
52 | Include takes a list of files to include. Quoting and wildcards is | |
53 | supported. | |
54 | ||
55 | For example, | |
56 | ||
57 | include /path/to/included/file/squid.acl.config | |
58 | ||
59 | Includes can be nested up to a hard-coded depth of 16 levels. | |
60 | This arbitrary restriction is to prevent recursive include references | |
61 | from causing Squid entering an infinite loop whilst trying to load | |
62 | configuration files. | |
63 | COMMENT_END | |
64 | ||
5473c134 | 65 | COMMENT_START |
41bd17a4 | 66 | OPTIONS FOR AUTHENTICATION |
5473c134 | 67 | ----------------------------------------------------------------------------- |
68 | COMMENT_END | |
69 | ||
41bd17a4 | 70 | NAME: auth_param |
71 | TYPE: authparam | |
72 | LOC: Config.authConfiguration | |
cccac0a2 | 73 | DEFAULT: none |
74 | DOC_START | |
41bd17a4 | 75 | This is used to define parameters for the various authentication |
76 | schemes supported by Squid. | |
cccac0a2 | 77 | |
41bd17a4 | 78 | format: auth_param scheme parameter [setting] |
cccac0a2 | 79 | |
41bd17a4 | 80 | The order in which authentication schemes are presented to the client is |
81 | dependent on the order the scheme first appears in config file. IE | |
82 | has a bug (it's not RFC 2617 compliant) in that it will use the basic | |
83 | scheme if basic is the first entry presented, even if more secure | |
84 | schemes are presented. For now use the order in the recommended | |
85 | settings section below. If other browsers have difficulties (don't | |
86 | recognize the schemes offered even if you are using basic) either | |
87 | put basic first, or disable the other schemes (by commenting out their | |
88 | program entry). | |
cccac0a2 | 89 | |
41bd17a4 | 90 | Once an authentication scheme is fully configured, it can only be |
91 | shutdown by shutting squid down and restarting. Changes can be made on | |
92 | the fly and activated with a reconfigure. I.E. You can change to a | |
93 | different helper, but not unconfigure the helper completely. | |
cccac0a2 | 94 | |
41bd17a4 | 95 | Please note that while this directive defines how Squid processes |
96 | authentication it does not automatically activate authentication. | |
97 | To use authentication you must in addition make use of ACLs based | |
98 | on login name in http_access (proxy_auth, proxy_auth_regex or | |
99 | external with %LOGIN used in the format tag). The browser will be | |
100 | challenged for authentication on the first such acl encountered | |
101 | in http_access processing and will also be re-challenged for new | |
102 | login credentials if the request is being denied by a proxy_auth | |
103 | type acl. | |
cccac0a2 | 104 | |
41bd17a4 | 105 | WARNING: authentication can't be used in a transparently intercepting |
106 | proxy as the client then thinks it is talking to an origin server and | |
107 | not the proxy. This is a limitation of bending the TCP/IP protocol to | |
108 | transparently intercepting port 80, not a limitation in Squid. | |
13b5cd0c AJ |
109 | Ports flagged 'transparent', 'intercept', or 'tproxy' have authentication |
110 | disabled. | |
cccac0a2 | 111 | |
41bd17a4 | 112 | === Parameters for the basic scheme follow. === |
cccac0a2 | 113 | |
41bd17a4 | 114 | "program" cmdline |
115 | Specify the command for the external authenticator. Such a program | |
116 | reads a line containing "username password" and replies "OK" or | |
117 | "ERR" in an endless loop. "ERR" responses may optionally be followed | |
118 | by a error description available as %m in the returned error page. | |
119 | If you use an authenticator, make sure you have 1 acl of type proxy_auth. | |
cccac0a2 | 120 | |
41bd17a4 | 121 | By default, the basic authentication scheme is not used unless a |
122 | program is specified. | |
cccac0a2 | 123 | |
41bd17a4 | 124 | If you want to use the traditional NCSA proxy authentication, set |
125 | this line to something like | |
307b83b7 | 126 | |
41bd17a4 | 127 | auth_param basic program @DEFAULT_PREFIX@/libexec/ncsa_auth @DEFAULT_PREFIX@/etc/passwd |
9e7dbc51 | 128 | |
41bd17a4 | 129 | "children" numberofchildren |
130 | The number of authenticator processes to spawn. If you start too few | |
131 | Squid will have to wait for them to process a backlog of credential | |
132 | verifications, slowing it down. When password verifications are | |
133 | done via a (slow) network you are likely to need lots of | |
134 | authenticator processes. | |
135 | auth_param basic children 5 | |
9e7dbc51 | 136 | |
41bd17a4 | 137 | "concurrency" concurrency |
138 | The number of concurrent requests the helper can process. | |
139 | The default of 0 is used for helpers who only supports | |
140 | one request at a time. Setting this changes the protocol used to | |
141 | include a channel number first on the request/response line, allowing | |
142 | multiple requests to be sent to the same helper in parallell without | |
143 | wating for the response. | |
144 | Must not be set unless it's known the helper supports this. | |
145 | auth_param basic concurrency 0 | |
0fdafae7 | 146 | |
41bd17a4 | 147 | "realm" realmstring |
148 | Specifies the realm name which is to be reported to the | |
149 | client for the basic proxy authentication scheme (part of | |
150 | the text the user will see when prompted their username and | |
151 | password). There is no default. | |
152 | auth_param basic realm Squid proxy-caching web server | |
d1b63fc8 | 153 | |
41bd17a4 | 154 | "credentialsttl" timetolive |
155 | Specifies how long squid assumes an externally validated | |
156 | username:password pair is valid for - in other words how | |
157 | often the helper program is called for that user. Set this | |
158 | low to force revalidation with short lived passwords. Note | |
159 | setting this high does not impact your susceptibility | |
160 | to replay attacks unless you are using an one-time password | |
161 | system (such as SecureID). If you are using such a system, | |
162 | you will be vulnerable to replay attacks unless you also | |
163 | use the max_user_ip ACL in an http_access rule. | |
cccac0a2 | 164 | |
41bd17a4 | 165 | "casesensitive" on|off |
166 | Specifies if usernames are case sensitive. Most user databases are | |
167 | case insensitive allowing the same username to be spelled using both | |
168 | lower and upper case letters, but some are case sensitive. This | |
169 | makes a big difference for user_max_ip ACL processing and similar. | |
170 | auth_param basic casesensitive off | |
cccac0a2 | 171 | |
41bd17a4 | 172 | === Parameters for the digest scheme follow === |
cccac0a2 | 173 | |
41bd17a4 | 174 | "program" cmdline |
175 | Specify the command for the external authenticator. Such | |
176 | a program reads a line containing "username":"realm" and | |
177 | replies with the appropriate H(A1) value hex encoded or | |
178 | ERR if the user (or his H(A1) hash) does not exists. | |
179 | See rfc 2616 for the definition of H(A1). | |
180 | "ERR" responses may optionally be followed by a error description | |
181 | available as %m in the returned error page. | |
cccac0a2 | 182 | |
41bd17a4 | 183 | By default, the digest authentication scheme is not used unless a |
184 | program is specified. | |
b8c0c06d | 185 | |
41bd17a4 | 186 | If you want to use a digest authenticator, set this line to |
187 | something like | |
cccac0a2 | 188 | |
41bd17a4 | 189 | auth_param digest program @DEFAULT_PREFIX@/bin/digest_auth_pw @DEFAULT_PREFIX@/etc/digpass |
cccac0a2 | 190 | |
41bd17a4 | 191 | "children" numberofchildren |
192 | The number of authenticator processes to spawn (no default). | |
193 | If you start too few Squid will have to wait for them to | |
194 | process a backlog of H(A1) calculations, slowing it down. | |
195 | When the H(A1) calculations are done via a (slow) network | |
196 | you are likely to need lots of authenticator processes. | |
197 | auth_param digest children 5 | |
cccac0a2 | 198 | |
41bd17a4 | 199 | "realm" realmstring |
200 | Specifies the realm name which is to be reported to the | |
201 | client for the digest proxy authentication scheme (part of | |
202 | the text the user will see when prompted their username and | |
203 | password). There is no default. | |
204 | auth_param digest realm Squid proxy-caching web server | |
cccac0a2 | 205 | |
41bd17a4 | 206 | "nonce_garbage_interval" timeinterval |
207 | Specifies the interval that nonces that have been issued | |
208 | to client_agent's are checked for validity. | |
cccac0a2 | 209 | |
41bd17a4 | 210 | "nonce_max_duration" timeinterval |
211 | Specifies the maximum length of time a given nonce will be | |
212 | valid for. | |
cccac0a2 | 213 | |
41bd17a4 | 214 | "nonce_max_count" number |
215 | Specifies the maximum number of times a given nonce can be | |
216 | used. | |
cccac0a2 | 217 | |
41bd17a4 | 218 | "nonce_strictness" on|off |
219 | Determines if squid requires strict increment-by-1 behavior | |
220 | for nonce counts, or just incrementing (off - for use when | |
221 | useragents generate nonce counts that occasionally miss 1 | |
222 | (ie, 1,2,4,6)). Default off. | |
cccac0a2 | 223 | |
41bd17a4 | 224 | "check_nonce_count" on|off |
225 | This directive if set to off can disable the nonce count check | |
226 | completely to work around buggy digest qop implementations in | |
227 | certain mainstream browser versions. Default on to check the | |
228 | nonce count to protect from authentication replay attacks. | |
cccac0a2 | 229 | |
41bd17a4 | 230 | "post_workaround" on|off |
231 | This is a workaround to certain buggy browsers who sends | |
232 | an incorrect request digest in POST requests when reusing | |
233 | the same nonce as acquired earlier on a GET request. | |
cccac0a2 | 234 | |
41bd17a4 | 235 | === NTLM scheme options follow === |
cccac0a2 | 236 | |
41bd17a4 | 237 | "program" cmdline |
238 | Specify the command for the external NTLM authenticator. | |
239 | Such a program reads exchanged NTLMSSP packets with | |
240 | the browser via Squid until authentication is completed. | |
241 | If you use an NTLM authenticator, make sure you have 1 acl | |
242 | of type proxy_auth. By default, the NTLM authenticator_program | |
243 | is not used. | |
cccac0a2 | 244 | |
41bd17a4 | 245 | auth_param ntlm program @DEFAULT_PREFIX@/bin/ntlm_auth |
cccac0a2 | 246 | |
41bd17a4 | 247 | "children" numberofchildren |
248 | The number of authenticator processes to spawn (no default). | |
249 | If you start too few Squid will have to wait for them to | |
250 | process a backlog of credential verifications, slowing it | |
251 | down. When credential verifications are done via a (slow) | |
252 | network you are likely to need lots of authenticator | |
253 | processes. | |
cccac0a2 | 254 | |
41bd17a4 | 255 | auth_param ntlm children 5 |
cccac0a2 | 256 | |
41bd17a4 | 257 | "keep_alive" on|off |
258 | If you experience problems with PUT/POST requests when using the | |
259 | Negotiate authentication scheme then you can try setting this to | |
260 | off. This will cause Squid to forcibly close the connection on | |
261 | the initial requests where the browser asks which schemes are | |
262 | supported by the proxy. | |
cccac0a2 | 263 | |
41bd17a4 | 264 | auth_param ntlm keep_alive on |
cccac0a2 | 265 | |
41bd17a4 | 266 | === Options for configuring the NEGOTIATE auth-scheme follow === |
cccac0a2 | 267 | |
41bd17a4 | 268 | "program" cmdline |
269 | Specify the command for the external Negotiate authenticator. | |
270 | This protocol is used in Microsoft Active-Directory enabled setups with | |
271 | the Microsoft Internet Explorer or Mozilla Firefox browsers. | |
272 | Its main purpose is to exchange credentials with the Squid proxy | |
273 | using the Kerberos mechanisms. | |
274 | If you use a Negotiate authenticator, make sure you have at least one acl | |
275 | of type proxy_auth active. By default, the negotiate authenticator_program | |
276 | is not used. | |
277 | The only supported program for this role is the ntlm_auth | |
278 | program distributed as part of Samba, version 4 or later. | |
cccac0a2 | 279 | |
41bd17a4 | 280 | auth_param negotiate program @DEFAULT_PREFIX@/bin/ntlm_auth --helper-protocol=gss-spnego |
cccac0a2 | 281 | |
41bd17a4 | 282 | "children" numberofchildren |
283 | The number of authenticator processes to spawn (no default). | |
284 | If you start too few Squid will have to wait for them to | |
285 | process a backlog of credential verifications, slowing it | |
286 | down. When crendential verifications are done via a (slow) | |
287 | network you are likely to need lots of authenticator | |
288 | processes. | |
289 | auth_param negotiate children 5 | |
d3803853 | 290 | |
41bd17a4 | 291 | "keep_alive" on|off |
292 | If you experience problems with PUT/POST requests when using the | |
293 | Negotiate authentication scheme then you can try setting this to | |
294 | off. This will cause Squid to forcibly close the connection on | |
295 | the initial requests where the browser asks which schemes are | |
296 | supported by the proxy. | |
527ee50d | 297 | |
41bd17a4 | 298 | auth_param negotiate keep_alive on |
cccac0a2 | 299 | |
41bd17a4 | 300 | NOCOMMENT_START |
301 | #Recommended minimum configuration per scheme: | |
302 | #auth_param negotiate program <uncomment and complete this line to activate> | |
303 | #auth_param negotiate children 5 | |
304 | #auth_param negotiate keep_alive on | |
305 | #auth_param ntlm program <uncomment and complete this line to activate> | |
306 | #auth_param ntlm children 5 | |
307 | #auth_param ntlm keep_alive on | |
308 | #auth_param digest program <uncomment and complete this line> | |
309 | #auth_param digest children 5 | |
310 | #auth_param digest realm Squid proxy-caching web server | |
311 | #auth_param digest nonce_garbage_interval 5 minutes | |
312 | #auth_param digest nonce_max_duration 30 minutes | |
313 | #auth_param digest nonce_max_count 50 | |
314 | #auth_param basic program <uncomment and complete this line> | |
315 | #auth_param basic children 5 | |
316 | #auth_param basic realm Squid proxy-caching web server | |
317 | #auth_param basic credentialsttl 2 hours | |
318 | NOCOMMENT_END | |
319 | DOC_END | |
cccac0a2 | 320 | |
41bd17a4 | 321 | NAME: authenticate_cache_garbage_interval |
322 | TYPE: time_t | |
323 | DEFAULT: 1 hour | |
324 | LOC: Config.authenticateGCInterval | |
325 | DOC_START | |
326 | The time period between garbage collection across the username cache. | |
327 | This is a tradeoff between memory utilization (long intervals - say | |
328 | 2 days) and CPU (short intervals - say 1 minute). Only change if you | |
329 | have good reason to. | |
330 | DOC_END | |
cccac0a2 | 331 | |
41bd17a4 | 332 | NAME: authenticate_ttl |
333 | TYPE: time_t | |
334 | DEFAULT: 1 hour | |
335 | LOC: Config.authenticateTTL | |
336 | DOC_START | |
337 | The time a user & their credentials stay in the logged in | |
338 | user cache since their last request. When the garbage | |
339 | interval passes, all user credentials that have passed their | |
340 | TTL are removed from memory. | |
341 | DOC_END | |
cccac0a2 | 342 | |
41bd17a4 | 343 | NAME: authenticate_ip_ttl |
344 | TYPE: time_t | |
345 | LOC: Config.authenticateIpTTL | |
346 | DEFAULT: 0 seconds | |
347 | DOC_START | |
348 | If you use proxy authentication and the 'max_user_ip' ACL, | |
349 | this directive controls how long Squid remembers the IP | |
350 | addresses associated with each user. Use a small value | |
351 | (e.g., 60 seconds) if your users might change addresses | |
352 | quickly, as is the case with dialups. You might be safe | |
353 | using a larger value (e.g., 2 hours) in a corporate LAN | |
354 | environment with relatively static address assignments. | |
355 | DOC_END | |
cccac0a2 | 356 | |
3d1e3e43 | 357 | COMMENT_START |
358 | ACCESS CONTROLS | |
359 | ----------------------------------------------------------------------------- | |
360 | COMMENT_END | |
361 | ||
41bd17a4 | 362 | NAME: external_acl_type |
363 | TYPE: externalAclHelper | |
364 | LOC: Config.externalAclHelperList | |
cccac0a2 | 365 | DEFAULT: none |
cccac0a2 | 366 | DOC_START |
41bd17a4 | 367 | This option defines external acl classes using a helper program |
368 | to look up the status | |
cccac0a2 | 369 | |
41bd17a4 | 370 | external_acl_type name [options] FORMAT.. /path/to/helper [helper arguments..] |
cccac0a2 | 371 | |
41bd17a4 | 372 | Options: |
cccac0a2 | 373 | |
41bd17a4 | 374 | ttl=n TTL in seconds for cached results (defaults to 3600 |
375 | for 1 hour) | |
376 | negative_ttl=n | |
377 | TTL for cached negative lookups (default same | |
378 | as ttl) | |
379 | children=n Number of acl helper processes spawn to service | |
380 | external acl lookups of this type. (default 5) | |
381 | concurrency=n concurrency level per process. Only used with helpers | |
382 | capable of processing more than one query at a time. | |
383 | cache=n result cache size, 0 is unbounded (default) | |
384 | grace=n Percentage remaining of TTL where a refresh of a | |
385 | cached entry should be initiated without needing to | |
386 | wait for a new reply. (default 0 for no grace period) | |
387 | protocol=2.5 Compatibility mode for Squid-2.5 external acl helpers | |
cc192b50 | 388 | ipv4 / ipv6 IP-mode used to communicate to this helper. |
389 | For compatability with older configurations and helpers | |
390 | 'ipv4' is the default unless --with-localhost-ipv6 is used. | |
391 | --with-localhost-ipv6 changes the default to 'ipv6'. | |
392 | SPECIAL NOTE: these options override --with-localhost-ipv6 | |
cccac0a2 | 393 | |
41bd17a4 | 394 | FORMAT specifications |
cccac0a2 | 395 | |
41bd17a4 | 396 | %LOGIN Authenticated user login name |
397 | %EXT_USER Username from external acl | |
398 | %IDENT Ident user name | |
399 | %SRC Client IP | |
400 | %SRCPORT Client source port | |
401 | %URI Requested URI | |
402 | %DST Requested host | |
403 | %PROTO Requested protocol | |
404 | %PORT Requested port | |
405 | %PATH Requested URL path | |
406 | %METHOD Request method | |
407 | %MYADDR Squid interface address | |
408 | %MYPORT Squid http_port number | |
409 | %PATH Requested URL-path (including query-string if any) | |
410 | %USER_CERT SSL User certificate in PEM format | |
411 | %USER_CERTCHAIN SSL User certificate chain in PEM format | |
412 | %USER_CERT_xx SSL User certificate subject attribute xx | |
413 | %USER_CA_xx SSL User certificate issuer attribute xx | |
7b0ca1e8 | 414 | |
c68c9682 | 415 | %>{Header} HTTP request header "Header" |
7b0ca1e8 | 416 | %>{Hdr:member} |
c68c9682 | 417 | HTTP request header "Hdr" list member "member" |
7b0ca1e8 | 418 | %>{Hdr:;member} |
41bd17a4 | 419 | HTTP request header list member using ; as |
420 | list separator. ; can be any non-alphanumeric | |
421 | character. | |
cccac0a2 | 422 | |
c68c9682 | 423 | %<{Header} HTTP reply header "Header" |
7b0ca1e8 | 424 | %<{Hdr:member} |
c68c9682 | 425 | HTTP reply header "Hdr" list member "member" |
7b0ca1e8 AJ |
426 | %<{Hdr:;member} |
427 | HTTP reply header list member using ; as | |
428 | list separator. ; can be any non-alphanumeric | |
429 | character. | |
430 | ||
41bd17a4 | 431 | In addition to the above, any string specified in the referencing |
432 | acl will also be included in the helper request line, after the | |
433 | specified formats (see the "acl external" directive) | |
cccac0a2 | 434 | |
41bd17a4 | 435 | The helper receives lines per the above format specification, |
436 | and returns lines starting with OK or ERR indicating the validity | |
437 | of the request and optionally followed by additional keywords with | |
438 | more details. | |
cccac0a2 | 439 | |
41bd17a4 | 440 | General result syntax: |
cccac0a2 | 441 | |
41bd17a4 | 442 | OK/ERR keyword=value ... |
cccac0a2 | 443 | |
41bd17a4 | 444 | Defined keywords: |
cccac0a2 | 445 | |
41bd17a4 | 446 | user= The users name (login) |
447 | password= The users password (for login= cache_peer option) | |
448 | message= Message describing the reason. Available as %o | |
449 | in error pages | |
450 | tag= Apply a tag to a request (for both ERR and OK results) | |
451 | Only sets a tag, does not alter existing tags. | |
452 | log= String to be logged in access.log. Available as | |
453 | %ea in logformat specifications | |
934b03fc | 454 | |
41bd17a4 | 455 | If protocol=3.0 (the default) then URL escaping is used to protect |
456 | each value in both requests and responses. | |
6a566b9c | 457 | |
41bd17a4 | 458 | If using protocol=2.5 then all values need to be enclosed in quotes |
459 | if they may contain whitespace, or the whitespace escaped using \. | |
460 | And quotes or \ characters within the keyword value must be \ escaped. | |
1e5562e3 | 461 | |
41bd17a4 | 462 | When using the concurrency= option the protocol is changed by |
463 | introducing a query channel tag infront of the request/response. | |
464 | The query channel tag is a number between 0 and concurrency-1. | |
cccac0a2 | 465 | DOC_END |
466 | ||
41bd17a4 | 467 | NAME: acl |
468 | TYPE: acl | |
469 | LOC: Config.aclList | |
1f5bd0a4 | 470 | DEFAULT: all src all |
cccac0a2 | 471 | DOC_START |
41bd17a4 | 472 | Defining an Access List |
cccac0a2 | 473 | |
375eeb3b AJ |
474 | Every access list definition must begin with an aclname and acltype, |
475 | followed by either type-specific arguments or a quoted filename that | |
476 | they are read from. | |
cccac0a2 | 477 | |
375eeb3b AJ |
478 | acl aclname acltype argument ... |
479 | acl aclname acltype "file" ... | |
cccac0a2 | 480 | |
375eeb3b | 481 | When using "file", the file should contain one item per line. |
cccac0a2 | 482 | |
41bd17a4 | 483 | By default, regular expressions are CASE-SENSITIVE. To make |
484 | them case-insensitive, use the -i option. | |
cccac0a2 | 485 | |
e988aa40 AJ |
486 | |
487 | ***** ACL TYPES AVAILABLE ***** | |
488 | ||
375eeb3b AJ |
489 | acl aclname src ip-address/netmask ... # clients IP address |
490 | acl aclname src addr1-addr2/netmask ... # range of addresses | |
491 | acl aclname dst ip-address/netmask ... # URL host's IP address | |
492 | acl aclname myip ip-address/netmask ... # local socket IP address | |
cccac0a2 | 493 | |
41bd17a4 | 494 | acl aclname arp mac-address ... (xx:xx:xx:xx:xx:xx notation) |
495 | # The arp ACL requires the special configure option --enable-arp-acl. | |
496 | # Furthermore, the ARP ACL code is not portable to all operating systems. | |
497 | # It works on Linux, Solaris, Windows, FreeBSD, and some other *BSD variants. | |
498 | # | |
499 | # NOTE: Squid can only determine the MAC address for clients that are on | |
500 | # the same subnet. If the client is on a different subnet, then Squid cannot | |
501 | # find out its MAC address. | |
934b03fc | 502 | |
375eeb3b AJ |
503 | acl aclname srcdomain .foo.com ... # reverse lookup, from client IP |
504 | acl aclname dstdomain .foo.com ... # Destination server from URL | |
505 | acl aclname srcdom_regex [-i] \.foo\.com ... # regex matching client name | |
506 | acl aclname dstdom_regex [-i] \.foo\.com ... # regex matching server | |
41bd17a4 | 507 | # For dstdomain and dstdom_regex a reverse lookup is tried if a IP |
508 | # based URL is used and no match is found. The name "none" is used | |
509 | # if the reverse lookup fails. | |
9bc73deb | 510 | |
375eeb3b AJ |
511 | acl aclname src_as number ... |
512 | acl aclname dst_as number ... | |
e988aa40 AJ |
513 | # Except for access control, AS numbers can be used for |
514 | # routing of requests to specific caches. Here's an | |
515 | # example for routing all requests for AS#1241 and only | |
516 | # those to mycache.mydomain.net: | |
517 | # acl asexample dst_as 1241 | |
518 | # cache_peer_access mycache.mydomain.net allow asexample | |
519 | # cache_peer_access mycache_mydomain.net deny all | |
7f7db318 | 520 | |
6db78a1a AJ |
521 | acl aclname peername myPeer ... |
522 | # match against a named cache_peer entry | |
523 | # set unique name= on cache_peer lines for reliable use. | |
524 | ||
375eeb3b AJ |
525 | acl aclname time [day-abbrevs] [h1:m1-h2:m2] |
526 | # day-abbrevs: | |
527 | # S - Sunday | |
528 | # M - Monday | |
529 | # T - Tuesday | |
530 | # W - Wednesday | |
531 | # H - Thursday | |
532 | # F - Friday | |
533 | # A - Saturday | |
534 | # h1:m1 must be less than h2:m2 | |
535 | ||
536 | acl aclname url_regex [-i] ^http:// ... # regex matching on whole URL | |
41bd17a4 | 537 | acl aclname urlpath_regex [-i] \.gif$ ... # regex matching on URL path |
e988aa40 | 538 | |
375eeb3b AJ |
539 | acl aclname port 80 70 21 ... |
540 | acl aclname port 0-1024 ... # ranges allowed | |
541 | acl aclname myport 3128 ... # (local socket TCP port) | |
197f6b3c | 542 | acl aclname myportname 3128 ... # http(s)_port name |
e988aa40 | 543 | |
375eeb3b | 544 | acl aclname proto HTTP FTP ... |
e988aa40 | 545 | |
375eeb3b | 546 | acl aclname method GET POST ... |
e988aa40 AJ |
547 | |
548 | acl aclname http_status 200 301 500- 400-403 ... # status code in reply | |
549 | ||
375eeb3b | 550 | acl aclname browser [-i] regexp ... |
41bd17a4 | 551 | # pattern match on User-Agent header (see also req_header below) |
e988aa40 | 552 | |
375eeb3b | 553 | acl aclname referer_regex [-i] regexp ... |
41bd17a4 | 554 | # pattern match on Referer header |
555 | # Referer is highly unreliable, so use with care | |
e988aa40 | 556 | |
375eeb3b | 557 | acl aclname ident username ... |
41bd17a4 | 558 | acl aclname ident_regex [-i] pattern ... |
559 | # string match on ident output. | |
560 | # use REQUIRED to accept any non-null ident. | |
cf5cc17e | 561 | |
41bd17a4 | 562 | acl aclname proxy_auth [-i] username ... |
563 | acl aclname proxy_auth_regex [-i] pattern ... | |
564 | # list of valid usernames | |
565 | # use REQUIRED to accept any valid username. | |
566 | # | |
567 | # NOTE: when a Proxy-Authentication header is sent but it is not | |
568 | # needed during ACL checking the username is NOT logged | |
569 | # in access.log. | |
570 | # | |
571 | # NOTE: proxy_auth requires a EXTERNAL authentication program | |
572 | # to check username/password combinations (see | |
573 | # auth_param directive). | |
574 | # | |
e988aa40 AJ |
575 | # NOTE: proxy_auth can't be used in a transparent/intercepting proxy |
576 | # as the browser needs to be configured for using a proxy in order | |
41bd17a4 | 577 | # to respond to proxy authentication. |
8e8d4f30 | 578 | |
41bd17a4 | 579 | acl aclname snmp_community string ... |
580 | # A community string to limit access to your SNMP Agent | |
581 | # Example: | |
582 | # | |
583 | # acl snmppublic snmp_community public | |
934b03fc | 584 | |
41bd17a4 | 585 | acl aclname maxconn number |
586 | # This will be matched when the client's IP address has | |
587 | # more than <number> HTTP connections established. | |
1e5562e3 | 588 | |
41bd17a4 | 589 | acl aclname max_user_ip [-s] number |
590 | # This will be matched when the user attempts to log in from more | |
591 | # than <number> different ip addresses. The authenticate_ip_ttl | |
592 | # parameter controls the timeout on the ip entries. | |
593 | # If -s is specified the limit is strict, denying browsing | |
594 | # from any further IP addresses until the ttl has expired. Without | |
595 | # -s Squid will just annoy the user by "randomly" denying requests. | |
596 | # (the counter is reset each time the limit is reached and a | |
597 | # request is denied) | |
598 | # NOTE: in acceleration mode or where there is mesh of child proxies, | |
599 | # clients may appear to come from multiple addresses if they are | |
600 | # going through proxy farms, so a limit of 1 may cause user problems. | |
cccac0a2 | 601 | |
375eeb3b | 602 | acl aclname req_mime_type [-i] mime-type ... |
41bd17a4 | 603 | # regex match against the mime type of the request generated |
604 | # by the client. Can be used to detect file upload or some | |
605 | # types HTTP tunneling requests. | |
606 | # NOTE: This does NOT match the reply. You cannot use this | |
607 | # to match the returned file type. | |
cccac0a2 | 608 | |
41bd17a4 | 609 | acl aclname req_header header-name [-i] any\.regex\.here |
610 | # regex match against any of the known request headers. May be | |
611 | # thought of as a superset of "browser", "referer" and "mime-type" | |
612 | # ACLs. | |
cccac0a2 | 613 | |
375eeb3b | 614 | acl aclname rep_mime_type [-i] mime-type ... |
41bd17a4 | 615 | # regex match against the mime type of the reply received by |
616 | # squid. Can be used to detect file download or some | |
617 | # types HTTP tunneling requests. | |
618 | # NOTE: This has no effect in http_access rules. It only has | |
619 | # effect in rules that affect the reply data stream such as | |
620 | # http_reply_access. | |
cccac0a2 | 621 | |
41bd17a4 | 622 | acl aclname rep_header header-name [-i] any\.regex\.here |
623 | # regex match against any of the known reply headers. May be | |
624 | # thought of as a superset of "browser", "referer" and "mime-type" | |
625 | # ACLs. | |
cccac0a2 | 626 | |
375eeb3b | 627 | acl aclname external class_name [arguments...] |
41bd17a4 | 628 | # external ACL lookup via a helper class defined by the |
629 | # external_acl_type directive. | |
cccac0a2 | 630 | |
41bd17a4 | 631 | acl aclname user_cert attribute values... |
632 | # match against attributes in a user SSL certificate | |
633 | # attribute is one of DN/C/O/CN/L/ST | |
cccac0a2 | 634 | |
41bd17a4 | 635 | acl aclname ca_cert attribute values... |
636 | # match against attributes a users issuing CA SSL certificate | |
637 | # attribute is one of DN/C/O/CN/L/ST | |
cccac0a2 | 638 | |
41bd17a4 | 639 | acl aclname ext_user username ... |
640 | acl aclname ext_user_regex [-i] pattern ... | |
641 | # string match on username returned by external acl helper | |
642 | # use REQUIRED to accept any non-null user name. | |
cccac0a2 | 643 | |
41bd17a4 | 644 | Examples: |
645 | acl macaddress arp 09:00:2b:23:45:67 | |
646 | acl myexample dst_as 1241 | |
647 | acl password proxy_auth REQUIRED | |
648 | acl fileupload req_mime_type -i ^multipart/form-data$ | |
649 | acl javascript rep_mime_type -i ^application/x-javascript$ | |
cccac0a2 | 650 | |
41bd17a4 | 651 | NOCOMMENT_START |
652 | #Recommended minimum configuration: | |
41bd17a4 | 653 | acl manager proto cache_object |
ee776778 | 654 | acl localhost src 127.0.0.1/32 |
41bd17a4 | 655 | acl to_localhost dst 127.0.0.0/8 |
ee776778 | 656 | # |
657 | # Example rule allowing access from your local networks. | |
658 | # Adapt to list your (internal) IP networks from where browsing | |
659 | # should be allowed | |
660 | acl localnet src 10.0.0.0/8 # RFC1918 possible internal network | |
661 | acl localnet src 172.16.0.0/12 # RFC1918 possible internal network | |
662 | acl localnet src 192.168.0.0/16 # RFC1918 possible internal network | |
663 | # | |
41bd17a4 | 664 | acl SSL_ports port 443 |
665 | acl Safe_ports port 80 # http | |
666 | acl Safe_ports port 21 # ftp | |
667 | acl Safe_ports port 443 # https | |
668 | acl Safe_ports port 70 # gopher | |
669 | acl Safe_ports port 210 # wais | |
670 | acl Safe_ports port 1025-65535 # unregistered ports | |
671 | acl Safe_ports port 280 # http-mgmt | |
672 | acl Safe_ports port 488 # gss-http | |
673 | acl Safe_ports port 591 # filemaker | |
674 | acl Safe_ports port 777 # multiling http | |
675 | acl CONNECT method CONNECT | |
676 | NOCOMMENT_END | |
677 | DOC_END | |
cccac0a2 | 678 | |
3d674977 AJ |
679 | NAME: follow_x_forwarded_for |
680 | TYPE: acl_access | |
681 | IFDEF: FOLLOW_X_FORWARDED_FOR | |
682 | LOC: Config.accessList.followXFF | |
683 | DEFAULT: none | |
684 | DEFAULT_IF_NONE: deny all | |
685 | DOC_START | |
686 | Allowing or Denying the X-Forwarded-For header to be followed to | |
687 | find the original source of a request. | |
688 | ||
689 | Requests may pass through a chain of several other proxies | |
690 | before reaching us. The X-Forwarded-For header will contain a | |
691 | comma-separated list of the IP addresses in the chain, with the | |
692 | rightmost address being the most recent. | |
693 | ||
694 | If a request reaches us from a source that is allowed by this | |
695 | configuration item, then we consult the X-Forwarded-For header | |
696 | to see where that host received the request from. If the | |
697 | X-Forwarded-For header contains multiple addresses, and if | |
698 | acl_uses_indirect_client is on, then we continue backtracking | |
699 | until we reach an address for which we are not allowed to | |
700 | follow the X-Forwarded-For header, or until we reach the first | |
701 | address in the list. (If acl_uses_indirect_client is off, then | |
702 | it's impossible to backtrack through more than one level of | |
703 | X-Forwarded-For addresses.) | |
704 | ||
705 | The end result of this process is an IP address that we will | |
706 | refer to as the indirect client address. This address may | |
707 | be treated as the client address for access control, delay | |
708 | pools and logging, depending on the acl_uses_indirect_client, | |
709 | delay_pool_uses_indirect_client and log_uses_indirect_client | |
710 | options. | |
711 | ||
712 | SECURITY CONSIDERATIONS: | |
713 | ||
714 | Any host for which we follow the X-Forwarded-For header | |
715 | can place incorrect information in the header, and Squid | |
716 | will use the incorrect information as if it were the | |
717 | source address of the request. This may enable remote | |
718 | hosts to bypass any access control restrictions that are | |
719 | based on the client's source addresses. | |
720 | ||
721 | For example: | |
722 | ||
723 | acl localhost src 127.0.0.1 | |
724 | acl my_other_proxy srcdomain .proxy.example.com | |
725 | follow_x_forwarded_for allow localhost | |
726 | follow_x_forwarded_for allow my_other_proxy | |
727 | DOC_END | |
728 | ||
729 | NAME: acl_uses_indirect_client | |
730 | COMMENT: on|off | |
731 | TYPE: onoff | |
732 | IFDEF: FOLLOW_X_FORWARDED_FOR | |
733 | DEFAULT: on | |
734 | LOC: Config.onoff.acl_uses_indirect_client | |
735 | DOC_START | |
736 | Controls whether the indirect client address | |
737 | (see follow_x_forwarded_for) is used instead of the | |
738 | direct client address in acl matching. | |
739 | DOC_END | |
740 | ||
741 | NAME: delay_pool_uses_indirect_client | |
742 | COMMENT: on|off | |
743 | TYPE: onoff | |
97a616ca | 744 | IFDEF: FOLLOW_X_FORWARDED_FOR DELAY_POOLS |
3d674977 AJ |
745 | DEFAULT: on |
746 | LOC: Config.onoff.delay_pool_uses_indirect_client | |
747 | DOC_START | |
748 | Controls whether the indirect client address | |
749 | (see follow_x_forwarded_for) is used instead of the | |
750 | direct client address in delay pools. | |
751 | DOC_END | |
752 | ||
753 | NAME: log_uses_indirect_client | |
754 | COMMENT: on|off | |
755 | TYPE: onoff | |
756 | IFDEF: FOLLOW_X_FORWARDED_FOR | |
757 | DEFAULT: on | |
758 | LOC: Config.onoff.log_uses_indirect_client | |
759 | DOC_START | |
760 | Controls whether the indirect client address | |
761 | (see follow_x_forwarded_for) is used instead of the | |
762 | direct client address in the access log. | |
763 | DOC_END | |
764 | ||
41bd17a4 | 765 | NAME: http_access |
766 | TYPE: acl_access | |
767 | LOC: Config.accessList.http | |
768 | DEFAULT: none | |
769 | DEFAULT_IF_NONE: deny all | |
770 | DOC_START | |
771 | Allowing or Denying access based on defined access lists | |
cccac0a2 | 772 | |
41bd17a4 | 773 | Access to the HTTP port: |
774 | http_access allow|deny [!]aclname ... | |
cccac0a2 | 775 | |
41bd17a4 | 776 | NOTE on default values: |
cccac0a2 | 777 | |
41bd17a4 | 778 | If there are no "access" lines present, the default is to deny |
779 | the request. | |
cccac0a2 | 780 | |
41bd17a4 | 781 | If none of the "access" lines cause a match, the default is the |
782 | opposite of the last line in the list. If the last line was | |
783 | deny, the default is allow. Conversely, if the last line | |
784 | is allow, the default will be deny. For these reasons, it is a | |
785 | good idea to have an "deny all" or "allow all" entry at the end | |
786 | of your access lists to avoid potential confusion. | |
cccac0a2 | 787 | |
41bd17a4 | 788 | NOCOMMENT_START |
789 | #Recommended minimum configuration: | |
790 | # | |
791 | # Only allow cachemgr access from localhost | |
792 | http_access allow manager localhost | |
793 | http_access deny manager | |
794 | # Deny requests to unknown ports | |
795 | http_access deny !Safe_ports | |
796 | # Deny CONNECT to other than SSL ports | |
797 | http_access deny CONNECT !SSL_ports | |
798 | # | |
799 | # We strongly recommend the following be uncommented to protect innocent | |
800 | # web applications running on the proxy server who think the only | |
801 | # one who can access services on "localhost" is a local user | |
802 | #http_access deny to_localhost | |
803 | # | |
804 | # INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS | |
c8f4eac4 | 805 | |
ee776778 | 806 | # Example rule allowing access from your local networks. |
807 | # Adapt localnet in the ACL section to list your (internal) IP networks | |
808 | # from where browsing should be allowed | |
809 | http_access allow localnet | |
7d90757b | 810 | |
41bd17a4 | 811 | # And finally deny all other access to this proxy |
812 | http_access deny all | |
813 | NOCOMMENT_END | |
814 | DOC_END | |
7d90757b | 815 | |
41bd17a4 | 816 | NAME: http_reply_access |
817 | TYPE: acl_access | |
818 | LOC: Config.accessList.reply | |
819 | DEFAULT: none | |
820 | DOC_START | |
821 | Allow replies to client requests. This is complementary to http_access. | |
cccac0a2 | 822 | |
41bd17a4 | 823 | http_reply_access allow|deny [!] aclname ... |
cccac0a2 | 824 | |
41bd17a4 | 825 | NOTE: if there are no access lines present, the default is to allow |
826 | all replies | |
1a224843 | 827 | |
41bd17a4 | 828 | If none of the access lines cause a match the opposite of the |
829 | last line will apply. Thus it is good practice to end the rules | |
830 | with an "allow all" or "deny all" entry. | |
cccac0a2 | 831 | DOC_END |
832 | ||
41bd17a4 | 833 | NAME: icp_access |
834 | TYPE: acl_access | |
835 | LOC: Config.accessList.icp | |
836 | DEFAULT: none | |
837 | DEFAULT_IF_NONE: deny all | |
5473c134 | 838 | DOC_START |
41bd17a4 | 839 | Allowing or Denying access to the ICP port based on defined |
840 | access lists | |
5473c134 | 841 | |
41bd17a4 | 842 | icp_access allow|deny [!]aclname ... |
5473c134 | 843 | |
41bd17a4 | 844 | See http_access for details |
845 | ||
846 | NOCOMMENT_START | |
ee776778 | 847 | #Allow ICP queries from local networks only |
df2eec10 AJ |
848 | #icp_access allow localnet |
849 | #icp_access deny all | |
41bd17a4 | 850 | NOCOMMENT_END |
5473c134 | 851 | DOC_END |
852 | ||
41bd17a4 | 853 | NAME: htcp_access |
854 | IFDEF: USE_HTCP | |
855 | TYPE: acl_access | |
856 | LOC: Config.accessList.htcp | |
857 | DEFAULT: none | |
858 | DEFAULT_IF_NONE: deny all | |
5473c134 | 859 | DOC_START |
41bd17a4 | 860 | Allowing or Denying access to the HTCP port based on defined |
861 | access lists | |
5473c134 | 862 | |
41bd17a4 | 863 | htcp_access allow|deny [!]aclname ... |
5473c134 | 864 | |
41bd17a4 | 865 | See http_access for details |
5473c134 | 866 | |
0b48417e | 867 | NOTE: The default if no htcp_access lines are present is to |
868 | deny all traffic. This default may cause problems with peers | |
869 | using the htcp or htcp-oldsquid options. | |
870 | ||
ee776778 | 871 | NOCOMMENT_START |
872 | #Allow HTCP queries from local networks only | |
df2eec10 AJ |
873 | #htcp_access allow localnet |
874 | #htcp_access deny all | |
ee776778 | 875 | NOCOMMENT_END |
41bd17a4 | 876 | DOC_END |
5473c134 | 877 | |
41bd17a4 | 878 | NAME: htcp_clr_access |
879 | IFDEF: USE_HTCP | |
880 | TYPE: acl_access | |
881 | LOC: Config.accessList.htcp_clr | |
882 | DEFAULT: none | |
883 | DEFAULT_IF_NONE: deny all | |
884 | DOC_START | |
885 | Allowing or Denying access to purge content using HTCP based | |
886 | on defined access lists | |
5473c134 | 887 | |
41bd17a4 | 888 | htcp_clr_access allow|deny [!]aclname ... |
5473c134 | 889 | |
41bd17a4 | 890 | See http_access for details |
5473c134 | 891 | |
41bd17a4 | 892 | #Allow HTCP CLR requests from trusted peers |
893 | acl htcp_clr_peer src 172.16.1.2 | |
894 | htcp_clr_access allow htcp_clr_peer | |
5473c134 | 895 | DOC_END |
896 | ||
41bd17a4 | 897 | NAME: miss_access |
898 | TYPE: acl_access | |
899 | LOC: Config.accessList.miss | |
df2eec10 | 900 | DEFAULT: allow all |
5473c134 | 901 | DOC_START |
41bd17a4 | 902 | Use to force your neighbors to use you as a sibling instead of |
903 | a parent. For example: | |
5473c134 | 904 | |
41bd17a4 | 905 | acl localclients src 172.16.0.0/16 |
906 | miss_access allow localclients | |
907 | miss_access deny !localclients | |
5473c134 | 908 | |
41bd17a4 | 909 | This means only your local clients are allowed to fetch |
910 | MISSES and all other clients can only fetch HITS. | |
5473c134 | 911 | |
41bd17a4 | 912 | By default, allow all clients who passed the http_access rules |
913 | to fetch MISSES from us. | |
41bd17a4 | 914 | DOC_END |
915 | ||
916 | NAME: ident_lookup_access | |
917 | TYPE: acl_access | |
918 | IFDEF: USE_IDENT | |
919 | DEFAULT: none | |
920 | DEFAULT_IF_NONE: deny all | |
921 | LOC: Config.accessList.identLookup | |
5473c134 | 922 | DOC_START |
41bd17a4 | 923 | A list of ACL elements which, if matched, cause an ident |
924 | (RFC 931) lookup to be performed for this request. For | |
925 | example, you might choose to always perform ident lookups | |
926 | for your main multi-user Unix boxes, but not for your Macs | |
927 | and PCs. By default, ident lookups are not performed for | |
928 | any requests. | |
5473c134 | 929 | |
41bd17a4 | 930 | To enable ident lookups for specific client addresses, you |
931 | can follow this example: | |
5473c134 | 932 | |
41bd17a4 | 933 | acl ident_aware_hosts src 198.168.1.0/255.255.255.0 |
934 | ident_lookup_access allow ident_aware_hosts | |
935 | ident_lookup_access deny all | |
5473c134 | 936 | |
41bd17a4 | 937 | Only src type ACL checks are fully supported. A src_domain |
938 | ACL might work at times, but it will not always provide | |
939 | the correct result. | |
940 | DOC_END | |
5473c134 | 941 | |
5b0f5383 | 942 | NAME: reply_body_max_size |
943 | COMMENT: size [acl acl...] | |
944 | TYPE: acl_b_size_t | |
945 | DEFAULT: none | |
946 | LOC: Config.ReplyBodySize | |
947 | DOC_START | |
948 | This option specifies the maximum size of a reply body. It can be | |
949 | used to prevent users from downloading very large files, such as | |
950 | MP3's and movies. When the reply headers are received, the | |
951 | reply_body_max_size lines are processed, and the first line where | |
952 | all (if any) listed ACLs are true is used as the maximum body size | |
953 | for this reply. | |
954 | ||
955 | This size is checked twice. First when we get the reply headers, | |
956 | we check the content-length value. If the content length value exists | |
957 | and is larger than the allowed size, the request is denied and the | |
958 | user receives an error message that says "the request or reply | |
959 | is too large." If there is no content-length, and the reply | |
960 | size exceeds this limit, the client's connection is just closed | |
961 | and they will receive a partial reply. | |
962 | ||
963 | WARNING: downstream caches probably can not detect a partial reply | |
964 | if there is no content-length header, so they will cache | |
965 | partial responses and give them out as hits. You should NOT | |
966 | use this option if you have downstream caches. | |
967 | ||
968 | WARNING: A maximum size smaller than the size of squid's error messages | |
969 | will cause an infinite loop and crash squid. Ensure that the smallest | |
970 | non-zero value you use is greater that the maximum header size plus | |
971 | the size of your largest error page. | |
972 | ||
973 | If you set this parameter none (the default), there will be | |
974 | no limit imposed. | |
3bc32f2f AJ |
975 | |
976 | Configuration Format is: | |
977 | reply_body_max_size SIZE UNITS [acl ...] | |
978 | ie. | |
979 | reply_body_max_size 10 MB | |
980 | ||
5b0f5383 | 981 | DOC_END |
982 | ||
983 | COMMENT_START | |
984 | NETWORK OPTIONS | |
985 | ----------------------------------------------------------------------------- | |
986 | COMMENT_END | |
987 | ||
988 | NAME: http_port ascii_port | |
989 | TYPE: http_port_list | |
990 | DEFAULT: none | |
991 | LOC: Config.Sockaddr.http | |
992 | DOC_START | |
993 | Usage: port [options] | |
994 | hostname:port [options] | |
995 | 1.2.3.4:port [options] | |
996 | ||
997 | The socket addresses where Squid will listen for HTTP client | |
998 | requests. You may specify multiple socket addresses. | |
999 | There are three forms: port alone, hostname with port, and | |
1000 | IP address with port. If you specify a hostname or IP | |
1001 | address, Squid binds the socket to that specific | |
1002 | address. This replaces the old 'tcp_incoming_address' | |
1003 | option. Most likely, you do not need to bind to a specific | |
1004 | address, so you can use the port number alone. | |
1005 | ||
1006 | If you are running Squid in accelerator mode, you | |
1007 | probably want to listen on port 80 also, or instead. | |
1008 | ||
1009 | The -a command line option may be used to specify additional | |
1010 | port(s) where Squid listens for proxy request. Such ports will | |
1011 | be plain proxy ports with no options. | |
1012 | ||
1013 | You may specify multiple socket addresses on multiple lines. | |
1014 | ||
1015 | Options: | |
1016 | ||
e77bdb4e | 1017 | intercept Support for IP-Layer interception of |
5b0f5383 | 1018 | outgoing requests without browser settings. |
13b5cd0c | 1019 | NP: disables authentication and IPv6 on the port. |
5b0f5383 | 1020 | |
1021 | tproxy Support Linux TPROXY for spoofing outgoing | |
1022 | connections using the client IP address. | |
13b5cd0c | 1023 | NP: disables authentication and IPv6 on the port. |
5b0f5383 | 1024 | |
1025 | accel Accelerator mode. Also needs at least one of | |
1026 | vhost / vport / defaultsite. | |
1027 | ||
1028 | defaultsite=domainname | |
1029 | What to use for the Host: header if it is not present | |
1030 | in a request. Determines what site (not origin server) | |
1031 | accelerators should consider the default. | |
1032 | Implies accel. | |
1033 | ||
1034 | vhost Accelerator mode using Host header for virtual | |
1035 | domain support. Implies accel. | |
1036 | ||
1037 | vport Accelerator with IP based virtual host support. | |
1038 | Implies accel. | |
1039 | ||
1040 | vport=NN As above, but uses specified port number rather | |
1041 | than the http_port number. Implies accel. | |
1042 | ||
1043 | protocol= Protocol to reconstruct accelerated requests with. | |
1044 | Defaults to http. | |
1045 | ||
d67acb4e AJ |
1046 | connection-auth[=on|off] |
1047 | use connection-auth=off to tell Squid to prevent | |
1048 | forwarding Microsoft connection oriented authentication | |
1049 | (NTLM, Negotiate and Kerberos) | |
1050 | ||
5b0f5383 | 1051 | disable-pmtu-discovery= |
1052 | Control Path-MTU discovery usage: | |
1053 | off lets OS decide on what to do (default). | |
1054 | transparent disable PMTU discovery when transparent | |
1055 | support is enabled. | |
1056 | always disable always PMTU discovery. | |
1057 | ||
1058 | In many setups of transparently intercepting proxies | |
1059 | Path-MTU discovery can not work on traffic towards the | |
1060 | clients. This is the case when the intercepting device | |
1061 | does not fully track connections and fails to forward | |
1062 | ICMP must fragment messages to the cache server. If you | |
1063 | have such setup and experience that certain clients | |
1064 | sporadically hang or never complete requests set | |
1065 | disable-pmtu-discovery option to 'transparent'. | |
1066 | ||
4c9da963 | 1067 | sslBump Intercept each CONNECT request matching ssl_bump ACL, |
1068 | establish secure connection with the client and with | |
1069 | the server, decrypt HTTP messages as they pass through | |
1070 | Squid, and treat them as unencrypted HTTP messages, | |
1071 | becoming the man-in-the-middle. | |
1072 | ||
1073 | When this option is enabled, additional options become | |
1074 | available to specify SSL-related properties of the | |
1075 | client-side connection: cert, key, version, cipher, | |
1076 | options, clientca, cafile, capath, crlfile, dhparams, | |
1077 | sslflags, and sslcontext. See the https_port directive | |
1078 | for more information on these options. | |
1079 | ||
1080 | The ssl_bump option is required to fully enable | |
1081 | the SslBump feature. | |
1082 | ||
81b6e9a7 | 1083 | name= Specifies a internal name for the port. Defaults to |
1084 | the port specification (port or addr:port) | |
1085 | ||
b2130d58 | 1086 | keepalive[=idle,interval,timeout] |
1087 | Enable TCP keepalive probes of idle connections | |
1088 | idle is the initial time before TCP starts probing | |
1089 | the connection, interval how often to probe, and | |
1090 | timeout the time before giving up. | |
1091 | ||
5b0f5383 | 1092 | If you run Squid on a dual-homed machine with an internal |
1093 | and an external interface we recommend you to specify the | |
1094 | internal address:port in http_port. This way Squid will only be | |
1095 | visible on the internal address. | |
1096 | ||
1097 | NOCOMMENT_START | |
1098 | # Squid normally listens to port 3128 | |
1099 | http_port @DEFAULT_HTTP_PORT@ | |
1100 | NOCOMMENT_END | |
1101 | DOC_END | |
1102 | ||
1103 | NAME: https_port | |
1104 | IFDEF: USE_SSL | |
1105 | TYPE: https_port_list | |
1106 | DEFAULT: none | |
1107 | LOC: Config.Sockaddr.https | |
1108 | DOC_START | |
1109 | Usage: [ip:]port cert=certificate.pem [key=key.pem] [options...] | |
1110 | ||
1111 | The socket address where Squid will listen for HTTPS client | |
1112 | requests. | |
1113 | ||
1114 | This is really only useful for situations where you are running | |
1115 | squid in accelerator mode and you want to do the SSL work at the | |
1116 | accelerator level. | |
1117 | ||
1118 | You may specify multiple socket addresses on multiple lines, | |
1119 | each with their own SSL certificate and/or options. | |
1120 | ||
1121 | Options: | |
1122 | ||
1123 | accel Accelerator mode. Also needs at least one of | |
1124 | defaultsite or vhost. | |
1125 | ||
1126 | defaultsite= The name of the https site presented on | |
1127 | this port. Implies accel. | |
1128 | ||
1129 | vhost Accelerator mode using Host header for virtual | |
1130 | domain support. Requires a wildcard certificate | |
1131 | or other certificate valid for more than one domain. | |
1132 | Implies accel. | |
1133 | ||
1134 | protocol= Protocol to reconstruct accelerated requests with. | |
1135 | Defaults to https. | |
1136 | ||
1137 | cert= Path to SSL certificate (PEM format). | |
1138 | ||
1139 | key= Path to SSL private key file (PEM format) | |
1140 | if not specified, the certificate file is | |
1141 | assumed to be a combined certificate and | |
1142 | key file. | |
1143 | ||
1144 | version= The version of SSL/TLS supported | |
1145 | 1 automatic (default) | |
1146 | 2 SSLv2 only | |
1147 | 3 SSLv3 only | |
1148 | 4 TLSv1 only | |
1149 | ||
1150 | cipher= Colon separated list of supported ciphers. | |
1151 | ||
1152 | options= Various SSL engine options. The most important | |
1153 | being: | |
1154 | NO_SSLv2 Disallow the use of SSLv2 | |
1155 | NO_SSLv3 Disallow the use of SSLv3 | |
1156 | NO_TLSv1 Disallow the use of TLSv1 | |
1157 | SINGLE_DH_USE Always create a new key when using | |
1158 | temporary/ephemeral DH key exchanges | |
1159 | See src/ssl_support.c or OpenSSL SSL_CTX_set_options | |
1160 | documentation for a complete list of options. | |
1161 | ||
1162 | clientca= File containing the list of CAs to use when | |
1163 | requesting a client certificate. | |
1164 | ||
1165 | cafile= File containing additional CA certificates to | |
1166 | use when verifying client certificates. If unset | |
1167 | clientca will be used. | |
1168 | ||
1169 | capath= Directory containing additional CA certificates | |
1170 | and CRL lists to use when verifying client certificates. | |
1171 | ||
1172 | crlfile= File of additional CRL lists to use when verifying | |
1173 | the client certificate, in addition to CRLs stored in | |
1174 | the capath. Implies VERIFY_CRL flag below. | |
1175 | ||
1176 | dhparams= File containing DH parameters for temporary/ephemeral | |
1177 | DH key exchanges. | |
1178 | ||
1179 | sslflags= Various flags modifying the use of SSL: | |
1180 | DELAYED_AUTH | |
1181 | Don't request client certificates | |
1182 | immediately, but wait until acl processing | |
1183 | requires a certificate (not yet implemented). | |
1184 | NO_DEFAULT_CA | |
1185 | Don't use the default CA lists built in | |
1186 | to OpenSSL. | |
1187 | NO_SESSION_REUSE | |
1188 | Don't allow for session reuse. Each connection | |
1189 | will result in a new SSL session. | |
1190 | VERIFY_CRL | |
1191 | Verify CRL lists when accepting client | |
1192 | certificates. | |
1193 | VERIFY_CRL_ALL | |
1194 | Verify CRL lists for all certificates in the | |
1195 | client certificate chain. | |
1196 | ||
1197 | sslcontext= SSL session ID context identifier. | |
1198 | ||
1199 | vport Accelerator with IP based virtual host support. | |
1200 | ||
1201 | vport=NN As above, but uses specified port number rather | |
1202 | than the https_port number. Implies accel. | |
1203 | ||
81b6e9a7 | 1204 | name= Specifies a internal name for the port. Defaults to |
1205 | the port specification (port or addr:port) | |
1206 | ||
5b0f5383 | 1207 | DOC_END |
1208 | ||
41bd17a4 | 1209 | NAME: tcp_outgoing_tos tcp_outgoing_ds tcp_outgoing_dscp |
1210 | TYPE: acl_tos | |
5473c134 | 1211 | DEFAULT: none |
41bd17a4 | 1212 | LOC: Config.accessList.outgoing_tos |
5473c134 | 1213 | DOC_START |
41bd17a4 | 1214 | Allows you to select a TOS/Diffserv value to mark outgoing |
1215 | connections with, based on the username or source address | |
1216 | making the request. | |
5473c134 | 1217 | |
41bd17a4 | 1218 | tcp_outgoing_tos ds-field [!]aclname ... |
cccac0a2 | 1219 | |
41bd17a4 | 1220 | Example where normal_service_net uses the TOS value 0x00 |
1221 | and normal_service_net uses 0x20 | |
cccac0a2 | 1222 | |
41bd17a4 | 1223 | acl normal_service_net src 10.0.0.0/255.255.255.0 |
1224 | acl good_service_net src 10.0.1.0/255.255.255.0 | |
2c73de90 | 1225 | tcp_outgoing_tos 0x00 normal_service_net |
41bd17a4 | 1226 | tcp_outgoing_tos 0x20 good_service_net |
fa38076e | 1227 | |
41bd17a4 | 1228 | TOS/DSCP values really only have local significance - so you should |
575cb927 AJ |
1229 | know what you're specifying. For more information, see RFC2474, |
1230 | RFC2475, and RFC3260. | |
cccac0a2 | 1231 | |
41bd17a4 | 1232 | The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or |
1233 | "default" to use whatever default your host has. Note that in | |
1234 | practice often only values 0 - 63 is usable as the two highest bits | |
1235 | have been redefined for use by ECN (RFC3168). | |
cccac0a2 | 1236 | |
41bd17a4 | 1237 | Processing proceeds in the order specified, and stops at first fully |
1238 | matching line. | |
cccac0a2 | 1239 | |
41bd17a4 | 1240 | Note: The use of this directive using client dependent ACLs is |
1241 | incompatible with the use of server side persistent connections. To | |
1242 | ensure correct results it is best to set server_persisten_connections | |
1243 | to off when using this directive in such configurations. | |
cccac0a2 | 1244 | DOC_END |
1245 | ||
41bd17a4 | 1246 | NAME: clientside_tos |
1247 | TYPE: acl_tos | |
cccac0a2 | 1248 | DEFAULT: none |
41bd17a4 | 1249 | LOC: Config.accessList.clientside_tos |
cccac0a2 | 1250 | DOC_START |
41bd17a4 | 1251 | Allows you to select a TOS/Diffserv value to mark client-side |
1252 | connections with, based on the username or source address | |
1253 | making the request. | |
1254 | DOC_END | |
cccac0a2 | 1255 | |
575cb927 AJ |
1256 | NAME: qos_flows |
1257 | TYPE: QosConfig | |
7172612f | 1258 | IFDEF: USE_ZPH_QOS |
575cb927 AJ |
1259 | DEFAULT: none |
1260 | LOC: Config.zph | |
7172612f | 1261 | DOC_START |
575cb927 AJ |
1262 | Allows you to select a TOS/DSCP value to mark outgoing |
1263 | connections with, based on where the reply was sourced. | |
7172612f | 1264 | |
575cb927 AJ |
1265 | TOS values really only have local significance - so you should |
1266 | know what you're specifying. For more information, see RFC2474, | |
1267 | RFC2475, and RFC3260. | |
7172612f | 1268 | |
575cb927 AJ |
1269 | The TOS/DSCP byte must be exactly that - octet value 0x00-0xFF. |
1270 | Note that in practice often only values up to 0x3F are usable | |
1271 | as the two highest bits have been redefined for use by ECN | |
1272 | (RFC3168). | |
7172612f | 1273 | |
575cb927 AJ |
1274 | This setting is configured by setting the source TOS values: |
1275 | ||
1276 | local-hit=0xFF Value to mark local cache hits. | |
1277 | ||
1278 | sibling-hit=0xFF Value to mark hits from sibling peers. | |
1279 | ||
1280 | parent-hit=0xFF Value to mark hits from parent peers. | |
1281 | ||
1282 | ||
2201bec6 AJ |
1283 | NOTE: 'miss' preserve feature is only possible on Linux at this time. |
1284 | ||
575cb927 AJ |
1285 | For the following to work correctly, you will need to patch your |
1286 | linux kernel with the TOS preserving ZPH patch. | |
1287 | The kernel patch can be downloaded from http://zph.bratcheda.org | |
1288 | ||
575cb927 AJ |
1289 | disable-preserve-miss |
1290 | If set, any HTTP response towards clients will | |
1291 | have the TOS value of the response comming from the | |
1292 | remote server masked with the value of miss-mask. | |
1293 | ||
1294 | miss-mask=0xFF | |
1295 | Allows you to mask certain bits in the TOS received from the | |
1296 | remote server, before copying the value to the TOS sent | |
1297 | towards clients. | |
1298 | Default: 0xFF (TOS from server is not changed). | |
7172612f | 1299 | |
7172612f AJ |
1300 | DOC_END |
1301 | ||
41bd17a4 | 1302 | NAME: tcp_outgoing_address |
1303 | TYPE: acl_address | |
1304 | DEFAULT: none | |
1305 | LOC: Config.accessList.outgoing_address | |
1306 | DOC_START | |
1307 | Allows you to map requests to different outgoing IP addresses | |
1308 | based on the username or source address of the user making | |
1309 | the request. | |
7f7db318 | 1310 | |
41bd17a4 | 1311 | tcp_outgoing_address ipaddr [[!]aclname] ... |
c33aa074 | 1312 | |
41bd17a4 | 1313 | Example where requests from 10.0.0.0/24 will be forwarded |
1314 | with source address 10.1.0.1, 10.0.2.0/24 forwarded with | |
1315 | source address 10.1.0.2 and the rest will be forwarded with | |
1316 | source address 10.1.0.3. | |
9197cd13 | 1317 | |
17148b2f | 1318 | acl normal_service_net src 10.0.0.0/24 |
1319 | acl good_service_net src 10.0.2.0/24 | |
1320 | tcp_outgoing_address 10.1.0.1 normal_service_net | |
1321 | tcp_outgoing_address 10.1.0.2 good_service_net | |
1322 | tcp_outgoing_address 10.1.0.3 | |
9197cd13 | 1323 | |
41bd17a4 | 1324 | Processing proceeds in the order specified, and stops at first fully |
1325 | matching line. | |
cccac0a2 | 1326 | |
41bd17a4 | 1327 | Note: The use of this directive using client dependent ACLs is |
1328 | incompatible with the use of server side persistent connections. To | |
1329 | ensure correct results it is best to set server_persistent_connections | |
1330 | to off when using this directive in such configurations. | |
cc192b50 | 1331 | |
1332 | ||
1333 | IPv6 Magic: | |
1334 | ||
1335 | Squid is built with a capability of bridging the IPv4 and IPv6 internets. | |
1336 | tcp_outgoing_address as exampled above breaks this bridging by forcing | |
1337 | all outbound traffic through a certain IPv4 which may be on the wrong | |
1338 | side of the IPv4/IPv6 boundary. | |
1339 | ||
1340 | To operate with tcp_outgoing_address and keep the bridging benefits | |
1341 | an additional ACL needs to be used which ensures the IPv6-bound traffic | |
1342 | is never forced or permitted out the IPv4 interface. | |
1343 | ||
1344 | acl to_ipv6 dst ipv6 | |
1345 | tcp_outgoing_address 2002::c001 good_service_net to_ipv6 | |
17148b2f | 1346 | tcp_outgoing_address 10.1.0.2 good_service_net !to_ipv6 |
cc192b50 | 1347 | |
1348 | tcp_outgoing_address 2002::beef normal_service_net to_ipv6 | |
17148b2f | 1349 | tcp_outgoing_address 10.1.0.1 normal_service_net !to_ipv6 |
cc192b50 | 1350 | |
1351 | tcp_outgoing_address 2002::1 to_ipv6 | |
17148b2f | 1352 | tcp_outgoing_address 10.1.0.3 !to_ipv6 |
6db78a1a AJ |
1353 | |
1354 | WARNING: | |
1355 | 'dst ipv6' bases its selection assuming DIRECT access. | |
1356 | If peers are used the peername ACL are needed to select outgoing | |
1357 | address which can link to the peer. | |
1358 | ||
cccac0a2 | 1359 | DOC_END |
1360 | ||
41bd17a4 | 1361 | COMMENT_START |
1362 | SSL OPTIONS | |
1363 | ----------------------------------------------------------------------------- | |
1364 | COMMENT_END | |
1365 | ||
1366 | NAME: ssl_unclean_shutdown | |
1367 | IFDEF: USE_SSL | |
cccac0a2 | 1368 | TYPE: onoff |
1369 | DEFAULT: off | |
41bd17a4 | 1370 | LOC: Config.SSL.unclean_shutdown |
cccac0a2 | 1371 | DOC_START |
41bd17a4 | 1372 | Some browsers (especially MSIE) bugs out on SSL shutdown |
1373 | messages. | |
cccac0a2 | 1374 | DOC_END |
1375 | ||
41bd17a4 | 1376 | NAME: ssl_engine |
1377 | IFDEF: USE_SSL | |
cccac0a2 | 1378 | TYPE: string |
41bd17a4 | 1379 | LOC: Config.SSL.ssl_engine |
1380 | DEFAULT: none | |
cccac0a2 | 1381 | DOC_START |
41bd17a4 | 1382 | The OpenSSL engine to use. You will need to set this if you |
1383 | would like to use hardware SSL acceleration for example. | |
cccac0a2 | 1384 | DOC_END |
1385 | ||
41bd17a4 | 1386 | NAME: sslproxy_client_certificate |
1387 | IFDEF: USE_SSL | |
cccac0a2 | 1388 | DEFAULT: none |
41bd17a4 | 1389 | LOC: Config.ssl_client.cert |
1390 | TYPE: string | |
cccac0a2 | 1391 | DOC_START |
41bd17a4 | 1392 | Client SSL Certificate to use when proxying https:// URLs |
cccac0a2 | 1393 | DOC_END |
1394 | ||
41bd17a4 | 1395 | NAME: sslproxy_client_key |
1396 | IFDEF: USE_SSL | |
cccac0a2 | 1397 | DEFAULT: none |
41bd17a4 | 1398 | LOC: Config.ssl_client.key |
1399 | TYPE: string | |
cccac0a2 | 1400 | DOC_START |
41bd17a4 | 1401 | Client SSL Key to use when proxying https:// URLs |
cccac0a2 | 1402 | DOC_END |
1403 | ||
41bd17a4 | 1404 | NAME: sslproxy_version |
1405 | IFDEF: USE_SSL | |
1406 | DEFAULT: 1 | |
1407 | LOC: Config.ssl_client.version | |
1408 | TYPE: int | |
cccac0a2 | 1409 | DOC_START |
41bd17a4 | 1410 | SSL version level to use when proxying https:// URLs |
cccac0a2 | 1411 | DOC_END |
1412 | ||
41bd17a4 | 1413 | NAME: sslproxy_options |
1414 | IFDEF: USE_SSL | |
1415 | DEFAULT: none | |
1416 | LOC: Config.ssl_client.options | |
1417 | TYPE: string | |
cccac0a2 | 1418 | DOC_START |
41bd17a4 | 1419 | SSL engine options to use when proxying https:// URLs |
cccac0a2 | 1420 | DOC_END |
1421 | ||
41bd17a4 | 1422 | NAME: sslproxy_cipher |
1423 | IFDEF: USE_SSL | |
1424 | DEFAULT: none | |
1425 | LOC: Config.ssl_client.cipher | |
1426 | TYPE: string | |
cccac0a2 | 1427 | DOC_START |
41bd17a4 | 1428 | SSL cipher list to use when proxying https:// URLs |
cccac0a2 | 1429 | DOC_END |
1430 | ||
41bd17a4 | 1431 | NAME: sslproxy_cafile |
1432 | IFDEF: USE_SSL | |
1433 | DEFAULT: none | |
1434 | LOC: Config.ssl_client.cafile | |
1435 | TYPE: string | |
cccac0a2 | 1436 | DOC_START |
41bd17a4 | 1437 | file containing CA certificates to use when verifying server |
1438 | certificates while proxying https:// URLs | |
cccac0a2 | 1439 | DOC_END |
0976f8db | 1440 | |
41bd17a4 | 1441 | NAME: sslproxy_capath |
1442 | IFDEF: USE_SSL | |
5473c134 | 1443 | DEFAULT: none |
41bd17a4 | 1444 | LOC: Config.ssl_client.capath |
1445 | TYPE: string | |
5473c134 | 1446 | DOC_START |
41bd17a4 | 1447 | directory containing CA certificates to use when verifying |
1448 | server certificates while proxying https:// URLs | |
5473c134 | 1449 | DOC_END |
1450 | ||
4c9da963 | 1451 | NAME: ssl_bump |
1452 | IFDEF: USE_SSL | |
1453 | TYPE: acl_access | |
1454 | LOC: Config.accessList.ssl_bump | |
1455 | DEFAULT: none | |
1456 | DOC_START | |
1457 | This ACL controls which CONNECT requests to an http_port | |
1458 | marked with an sslBump flag are actually "bumped". Please | |
1459 | see the sslBump flag of an http_port option for more details | |
1460 | about decoding proxied SSL connections. | |
1461 | ||
1462 | By default, no requests are bumped. | |
1463 | ||
1464 | See also: http_port sslBump | |
1465 | ||
1466 | NOCOMMENT_START | |
1467 | # Example: Bump all requests except those originating from localhost and | |
1468 | # those going to webax.com or example.com sites. | |
1469 | # | |
1470 | # acl localhost src 127.0.0.1/32 | |
1471 | # acl broken_sites dstdomain .webax.com | |
1472 | # acl broken_sites dstdomain .example.com | |
1473 | # ssl_bump deny localhost | |
1474 | # ssl_bump deny broken_sites | |
1475 | # ssl_bump allow all | |
1476 | NOCOMMENT_END | |
1477 | DOC_END | |
1478 | ||
41bd17a4 | 1479 | NAME: sslproxy_flags |
1480 | IFDEF: USE_SSL | |
1481 | DEFAULT: none | |
1482 | LOC: Config.ssl_client.flags | |
1483 | TYPE: string | |
5473c134 | 1484 | DOC_START |
41bd17a4 | 1485 | Various flags modifying the use of SSL while proxying https:// URLs: |
4c9da963 | 1486 | DONT_VERIFY_PEER Accept certificates that fail verification. |
1487 | For refined control, see sslproxy_cert_error. | |
41bd17a4 | 1488 | NO_DEFAULT_CA Don't use the default CA list built in |
1489 | to OpenSSL. | |
5473c134 | 1490 | DOC_END |
1491 | ||
4c9da963 | 1492 | |
1493 | NAME: sslproxy_cert_error | |
1494 | IFDEF: USE_SSL | |
1495 | DEFAULT: none | |
1496 | LOC: Config.ssl_client.cert_error | |
1497 | TYPE: acl_access | |
1498 | DOC_START | |
1499 | Use this ACL to bypass server certificate validation errors. | |
1500 | ||
1501 | For example, the following lines will bypass all validation errors | |
1502 | when talking to servers located at 172.16.0.0/16. All other | |
1503 | validation errors will result in ERR_SECURE_CONNECT_FAIL error. | |
1504 | ||
1505 | acl BrokenServersAtTrustedIP dst 172.16.0.0/16 | |
1506 | sslproxy_cert_error allow BrokenServersAtTrustedIP | |
1507 | sslproxy_cert_error deny all | |
1508 | ||
1509 | This option must use fast ACL expressions only. Expressions that use | |
1510 | external lookups or communication result in unpredictable behavior or | |
1511 | crashes. | |
1512 | ||
1513 | Without this option, all server certificate validation errors | |
1514 | terminate the transaction. Bypassing validation errors is dangerous | |
1515 | because an error usually implies that the server cannot be trusted and | |
1516 | the connection may be insecure. | |
1517 | ||
1518 | See also: sslproxy_flags and DONT_VERIFY_PEER. | |
1519 | ||
1520 | NOCOMMENT_START | |
1521 | #Default setting: | |
1522 | # sslproxy_cert_error deny all | |
1523 | NOCOMMENT_END | |
1524 | DOC_END | |
1525 | ||
1526 | ||
1527 | ||
41bd17a4 | 1528 | NAME: sslpassword_program |
1529 | IFDEF: USE_SSL | |
1530 | DEFAULT: none | |
1531 | LOC: Config.Program.ssl_password | |
1532 | TYPE: string | |
5473c134 | 1533 | DOC_START |
41bd17a4 | 1534 | Specify a program used for entering SSL key passphrases |
1535 | when using encrypted SSL certificate keys. If not specified | |
1536 | keys must either be unencrypted, or Squid started with the -N | |
1537 | option to allow it to query interactively for the passphrase. | |
5473c134 | 1538 | DOC_END |
1539 | ||
cccac0a2 | 1540 | COMMENT_START |
41bd17a4 | 1541 | OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM |
cccac0a2 | 1542 | ----------------------------------------------------------------------------- |
1543 | COMMENT_END | |
1544 | ||
41bd17a4 | 1545 | NAME: cache_peer |
1546 | TYPE: peer | |
1547 | DEFAULT: none | |
1548 | LOC: Config.peers | |
cccac0a2 | 1549 | DOC_START |
41bd17a4 | 1550 | To specify other caches in a hierarchy, use the format: |
cccac0a2 | 1551 | |
41bd17a4 | 1552 | cache_peer hostname type http-port icp-port [options] |
cccac0a2 | 1553 | |
41bd17a4 | 1554 | For example, |
cccac0a2 | 1555 | |
41bd17a4 | 1556 | # proxy icp |
1557 | # hostname type port port options | |
1558 | # -------------------- -------- ----- ----- ----------- | |
1559 | cache_peer parent.foo.net parent 3128 3130 proxy-only default | |
1560 | cache_peer sib1.foo.net sibling 3128 3130 proxy-only | |
1561 | cache_peer sib2.foo.net sibling 3128 3130 proxy-only | |
cccac0a2 | 1562 | |
41bd17a4 | 1563 | type: either 'parent', 'sibling', or 'multicast'. |
d5277f40 | 1564 | |
41bd17a4 | 1565 | proxy-port: The port number where the cache listens for proxy |
1566 | requests. | |
8d6275c0 | 1567 | |
41bd17a4 | 1568 | icp-port: Used for querying neighbor caches about |
1569 | objects. To have a non-ICP neighbor | |
df2eec10 | 1570 | specify '0' for the ICP port. |
41bd17a4 | 1571 | NOTE: Also requires icp_port option enabled to send/receive |
1572 | requests via this method. | |
a78278e2 | 1573 | |
41bd17a4 | 1574 | options: proxy-only |
1575 | weight=n | |
1576 | basetime=n | |
1577 | ttl=n | |
1578 | no-query | |
1579 | background-ping | |
1580 | default | |
1581 | round-robin | |
1582 | weighted-round-robin | |
1583 | carp | |
f7e1d9ce HN |
1584 | userhash |
1585 | sourcehash | |
41bd17a4 | 1586 | multicast-responder |
1587 | closest-only | |
1588 | no-digest | |
1589 | no-netdb-exchange | |
1590 | no-delay | |
1591 | login=user:password | PASS | *:password | |
1592 | connect-timeout=nn | |
1593 | digest-url=url | |
1594 | allow-miss | |
1595 | max-conn=n | |
1596 | htcp | |
1597 | htcp-oldsquid | |
4f4fa815 BR |
1598 | htcp-no-clr |
1599 | htcp-no-purge-clr | |
1600 | htcp-only-clr | |
1601 | htcp-forward-clr | |
41bd17a4 | 1602 | originserver |
1603 | name=xxx | |
1604 | forceddomain=name | |
1605 | ssl | |
1606 | sslcert=/path/to/ssl/certificate | |
1607 | sslkey=/path/to/ssl/key | |
1608 | sslversion=1|2|3|4 | |
1609 | sslcipher=... | |
1610 | ssloptions=... | |
1611 | front-end-https[=on|auto] | |
d67acb4e | 1612 | connection-auth[=on|off|auto] |
cccac0a2 | 1613 | |
41bd17a4 | 1614 | use 'proxy-only' to specify objects fetched |
1615 | from this cache should not be saved locally. | |
cccac0a2 | 1616 | |
41bd17a4 | 1617 | use 'weight=n' to affect the selection of a peer |
1618 | during any weighted peer-selection mechanisms. | |
1619 | The weight must be an integer; default is 1, | |
1620 | larger weights are favored more. | |
1621 | This option does not affect parent selection if a peering | |
1622 | protocol is not in use. | |
cccac0a2 | 1623 | |
41bd17a4 | 1624 | use 'basetime=n' to specify a base amount to |
1625 | be subtracted from round trip times of parents. | |
1626 | It is subtracted before division by weight in calculating | |
1627 | which parent to fectch from. If the rtt is less than the | |
1628 | base time the rtt is set to a minimal value. | |
cccac0a2 | 1629 | |
41bd17a4 | 1630 | use 'ttl=n' to specify a IP multicast TTL to use |
1631 | when sending an ICP queries to this address. | |
1632 | Only useful when sending to a multicast group. | |
1633 | Because we don't accept ICP replies from random | |
1634 | hosts, you must configure other group members as | |
1635 | peers with the 'multicast-responder' option below. | |
5473c134 | 1636 | |
41bd17a4 | 1637 | use 'no-query' to NOT send ICP queries to this |
1638 | neighbor. | |
5473c134 | 1639 | |
41bd17a4 | 1640 | use 'background-ping' to only send ICP queries to this |
1641 | neighbor infrequently. This is used to keep the neighbor | |
1642 | round trip time updated and is usually used in | |
1643 | conjunction with weighted-round-robin. | |
cccac0a2 | 1644 | |
41bd17a4 | 1645 | use 'default' if this is a parent cache which can |
1646 | be used as a "last-resort" if a peer cannot be located | |
1647 | by any of the peer-selection mechanisms. | |
1648 | If specified more than once, only the first is used. | |
cccac0a2 | 1649 | |
41bd17a4 | 1650 | use 'round-robin' to define a set of parents which |
1651 | should be used in a round-robin fashion in the | |
1652 | absence of any ICP queries. | |
cccac0a2 | 1653 | |
41bd17a4 | 1654 | use 'weighted-round-robin' to define a set of parents |
1655 | which should be used in a round-robin fashion with the | |
1656 | frequency of each parent being based on the round trip | |
1657 | time. Closer parents are used more often. | |
1658 | Usually used for background-ping parents. | |
cccac0a2 | 1659 | |
41bd17a4 | 1660 | use 'carp' to define a set of parents which should |
1661 | be used as a CARP array. The requests will be | |
1662 | distributed among the parents based on the CARP load | |
382db7eb | 1663 | balancing hash function based on their weight. |
cccac0a2 | 1664 | |
f7e1d9ce HN |
1665 | use 'userhash' to load-balance amongst a set of parents |
1666 | based on the client proxy_auth or ident username. | |
1667 | ||
1668 | use 'sourcehash' to load-balance amongst a set of parents | |
1669 | based on the client source ip. | |
1670 | ||
41bd17a4 | 1671 | 'multicast-responder' indicates the named peer |
1672 | is a member of a multicast group. ICP queries will | |
1673 | not be sent directly to the peer, but ICP replies | |
1674 | will be accepted from it. | |
cccac0a2 | 1675 | |
41bd17a4 | 1676 | 'closest-only' indicates that, for ICP_OP_MISS |
1677 | replies, we'll only forward CLOSEST_PARENT_MISSes | |
1678 | and never FIRST_PARENT_MISSes. | |
cccac0a2 | 1679 | |
41bd17a4 | 1680 | use 'no-digest' to NOT request cache digests from |
1681 | this neighbor. | |
cccac0a2 | 1682 | |
41bd17a4 | 1683 | 'no-netdb-exchange' disables requesting ICMP |
1684 | RTT database (NetDB) from the neighbor. | |
cccac0a2 | 1685 | |
41bd17a4 | 1686 | use 'no-delay' to prevent access to this neighbor |
1687 | from influencing the delay pools. | |
7d90757b | 1688 | |
41bd17a4 | 1689 | use 'login=user:password' if this is a personal/workgroup |
1690 | proxy and your parent requires proxy authentication. | |
1691 | Note: The string can include URL escapes (i.e. %20 for | |
1692 | spaces). This also means % must be written as %%. | |
7d90757b | 1693 | |
41bd17a4 | 1694 | use 'login=PASS' if users must authenticate against |
1695 | the upstream proxy or in the case of a reverse proxy | |
1696 | configuration, the origin web server. This will pass | |
1697 | the users credentials as they are to the peer. | |
1698 | This only works for the Basic HTTP authentication scheme. | |
1699 | Note: To combine this with proxy_auth both proxies must | |
1700 | share the same user database as HTTP only allows for | |
1701 | a single login (one for proxy, one for origin server). | |
1702 | Also be warned this will expose your users proxy | |
1703 | password to the peer. USE WITH CAUTION | |
7d90757b | 1704 | |
41bd17a4 | 1705 | use 'login=*:password' to pass the username to the |
1706 | upstream cache, but with a fixed password. This is meant | |
1707 | to be used when the peer is in another administrative | |
1708 | domain, but it is still needed to identify each user. | |
1709 | The star can optionally be followed by some extra | |
1710 | information which is added to the username. This can | |
1711 | be used to identify this proxy to the peer, similar to | |
1712 | the login=username:password option above. | |
cccac0a2 | 1713 | |
41bd17a4 | 1714 | use 'connect-timeout=nn' to specify a peer |
1715 | specific connect timeout (also see the | |
1716 | peer_connect_timeout directive) | |
7f7db318 | 1717 | |
41bd17a4 | 1718 | use 'digest-url=url' to tell Squid to fetch the cache |
1719 | digest (if digests are enabled) for this host from | |
1720 | the specified URL rather than the Squid default | |
1721 | location. | |
cccac0a2 | 1722 | |
41bd17a4 | 1723 | use 'allow-miss' to disable Squid's use of only-if-cached |
1724 | when forwarding requests to siblings. This is primarily | |
1725 | useful when icp_hit_stale is used by the sibling. To | |
1726 | extensive use of this option may result in forwarding | |
1727 | loops, and you should avoid having two-way peerings | |
1728 | with this option. (for example to deny peer usage on | |
1729 | requests from peer by denying cache_peer_access if the | |
1730 | source is a peer) | |
cccac0a2 | 1731 | |
41bd17a4 | 1732 | use 'max-conn=n' to limit the amount of connections Squid |
1733 | may open to this peer. | |
cccac0a2 | 1734 | |
41bd17a4 | 1735 | use 'htcp' to send HTCP, instead of ICP, queries |
1736 | to the neighbor. You probably also want to | |
1737 | set the "icp port" to 4827 instead of 3130. | |
0b48417e | 1738 | You MUST also set htcp_access expicitly. The default of |
1739 | deny all will prevent peer traffic. | |
cccac0a2 | 1740 | |
41bd17a4 | 1741 | use 'htcp-oldsquid' to send HTCP to old Squid versions |
0b48417e | 1742 | You MUST also set htcp_access expicitly. The default of |
1743 | deny all will prevent peer traffic. | |
cccac0a2 | 1744 | |
4f4fa815 BR |
1745 | use 'htcp-no-clr' to send HTCP to the neighbor but without |
1746 | sending any CLR requests. This cannot be used with | |
1747 | htcp-only-clr. | |
1748 | ||
1749 | use 'htcp-no-purge-clr' to send HTCP to the neighbor | |
1750 | including CLRs but only when they do not result from | |
1751 | PURGE requests. | |
1752 | ||
1753 | use 'htcp-only-clr' to send HTCP to the neighbor but ONLY | |
1754 | CLR requests. This cannot be used with htcp-no-clr. | |
1755 | ||
1756 | use 'htcp-forward-clr' to forward any HTCP CLR requests | |
1757 | this proxy receives to the peer. | |
1758 | ||
41bd17a4 | 1759 | 'originserver' causes this parent peer to be contacted as |
1760 | a origin server. Meant to be used in accelerator setups. | |
cccac0a2 | 1761 | |
41bd17a4 | 1762 | use 'name=xxx' if you have multiple peers on the same |
1763 | host but different ports. This name can be used to | |
1764 | differentiate the peers in cache_peer_access and similar | |
6db78a1a | 1765 | directives. Including the peername ACL type. |
cccac0a2 | 1766 | |
41bd17a4 | 1767 | use 'forceddomain=name' to forcibly set the Host header |
1768 | of requests forwarded to this peer. Useful in accelerator | |
1769 | setups where the server (peer) expects a certain domain | |
1770 | name and using redirectors to feed this domain name | |
1771 | is not feasible. | |
64658378 | 1772 | |
41bd17a4 | 1773 | use 'ssl' to indicate connections to this peer should |
1774 | be SSL/TLS encrypted. | |
cccac0a2 | 1775 | |
41bd17a4 | 1776 | use 'sslcert=/path/to/ssl/certificate' to specify a client |
1777 | SSL certificate to use when connecting to this peer. | |
4c9fa5d5 | 1778 | |
41bd17a4 | 1779 | use 'sslkey=/path/to/ssl/key' to specify the private SSL |
1780 | key corresponding to sslcert above. If 'sslkey' is not | |
1781 | specified 'sslcert' is assumed to reference a | |
1782 | combined file containing both the certificate and the key. | |
4c9fa5d5 | 1783 | |
41bd17a4 | 1784 | use sslversion=1|2|3|4 to specify the SSL version to use |
1785 | when connecting to this peer | |
1786 | 1 = automatic (default) | |
1787 | 2 = SSL v2 only | |
1788 | 3 = SSL v3 only | |
1789 | 4 = TLS v1 only | |
cccac0a2 | 1790 | |
41bd17a4 | 1791 | use sslcipher=... to specify the list of valid SSL ciphers |
1792 | to use when connecting to this peer. | |
cccac0a2 | 1793 | |
41bd17a4 | 1794 | use ssloptions=... to specify various SSL engine options: |
1795 | NO_SSLv2 Disallow the use of SSLv2 | |
1796 | NO_SSLv3 Disallow the use of SSLv3 | |
1797 | NO_TLSv1 Disallow the use of TLSv1 | |
1798 | See src/ssl_support.c or the OpenSSL documentation for | |
1799 | a more complete list. | |
cccac0a2 | 1800 | |
41bd17a4 | 1801 | use sslcafile=... to specify a file containing |
1802 | additional CA certificates to use when verifying the | |
1803 | peer certificate. | |
cccac0a2 | 1804 | |
41bd17a4 | 1805 | use sslcapath=... to specify a directory containing |
1806 | additional CA certificates to use when verifying the | |
1807 | peer certificate. | |
cccac0a2 | 1808 | |
41bd17a4 | 1809 | use sslcrlfile=... to specify a certificate revocation |
1810 | list file to use when verifying the peer certificate. | |
1811 | ||
1812 | use sslflags=... to specify various flags modifying the | |
1813 | SSL implementation: | |
1814 | DONT_VERIFY_PEER | |
1815 | Accept certificates even if they fail to | |
1816 | verify. | |
1817 | NO_DEFAULT_CA | |
1818 | Don't use the default CA list built in | |
1819 | to OpenSSL. | |
1820 | DONT_VERIFY_DOMAIN | |
1821 | Don't verify the peer certificate | |
1822 | matches the server name | |
cccac0a2 | 1823 | |
41bd17a4 | 1824 | use ssldomain= to specify the peer name as advertised |
1825 | in it's certificate. Used for verifying the correctness | |
1826 | of the received peer certificate. If not specified the | |
1827 | peer hostname will be used. | |
cccac0a2 | 1828 | |
41bd17a4 | 1829 | use front-end-https to enable the "Front-End-Https: On" |
1830 | header needed when using Squid as a SSL frontend in front | |
1831 | of Microsoft OWA. See MS KB document Q307347 for details | |
1832 | on this header. If set to auto the header will | |
1833 | only be added if the request is forwarded as a https:// | |
1834 | URL. | |
d67acb4e AJ |
1835 | |
1836 | use connection-auth=off to tell Squid that this peer does | |
1837 | not support Microsoft connection oriented authentication, | |
1838 | and any such challenges received from there should be | |
1839 | ignored. Default is auto to automatically determine the | |
1840 | status of the peer. | |
41bd17a4 | 1841 | DOC_END |
cccac0a2 | 1842 | |
41bd17a4 | 1843 | NAME: cache_peer_domain cache_host_domain |
1844 | TYPE: hostdomain | |
1845 | DEFAULT: none | |
1846 | LOC: none | |
1847 | DOC_START | |
1848 | Use to limit the domains for which a neighbor cache will be | |
1849 | queried. Usage: | |
cccac0a2 | 1850 | |
41bd17a4 | 1851 | cache_peer_domain cache-host domain [domain ...] |
1852 | cache_peer_domain cache-host !domain | |
cccac0a2 | 1853 | |
41bd17a4 | 1854 | For example, specifying |
cccac0a2 | 1855 | |
41bd17a4 | 1856 | cache_peer_domain parent.foo.net .edu |
cccac0a2 | 1857 | |
41bd17a4 | 1858 | has the effect such that UDP query packets are sent to |
1859 | 'bigserver' only when the requested object exists on a | |
1860 | server in the .edu domain. Prefixing the domainname | |
1861 | with '!' means the cache will be queried for objects | |
1862 | NOT in that domain. | |
cccac0a2 | 1863 | |
41bd17a4 | 1864 | NOTE: * Any number of domains may be given for a cache-host, |
1865 | either on the same or separate lines. | |
1866 | * When multiple domains are given for a particular | |
1867 | cache-host, the first matched domain is applied. | |
1868 | * Cache hosts with no domain restrictions are queried | |
1869 | for all requests. | |
1870 | * There are no defaults. | |
1871 | * There is also a 'cache_peer_access' tag in the ACL | |
1872 | section. | |
1873 | DOC_END | |
dd9b1776 | 1874 | |
41bd17a4 | 1875 | NAME: cache_peer_access |
1876 | TYPE: peer_access | |
1877 | DEFAULT: none | |
1878 | LOC: none | |
1879 | DOC_START | |
1880 | Similar to 'cache_peer_domain' but provides more flexibility by | |
1881 | using ACL elements. | |
cccac0a2 | 1882 | |
41bd17a4 | 1883 | cache_peer_access cache-host allow|deny [!]aclname ... |
dd9b1776 | 1884 | |
41bd17a4 | 1885 | The syntax is identical to 'http_access' and the other lists of |
1886 | ACL elements. See the comments for 'http_access' below, or | |
1887 | the Squid FAQ (http://www.squid-cache.org/FAQ/FAQ-10.html). | |
1888 | DOC_END | |
dd9b1776 | 1889 | |
41bd17a4 | 1890 | NAME: neighbor_type_domain |
1891 | TYPE: hostdomaintype | |
1892 | DEFAULT: none | |
1893 | LOC: none | |
1894 | DOC_START | |
1895 | usage: neighbor_type_domain neighbor parent|sibling domain domain ... | |
cccac0a2 | 1896 | |
41bd17a4 | 1897 | Modifying the neighbor type for specific domains is now |
1898 | possible. You can treat some domains differently than the the | |
1899 | default neighbor type specified on the 'cache_peer' line. | |
1900 | Normally it should only be necessary to list domains which | |
1901 | should be treated differently because the default neighbor type | |
1902 | applies for hostnames which do not match domains listed here. | |
6bf4f823 | 1903 | |
41bd17a4 | 1904 | EXAMPLE: |
dbe3992d | 1905 | cache_peer cache.foo.org parent 3128 3130 |
41bd17a4 | 1906 | neighbor_type_domain cache.foo.org sibling .com .net |
1907 | neighbor_type_domain cache.foo.org sibling .au .de | |
1908 | DOC_END | |
6bf4f823 | 1909 | |
41bd17a4 | 1910 | NAME: dead_peer_timeout |
1911 | COMMENT: (seconds) | |
1912 | DEFAULT: 10 seconds | |
1913 | TYPE: time_t | |
1914 | LOC: Config.Timeout.deadPeer | |
1915 | DOC_START | |
1916 | This controls how long Squid waits to declare a peer cache | |
1917 | as "dead." If there are no ICP replies received in this | |
1918 | amount of time, Squid will declare the peer dead and not | |
1919 | expect to receive any further ICP replies. However, it | |
1920 | continues to send ICP queries, and will mark the peer as | |
1921 | alive upon receipt of the first subsequent ICP reply. | |
699acd19 | 1922 | |
41bd17a4 | 1923 | This timeout also affects when Squid expects to receive ICP |
1924 | replies from peers. If more than 'dead_peer' seconds have | |
1925 | passed since the last ICP reply was received, Squid will not | |
1926 | expect to receive an ICP reply on the next query. Thus, if | |
1927 | your time between requests is greater than this timeout, you | |
1928 | will see a lot of requests sent DIRECT to origin servers | |
1929 | instead of to your parents. | |
1930 | DOC_END | |
cccac0a2 | 1931 | |
41bd17a4 | 1932 | NAME: hierarchy_stoplist |
1933 | TYPE: wordlist | |
1934 | DEFAULT: none | |
1935 | LOC: Config.hierarchy_stoplist | |
1936 | DOC_START | |
1937 | A list of words which, if found in a URL, cause the object to | |
1938 | be handled directly by this cache. In other words, use this | |
1939 | to not query neighbor caches for certain objects. You may | |
1940 | list this option multiple times. | |
1941 | Note: never_direct overrides this option. | |
cccac0a2 | 1942 | NOCOMMENT_START |
41bd17a4 | 1943 | #We recommend you to use at least the following line. |
1944 | hierarchy_stoplist cgi-bin ? | |
6b698a21 | 1945 | NOCOMMENT_END |
1946 | DOC_END | |
0976f8db | 1947 | |
41bd17a4 | 1948 | COMMENT_START |
1949 | MEMORY CACHE OPTIONS | |
1950 | ----------------------------------------------------------------------------- | |
1951 | COMMENT_END | |
1952 | ||
1953 | NAME: cache_mem | |
1954 | COMMENT: (bytes) | |
1955 | TYPE: b_size_t | |
df2eec10 | 1956 | DEFAULT: 256 MB |
41bd17a4 | 1957 | LOC: Config.memMaxSize |
6b698a21 | 1958 | DOC_START |
41bd17a4 | 1959 | NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS SIZE. |
1960 | IT ONLY PLACES A LIMIT ON HOW MUCH ADDITIONAL MEMORY SQUID WILL | |
1961 | USE AS A MEMORY CACHE OF OBJECTS. SQUID USES MEMORY FOR OTHER | |
1962 | THINGS AS WELL. SEE THE SQUID FAQ SECTION 8 FOR DETAILS. | |
1963 | ||
1964 | 'cache_mem' specifies the ideal amount of memory to be used | |
1965 | for: | |
1966 | * In-Transit objects | |
1967 | * Hot Objects | |
1968 | * Negative-Cached objects | |
1969 | ||
1970 | Data for these objects are stored in 4 KB blocks. This | |
1971 | parameter specifies the ideal upper limit on the total size of | |
1972 | 4 KB blocks allocated. In-Transit objects take the highest | |
1973 | priority. | |
1974 | ||
1975 | In-transit objects have priority over the others. When | |
1976 | additional space is needed for incoming data, negative-cached | |
1977 | and hot objects will be released. In other words, the | |
1978 | negative-cached and hot objects will fill up any unused space | |
1979 | not needed for in-transit objects. | |
1980 | ||
1981 | If circumstances require, this limit will be exceeded. | |
1982 | Specifically, if your incoming request rate requires more than | |
1983 | 'cache_mem' of memory to hold in-transit objects, Squid will | |
1984 | exceed this limit to satisfy the new requests. When the load | |
1985 | decreases, blocks will be freed until the high-water mark is | |
1986 | reached. Thereafter, blocks will be used to store hot | |
1987 | objects. | |
6b698a21 | 1988 | DOC_END |
0976f8db | 1989 | |
41bd17a4 | 1990 | NAME: maximum_object_size_in_memory |
1991 | COMMENT: (bytes) | |
1992 | TYPE: b_size_t | |
df2eec10 | 1993 | DEFAULT: 512 KB |
41bd17a4 | 1994 | LOC: Config.Store.maxInMemObjSize |
6b698a21 | 1995 | DOC_START |
41bd17a4 | 1996 | Objects greater than this size will not be attempted to kept in |
1997 | the memory cache. This should be set high enough to keep objects | |
1998 | accessed frequently in memory to improve performance whilst low | |
1999 | enough to keep larger objects from hoarding cache_mem. | |
6b698a21 | 2000 | DOC_END |
0976f8db | 2001 | |
41bd17a4 | 2002 | NAME: memory_replacement_policy |
2003 | TYPE: removalpolicy | |
2004 | LOC: Config.memPolicy | |
2005 | DEFAULT: lru | |
6b698a21 | 2006 | DOC_START |
41bd17a4 | 2007 | The memory replacement policy parameter determines which |
2008 | objects are purged from memory when memory space is needed. | |
7f7db318 | 2009 | |
41bd17a4 | 2010 | See cache_replacement_policy for details. |
2011 | DOC_END | |
6b698a21 | 2012 | |
41bd17a4 | 2013 | COMMENT_START |
2014 | DISK CACHE OPTIONS | |
2015 | ----------------------------------------------------------------------------- | |
2016 | COMMENT_END | |
6b698a21 | 2017 | |
41bd17a4 | 2018 | NAME: cache_replacement_policy |
2019 | TYPE: removalpolicy | |
2020 | LOC: Config.replPolicy | |
2021 | DEFAULT: lru | |
2022 | DOC_START | |
2023 | The cache replacement policy parameter determines which | |
2024 | objects are evicted (replaced) when disk space is needed. | |
6b698a21 | 2025 | |
41bd17a4 | 2026 | lru : Squid's original list based LRU policy |
2027 | heap GDSF : Greedy-Dual Size Frequency | |
2028 | heap LFUDA: Least Frequently Used with Dynamic Aging | |
2029 | heap LRU : LRU policy implemented using a heap | |
6b698a21 | 2030 | |
41bd17a4 | 2031 | Applies to any cache_dir lines listed below this. |
7f7db318 | 2032 | |
41bd17a4 | 2033 | The LRU policies keeps recently referenced objects. |
0976f8db | 2034 | |
41bd17a4 | 2035 | The heap GDSF policy optimizes object hit rate by keeping smaller |
2036 | popular objects in cache so it has a better chance of getting a | |
2037 | hit. It achieves a lower byte hit rate than LFUDA though since | |
2038 | it evicts larger (possibly popular) objects. | |
0976f8db | 2039 | |
41bd17a4 | 2040 | The heap LFUDA policy keeps popular objects in cache regardless of |
2041 | their size and thus optimizes byte hit rate at the expense of | |
2042 | hit rate since one large, popular object will prevent many | |
2043 | smaller, slightly less popular objects from being cached. | |
0976f8db | 2044 | |
41bd17a4 | 2045 | Both policies utilize a dynamic aging mechanism that prevents |
2046 | cache pollution that can otherwise occur with frequency-based | |
2047 | replacement policies. | |
7d90757b | 2048 | |
41bd17a4 | 2049 | NOTE: if using the LFUDA replacement policy you should increase |
2050 | the value of maximum_object_size above its default of 4096 KB to | |
2051 | to maximize the potential byte hit rate improvement of LFUDA. | |
dc1af3cf | 2052 | |
41bd17a4 | 2053 | For more information about the GDSF and LFUDA cache replacement |
2054 | policies see http://www.hpl.hp.com/techreports/1999/HPL-1999-69.html | |
2055 | and http://fog.hpl.external.hp.com/techreports/98/HPL-98-173.html. | |
6b698a21 | 2056 | DOC_END |
0976f8db | 2057 | |
41bd17a4 | 2058 | NAME: cache_dir |
2059 | TYPE: cachedir | |
2060 | DEFAULT: none | |
41bd17a4 | 2061 | LOC: Config.cacheSwap |
6b698a21 | 2062 | DOC_START |
41bd17a4 | 2063 | Usage: |
0976f8db | 2064 | |
41bd17a4 | 2065 | cache_dir Type Directory-Name Fs-specific-data [options] |
0976f8db | 2066 | |
41bd17a4 | 2067 | You can specify multiple cache_dir lines to spread the |
2068 | cache among different disk partitions. | |
0976f8db | 2069 | |
41bd17a4 | 2070 | Type specifies the kind of storage system to use. Only "ufs" |
2071 | is built by default. To enable any of the other storage systems | |
2072 | see the --enable-storeio configure option. | |
0976f8db | 2073 | |
41bd17a4 | 2074 | 'Directory' is a top-level directory where cache swap |
2075 | files will be stored. If you want to use an entire disk | |
2076 | for caching, this can be the mount-point directory. | |
2077 | The directory must exist and be writable by the Squid | |
2078 | process. Squid will NOT create this directory for you. | |
0976f8db | 2079 | |
41bd17a4 | 2080 | The ufs store type: |
0976f8db | 2081 | |
41bd17a4 | 2082 | "ufs" is the old well-known Squid storage format that has always |
2083 | been there. | |
0976f8db | 2084 | |
41bd17a4 | 2085 | cache_dir ufs Directory-Name Mbytes L1 L2 [options] |
0976f8db | 2086 | |
41bd17a4 | 2087 | 'Mbytes' is the amount of disk space (MB) to use under this |
2088 | directory. The default is 100 MB. Change this to suit your | |
2089 | configuration. Do NOT put the size of your disk drive here. | |
2090 | Instead, if you want Squid to use the entire disk drive, | |
2091 | subtract 20% and use that value. | |
0976f8db | 2092 | |
41bd17a4 | 2093 | 'Level-1' is the number of first-level subdirectories which |
2094 | will be created under the 'Directory'. The default is 16. | |
0976f8db | 2095 | |
41bd17a4 | 2096 | 'Level-2' is the number of second-level subdirectories which |
2097 | will be created under each first-level directory. The default | |
2098 | is 256. | |
0976f8db | 2099 | |
41bd17a4 | 2100 | The aufs store type: |
7f7db318 | 2101 | |
41bd17a4 | 2102 | "aufs" uses the same storage format as "ufs", utilizing |
2103 | POSIX-threads to avoid blocking the main Squid process on | |
2104 | disk-I/O. This was formerly known in Squid as async-io. | |
38f9c547 | 2105 | |
41bd17a4 | 2106 | cache_dir aufs Directory-Name Mbytes L1 L2 [options] |
38f9c547 | 2107 | |
41bd17a4 | 2108 | see argument descriptions under ufs above |
38f9c547 | 2109 | |
41bd17a4 | 2110 | The diskd store type: |
38f9c547 | 2111 | |
41bd17a4 | 2112 | "diskd" uses the same storage format as "ufs", utilizing a |
2113 | separate process to avoid blocking the main Squid process on | |
2114 | disk-I/O. | |
4c3ef9b2 | 2115 | |
41bd17a4 | 2116 | cache_dir diskd Directory-Name Mbytes L1 L2 [options] [Q1=n] [Q2=n] |
0976f8db | 2117 | |
41bd17a4 | 2118 | see argument descriptions under ufs above |
0976f8db | 2119 | |
41bd17a4 | 2120 | Q1 specifies the number of unacknowledged I/O requests when Squid |
2121 | stops opening new files. If this many messages are in the queues, | |
2122 | Squid won't open new files. Default is 64 | |
0976f8db | 2123 | |
41bd17a4 | 2124 | Q2 specifies the number of unacknowledged messages when Squid |
2125 | starts blocking. If this many messages are in the queues, | |
2126 | Squid blocks until it receives some replies. Default is 72 | |
0976f8db | 2127 | |
41bd17a4 | 2128 | When Q1 < Q2 (the default), the cache directory is optimized |
2129 | for lower response time at the expense of a decrease in hit | |
2130 | ratio. If Q1 > Q2, the cache directory is optimized for | |
2131 | higher hit ratio at the expense of an increase in response | |
2132 | time. | |
0976f8db | 2133 | |
41bd17a4 | 2134 | The coss store type: |
0976f8db | 2135 | |
db263d62 AJ |
2136 | NP: COSS filesystem in Squid-3 has been deemed too unstable for |
2137 | production use and has thus been removed from this release. | |
2138 | We hope that it can be made usable again soon. | |
2139 | ||
41bd17a4 | 2140 | block-size=n defines the "block size" for COSS cache_dir's. |
2141 | Squid uses file numbers as block numbers. Since file numbers | |
2142 | are limited to 24 bits, the block size determines the maximum | |
2143 | size of the COSS partition. The default is 512 bytes, which | |
2144 | leads to a maximum cache_dir size of 512<<24, or 8 GB. Note | |
2145 | you should not change the coss block size after Squid | |
2146 | has written some objects to the cache_dir. | |
0976f8db | 2147 | |
41bd17a4 | 2148 | The coss file store has changed from 2.5. Now it uses a file |
2149 | called 'stripe' in the directory names in the config - and | |
2150 | this will be created by squid -z. | |
0976f8db | 2151 | |
41bd17a4 | 2152 | Common options: |
0976f8db | 2153 | |
41bd17a4 | 2154 | no-store, no new objects should be stored to this cache_dir |
0976f8db | 2155 | |
41bd17a4 | 2156 | max-size=n, refers to the max object size this storedir supports. |
2157 | It is used to initially choose the storedir to dump the object. | |
2158 | Note: To make optimal use of the max-size limits you should order | |
2159 | the cache_dir lines with the smallest max-size value first and the | |
2160 | ones with no max-size specification last. | |
0976f8db | 2161 | |
41bd17a4 | 2162 | Note for coss, max-size must be less than COSS_MEMBUF_SZ, |
2163 | which can be changed with the --with-coss-membuf-size=N configure | |
2164 | option. | |
bebc043b | 2165 | NOCOMMENT_START |
df2eec10 | 2166 | # cache_dir ufs @DEFAULT_SWAP_DIR@ 100 16 256 |
bebc043b | 2167 | NOCOMMENT_END |
6b698a21 | 2168 | DOC_END |
0976f8db | 2169 | |
41bd17a4 | 2170 | NAME: store_dir_select_algorithm |
2171 | TYPE: string | |
2172 | LOC: Config.store_dir_select_algorithm | |
2173 | DEFAULT: least-load | |
6b698a21 | 2174 | DOC_START |
41bd17a4 | 2175 | Set this to 'round-robin' as an alternative. |
6b698a21 | 2176 | DOC_END |
0976f8db | 2177 | |
41bd17a4 | 2178 | NAME: max_open_disk_fds |
2179 | TYPE: int | |
2180 | LOC: Config.max_open_disk_fds | |
2181 | DEFAULT: 0 | |
6b698a21 | 2182 | DOC_START |
41bd17a4 | 2183 | To avoid having disk as the I/O bottleneck Squid can optionally |
2184 | bypass the on-disk cache if more than this amount of disk file | |
2185 | descriptors are open. | |
2186 | ||
2187 | A value of 0 indicates no limit. | |
6b698a21 | 2188 | DOC_END |
0976f8db | 2189 | |
41bd17a4 | 2190 | NAME: minimum_object_size |
6b698a21 | 2191 | COMMENT: (bytes) |
47f6e231 | 2192 | TYPE: b_int64_t |
6b698a21 | 2193 | DEFAULT: 0 KB |
41bd17a4 | 2194 | LOC: Config.Store.minObjectSize |
6b698a21 | 2195 | DOC_START |
41bd17a4 | 2196 | Objects smaller than this size will NOT be saved on disk. The |
2197 | value is specified in kilobytes, and the default is 0 KB, which | |
2198 | means there is no minimum. | |
6b698a21 | 2199 | DOC_END |
0976f8db | 2200 | |
41bd17a4 | 2201 | NAME: maximum_object_size |
2202 | COMMENT: (bytes) | |
2203 | TYPE: b_int64_t | |
2204 | DEFAULT: 4096 KB | |
2205 | LOC: Config.Store.maxObjectSize | |
777831e0 | 2206 | DOC_START |
41bd17a4 | 2207 | Objects larger than this size will NOT be saved on disk. The |
2208 | value is specified in kilobytes, and the default is 4MB. If | |
2209 | you wish to get a high BYTES hit ratio, you should probably | |
2210 | increase this (one 32 MB object hit counts for 3200 10KB | |
2211 | hits). If you wish to increase speed more than your want to | |
2212 | save bandwidth you should leave this low. | |
777831e0 | 2213 | |
41bd17a4 | 2214 | NOTE: if using the LFUDA replacement policy you should increase |
2215 | this value to maximize the byte hit rate improvement of LFUDA! | |
2216 | See replacement_policy below for a discussion of this policy. | |
6b698a21 | 2217 | DOC_END |
0976f8db | 2218 | |
41bd17a4 | 2219 | NAME: cache_swap_low |
2220 | COMMENT: (percent, 0-100) | |
5473c134 | 2221 | TYPE: int |
41bd17a4 | 2222 | DEFAULT: 90 |
2223 | LOC: Config.Swap.lowWaterMark | |
2224 | DOC_NONE | |
2225 | ||
2226 | NAME: cache_swap_high | |
2227 | COMMENT: (percent, 0-100) | |
2228 | TYPE: int | |
2229 | DEFAULT: 95 | |
2230 | LOC: Config.Swap.highWaterMark | |
6b698a21 | 2231 | DOC_START |
41bd17a4 | 2232 | |
2233 | The low- and high-water marks for cache object replacement. | |
2234 | Replacement begins when the swap (disk) usage is above the | |
2235 | low-water mark and attempts to maintain utilization near the | |
2236 | low-water mark. As swap utilization gets close to high-water | |
2237 | mark object eviction becomes more aggressive. If utilization is | |
2238 | close to the low-water mark less replacement is done each time. | |
2239 | ||
2240 | Defaults are 90% and 95%. If you have a large cache, 5% could be | |
2241 | hundreds of MB. If this is the case you may wish to set these | |
2242 | numbers closer together. | |
6b698a21 | 2243 | DOC_END |
0976f8db | 2244 | |
5473c134 | 2245 | COMMENT_START |
41bd17a4 | 2246 | LOGFILE OPTIONS |
5473c134 | 2247 | ----------------------------------------------------------------------------- |
2248 | COMMENT_END | |
0976f8db | 2249 | |
41bd17a4 | 2250 | NAME: logformat |
2251 | TYPE: logformat | |
2252 | LOC: Config.Log.logformats | |
5473c134 | 2253 | DEFAULT: none |
6b698a21 | 2254 | DOC_START |
41bd17a4 | 2255 | Usage: |
0976f8db | 2256 | |
41bd17a4 | 2257 | logformat <name> <format specification> |
0976f8db | 2258 | |
41bd17a4 | 2259 | Defines an access log format. |
6b698a21 | 2260 | |
41bd17a4 | 2261 | The <format specification> is a string with embedded % format codes |
5473c134 | 2262 | |
41bd17a4 | 2263 | % format codes all follow the same basic structure where all but |
2264 | the formatcode is optional. Output strings are automatically escaped | |
2265 | as required according to their context and the output format | |
2266 | modifiers are usually not needed, but can be specified if an explicit | |
2267 | output format is desired. | |
6b698a21 | 2268 | |
41bd17a4 | 2269 | % ["|[|'|#] [-] [[0]width] [{argument}] formatcode |
0976f8db | 2270 | |
41bd17a4 | 2271 | " output in quoted string format |
2272 | [ output in squid text log format as used by log_mime_hdrs | |
2273 | # output in URL quoted format | |
2274 | ' output as-is | |
5473c134 | 2275 | |
41bd17a4 | 2276 | - left aligned |
2277 | width field width. If starting with 0 the | |
2278 | output is zero padded | |
2279 | {arg} argument such as header name etc | |
5473c134 | 2280 | |
41bd17a4 | 2281 | Format codes: |
5473c134 | 2282 | |
41bd17a4 | 2283 | >a Client source IP address |
2284 | >A Client FQDN | |
2285 | >p Client source port | |
2286 | <A Server IP address or peer name | |
2287 | la Local IP address (http_port) | |
2288 | lp Local port number (http_port) | |
2289 | ts Seconds since epoch | |
2290 | tu subsecond time (milliseconds) | |
2291 | tl Local time. Optional strftime format argument | |
2292 | default %d/%b/%Y:%H:%M:%S %z | |
2293 | tg GMT time. Optional strftime format argument | |
2294 | default %d/%b/%Y:%H:%M:%S %z | |
2295 | tr Response time (milliseconds) | |
2296 | >h Request header. Optional header name argument | |
2297 | on the format header[:[separator]element] | |
2298 | <h Reply header. Optional header name argument | |
2299 | as for >h | |
2300 | un User name | |
2301 | ul User name from authentication | |
2302 | ui User name from ident | |
2303 | us User name from SSL | |
2304 | ue User name from external acl helper | |
2305 | Hs HTTP status code | |
2306 | Ss Squid request status (TCP_MISS etc) | |
2307 | Sh Squid hierarchy status (DEFAULT_PARENT etc) | |
2308 | mt MIME content type | |
2309 | rm Request method (GET/POST etc) | |
2310 | ru Request URL | |
2311 | rp Request URL-Path excluding hostname | |
2312 | rv Request protocol version | |
2313 | et Tag returned by external acl | |
2314 | ea Log string returned by external acl | |
2315 | <st Reply size including HTTP headers | |
1a86db31 AJ |
2316 | >st Request size including HTTP headers |
2317 | st Request+Reply size including HTTP headers | |
41bd17a4 | 2318 | <sH Reply high offset sent |
2319 | <sS Upstream object size | |
2320 | % a literal % character | |
5473c134 | 2321 | |
7d9acc3c AJ |
2322 | The default formats available (which do not need re-defining) are: |
2323 | ||
2324 | logformat squid %ts.%03tu %6tr %>a %Ss/%03Hs %<st %rm %ru %un %Sh/%<A %mt | |
2325 | logformat squidmime %ts.%03tu %6tr %>a %Ss/%03Hs %<st %rm %ru %un %Sh/%<A %mt [%>h] [%<h] | |
41bd17a4 | 2326 | logformat common %>a %ui %un [%tl] "%rm %ru HTTP/%rv" %Hs %<st %Ss:%Sh |
2327 | logformat combined %>a %ui %un [%tl] "%rm %ru HTTP/%rv" %Hs %<st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh | |
5473c134 | 2328 | DOC_END |
2329 | ||
41bd17a4 | 2330 | NAME: access_log cache_access_log |
2331 | TYPE: access_log | |
2332 | LOC: Config.Log.accesslogs | |
02424612 | 2333 | DEFAULT: none |
01ddaf65 | 2334 | DEFAULT_IF_NONE: @DEFAULT_ACCESS_LOG@ squid |
5473c134 | 2335 | DOC_START |
41bd17a4 | 2336 | These files log client request activities. Has a line every HTTP or |
2337 | ICP request. The format is: | |
2338 | access_log <filepath> [<logformat name> [acl acl ...]] | |
2339 | access_log none [acl acl ...]] | |
5473c134 | 2340 | |
41bd17a4 | 2341 | Will log to the specified file using the specified format (which |
2342 | must be defined in a logformat directive) those entries which match | |
2343 | ALL the acl's specified (which must be defined in acl clauses). | |
2344 | If no acl is specified, all requests will be logged to this file. | |
5473c134 | 2345 | |
41bd17a4 | 2346 | To disable logging of a request use the filepath "none", in which case |
2347 | a logformat name should not be specified. | |
5473c134 | 2348 | |
41bd17a4 | 2349 | To log the request via syslog specify a filepath of "syslog": |
5473c134 | 2350 | |
41bd17a4 | 2351 | access_log syslog[:facility.priority] [format [acl1 [acl2 ....]]] |
2352 | where facility could be any of: | |
2353 | authpriv, daemon, local0 .. local7 or user. | |
5473c134 | 2354 | |
41bd17a4 | 2355 | And priority could be any of: |
2356 | err, warning, notice, info, debug. | |
df2eec10 AJ |
2357 | |
2358 | Default: | |
2359 | access_log @DEFAULT_ACCESS_LOG@ squid | |
41bd17a4 | 2360 | DOC_END |
5473c134 | 2361 | |
5b0f5383 | 2362 | NAME: log_access |
2363 | TYPE: acl_access | |
2364 | LOC: Config.accessList.log | |
2365 | DEFAULT: none | |
2366 | COMMENT: allow|deny acl acl... | |
2367 | DOC_START | |
2368 | This options allows you to control which requests gets logged | |
2369 | to access.log (see access_log directive). Requests denied for | |
2370 | logging will also not be accounted for in performance counters. | |
2371 | DOC_END | |
2372 | ||
41bd17a4 | 2373 | NAME: cache_log |
2374 | TYPE: string | |
02424612 | 2375 | DEFAULT: none |
01ddaf65 | 2376 | DEFAULT_IF_NONE: @DEFAULT_CACHE_LOG@ |
41bd17a4 | 2377 | LOC: Config.Log.log |
2378 | DOC_START | |
2379 | Cache logging file. This is where general information about | |
2380 | your cache's behavior goes. You can increase the amount of data | |
2381 | logged to this file with the "debug_options" tag below. | |
2382 | DOC_END | |
5473c134 | 2383 | |
41bd17a4 | 2384 | NAME: cache_store_log |
2385 | TYPE: string | |
df2eec10 | 2386 | DEFAULT: none |
41bd17a4 | 2387 | LOC: Config.Log.store |
2388 | DOC_START | |
2389 | Logs the activities of the storage manager. Shows which | |
2390 | objects are ejected from the cache, and which objects are | |
df2eec10 AJ |
2391 | saved and for how long. To disable, enter "none" or remove the line. |
2392 | There are not really utilities to analyze this data, so you can safely | |
41bd17a4 | 2393 | disable it. |
df2eec10 AJ |
2394 | NOCOMMENT_START |
2395 | # cache_store_log @DEFAULT_STORE_LOG@ | |
2396 | NOCOMMENT_END | |
5473c134 | 2397 | DOC_END |
2398 | ||
41bd17a4 | 2399 | NAME: cache_swap_state cache_swap_log |
2400 | TYPE: string | |
2401 | LOC: Config.Log.swap | |
5473c134 | 2402 | DEFAULT: none |
2403 | DOC_START | |
41bd17a4 | 2404 | Location for the cache "swap.state" file. This index file holds |
2405 | the metadata of objects saved on disk. It is used to rebuild | |
2406 | the cache during startup. Normally this file resides in each | |
2407 | 'cache_dir' directory, but you may specify an alternate | |
2408 | pathname here. Note you must give a full filename, not just | |
2409 | a directory. Since this is the index for the whole object | |
2410 | list you CANNOT periodically rotate it! | |
5473c134 | 2411 | |
41bd17a4 | 2412 | If %s can be used in the file name it will be replaced with a |
2413 | a representation of the cache_dir name where each / is replaced | |
2414 | with '.'. This is needed to allow adding/removing cache_dir | |
2415 | lines when cache_swap_log is being used. | |
5473c134 | 2416 | |
41bd17a4 | 2417 | If have more than one 'cache_dir', and %s is not used in the name |
2418 | these swap logs will have names such as: | |
5473c134 | 2419 | |
41bd17a4 | 2420 | cache_swap_log.00 |
2421 | cache_swap_log.01 | |
2422 | cache_swap_log.02 | |
5473c134 | 2423 | |
41bd17a4 | 2424 | The numbered extension (which is added automatically) |
2425 | corresponds to the order of the 'cache_dir' lines in this | |
2426 | configuration file. If you change the order of the 'cache_dir' | |
2427 | lines in this file, these index files will NOT correspond to | |
2428 | the correct 'cache_dir' entry (unless you manually rename | |
2429 | them). We recommend you do NOT use this option. It is | |
2430 | better to keep these index files in each 'cache_dir' directory. | |
5473c134 | 2431 | DOC_END |
2432 | ||
41bd17a4 | 2433 | NAME: logfile_rotate |
2434 | TYPE: int | |
2435 | DEFAULT: 10 | |
2436 | LOC: Config.Log.rotateNumber | |
5473c134 | 2437 | DOC_START |
41bd17a4 | 2438 | Specifies the number of logfile rotations to make when you |
2439 | type 'squid -k rotate'. The default is 10, which will rotate | |
2440 | with extensions 0 through 9. Setting logfile_rotate to 0 will | |
2441 | disable the file name rotation, but the logfiles are still closed | |
2442 | and re-opened. This will enable you to rename the logfiles | |
2443 | yourself just before sending the rotate signal. | |
5473c134 | 2444 | |
41bd17a4 | 2445 | Note, the 'squid -k rotate' command normally sends a USR1 |
2446 | signal to the running squid process. In certain situations | |
2447 | (e.g. on Linux with Async I/O), USR1 is used for other | |
2448 | purposes, so -k rotate uses another signal. It is best to get | |
2449 | in the habit of using 'squid -k rotate' instead of 'kill -USR1 | |
2450 | <pid>'. | |
2451 | DOC_END | |
5473c134 | 2452 | |
41bd17a4 | 2453 | NAME: emulate_httpd_log |
2454 | COMMENT: on|off | |
2455 | TYPE: onoff | |
2456 | DEFAULT: off | |
2457 | LOC: Config.onoff.common_log | |
2458 | DOC_START | |
2459 | The Cache can emulate the log file format which many 'httpd' | |
2460 | programs use. To disable/enable this emulation, set | |
2461 | emulate_httpd_log to 'off' or 'on'. The default | |
2462 | is to use the native log format since it includes useful | |
2463 | information Squid-specific log analyzers use. | |
5473c134 | 2464 | DOC_END |
2465 | ||
41bd17a4 | 2466 | NAME: log_ip_on_direct |
2467 | COMMENT: on|off | |
2468 | TYPE: onoff | |
5473c134 | 2469 | DEFAULT: on |
41bd17a4 | 2470 | LOC: Config.onoff.log_ip_on_direct |
5473c134 | 2471 | DOC_START |
41bd17a4 | 2472 | Log the destination IP address in the hierarchy log tag when going |
2473 | direct. Earlier Squid versions logged the hostname here. If you | |
2474 | prefer the old way set this to off. | |
2475 | DOC_END | |
5473c134 | 2476 | |
41bd17a4 | 2477 | NAME: mime_table |
2478 | TYPE: string | |
2479 | DEFAULT: @DEFAULT_MIME_TABLE@ | |
2480 | LOC: Config.mimeTablePathname | |
2481 | DOC_START | |
2482 | Pathname to Squid's MIME table. You shouldn't need to change | |
2483 | this, but the default file contains examples and formatting | |
2484 | information if you do. | |
5473c134 | 2485 | DOC_END |
2486 | ||
41bd17a4 | 2487 | NAME: log_mime_hdrs |
2488 | COMMENT: on|off | |
2489 | TYPE: onoff | |
2490 | LOC: Config.onoff.log_mime_hdrs | |
2491 | DEFAULT: off | |
2492 | DOC_START | |
2493 | The Cache can record both the request and the response MIME | |
2494 | headers for each HTTP transaction. The headers are encoded | |
2495 | safely and will appear as two bracketed fields at the end of | |
2496 | the access log (for either the native or httpd-emulated log | |
2497 | formats). To enable this logging set log_mime_hdrs to 'on'. | |
2498 | DOC_END | |
5473c134 | 2499 | |
41bd17a4 | 2500 | NAME: useragent_log |
2501 | TYPE: string | |
2502 | LOC: Config.Log.useragent | |
2503 | DEFAULT: none | |
2504 | IFDEF: USE_USERAGENT_LOG | |
5473c134 | 2505 | DOC_START |
41bd17a4 | 2506 | Squid will write the User-Agent field from HTTP requests |
2507 | to the filename specified here. By default useragent_log | |
2508 | is disabled. | |
5473c134 | 2509 | DOC_END |
2510 | ||
41bd17a4 | 2511 | NAME: referer_log referrer_log |
2512 | TYPE: string | |
2513 | LOC: Config.Log.referer | |
2514 | DEFAULT: none | |
2515 | IFDEF: USE_REFERER_LOG | |
5473c134 | 2516 | DOC_START |
41bd17a4 | 2517 | Squid will write the Referer field from HTTP requests to the |
2518 | filename specified here. By default referer_log is disabled. | |
2519 | Note that "referer" is actually a misspelling of "referrer" | |
2520 | however the misspelt version has been accepted into the HTTP RFCs | |
2521 | and we accept both. | |
5473c134 | 2522 | DOC_END |
2523 | ||
41bd17a4 | 2524 | NAME: pid_filename |
2525 | TYPE: string | |
2526 | DEFAULT: @DEFAULT_PID_FILE@ | |
2527 | LOC: Config.pidFilename | |
5473c134 | 2528 | DOC_START |
41bd17a4 | 2529 | A filename to write the process-id to. To disable, enter "none". |
5473c134 | 2530 | DOC_END |
2531 | ||
41bd17a4 | 2532 | NAME: debug_options |
fb6a61d1 | 2533 | TYPE: eol |
41bd17a4 | 2534 | DEFAULT: ALL,1 |
2535 | LOC: Config.debugOptions | |
5473c134 | 2536 | DOC_START |
41bd17a4 | 2537 | Logging options are set as section,level where each source file |
2538 | is assigned a unique section. Lower levels result in less | |
2539 | output, Full debugging (level 9) can result in a very large | |
2540 | log file, so be careful. The magic word "ALL" sets debugging | |
2541 | levels for all sections. We recommend normally running with | |
2542 | "ALL,1". | |
5473c134 | 2543 | DOC_END |
2544 | ||
41bd17a4 | 2545 | NAME: log_fqdn |
2546 | COMMENT: on|off | |
2547 | TYPE: onoff | |
2548 | DEFAULT: off | |
2549 | LOC: Config.onoff.log_fqdn | |
5473c134 | 2550 | DOC_START |
41bd17a4 | 2551 | Turn this on if you wish to log fully qualified domain names |
2552 | in the access.log. To do this Squid does a DNS lookup of all | |
2553 | IP's connecting to it. This can (in some situations) increase | |
2554 | latency, which makes your cache seem slower for interactive | |
2555 | browsing. | |
5473c134 | 2556 | DOC_END |
2557 | ||
41bd17a4 | 2558 | NAME: client_netmask |
2559 | TYPE: address | |
2560 | LOC: Config.Addrs.client_netmask | |
2561 | DEFAULT: 255.255.255.255 | |
5473c134 | 2562 | DOC_START |
41bd17a4 | 2563 | A netmask for client addresses in logfiles and cachemgr output. |
2564 | Change this to protect the privacy of your cache clients. | |
2565 | A netmask of 255.255.255.0 will log all IP's in that range with | |
2566 | the last digit set to '0'. | |
5473c134 | 2567 | DOC_END |
2568 | ||
41bd17a4 | 2569 | NAME: forward_log |
2570 | IFDEF: WIP_FWD_LOG | |
2571 | TYPE: string | |
2572 | DEFAULT: none | |
2573 | LOC: Config.Log.forward | |
5473c134 | 2574 | DOC_START |
41bd17a4 | 2575 | Logs the server-side requests. |
5473c134 | 2576 | |
41bd17a4 | 2577 | This is currently work in progress. |
5473c134 | 2578 | DOC_END |
2579 | ||
41bd17a4 | 2580 | NAME: strip_query_terms |
5473c134 | 2581 | TYPE: onoff |
41bd17a4 | 2582 | LOC: Config.onoff.strip_query_terms |
5473c134 | 2583 | DEFAULT: on |
2584 | DOC_START | |
41bd17a4 | 2585 | By default, Squid strips query terms from requested URLs before |
2586 | logging. This protects your user's privacy. | |
5473c134 | 2587 | DOC_END |
2588 | ||
41bd17a4 | 2589 | NAME: buffered_logs |
2590 | COMMENT: on|off | |
2591 | TYPE: onoff | |
2592 | DEFAULT: off | |
2593 | LOC: Config.onoff.buffered_logs | |
5473c134 | 2594 | DOC_START |
41bd17a4 | 2595 | cache.log log file is written with stdio functions, and as such |
2596 | it can be buffered or unbuffered. By default it will be unbuffered. | |
2597 | Buffering it can speed up the writing slightly (though you are | |
2598 | unlikely to need to worry unless you run with tons of debugging | |
2599 | enabled in which case performance will suffer badly anyway..). | |
6b698a21 | 2600 | DOC_END |
0976f8db | 2601 | |
2b753521 | 2602 | NAME: netdb_filename |
2603 | TYPE: string | |
2604 | DEFAULT: @DEFAULT_NETDB_FILE@ | |
2605 | LOC: Config.netdbFilename | |
fb6a61d1 | 2606 | IFDEF: USE_ICMP |
2b753521 | 2607 | DOC_START |
2608 | A filename where Squid stores it's netdb state between restarts. | |
2609 | To disable, enter "none". | |
2610 | DOC_END | |
2611 | ||
41bd17a4 | 2612 | COMMENT_START |
2613 | OPTIONS FOR FTP GATEWAYING | |
2614 | ----------------------------------------------------------------------------- | |
2615 | COMMENT_END | |
2616 | ||
2617 | NAME: ftp_user | |
2618 | TYPE: string | |
2619 | DEFAULT: Squid@ | |
2620 | LOC: Config.Ftp.anon_user | |
6b698a21 | 2621 | DOC_START |
41bd17a4 | 2622 | If you want the anonymous login password to be more informative |
2623 | (and enable the use of picky ftp servers), set this to something | |
2624 | reasonable for your domain, like wwwuser@somewhere.net | |
7f7db318 | 2625 | |
41bd17a4 | 2626 | The reason why this is domainless by default is the |
2627 | request can be made on the behalf of a user in any domain, | |
2628 | depending on how the cache is used. | |
2629 | Some ftp server also validate the email address is valid | |
2630 | (for example perl.com). | |
6b698a21 | 2631 | DOC_END |
0976f8db | 2632 | |
41bd17a4 | 2633 | NAME: ftp_list_width |
2634 | TYPE: size_t | |
2635 | DEFAULT: 32 | |
2636 | LOC: Config.Ftp.list_width | |
6b698a21 | 2637 | DOC_START |
41bd17a4 | 2638 | Sets the width of ftp listings. This should be set to fit in |
2639 | the width of a standard browser. Setting this too small | |
2640 | can cut off long filenames when browsing ftp sites. | |
6b698a21 | 2641 | DOC_END |
9e7dbc51 | 2642 | |
41bd17a4 | 2643 | NAME: ftp_passive |
2644 | TYPE: onoff | |
2645 | DEFAULT: on | |
2646 | LOC: Config.Ftp.passive | |
6b698a21 | 2647 | DOC_START |
41bd17a4 | 2648 | If your firewall does not allow Squid to use passive |
2649 | connections, turn off this option. | |
a689bd4e | 2650 | |
2651 | Use of ftp_epsv_all option requires this to be ON. | |
2652 | DOC_END | |
2653 | ||
2654 | NAME: ftp_epsv_all | |
2655 | TYPE: onoff | |
2656 | DEFAULT: off | |
2657 | LOC: Config.Ftp.epsv_all | |
2658 | DOC_START | |
2659 | FTP Protocol extensions permit the use of a special "EPSV ALL" command. | |
2660 | ||
2661 | NATs may be able to put the connection on a "fast path" through the | |
2662 | translator, as the EPRT command will never be used and therefore, | |
2663 | translation of the data portion of the segments will never be needed. | |
2664 | ||
2665 | When a client only expects to do two-way FTP transfers this may be useful. | |
2666 | If squid finds that it must do a three-way FTP transfer after issuing | |
2667 | an EPSV ALL command, the FTP session will fail. | |
2668 | ||
2669 | If you have any doubts about this option do not use it. | |
2670 | Squid will nicely attempt all other connection methods. | |
2671 | ||
2672 | Requires ftp_passive to be ON (default) | |
41bd17a4 | 2673 | DOC_END |
9e7dbc51 | 2674 | |
41bd17a4 | 2675 | NAME: ftp_sanitycheck |
2676 | TYPE: onoff | |
2677 | DEFAULT: on | |
2678 | LOC: Config.Ftp.sanitycheck | |
2679 | DOC_START | |
2680 | For security and data integrity reasons Squid by default performs | |
2681 | sanity checks of the addresses of FTP data connections ensure the | |
2682 | data connection is to the requested server. If you need to allow | |
2683 | FTP connections to servers using another IP address for the data | |
2684 | connection turn this off. | |
2685 | DOC_END | |
9e7dbc51 | 2686 | |
41bd17a4 | 2687 | NAME: ftp_telnet_protocol |
2688 | TYPE: onoff | |
2689 | DEFAULT: on | |
2690 | LOC: Config.Ftp.telnet | |
2691 | DOC_START | |
2692 | The FTP protocol is officially defined to use the telnet protocol | |
2693 | as transport channel for the control connection. However, many | |
2694 | implementations are broken and does not respect this aspect of | |
2695 | the FTP protocol. | |
2696 | ||
2697 | If you have trouble accessing files with ASCII code 255 in the | |
2698 | path or similar problems involving this ASCII code you can | |
2699 | try setting this directive to off. If that helps, report to the | |
2700 | operator of the FTP server in question that their FTP server | |
2701 | is broken and does not follow the FTP standard. | |
2702 | DOC_END | |
2703 | ||
2704 | COMMENT_START | |
2705 | OPTIONS FOR EXTERNAL SUPPORT PROGRAMS | |
2706 | ----------------------------------------------------------------------------- | |
2707 | COMMENT_END | |
2708 | ||
2709 | NAME: diskd_program | |
2710 | TYPE: string | |
2711 | DEFAULT: @DEFAULT_DISKD@ | |
2712 | LOC: Config.Program.diskd | |
2713 | DOC_START | |
2714 | Specify the location of the diskd executable. | |
2715 | Note this is only useful if you have compiled in | |
2716 | diskd as one of the store io modules. | |
2717 | DOC_END | |
2718 | ||
2719 | NAME: unlinkd_program | |
2720 | IFDEF: USE_UNLINKD | |
2721 | TYPE: string | |
2722 | DEFAULT: @DEFAULT_UNLINKD@ | |
2723 | LOC: Config.Program.unlinkd | |
2724 | DOC_START | |
2725 | Specify the location of the executable for file deletion process. | |
2726 | DOC_END | |
2727 | ||
2728 | NAME: pinger_program | |
2729 | TYPE: string | |
2730 | DEFAULT: @DEFAULT_PINGER@ | |
cc192b50 | 2731 | LOC: Config.pinger.program |
41bd17a4 | 2732 | IFDEF: USE_ICMP |
2733 | DOC_START | |
2734 | Specify the location of the executable for the pinger process. | |
2735 | DOC_END | |
2736 | ||
cc192b50 | 2737 | NAME: pinger_enable |
2738 | TYPE: onoff | |
2739 | DEFAULT: on | |
2740 | LOC: Config.pinger.enable | |
2741 | IFDEF: USE_ICMP | |
2742 | DOC_START | |
2743 | Control whether the pinger is active at run-time. | |
2744 | Enables turning ICMP pinger on and off with a simple squid -k reconfigure. | |
2745 | DOC_END | |
2746 | ||
2747 | ||
41bd17a4 | 2748 | COMMENT_START |
2749 | OPTIONS FOR URL REWRITING | |
2750 | ----------------------------------------------------------------------------- | |
2751 | COMMENT_END | |
2752 | ||
2753 | NAME: url_rewrite_program redirect_program | |
2754 | TYPE: wordlist | |
2755 | LOC: Config.Program.redirect | |
2756 | DEFAULT: none | |
2757 | DOC_START | |
2758 | Specify the location of the executable for the URL rewriter. | |
2759 | Since they can perform almost any function there isn't one included. | |
2760 | ||
2761 | For each requested URL rewriter will receive on line with the format | |
2762 | ||
c71adec1 | 2763 | URL <SP> client_ip "/" fqdn <SP> user <SP> method [<SP> kvpairs]<NL> |
2764 | ||
2765 | In the future, the rewriter interface will be extended with | |
2766 | key=value pairs ("kvpairs" shown above). Rewriter programs | |
2767 | should be prepared to receive and possibly ignore additional | |
2768 | whitespace-separated tokens on each input line. | |
41bd17a4 | 2769 | |
2770 | And the rewriter may return a rewritten URL. The other components of | |
2771 | the request line does not need to be returned (ignored if they are). | |
2772 | ||
2773 | The rewriter can also indicate that a client-side redirect should | |
2774 | be performed to the new URL. This is done by prefixing the returned | |
2775 | URL with "301:" (moved permanently) or 302: (moved temporarily). | |
2776 | ||
2777 | By default, a URL rewriter is not used. | |
2778 | DOC_END | |
2779 | ||
2780 | NAME: url_rewrite_children redirect_children | |
2781 | TYPE: int | |
2782 | DEFAULT: 5 | |
2783 | LOC: Config.redirectChildren | |
2784 | DOC_START | |
2785 | The number of redirector processes to spawn. If you start | |
2786 | too few Squid will have to wait for them to process a backlog of | |
2787 | URLs, slowing it down. If you start too many they will use RAM | |
2788 | and other system resources. | |
2789 | DOC_END | |
2790 | ||
2791 | NAME: url_rewrite_concurrency redirect_concurrency | |
2792 | TYPE: int | |
2793 | DEFAULT: 0 | |
2794 | LOC: Config.redirectConcurrency | |
2795 | DOC_START | |
2796 | The number of requests each redirector helper can handle in | |
2797 | parallel. Defaults to 0 which indicates the redirector | |
2798 | is a old-style single threaded redirector. | |
6a171502 AJ |
2799 | |
2800 | When this directive is set to a value >= 1 then the protocol | |
2801 | used to communicate with the helper is modified to include | |
2802 | a request ID in front of the request/response. The request | |
2803 | ID from the request must be echoed back with the response | |
2804 | to that request. | |
41bd17a4 | 2805 | DOC_END |
2806 | ||
2807 | NAME: url_rewrite_host_header redirect_rewrites_host_header | |
2808 | TYPE: onoff | |
2809 | DEFAULT: on | |
2810 | LOC: Config.onoff.redir_rewrites_host | |
2811 | DOC_START | |
2812 | By default Squid rewrites any Host: header in redirected | |
2813 | requests. If you are running an accelerator this may | |
2814 | not be a wanted effect of a redirector. | |
2815 | ||
2816 | WARNING: Entries are cached on the result of the URL rewriting | |
2817 | process, so be careful if you have domain-virtual hosts. | |
2818 | DOC_END | |
2819 | ||
2820 | NAME: url_rewrite_access redirector_access | |
2821 | TYPE: acl_access | |
2822 | DEFAULT: none | |
2823 | LOC: Config.accessList.redirector | |
2824 | DOC_START | |
2825 | If defined, this access list specifies which requests are | |
2826 | sent to the redirector processes. By default all requests | |
2827 | are sent. | |
2828 | DOC_END | |
2829 | ||
2830 | NAME: url_rewrite_bypass redirector_bypass | |
2831 | TYPE: onoff | |
2832 | LOC: Config.onoff.redirector_bypass | |
2833 | DEFAULT: off | |
2834 | DOC_START | |
2835 | When this is 'on', a request will not go through the | |
2836 | redirector if all redirectors are busy. If this is 'off' | |
2837 | and the redirector queue grows too large, Squid will exit | |
2838 | with a FATAL error and ask you to increase the number of | |
2839 | redirectors. You should only enable this if the redirectors | |
2840 | are not critical to your caching system. If you use | |
2841 | redirectors for access control, and you enable this option, | |
2842 | users may have access to pages they should not | |
2843 | be allowed to request. | |
2844 | DOC_END | |
2845 | ||
2846 | COMMENT_START | |
2847 | OPTIONS FOR TUNING THE CACHE | |
2848 | ----------------------------------------------------------------------------- | |
2849 | COMMENT_END | |
2850 | ||
f04b37d8 | 2851 | NAME: cache no_cache |
2852 | TYPE: acl_access | |
2853 | DEFAULT: none | |
2854 | LOC: Config.accessList.noCache | |
41bd17a4 | 2855 | DOC_START |
240887f0 | 2856 | A list of ACL elements which, if matched and denied, cause the request to |
f04b37d8 | 2857 | not be satisfied from the cache and the reply to not be cached. |
2858 | In other words, use this to force certain objects to never be cached. | |
41bd17a4 | 2859 | |
240887f0 | 2860 | You must use the words 'allow' or 'deny' to indicate whether items |
2861 | matching the ACL should be allowed or denied into the cache. | |
f04b37d8 | 2862 | |
240887f0 | 2863 | Default is to allow all to be cached. |
41bd17a4 | 2864 | DOC_END |
2865 | ||
2866 | NAME: refresh_pattern | |
2867 | TYPE: refreshpattern | |
2868 | LOC: Config.Refresh | |
2869 | DEFAULT: none | |
2870 | DOC_START | |
2871 | usage: refresh_pattern [-i] regex min percent max [options] | |
9e7dbc51 | 2872 | |
6b698a21 | 2873 | By default, regular expressions are CASE-SENSITIVE. To make |
2874 | them case-insensitive, use the -i option. | |
9e7dbc51 | 2875 | |
41bd17a4 | 2876 | 'Min' is the time (in minutes) an object without an explicit |
2877 | expiry time should be considered fresh. The recommended | |
2878 | value is 0, any higher values may cause dynamic applications | |
2879 | to be erroneously cached unless the application designer | |
2880 | has taken the appropriate actions. | |
9e7dbc51 | 2881 | |
41bd17a4 | 2882 | 'Percent' is a percentage of the objects age (time since last |
2883 | modification age) an object without explicit expiry time | |
2884 | will be considered fresh. | |
5b807763 | 2885 | |
41bd17a4 | 2886 | 'Max' is an upper limit on how long objects without an explicit |
2887 | expiry time will be considered fresh. | |
9e7dbc51 | 2888 | |
41bd17a4 | 2889 | options: override-expire |
2890 | override-lastmod | |
2891 | reload-into-ims | |
2892 | ignore-reload | |
2893 | ignore-no-cache | |
2894 | ignore-no-store | |
2895 | ignore-private | |
2896 | ignore-auth | |
2897 | refresh-ims | |
a0ec9f68 | 2898 | |
41bd17a4 | 2899 | override-expire enforces min age even if the server |
9b2ad080 HN |
2900 | sent an explicit expiry time (e.g., with the |
2901 | Expires: header or Cache-Control: max-age). Doing this | |
2902 | VIOLATES the HTTP standard. Enabling this feature | |
2903 | could make you liable for problems which it causes. | |
6468fe10 | 2904 | |
41bd17a4 | 2905 | override-lastmod enforces min age even on objects |
2906 | that were modified recently. | |
934b03fc | 2907 | |
41bd17a4 | 2908 | reload-into-ims changes client no-cache or ``reload'' |
2909 | to If-Modified-Since requests. Doing this VIOLATES the | |
2910 | HTTP standard. Enabling this feature could make you | |
2911 | liable for problems which it causes. | |
dba79ac5 | 2912 | |
41bd17a4 | 2913 | ignore-reload ignores a client no-cache or ``reload'' |
2914 | header. Doing this VIOLATES the HTTP standard. Enabling | |
2915 | this feature could make you liable for problems which | |
2916 | it causes. | |
9bc73deb | 2917 | |
41bd17a4 | 2918 | ignore-no-cache ignores any ``Pragma: no-cache'' and |
2919 | ``Cache-control: no-cache'' headers received from a server. | |
2920 | The HTTP RFC never allows the use of this (Pragma) header | |
2921 | from a server, only a client, though plenty of servers | |
2922 | send it anyway. | |
2923 | ||
2924 | ignore-no-store ignores any ``Cache-control: no-store'' | |
2925 | headers received from a server. Doing this VIOLATES | |
2926 | the HTTP standard. Enabling this feature could make you | |
2927 | liable for problems which it causes. | |
2928 | ||
2929 | ignore-private ignores any ``Cache-control: private'' | |
2930 | headers received from a server. Doing this VIOLATES | |
2931 | the HTTP standard. Enabling this feature could make you | |
2932 | liable for problems which it causes. | |
2933 | ||
2934 | ignore-auth caches responses to requests with authorization, | |
2935 | as if the originserver had sent ``Cache-control: public'' | |
2936 | in the response header. Doing this VIOLATES the HTTP standard. | |
2937 | Enabling this feature could make you liable for problems which | |
2938 | it causes. | |
2939 | ||
2940 | refresh-ims causes squid to contact the origin server | |
2941 | when a client issues an If-Modified-Since request. This | |
2942 | ensures that the client will receive an updated version | |
2943 | if one is available. | |
2944 | ||
2945 | Basically a cached object is: | |
2946 | ||
2947 | FRESH if expires < now, else STALE | |
2948 | STALE if age > max | |
2949 | FRESH if lm-factor < percent, else STALE | |
2950 | FRESH if age < min | |
2951 | else STALE | |
2952 | ||
2953 | The refresh_pattern lines are checked in the order listed here. | |
2954 | The first entry which matches is used. If none of the entries | |
2955 | match the default will be used. | |
2956 | ||
2957 | Note, you must uncomment all the default lines if you want | |
2958 | to change one. The default setting is only active if none is | |
2959 | used. | |
2960 | ||
2961 | Suggested default: | |
2962 | NOCOMMENT_START | |
2963 | refresh_pattern ^ftp: 1440 20% 10080 | |
2964 | refresh_pattern ^gopher: 1440 0% 1440 | |
89db45fa | 2965 | refresh_pattern -i (/cgi-bin/|\?) 0 0% 0 |
41bd17a4 | 2966 | refresh_pattern . 0 20% 4320 |
2967 | NOCOMMENT_END | |
2968 | DOC_END | |
2969 | ||
2970 | NAME: quick_abort_min | |
2971 | COMMENT: (KB) | |
2972 | TYPE: kb_int64_t | |
2973 | DEFAULT: 16 KB | |
2974 | LOC: Config.quickAbort.min | |
2975 | DOC_NONE | |
2976 | ||
2977 | NAME: quick_abort_max | |
2978 | COMMENT: (KB) | |
2979 | TYPE: kb_int64_t | |
2980 | DEFAULT: 16 KB | |
2981 | LOC: Config.quickAbort.max | |
2982 | DOC_NONE | |
2983 | ||
2984 | NAME: quick_abort_pct | |
2985 | COMMENT: (percent) | |
2986 | TYPE: int | |
2987 | DEFAULT: 95 | |
2988 | LOC: Config.quickAbort.pct | |
2989 | DOC_START | |
2990 | The cache by default continues downloading aborted requests | |
2991 | which are almost completed (less than 16 KB remaining). This | |
2992 | may be undesirable on slow (e.g. SLIP) links and/or very busy | |
2993 | caches. Impatient users may tie up file descriptors and | |
2994 | bandwidth by repeatedly requesting and immediately aborting | |
2995 | downloads. | |
2996 | ||
2997 | When the user aborts a request, Squid will check the | |
2998 | quick_abort values to the amount of data transfered until | |
2999 | then. | |
3000 | ||
3001 | If the transfer has less than 'quick_abort_min' KB remaining, | |
3002 | it will finish the retrieval. | |
3003 | ||
3004 | If the transfer has more than 'quick_abort_max' KB remaining, | |
3005 | it will abort the retrieval. | |
3006 | ||
3007 | If more than 'quick_abort_pct' of the transfer has completed, | |
3008 | it will finish the retrieval. | |
3009 | ||
3010 | If you do not want any retrieval to continue after the client | |
3011 | has aborted, set both 'quick_abort_min' and 'quick_abort_max' | |
3012 | to '0 KB'. | |
3013 | ||
3014 | If you want retrievals to always continue if they are being | |
3015 | cached set 'quick_abort_min' to '-1 KB'. | |
3016 | DOC_END | |
60d096f4 | 3017 | |
41bd17a4 | 3018 | NAME: read_ahead_gap |
3019 | COMMENT: buffer-size | |
3020 | TYPE: b_int64_t | |
3021 | LOC: Config.readAheadGap | |
3022 | DEFAULT: 16 KB | |
3023 | DOC_START | |
3024 | The amount of data the cache will buffer ahead of what has been | |
3025 | sent to the client when retrieving an object from another server. | |
3026 | DOC_END | |
53e738c6 | 3027 | |
41bd17a4 | 3028 | NAME: negative_ttl |
ac9cc053 | 3029 | IFDEF: HTTP_VIOLATIONS |
41bd17a4 | 3030 | COMMENT: time-units |
3031 | TYPE: time_t | |
3032 | LOC: Config.negativeTtl | |
ac9cc053 | 3033 | DEFAULT: 0 seconds |
41bd17a4 | 3034 | DOC_START |
ac9cc053 AJ |
3035 | Set the Default Time-to-Live (TTL) for failed requests. |
3036 | Certain types of failures (such as "connection refused" and | |
3037 | "404 Not Found") are able to be negatively-cached for a short time. | |
3038 | Modern web servers should provide Expires: header, however if they | |
3039 | do not this can provide a minimum TTL. | |
3040 | The default is not to cache errors with unknown expiry details. | |
3041 | ||
3042 | Note that this is different from negative caching of DNS lookups. | |
39956c7c AJ |
3043 | |
3044 | WARNING: Doing this VIOLATES the HTTP standard. Enabling | |
3045 | this feature could make you liable for problems which it | |
3046 | causes. | |
41bd17a4 | 3047 | DOC_END |
53e738c6 | 3048 | |
41bd17a4 | 3049 | NAME: positive_dns_ttl |
3050 | COMMENT: time-units | |
3051 | TYPE: time_t | |
3052 | LOC: Config.positiveDnsTtl | |
3053 | DEFAULT: 6 hours | |
3054 | DOC_START | |
3055 | Upper limit on how long Squid will cache positive DNS responses. | |
3056 | Default is 6 hours (360 minutes). This directive must be set | |
3057 | larger than negative_dns_ttl. | |
3058 | DOC_END | |
c4ab8329 | 3059 | |
41bd17a4 | 3060 | NAME: negative_dns_ttl |
3061 | COMMENT: time-units | |
3062 | TYPE: time_t | |
3063 | LOC: Config.negativeDnsTtl | |
3064 | DEFAULT: 1 minutes | |
3065 | DOC_START | |
3066 | Time-to-Live (TTL) for negative caching of failed DNS lookups. | |
3067 | This also sets the lower cache limit on positive lookups. | |
3068 | Minimum value is 1 second, and it is not recommendable to go | |
3069 | much below 10 seconds. | |
3070 | DOC_END | |
7df0bfd7 | 3071 | |
41bd17a4 | 3072 | NAME: range_offset_limit |
3073 | COMMENT: (bytes) | |
3074 | TYPE: b_int64_t | |
3075 | LOC: Config.rangeOffsetLimit | |
3076 | DEFAULT: 0 KB | |
3077 | DOC_START | |
3078 | Sets a upper limit on how far into the the file a Range request | |
3079 | may be to cause Squid to prefetch the whole file. If beyond this | |
3080 | limit Squid forwards the Range request as it is and the result | |
3081 | is NOT cached. | |
c4ab8329 | 3082 | |
41bd17a4 | 3083 | This is to stop a far ahead range request (lets say start at 17MB) |
3084 | from making Squid fetch the whole object up to that point before | |
3085 | sending anything to the client. | |
a7ad6e4e | 3086 | |
41bd17a4 | 3087 | A value of -1 causes Squid to always fetch the object from the |
3088 | beginning so it may cache the result. (2.0 style) | |
a7ad6e4e | 3089 | |
41bd17a4 | 3090 | A value of 0 causes Squid to never fetch more than the |
3091 | client requested. (default) | |
3092 | DOC_END | |
d95b862f | 3093 | |
41bd17a4 | 3094 | NAME: minimum_expiry_time |
3095 | COMMENT: (seconds) | |
3096 | TYPE: time_t | |
3097 | LOC: Config.minimum_expiry_time | |
3098 | DEFAULT: 60 seconds | |
3099 | DOC_START | |
3100 | The minimum caching time according to (Expires - Date) | |
3101 | Headers Squid honors if the object can't be revalidated | |
649fa918 | 3102 | defaults to 60 seconds. In reverse proxy environments it |
41bd17a4 | 3103 | might be desirable to honor shorter object lifetimes. It |
3104 | is most likely better to make your server return a | |
3105 | meaningful Last-Modified header however. In ESI environments | |
3106 | where page fragments often have short lifetimes, this will | |
3107 | often be best set to 0. | |
3108 | DOC_END | |
c68e9c6b | 3109 | |
41bd17a4 | 3110 | NAME: store_avg_object_size |
3111 | COMMENT: (kbytes) | |
3e62bd58 | 3112 | TYPE: kb_int64_t |
41bd17a4 | 3113 | DEFAULT: 13 KB |
3114 | LOC: Config.Store.avgObjectSize | |
3115 | DOC_START | |
3116 | Average object size, used to estimate number of objects your | |
3117 | cache can hold. The default is 13 KB. | |
cccac0a2 | 3118 | DOC_END |
3119 | ||
41bd17a4 | 3120 | NAME: store_objects_per_bucket |
3121 | TYPE: int | |
3122 | DEFAULT: 20 | |
3123 | LOC: Config.Store.objectsPerBucket | |
3124 | DOC_START | |
3125 | Target number of objects per bucket in the store hash table. | |
3126 | Lowering this value increases the total number of buckets and | |
3127 | also the storage maintenance rate. The default is 20. | |
3128 | DOC_END | |
3129 | ||
3130 | COMMENT_START | |
3131 | HTTP OPTIONS | |
3132 | ----------------------------------------------------------------------------- | |
3133 | COMMENT_END | |
3134 | ||
f04b37d8 | 3135 | NAME: request_header_max_size |
3136 | COMMENT: (KB) | |
3137 | TYPE: b_size_t | |
df2eec10 | 3138 | DEFAULT: 64 KB |
f04b37d8 | 3139 | LOC: Config.maxRequestHeaderSize |
3140 | DOC_START | |
3141 | This specifies the maximum size for HTTP headers in a request. | |
3142 | Request headers are usually relatively small (about 512 bytes). | |
3143 | Placing a limit on the request header size will catch certain | |
3144 | bugs (for example with persistent connections) and possibly | |
3145 | buffer-overflow or denial-of-service attacks. | |
3146 | DOC_END | |
3147 | ||
3148 | NAME: reply_header_max_size | |
3149 | COMMENT: (KB) | |
3150 | TYPE: b_size_t | |
df2eec10 | 3151 | DEFAULT: 64 KB |
f04b37d8 | 3152 | LOC: Config.maxReplyHeaderSize |
3153 | DOC_START | |
3154 | This specifies the maximum size for HTTP headers in a reply. | |
3155 | Reply headers are usually relatively small (about 512 bytes). | |
3156 | Placing a limit on the reply header size will catch certain | |
3157 | bugs (for example with persistent connections) and possibly | |
3158 | buffer-overflow or denial-of-service attacks. | |
3159 | DOC_END | |
3160 | ||
3161 | NAME: request_body_max_size | |
3162 | COMMENT: (bytes) | |
3163 | TYPE: b_int64_t | |
3164 | DEFAULT: 0 KB | |
3165 | LOC: Config.maxRequestBodySize | |
3166 | DOC_START | |
3167 | This specifies the maximum size for an HTTP request body. | |
3168 | In other words, the maximum size of a PUT/POST request. | |
3169 | A user who attempts to send a request with a body larger | |
3170 | than this limit receives an "Invalid Request" error message. | |
3171 | If you set this parameter to a zero (the default), there will | |
3172 | be no limit imposed. | |
3173 | DOC_END | |
3174 | ||
41bd17a4 | 3175 | NAME: broken_posts |
cccac0a2 | 3176 | TYPE: acl_access |
cccac0a2 | 3177 | DEFAULT: none |
41bd17a4 | 3178 | LOC: Config.accessList.brokenPosts |
cccac0a2 | 3179 | DOC_START |
41bd17a4 | 3180 | A list of ACL elements which, if matched, causes Squid to send |
3181 | an extra CRLF pair after the body of a PUT/POST request. | |
cccac0a2 | 3182 | |
41bd17a4 | 3183 | Some HTTP servers has broken implementations of PUT/POST, |
3184 | and rely on an extra CRLF pair sent by some WWW clients. | |
cccac0a2 | 3185 | |
41bd17a4 | 3186 | Quote from RFC2616 section 4.1 on this matter: |
cccac0a2 | 3187 | |
41bd17a4 | 3188 | Note: certain buggy HTTP/1.0 client implementations generate an |
3189 | extra CRLF's after a POST request. To restate what is explicitly | |
3190 | forbidden by the BNF, an HTTP/1.1 client must not preface or follow | |
3191 | a request with an extra CRLF. | |
cccac0a2 | 3192 | |
41bd17a4 | 3193 | Example: |
3194 | acl buggy_server url_regex ^http://.... | |
3195 | broken_posts allow buggy_server | |
3196 | DOC_END | |
cccac0a2 | 3197 | |
41bd17a4 | 3198 | NAME: via |
3199 | IFDEF: HTTP_VIOLATIONS | |
3200 | COMMENT: on|off | |
3201 | TYPE: onoff | |
3202 | DEFAULT: on | |
3203 | LOC: Config.onoff.via | |
3204 | DOC_START | |
3205 | If set (default), Squid will include a Via header in requests and | |
3206 | replies as required by RFC2616. | |
3207 | DOC_END | |
4cc6eb12 | 3208 | |
41bd17a4 | 3209 | NAME: ie_refresh |
3210 | COMMENT: on|off | |
3211 | TYPE: onoff | |
3212 | LOC: Config.onoff.ie_refresh | |
3213 | DEFAULT: off | |
3214 | DOC_START | |
3215 | Microsoft Internet Explorer up until version 5.5 Service | |
3216 | Pack 1 has an issue with transparent proxies, wherein it | |
3217 | is impossible to force a refresh. Turning this on provides | |
3218 | a partial fix to the problem, by causing all IMS-REFRESH | |
3219 | requests from older IE versions to check the origin server | |
3220 | for fresh content. This reduces hit ratio by some amount | |
3221 | (~10% in my experience), but allows users to actually get | |
3222 | fresh content when they want it. Note because Squid | |
3223 | cannot tell if the user is using 5.5 or 5.5SP1, the behavior | |
3224 | of 5.5 is unchanged from old versions of Squid (i.e. a | |
3225 | forced refresh is impossible). Newer versions of IE will, | |
3226 | hopefully, continue to have the new behavior and will be | |
3227 | handled based on that assumption. This option defaults to | |
3228 | the old Squid behavior, which is better for hit ratios but | |
3229 | worse for clients using IE, if they need to be able to | |
3230 | force fresh content. | |
3231 | DOC_END | |
b9d7fe3e | 3232 | |
41bd17a4 | 3233 | NAME: vary_ignore_expire |
3234 | COMMENT: on|off | |
3235 | TYPE: onoff | |
3236 | LOC: Config.onoff.vary_ignore_expire | |
3237 | DEFAULT: off | |
3238 | DOC_START | |
3239 | Many HTTP servers supporting Vary gives such objects | |
3240 | immediate expiry time with no cache-control header | |
3241 | when requested by a HTTP/1.0 client. This option | |
3242 | enables Squid to ignore such expiry times until | |
3243 | HTTP/1.1 is fully implemented. | |
3244 | WARNING: This may eventually cause some varying | |
3245 | objects not intended for caching to get cached. | |
cccac0a2 | 3246 | DOC_END |
c4ab8329 | 3247 | |
41bd17a4 | 3248 | NAME: request_entities |
3249 | TYPE: onoff | |
3250 | LOC: Config.onoff.request_entities | |
3251 | DEFAULT: off | |
3252 | DOC_START | |
3253 | Squid defaults to deny GET and HEAD requests with request entities, | |
3254 | as the meaning of such requests are undefined in the HTTP standard | |
3255 | even if not explicitly forbidden. | |
0976f8db | 3256 | |
41bd17a4 | 3257 | Set this directive to on if you have clients which insists |
3258 | on sending request entities in GET or HEAD requests. But be warned | |
3259 | that there is server software (both proxies and web servers) which | |
3260 | can fail to properly process this kind of request which may make you | |
3261 | vulnerable to cache pollution attacks if enabled. | |
cccac0a2 | 3262 | DOC_END |
6b53c392 | 3263 | |
41bd17a4 | 3264 | NAME: request_header_access |
3265 | IFDEF: HTTP_VIOLATIONS | |
3266 | TYPE: http_header_access[] | |
3267 | LOC: Config.request_header_access | |
cccac0a2 | 3268 | DEFAULT: none |
cccac0a2 | 3269 | DOC_START |
41bd17a4 | 3270 | Usage: request_header_access header_name allow|deny [!]aclname ... |
0976f8db | 3271 | |
41bd17a4 | 3272 | WARNING: Doing this VIOLATES the HTTP standard. Enabling |
3273 | this feature could make you liable for problems which it | |
3274 | causes. | |
0976f8db | 3275 | |
41bd17a4 | 3276 | This option replaces the old 'anonymize_headers' and the |
3277 | older 'http_anonymizer' option with something that is much | |
3278 | more configurable. This new method creates a list of ACLs | |
3279 | for each header, allowing you very fine-tuned header | |
3280 | mangling. | |
934b03fc | 3281 | |
41bd17a4 | 3282 | This option only applies to request headers, i.e., from the |
3283 | client to the server. | |
5401aa8d | 3284 | |
41bd17a4 | 3285 | You can only specify known headers for the header name. |
3286 | Other headers are reclassified as 'Other'. You can also | |
3287 | refer to all the headers with 'All'. | |
5401aa8d | 3288 | |
41bd17a4 | 3289 | For example, to achieve the same behavior as the old |
3290 | 'http_anonymizer standard' option, you should use: | |
5401aa8d | 3291 | |
41bd17a4 | 3292 | request_header_access From deny all |
3293 | request_header_access Referer deny all | |
3294 | request_header_access Server deny all | |
3295 | request_header_access User-Agent deny all | |
3296 | request_header_access WWW-Authenticate deny all | |
3297 | request_header_access Link deny all | |
5401aa8d | 3298 | |
41bd17a4 | 3299 | Or, to reproduce the old 'http_anonymizer paranoid' feature |
3300 | you should use: | |
5401aa8d | 3301 | |
41bd17a4 | 3302 | request_header_access Allow allow all |
3303 | request_header_access Authorization allow all | |
3304 | request_header_access WWW-Authenticate allow all | |
3305 | request_header_access Proxy-Authorization allow all | |
3306 | request_header_access Proxy-Authenticate allow all | |
3307 | request_header_access Cache-Control allow all | |
3308 | request_header_access Content-Encoding allow all | |
3309 | request_header_access Content-Length allow all | |
3310 | request_header_access Content-Type allow all | |
3311 | request_header_access Date allow all | |
3312 | request_header_access Expires allow all | |
3313 | request_header_access Host allow all | |
3314 | request_header_access If-Modified-Since allow all | |
3315 | request_header_access Last-Modified allow all | |
3316 | request_header_access Location allow all | |
3317 | request_header_access Pragma allow all | |
3318 | request_header_access Accept allow all | |
3319 | request_header_access Accept-Charset allow all | |
3320 | request_header_access Accept-Encoding allow all | |
3321 | request_header_access Accept-Language allow all | |
3322 | request_header_access Content-Language allow all | |
3323 | request_header_access Mime-Version allow all | |
3324 | request_header_access Retry-After allow all | |
3325 | request_header_access Title allow all | |
3326 | request_header_access Connection allow all | |
3327 | request_header_access Proxy-Connection allow all | |
3328 | request_header_access All deny all | |
5401aa8d | 3329 | |
41bd17a4 | 3330 | although many of those are HTTP reply headers, and so should be |
3331 | controlled with the reply_header_access directive. | |
5401aa8d | 3332 | |
41bd17a4 | 3333 | By default, all headers are allowed (no anonymizing is |
3334 | performed). | |
5401aa8d | 3335 | DOC_END |
3336 | ||
41bd17a4 | 3337 | NAME: reply_header_access |
3338 | IFDEF: HTTP_VIOLATIONS | |
3339 | TYPE: http_header_access[] | |
3340 | LOC: Config.reply_header_access | |
cccac0a2 | 3341 | DEFAULT: none |
3342 | DOC_START | |
41bd17a4 | 3343 | Usage: reply_header_access header_name allow|deny [!]aclname ... |
934b03fc | 3344 | |
41bd17a4 | 3345 | WARNING: Doing this VIOLATES the HTTP standard. Enabling |
3346 | this feature could make you liable for problems which it | |
3347 | causes. | |
934b03fc | 3348 | |
41bd17a4 | 3349 | This option only applies to reply headers, i.e., from the |
3350 | server to the client. | |
934b03fc | 3351 | |
41bd17a4 | 3352 | This is the same as request_header_access, but in the other |
3353 | direction. | |
6b53c392 | 3354 | |
41bd17a4 | 3355 | This option replaces the old 'anonymize_headers' and the |
3356 | older 'http_anonymizer' option with something that is much | |
3357 | more configurable. This new method creates a list of ACLs | |
3358 | for each header, allowing you very fine-tuned header | |
3359 | mangling. | |
cccac0a2 | 3360 | |
41bd17a4 | 3361 | You can only specify known headers for the header name. |
3362 | Other headers are reclassified as 'Other'. You can also | |
3363 | refer to all the headers with 'All'. | |
cccac0a2 | 3364 | |
41bd17a4 | 3365 | For example, to achieve the same behavior as the old |
3366 | 'http_anonymizer standard' option, you should use: | |
cccac0a2 | 3367 | |
41bd17a4 | 3368 | reply_header_access From deny all |
3369 | reply_header_access Referer deny all | |
3370 | reply_header_access Server deny all | |
3371 | reply_header_access User-Agent deny all | |
3372 | reply_header_access WWW-Authenticate deny all | |
3373 | reply_header_access Link deny all | |
cccac0a2 | 3374 | |
41bd17a4 | 3375 | Or, to reproduce the old 'http_anonymizer paranoid' feature |
3376 | you should use: | |
cccac0a2 | 3377 | |
41bd17a4 | 3378 | reply_header_access Allow allow all |
3379 | reply_header_access Authorization allow all | |
3380 | reply_header_access WWW-Authenticate allow all | |
3381 | reply_header_access Proxy-Authorization allow all | |
3382 | reply_header_access Proxy-Authenticate allow all | |
3383 | reply_header_access Cache-Control allow all | |
3384 | reply_header_access Content-Encoding allow all | |
3385 | reply_header_access Content-Length allow all | |
3386 | reply_header_access Content-Type allow all | |
3387 | reply_header_access Date allow all | |
3388 | reply_header_access Expires allow all | |
3389 | reply_header_access Host allow all | |
3390 | reply_header_access If-Modified-Since allow all | |
3391 | reply_header_access Last-Modified allow all | |
3392 | reply_header_access Location allow all | |
3393 | reply_header_access Pragma allow all | |
3394 | reply_header_access Accept allow all | |
3395 | reply_header_access Accept-Charset allow all | |
3396 | reply_header_access Accept-Encoding allow all | |
3397 | reply_header_access Accept-Language allow all | |
3398 | reply_header_access Content-Language allow all | |
3399 | reply_header_access Mime-Version allow all | |
3400 | reply_header_access Retry-After allow all | |
3401 | reply_header_access Title allow all | |
3402 | reply_header_access Connection allow all | |
3403 | reply_header_access Proxy-Connection allow all | |
3404 | reply_header_access All deny all | |
cccac0a2 | 3405 | |
41bd17a4 | 3406 | although the HTTP request headers won't be usefully controlled |
3407 | by this directive -- see request_header_access for details. | |
cccac0a2 | 3408 | |
41bd17a4 | 3409 | By default, all headers are allowed (no anonymizing is |
3410 | performed). | |
cccac0a2 | 3411 | DOC_END |
3412 | ||
41bd17a4 | 3413 | NAME: header_replace |
3414 | IFDEF: HTTP_VIOLATIONS | |
3415 | TYPE: http_header_replace[] | |
3416 | LOC: Config.request_header_access | |
cccac0a2 | 3417 | DEFAULT: none |
41bd17a4 | 3418 | DOC_START |
3419 | Usage: header_replace header_name message | |
3420 | Example: header_replace User-Agent Nutscrape/1.0 (CP/M; 8-bit) | |
cccac0a2 | 3421 | |
41bd17a4 | 3422 | This option allows you to change the contents of headers |
3423 | denied with header_access above, by replacing them with | |
3424 | some fixed string. This replaces the old fake_user_agent | |
3425 | option. | |
cccac0a2 | 3426 | |
41bd17a4 | 3427 | This only applies to request headers, not reply headers. |
cccac0a2 | 3428 | |
41bd17a4 | 3429 | By default, headers are removed if denied. |
3430 | DOC_END | |
cccac0a2 | 3431 | |
41bd17a4 | 3432 | NAME: relaxed_header_parser |
3433 | COMMENT: on|off|warn | |
3434 | TYPE: tristate | |
3435 | LOC: Config.onoff.relaxed_header_parser | |
3436 | DEFAULT: on | |
3437 | DOC_START | |
3438 | In the default "on" setting Squid accepts certain forms | |
3439 | of non-compliant HTTP messages where it is unambiguous | |
3440 | what the sending application intended even if the message | |
3441 | is not correctly formatted. The messages is then normalized | |
3442 | to the correct form when forwarded by Squid. | |
cccac0a2 | 3443 | |
41bd17a4 | 3444 | If set to "warn" then a warning will be emitted in cache.log |
3445 | each time such HTTP error is encountered. | |
cccac0a2 | 3446 | |
41bd17a4 | 3447 | If set to "off" then such HTTP errors will cause the request |
3448 | or response to be rejected. | |
3449 | DOC_END | |
7d90757b | 3450 | |
41bd17a4 | 3451 | COMMENT_START |
3452 | TIMEOUTS | |
3453 | ----------------------------------------------------------------------------- | |
3454 | COMMENT_END | |
3455 | ||
3456 | NAME: forward_timeout | |
3457 | COMMENT: time-units | |
3458 | TYPE: time_t | |
3459 | LOC: Config.Timeout.forward | |
3460 | DEFAULT: 4 minutes | |
3461 | DOC_START | |
3462 | This parameter specifies how long Squid should at most attempt in | |
3463 | finding a forwarding path for the request before giving up. | |
cccac0a2 | 3464 | DOC_END |
3465 | ||
41bd17a4 | 3466 | NAME: connect_timeout |
3467 | COMMENT: time-units | |
3468 | TYPE: time_t | |
3469 | LOC: Config.Timeout.connect | |
3470 | DEFAULT: 1 minute | |
057f5854 | 3471 | DOC_START |
41bd17a4 | 3472 | This parameter specifies how long to wait for the TCP connect to |
3473 | the requested server or peer to complete before Squid should | |
3474 | attempt to find another path where to forward the request. | |
057f5854 | 3475 | DOC_END |
3476 | ||
41bd17a4 | 3477 | NAME: peer_connect_timeout |
3478 | COMMENT: time-units | |
3479 | TYPE: time_t | |
3480 | LOC: Config.Timeout.peer_connect | |
3481 | DEFAULT: 30 seconds | |
cccac0a2 | 3482 | DOC_START |
41bd17a4 | 3483 | This parameter specifies how long to wait for a pending TCP |
3484 | connection to a peer cache. The default is 30 seconds. You | |
3485 | may also set different timeout values for individual neighbors | |
3486 | with the 'connect-timeout' option on a 'cache_peer' line. | |
3487 | DOC_END | |
7f7db318 | 3488 | |
41bd17a4 | 3489 | NAME: read_timeout |
3490 | COMMENT: time-units | |
3491 | TYPE: time_t | |
3492 | LOC: Config.Timeout.read | |
3493 | DEFAULT: 15 minutes | |
3494 | DOC_START | |
3495 | The read_timeout is applied on server-side connections. After | |
3496 | each successful read(), the timeout will be extended by this | |
3497 | amount. If no data is read again after this amount of time, | |
3498 | the request is aborted and logged with ERR_READ_TIMEOUT. The | |
3499 | default is 15 minutes. | |
3500 | DOC_END | |
cccac0a2 | 3501 | |
41bd17a4 | 3502 | NAME: request_timeout |
3503 | TYPE: time_t | |
3504 | LOC: Config.Timeout.request | |
3505 | DEFAULT: 5 minutes | |
3506 | DOC_START | |
3507 | How long to wait for an HTTP request after initial | |
3508 | connection establishment. | |
3509 | DOC_END | |
cccac0a2 | 3510 | |
41bd17a4 | 3511 | NAME: persistent_request_timeout |
3512 | TYPE: time_t | |
3513 | LOC: Config.Timeout.persistent_request | |
3514 | DEFAULT: 2 minutes | |
3515 | DOC_START | |
3516 | How long to wait for the next HTTP request on a persistent | |
3517 | connection after the previous request completes. | |
3518 | DOC_END | |
cccac0a2 | 3519 | |
41bd17a4 | 3520 | NAME: client_lifetime |
3521 | COMMENT: time-units | |
3522 | TYPE: time_t | |
3523 | LOC: Config.Timeout.lifetime | |
3524 | DEFAULT: 1 day | |
3525 | DOC_START | |
3526 | The maximum amount of time a client (browser) is allowed to | |
3527 | remain connected to the cache process. This protects the Cache | |
3528 | from having a lot of sockets (and hence file descriptors) tied up | |
3529 | in a CLOSE_WAIT state from remote clients that go away without | |
3530 | properly shutting down (either because of a network failure or | |
3531 | because of a poor client implementation). The default is one | |
3532 | day, 1440 minutes. | |
7d90757b | 3533 | |
41bd17a4 | 3534 | NOTE: The default value is intended to be much larger than any |
3535 | client would ever need to be connected to your cache. You | |
3536 | should probably change client_lifetime only as a last resort. | |
3537 | If you seem to have many client connections tying up | |
3538 | filedescriptors, we recommend first tuning the read_timeout, | |
3539 | request_timeout, persistent_request_timeout and quick_abort values. | |
cccac0a2 | 3540 | DOC_END |
3541 | ||
41bd17a4 | 3542 | NAME: half_closed_clients |
3543 | TYPE: onoff | |
3544 | LOC: Config.onoff.half_closed_clients | |
0c2f5c4f | 3545 | DEFAULT: off |
4eb368f9 | 3546 | DOC_START |
41bd17a4 | 3547 | Some clients may shutdown the sending side of their TCP |
3548 | connections, while leaving their receiving sides open. Sometimes, | |
3549 | Squid can not tell the difference between a half-closed and a | |
0c2f5c4f AJ |
3550 | fully-closed TCP connection. |
3551 | ||
3552 | By default, Squid will immediately close client connections when | |
3553 | read(2) returns "no more data to read." | |
3554 | ||
abdf1651 | 3555 | Change this option to 'on' and Squid will keep open connections |
0c2f5c4f AJ |
3556 | until a read(2) or write(2) on the socket returns an error. |
3557 | This may show some benefits for reverse proxies. But if not | |
3558 | it is recommended to leave OFF. | |
4eb368f9 | 3559 | DOC_END |
3560 | ||
41bd17a4 | 3561 | NAME: pconn_timeout |
3562 | TYPE: time_t | |
3563 | LOC: Config.Timeout.pconn | |
3564 | DEFAULT: 1 minute | |
cccac0a2 | 3565 | DOC_START |
41bd17a4 | 3566 | Timeout for idle persistent connections to servers and other |
3567 | proxies. | |
3568 | DOC_END | |
cccac0a2 | 3569 | |
41bd17a4 | 3570 | NAME: ident_timeout |
3571 | TYPE: time_t | |
3572 | IFDEF: USE_IDENT | |
3573 | LOC: Config.Timeout.ident | |
3574 | DEFAULT: 10 seconds | |
3575 | DOC_START | |
3576 | Maximum time to wait for IDENT lookups to complete. | |
cccac0a2 | 3577 | |
41bd17a4 | 3578 | If this is too high, and you enabled IDENT lookups from untrusted |
3579 | users, you might be susceptible to denial-of-service by having | |
3580 | many ident requests going at once. | |
cccac0a2 | 3581 | DOC_END |
3582 | ||
41bd17a4 | 3583 | NAME: shutdown_lifetime |
3584 | COMMENT: time-units | |
3585 | TYPE: time_t | |
3586 | LOC: Config.shutdownLifetime | |
3587 | DEFAULT: 30 seconds | |
cccac0a2 | 3588 | DOC_START |
41bd17a4 | 3589 | When SIGTERM or SIGHUP is received, the cache is put into |
3590 | "shutdown pending" mode until all active sockets are closed. | |
3591 | This value is the lifetime to set for all open descriptors | |
3592 | during shutdown mode. Any active clients after this many | |
3593 | seconds will receive a 'timeout' message. | |
cccac0a2 | 3594 | DOC_END |
0976f8db | 3595 | |
cccac0a2 | 3596 | COMMENT_START |
3597 | ADMINISTRATIVE PARAMETERS | |
3598 | ----------------------------------------------------------------------------- | |
3599 | COMMENT_END | |
3600 | ||
3601 | NAME: cache_mgr | |
3602 | TYPE: string | |
3603 | DEFAULT: webmaster | |
3604 | LOC: Config.adminEmail | |
3605 | DOC_START | |
3606 | Email-address of local cache manager who will receive | |
3607 | mail if the cache dies. The default is "webmaster." | |
3608 | DOC_END | |
3609 | ||
abacf776 | 3610 | NAME: mail_from |
3611 | TYPE: string | |
3612 | DEFAULT: none | |
3613 | LOC: Config.EmailFrom | |
3614 | DOC_START | |
3615 | From: email-address for mail sent when the cache dies. | |
3616 | The default is to use 'appname@unique_hostname'. | |
b8c0c06d | 3617 | Default appname value is "squid", can be changed into |
abacf776 | 3618 | src/globals.h before building squid. |
3619 | DOC_END | |
3620 | ||
d084bf20 | 3621 | NAME: mail_program |
3622 | TYPE: eol | |
3623 | DEFAULT: mail | |
3624 | LOC: Config.EmailProgram | |
3625 | DOC_START | |
3626 | Email program used to send mail if the cache dies. | |
846a5e31 | 3627 | The default is "mail". The specified program must comply |
d084bf20 | 3628 | with the standard Unix mail syntax: |
846a5e31 | 3629 | mail-program recipient < mailfile |
3630 | ||
d084bf20 | 3631 | Optional command line options can be specified. |
3632 | DOC_END | |
3633 | ||
cccac0a2 | 3634 | NAME: cache_effective_user |
3635 | TYPE: string | |
5483d916 | 3636 | DEFAULT: @DEFAULT_CACHE_EFFECTIVE_USER@ |
cccac0a2 | 3637 | LOC: Config.effectiveUser |
e3d74828 | 3638 | DOC_START |
3639 | If you start Squid as root, it will change its effective/real | |
3640 | UID/GID to the user specified below. The default is to change | |
5483d916 | 3641 | to UID of @DEFAULT_CACHE_EFFECTIVE_USER@. |
64e288bd | 3642 | see also; cache_effective_group |
e3d74828 | 3643 | DOC_END |
3644 | ||
cccac0a2 | 3645 | NAME: cache_effective_group |
3646 | TYPE: string | |
3647 | DEFAULT: none | |
3648 | LOC: Config.effectiveGroup | |
3649 | DOC_START | |
64e288bd | 3650 | Squid sets the GID to the effective user's default group ID |
3651 | (taken from the password file) and supplementary group list | |
3652 | from the groups membership. | |
3653 | ||
e3d74828 | 3654 | If you want Squid to run with a specific GID regardless of |
3655 | the group memberships of the effective user then set this | |
3656 | to the group (or GID) you want Squid to run as. When set | |
64e288bd | 3657 | all other group privileges of the effective user are ignored |
e3d74828 | 3658 | and only this GID is effective. If Squid is not started as |
64e288bd | 3659 | root the user starting Squid MUST be member of the specified |
e3d74828 | 3660 | group. |
64e288bd | 3661 | |
3662 | This option is not recommended by the Squid Team. | |
3663 | Our preference is for administrators to configure a secure | |
3664 | user account for squid with UID/GID matching system policies. | |
cccac0a2 | 3665 | DOC_END |
3666 | ||
d3caee79 | 3667 | NAME: httpd_suppress_version_string |
3668 | COMMENT: on|off | |
3669 | TYPE: onoff | |
3670 | DEFAULT: off | |
3671 | LOC: Config.onoff.httpd_suppress_version_string | |
3672 | DOC_START | |
3673 | Suppress Squid version string info in HTTP headers and HTML error pages. | |
3674 | DOC_END | |
3675 | ||
cccac0a2 | 3676 | NAME: visible_hostname |
3677 | TYPE: string | |
3678 | LOC: Config.visibleHostname | |
3679 | DEFAULT: none | |
3680 | DOC_START | |
3681 | If you want to present a special hostname in error messages, etc, | |
7f7db318 | 3682 | define this. Otherwise, the return value of gethostname() |
cccac0a2 | 3683 | will be used. If you have multiple caches in a cluster and |
3684 | get errors about IP-forwarding you must set them to have individual | |
3685 | names with this setting. | |
3686 | DOC_END | |
3687 | ||
cccac0a2 | 3688 | NAME: unique_hostname |
3689 | TYPE: string | |
3690 | LOC: Config.uniqueHostname | |
3691 | DEFAULT: none | |
3692 | DOC_START | |
3693 | If you want to have multiple machines with the same | |
7f7db318 | 3694 | 'visible_hostname' you must give each machine a different |
3695 | 'unique_hostname' so forwarding loops can be detected. | |
cccac0a2 | 3696 | DOC_END |
3697 | ||
cccac0a2 | 3698 | NAME: hostname_aliases |
3699 | TYPE: wordlist | |
3700 | LOC: Config.hostnameAliases | |
3701 | DEFAULT: none | |
3702 | DOC_START | |
7f7db318 | 3703 | A list of other DNS names your cache has. |
cccac0a2 | 3704 | DOC_END |
0976f8db | 3705 | |
c642c141 AJ |
3706 | NAME: umask |
3707 | TYPE: int | |
3708 | LOC: Config.umask | |
3709 | DEFAULT: 027 | |
3710 | DOC_START | |
3711 | Minimum umask which should be enforced while the proxy | |
3712 | is running, in addition to the umask set at startup. | |
3713 | ||
3714 | For a traditional octal representation of umasks, start | |
3715 | your value with 0. | |
3716 | DOC_END | |
3717 | ||
cccac0a2 | 3718 | COMMENT_START |
3719 | OPTIONS FOR THE CACHE REGISTRATION SERVICE | |
3720 | ----------------------------------------------------------------------------- | |
3721 | ||
3722 | This section contains parameters for the (optional) cache | |
3723 | announcement service. This service is provided to help | |
3724 | cache administrators locate one another in order to join or | |
3725 | create cache hierarchies. | |
3726 | ||
3727 | An 'announcement' message is sent (via UDP) to the registration | |
3728 | service by Squid. By default, the announcement message is NOT | |
3729 | SENT unless you enable it with 'announce_period' below. | |
3730 | ||
3731 | The announcement message includes your hostname, plus the | |
3732 | following information from this configuration file: | |
3733 | ||
3734 | http_port | |
3735 | icp_port | |
3736 | cache_mgr | |
3737 | ||
3738 | All current information is processed regularly and made | |
3739 | available on the Web at http://www.ircache.net/Cache/Tracker/. | |
3740 | COMMENT_END | |
3741 | ||
3742 | NAME: announce_period | |
3743 | TYPE: time_t | |
3744 | LOC: Config.Announce.period | |
3745 | DEFAULT: 0 | |
3746 | DOC_START | |
3747 | This is how frequently to send cache announcements. The | |
3748 | default is `0' which disables sending the announcement | |
3749 | messages. | |
3750 | ||
3751 | To enable announcing your cache, just uncomment the line | |
3752 | below. | |
3753 | ||
3754 | NOCOMMENT_START | |
9e7dbc51 | 3755 | #To enable announcing your cache, just uncomment the line below. |
3756 | #announce_period 1 day | |
cccac0a2 | 3757 | NOCOMMENT_END |
3758 | DOC_END | |
3759 | ||
cccac0a2 | 3760 | NAME: announce_host |
3761 | TYPE: string | |
3762 | DEFAULT: tracker.ircache.net | |
3763 | LOC: Config.Announce.host | |
3764 | DOC_NONE | |
3765 | ||
3766 | NAME: announce_file | |
3767 | TYPE: string | |
3768 | DEFAULT: none | |
3769 | LOC: Config.Announce.file | |
3770 | DOC_NONE | |
3771 | ||
3772 | NAME: announce_port | |
3773 | TYPE: ushort | |
3774 | DEFAULT: 3131 | |
3775 | LOC: Config.Announce.port | |
3776 | DOC_START | |
3777 | announce_host and announce_port set the hostname and port | |
3778 | number where the registration message will be sent. | |
3779 | ||
3780 | Hostname will default to 'tracker.ircache.net' and port will | |
3781 | default default to 3131. If the 'filename' argument is given, | |
3782 | the contents of that file will be included in the announce | |
3783 | message. | |
3784 | DOC_END | |
3785 | ||
8d6275c0 | 3786 | COMMENT_START |
3787 | HTTPD-ACCELERATOR OPTIONS | |
3788 | ----------------------------------------------------------------------------- | |
3789 | COMMENT_END | |
3790 | ||
cccac0a2 | 3791 | NAME: httpd_accel_surrogate_id |
f41735ea | 3792 | IFDEF: USE_SQUID_ESI |
cccac0a2 | 3793 | TYPE: string |
3794 | LOC: Config.Accel.surrogate_id | |
3795 | DEFAULT: unset-id | |
3796 | DOC_START | |
3797 | Surrogates (http://www.esi.org/architecture_spec_1.0.html) | |
3798 | need an identification token to allow control targeting. Because | |
3799 | a farm of surrogates may all perform the same tasks, they may share | |
3800 | an identification token. | |
3801 | DOC_END | |
3802 | ||
3803 | NAME: http_accel_surrogate_remote | |
f41735ea | 3804 | IFDEF: USE_SQUID_ESI |
cccac0a2 | 3805 | COMMENT: on|off |
3806 | TYPE: onoff | |
3807 | DEFAULT: off | |
3808 | LOC: Config.onoff.surrogate_is_remote | |
3809 | DOC_START | |
3810 | Remote surrogates (such as those in a CDN) honour Surrogate-Control: no-store-remote. | |
3811 | Set this to on to have squid behave as a remote surrogate. | |
3812 | DOC_END | |
3813 | ||
3814 | NAME: esi_parser | |
f41735ea | 3815 | IFDEF: USE_SQUID_ESI |
964b44c3 | 3816 | COMMENT: libxml2|expat|custom |
cccac0a2 | 3817 | TYPE: string |
3818 | LOC: ESIParser::Type | |
3819 | DEFAULT: custom | |
3820 | DOC_START | |
3821 | ESI markup is not strictly XML compatible. The custom ESI parser | |
3822 | will give higher performance, but cannot handle non ASCII character | |
3823 | encodings. | |
3824 | DOC_END | |
0976f8db | 3825 | |
9edd9041 | 3826 | COMMENT_START |
8d6275c0 | 3827 | DELAY POOL PARAMETERS |
9edd9041 | 3828 | ----------------------------------------------------------------------------- |
3829 | COMMENT_END | |
3830 | ||
3831 | NAME: delay_pools | |
3832 | TYPE: delay_pool_count | |
3833 | DEFAULT: 0 | |
3834 | IFDEF: DELAY_POOLS | |
3835 | LOC: Config.Delay | |
3836 | DOC_START | |
3837 | This represents the number of delay pools to be used. For example, | |
3838 | if you have one class 2 delay pool and one class 3 delays pool, you | |
3839 | have a total of 2 delay pools. | |
3840 | DOC_END | |
3841 | ||
3842 | NAME: delay_class | |
3843 | TYPE: delay_pool_class | |
3844 | DEFAULT: none | |
3845 | IFDEF: DELAY_POOLS | |
3846 | LOC: Config.Delay | |
3847 | DOC_START | |
3848 | This defines the class of each delay pool. There must be exactly one | |
3849 | delay_class line for each delay pool. For example, to define two | |
3850 | delay pools, one of class 2 and one of class 3, the settings above | |
3851 | and here would be: | |
3852 | ||
3853 | Example: | |
3854 | delay_pools 4 # 4 delay pools | |
3855 | delay_class 1 2 # pool 1 is a class 2 pool | |
3856 | delay_class 2 3 # pool 2 is a class 3 pool | |
3857 | delay_class 3 4 # pool 3 is a class 4 pool | |
3858 | delay_class 4 5 # pool 4 is a class 5 pool | |
3859 | ||
3860 | The delay pool classes are: | |
3861 | ||
3862 | class 1 Everything is limited by a single aggregate | |
3863 | bucket. | |
3864 | ||
3865 | class 2 Everything is limited by a single aggregate | |
3866 | bucket as well as an "individual" bucket chosen | |
3867 | from bits 25 through 32 of the IP address. | |
3868 | ||
3869 | class 3 Everything is limited by a single aggregate | |
3870 | bucket as well as a "network" bucket chosen | |
3871 | from bits 17 through 24 of the IP address and a | |
3872 | "individual" bucket chosen from bits 17 through | |
3873 | 32 of the IP address. | |
3874 | ||
3875 | class 4 Everything in a class 3 delay pool, with an | |
3876 | additional limit on a per user basis. This | |
3877 | only takes effect if the username is established | |
3878 | in advance - by forcing authentication in your | |
3879 | http_access rules. | |
3880 | ||
3881 | class 5 Requests are grouped according their tag (see | |
3882 | external_acl's tag= reply). | |
3883 | ||
3884 | NOTE: If an IP address is a.b.c.d | |
3885 | -> bits 25 through 32 are "d" | |
3886 | -> bits 17 through 24 are "c" | |
3887 | -> bits 17 through 32 are "c * 256 + d" | |
3888 | DOC_END | |
3889 | ||
3890 | NAME: delay_access | |
3891 | TYPE: delay_pool_access | |
3892 | DEFAULT: none | |
3893 | IFDEF: DELAY_POOLS | |
3894 | LOC: Config.Delay | |
3895 | DOC_START | |
3896 | This is used to determine which delay pool a request falls into. | |
3897 | ||
3898 | delay_access is sorted per pool and the matching starts with pool 1, | |
3899 | then pool 2, ..., and finally pool N. The first delay pool where the | |
3900 | request is allowed is selected for the request. If it does not allow | |
3901 | the request to any pool then the request is not delayed (default). | |
3902 | ||
3903 | For example, if you want some_big_clients in delay | |
3904 | pool 1 and lotsa_little_clients in delay pool 2: | |
3905 | ||
3906 | Example: | |
3907 | delay_access 1 allow some_big_clients | |
3908 | delay_access 1 deny all | |
3909 | delay_access 2 allow lotsa_little_clients | |
3910 | delay_access 2 deny all | |
3911 | delay_access 3 allow authenticated_clients | |
3912 | DOC_END | |
3913 | ||
3914 | NAME: delay_parameters | |
3915 | TYPE: delay_pool_rates | |
3916 | DEFAULT: none | |
3917 | IFDEF: DELAY_POOLS | |
3918 | LOC: Config.Delay | |
3919 | DOC_START | |
3920 | This defines the parameters for a delay pool. Each delay pool has | |
3921 | a number of "buckets" associated with it, as explained in the | |
3922 | description of delay_class. For a class 1 delay pool, the syntax is: | |
3923 | ||
3924 | delay_parameters pool aggregate | |
3925 | ||
3926 | For a class 2 delay pool: | |
3927 | ||
3928 | delay_parameters pool aggregate individual | |
3929 | ||
3930 | For a class 3 delay pool: | |
3931 | ||
3932 | delay_parameters pool aggregate network individual | |
3933 | ||
3934 | For a class 4 delay pool: | |
3935 | ||
3936 | delay_parameters pool aggregate network individual user | |
3937 | ||
3938 | For a class 5 delay pool: | |
3939 | ||
3940 | delay_parameters pool tag | |
3941 | ||
3942 | The variables here are: | |
3943 | ||
3944 | pool a pool number - ie, a number between 1 and the | |
3945 | number specified in delay_pools as used in | |
3946 | delay_class lines. | |
3947 | ||
3948 | aggregate the "delay parameters" for the aggregate bucket | |
3949 | (class 1, 2, 3). | |
3950 | ||
3951 | individual the "delay parameters" for the individual | |
3952 | buckets (class 2, 3). | |
3953 | ||
3954 | network the "delay parameters" for the network buckets | |
3955 | (class 3). | |
3956 | ||
3957 | user the delay parameters for the user buckets | |
3958 | (class 4). | |
3959 | ||
3960 | tag the delay parameters for the tag buckets | |
3961 | (class 5). | |
3962 | ||
3963 | A pair of delay parameters is written restore/maximum, where restore is | |
3964 | the number of bytes (not bits - modem and network speeds are usually | |
3965 | quoted in bits) per second placed into the bucket, and maximum is the | |
3966 | maximum number of bytes which can be in the bucket at any time. | |
3967 | ||
3968 | For example, if delay pool number 1 is a class 2 delay pool as in the | |
3969 | above example, and is being used to strictly limit each host to 64kbps | |
3970 | (plus overheads), with no overall limit, the line is: | |
3971 | ||
3972 | delay_parameters 1 -1/-1 8000/8000 | |
3973 | ||
3974 | Note that the figure -1 is used to represent "unlimited". | |
3975 | ||
3976 | And, if delay pool number 2 is a class 3 delay pool as in the above | |
3977 | example, and you want to limit it to a total of 256kbps (strict limit) | |
3978 | with each 8-bit network permitted 64kbps (strict limit) and each | |
3979 | individual host permitted 4800bps with a bucket maximum size of 64kb | |
3980 | to permit a decent web page to be downloaded at a decent speed | |
3981 | (if the network is not being limited due to overuse) but slow down | |
3982 | large downloads more significantly: | |
3983 | ||
3984 | delay_parameters 2 32000/32000 8000/8000 600/8000 | |
3985 | ||
3986 | There must be one delay_parameters line for each delay pool. | |
3987 | ||
3988 | Finally, for a class 4 delay pool as in the example - each user will | |
3989 | be limited to 128Kb no matter how many workstations they are logged into.: | |
3990 | ||
3991 | delay_parameters 4 32000/32000 8000/8000 600/64000 16000/16000 | |
3992 | DOC_END | |
3993 | ||
3994 | NAME: delay_initial_bucket_level | |
3995 | COMMENT: (percent, 0-100) | |
3996 | TYPE: ushort | |
3997 | DEFAULT: 50 | |
3998 | IFDEF: DELAY_POOLS | |
3999 | LOC: Config.Delay.initial | |
4000 | DOC_START | |
4001 | The initial bucket percentage is used to determine how much is put | |
4002 | in each bucket when squid starts, is reconfigured, or first notices | |
4003 | a host accessing it (in class 2 and class 3, individual hosts and | |
4004 | networks only have buckets associated with them once they have been | |
4005 | "seen" by squid). | |
4006 | DOC_END | |
4007 | ||
cccac0a2 | 4008 | COMMENT_START |
8d6275c0 | 4009 | WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS |
cccac0a2 | 4010 | ----------------------------------------------------------------------------- |
4011 | COMMENT_END | |
4012 | ||
8d6275c0 | 4013 | NAME: wccp_router |
4014 | TYPE: address | |
4015 | LOC: Config.Wccp.router | |
4016 | DEFAULT: 0.0.0.0 | |
4017 | IFDEF: USE_WCCP | |
e313ab0a AJ |
4018 | DOC_START |
4019 | Use this option to define your WCCP ``home'' router for | |
4020 | Squid. | |
4021 | ||
4022 | wccp_router supports a single WCCP(v1) router | |
4023 | ||
4024 | wccp2_router supports multiple WCCPv2 routers | |
4025 | ||
4026 | only one of the two may be used at the same time and defines | |
4027 | which version of WCCP to use. | |
4028 | DOC_END | |
df2eec10 | 4029 | |
8d6275c0 | 4030 | NAME: wccp2_router |
9fb4efad | 4031 | TYPE: IpAddress_list |
8d6275c0 | 4032 | LOC: Config.Wccp2.router |
cccac0a2 | 4033 | DEFAULT: none |
8d6275c0 | 4034 | IFDEF: USE_WCCPv2 |
cccac0a2 | 4035 | DOC_START |
8d6275c0 | 4036 | Use this option to define your WCCP ``home'' router for |
4037 | Squid. | |
cccac0a2 | 4038 | |
8d6275c0 | 4039 | wccp_router supports a single WCCP(v1) router |
cccac0a2 | 4040 | |
8d6275c0 | 4041 | wccp2_router supports multiple WCCPv2 routers |
cccac0a2 | 4042 | |
8d6275c0 | 4043 | only one of the two may be used at the same time and defines |
4044 | which version of WCCP to use. | |
4045 | DOC_END | |
4046 | ||
4047 | NAME: wccp_version | |
cccac0a2 | 4048 | TYPE: int |
8d6275c0 | 4049 | LOC: Config.Wccp.version |
4050 | DEFAULT: 4 | |
4051 | IFDEF: USE_WCCP | |
cccac0a2 | 4052 | DOC_START |
8d6275c0 | 4053 | This directive is only relevant if you need to set up WCCP(v1) |
4054 | to some very old and end-of-life Cisco routers. In all other | |
4055 | setups it must be left unset or at the default setting. | |
4056 | It defines an internal version in the WCCP(v1) protocol, | |
4057 | with version 4 being the officially documented protocol. | |
cccac0a2 | 4058 | |
8d6275c0 | 4059 | According to some users, Cisco IOS 11.2 and earlier only |
4060 | support WCCP version 3. If you're using that or an earlier | |
4061 | version of IOS, you may need to change this value to 3, otherwise | |
4062 | do not specify this parameter. | |
cccac0a2 | 4063 | DOC_END |
4064 | ||
8d6275c0 | 4065 | NAME: wccp2_rebuild_wait |
4066 | TYPE: onoff | |
4067 | LOC: Config.Wccp2.rebuildwait | |
4068 | DEFAULT: on | |
4069 | IFDEF: USE_WCCPv2 | |
4070 | DOC_START | |
4071 | If this is enabled Squid will wait for the cache dir rebuild to finish | |
4072 | before sending the first wccp2 HereIAm packet | |
4073 | DOC_END | |
cccac0a2 | 4074 | |
8d6275c0 | 4075 | NAME: wccp2_forwarding_method |
e313ab0a | 4076 | TYPE: wccp2_method |
8d6275c0 | 4077 | LOC: Config.Wccp2.forwarding_method |
451c4786 | 4078 | DEFAULT: gre |
8d6275c0 | 4079 | IFDEF: USE_WCCPv2 |
cccac0a2 | 4080 | DOC_START |
699acd19 | 4081 | WCCP2 allows the setting of forwarding methods between the |
8d6275c0 | 4082 | router/switch and the cache. Valid values are as follows: |
cccac0a2 | 4083 | |
451c4786 AJ |
4084 | gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) |
4085 | l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) | |
cccac0a2 | 4086 | |
8d6275c0 | 4087 | Currently (as of IOS 12.4) cisco routers only support GRE. |
4088 | Cisco switches only support the L2 redirect assignment method. | |
cccac0a2 | 4089 | DOC_END |
4090 | ||
8d6275c0 | 4091 | NAME: wccp2_return_method |
e313ab0a | 4092 | TYPE: wccp2_method |
8d6275c0 | 4093 | LOC: Config.Wccp2.return_method |
451c4786 | 4094 | DEFAULT: gre |
8d6275c0 | 4095 | IFDEF: USE_WCCPv2 |
cccac0a2 | 4096 | DOC_START |
699acd19 | 4097 | WCCP2 allows the setting of return methods between the |
8d6275c0 | 4098 | router/switch and the cache for packets that the cache |
4099 | decides not to handle. Valid values are as follows: | |
cccac0a2 | 4100 | |
451c4786 AJ |
4101 | gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) |
4102 | l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) | |
cccac0a2 | 4103 | |
8d6275c0 | 4104 | Currently (as of IOS 12.4) cisco routers only support GRE. |
4105 | Cisco switches only support the L2 redirect assignment. | |
cccac0a2 | 4106 | |
699acd19 | 4107 | If the "ip wccp redirect exclude in" command has been |
8d6275c0 | 4108 | enabled on the cache interface, then it is still safe for |
4109 | the proxy server to use a l2 redirect method even if this | |
4110 | option is set to GRE. | |
cccac0a2 | 4111 | DOC_END |
4112 | ||
8d6275c0 | 4113 | NAME: wccp2_assignment_method |
451c4786 | 4114 | TYPE: wccp2_amethod |
8d6275c0 | 4115 | LOC: Config.Wccp2.assignment_method |
451c4786 | 4116 | DEFAULT: hash |
8d6275c0 | 4117 | IFDEF: USE_WCCPv2 |
cccac0a2 | 4118 | DOC_START |
8d6275c0 | 4119 | WCCP2 allows the setting of methods to assign the WCCP hash |
4120 | Valid values are as follows: | |
cccac0a2 | 4121 | |
451c4786 AJ |
4122 | hash - Hash assignment |
4123 | mask - Mask assignment | |
cccac0a2 | 4124 | |
8d6275c0 | 4125 | As a general rule, cisco routers support the hash assignment method |
4126 | and cisco switches support the mask assignment method. | |
4127 | DOC_END | |
cccac0a2 | 4128 | |
8d6275c0 | 4129 | NAME: wccp2_service |
4130 | TYPE: wccp2_service | |
4131 | LOC: Config.Wccp2.info | |
4132 | DEFAULT: none | |
4133 | DEFAULT_IF_NONE: standard 0 | |
4134 | IFDEF: USE_WCCPv2 | |
4135 | DOC_START | |
4136 | WCCP2 allows for multiple traffic services. There are two | |
4137 | types: "standard" and "dynamic". The standard type defines | |
4138 | one service id - http (id 0). The dynamic service ids can be from | |
4139 | 51 to 255 inclusive. In order to use a dynamic service id | |
4140 | one must define the type of traffic to be redirected; this is done | |
4141 | using the wccp2_service_info option. | |
4142 | ||
4143 | The "standard" type does not require a wccp2_service_info option, | |
4144 | just specifying the service id will suffice. | |
4145 | ||
4146 | MD5 service authentication can be enabled by adding | |
4147 | "password=<password>" to the end of this service declaration. | |
4148 | ||
4149 | Examples: | |
4150 | ||
4151 | wccp2_service standard 0 # for the 'web-cache' standard service | |
4152 | wccp2_service dynamic 80 # a dynamic service type which will be | |
4153 | # fleshed out with subsequent options. | |
4154 | wccp2_service standard 0 password=foo | |
8d6275c0 | 4155 | DOC_END |
4156 | ||
4157 | NAME: wccp2_service_info | |
4158 | TYPE: wccp2_service_info | |
4159 | LOC: Config.Wccp2.info | |
4160 | DEFAULT: none | |
4161 | IFDEF: USE_WCCPv2 | |
4162 | DOC_START | |
4163 | Dynamic WCCPv2 services require further information to define the | |
4164 | traffic you wish to have diverted. | |
4165 | ||
4166 | The format is: | |
4167 | ||
4168 | wccp2_service_info <id> protocol=<protocol> flags=<flag>,<flag>.. | |
4169 | priority=<priority> ports=<port>,<port>.. | |
4170 | ||
4171 | The relevant WCCPv2 flags: | |
4172 | + src_ip_hash, dst_ip_hash | |
005fe566 | 4173 | + source_port_hash, dst_port_hash |
8d6275c0 | 4174 | + src_ip_alt_hash, dst_ip_alt_hash |
4175 | + src_port_alt_hash, dst_port_alt_hash | |
4176 | + ports_source | |
4177 | ||
4178 | The port list can be one to eight entries. | |
4179 | ||
4180 | Example: | |
4181 | ||
4182 | wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source | |
4183 | priority=240 ports=80 | |
4184 | ||
4185 | Note: the service id must have been defined by a previous | |
4186 | 'wccp2_service dynamic <id>' entry. | |
4187 | DOC_END | |
4188 | ||
4189 | NAME: wccp2_weight | |
4190 | TYPE: int | |
4191 | LOC: Config.Wccp2.weight | |
4192 | DEFAULT: 10000 | |
4193 | IFDEF: USE_WCCPv2 | |
4194 | DOC_START | |
4195 | Each cache server gets assigned a set of the destination | |
4196 | hash proportional to their weight. | |
4197 | DOC_END | |
4198 | ||
4199 | NAME: wccp_address | |
4200 | TYPE: address | |
4201 | LOC: Config.Wccp.address | |
4202 | DEFAULT: 0.0.0.0 | |
4203 | IFDEF: USE_WCCP | |
4204 | DOC_NONE | |
df2eec10 | 4205 | |
8d6275c0 | 4206 | NAME: wccp2_address |
4207 | TYPE: address | |
4208 | LOC: Config.Wccp2.address | |
4209 | DEFAULT: 0.0.0.0 | |
4210 | IFDEF: USE_WCCPv2 | |
4211 | DOC_START | |
4212 | Use this option if you require WCCP to use a specific | |
4213 | interface address. | |
4214 | ||
4215 | The default behavior is to not bind to any specific address. | |
4216 | DOC_END | |
4217 | ||
4218 | COMMENT_START | |
4219 | PERSISTENT CONNECTION HANDLING | |
4220 | ----------------------------------------------------------------------------- | |
4221 | ||
4222 | Also see "pconn_timeout" in the TIMEOUTS section | |
4223 | COMMENT_END | |
4224 | ||
4225 | NAME: client_persistent_connections | |
4226 | TYPE: onoff | |
4227 | LOC: Config.onoff.client_pconns | |
4228 | DEFAULT: on | |
4229 | DOC_NONE | |
4230 | ||
4231 | NAME: server_persistent_connections | |
4232 | TYPE: onoff | |
4233 | LOC: Config.onoff.server_pconns | |
4234 | DEFAULT: on | |
4235 | DOC_START | |
4236 | Persistent connection support for clients and servers. By | |
4237 | default, Squid uses persistent connections (when allowed) | |
4238 | with its clients and servers. You can use these options to | |
4239 | disable persistent connections with clients and/or servers. | |
4240 | DOC_END | |
4241 | ||
4242 | NAME: persistent_connection_after_error | |
4243 | TYPE: onoff | |
4244 | LOC: Config.onoff.error_pconns | |
4245 | DEFAULT: off | |
4246 | DOC_START | |
4247 | With this directive the use of persistent connections after | |
4248 | HTTP errors can be disabled. Useful if you have clients | |
4249 | who fail to handle errors on persistent connections proper. | |
4250 | DOC_END | |
4251 | ||
4252 | NAME: detect_broken_pconn | |
4253 | TYPE: onoff | |
4254 | LOC: Config.onoff.detect_broken_server_pconns | |
4255 | DEFAULT: off | |
4256 | DOC_START | |
4257 | Some servers have been found to incorrectly signal the use | |
4258 | of HTTP/1.0 persistent connections even on replies not | |
4259 | compatible, causing significant delays. This server problem | |
4260 | has mostly been seen on redirects. | |
4261 | ||
4262 | By enabling this directive Squid attempts to detect such | |
4263 | broken replies and automatically assume the reply is finished | |
4264 | after 10 seconds timeout. | |
4265 | DOC_END | |
4266 | ||
4267 | COMMENT_START | |
4268 | CACHE DIGEST OPTIONS | |
4269 | ----------------------------------------------------------------------------- | |
4270 | COMMENT_END | |
4271 | ||
4272 | NAME: digest_generation | |
4273 | IFDEF: USE_CACHE_DIGESTS | |
4274 | TYPE: onoff | |
4275 | LOC: Config.onoff.digest_generation | |
4276 | DEFAULT: on | |
4277 | DOC_START | |
4278 | This controls whether the server will generate a Cache Digest | |
4279 | of its contents. By default, Cache Digest generation is | |
13e917b5 | 4280 | enabled if Squid is compiled with --enable-cache-digests defined. |
8d6275c0 | 4281 | DOC_END |
4282 | ||
4283 | NAME: digest_bits_per_entry | |
4284 | IFDEF: USE_CACHE_DIGESTS | |
4285 | TYPE: int | |
4286 | LOC: Config.digest.bits_per_entry | |
4287 | DEFAULT: 5 | |
4288 | DOC_START | |
4289 | This is the number of bits of the server's Cache Digest which | |
4290 | will be associated with the Digest entry for a given HTTP | |
4291 | Method and URL (public key) combination. The default is 5. | |
4292 | DOC_END | |
4293 | ||
4294 | NAME: digest_rebuild_period | |
4295 | IFDEF: USE_CACHE_DIGESTS | |
4296 | COMMENT: (seconds) | |
4297 | TYPE: time_t | |
4298 | LOC: Config.digest.rebuild_period | |
4299 | DEFAULT: 1 hour | |
4300 | DOC_START | |
749ceff8 | 4301 | This is the wait time between Cache Digest rebuilds. |
8d6275c0 | 4302 | DOC_END |
4303 | ||
4304 | NAME: digest_rewrite_period | |
4305 | COMMENT: (seconds) | |
4306 | IFDEF: USE_CACHE_DIGESTS | |
4307 | TYPE: time_t | |
4308 | LOC: Config.digest.rewrite_period | |
4309 | DEFAULT: 1 hour | |
4310 | DOC_START | |
749ceff8 | 4311 | This is the wait time between Cache Digest writes to |
8d6275c0 | 4312 | disk. |
4313 | DOC_END | |
4314 | ||
4315 | NAME: digest_swapout_chunk_size | |
4316 | COMMENT: (bytes) | |
4317 | TYPE: b_size_t | |
4318 | IFDEF: USE_CACHE_DIGESTS | |
4319 | LOC: Config.digest.swapout_chunk_size | |
4320 | DEFAULT: 4096 bytes | |
4321 | DOC_START | |
4322 | This is the number of bytes of the Cache Digest to write to | |
4323 | disk at a time. It defaults to 4096 bytes (4KB), the Squid | |
4324 | default swap page. | |
4325 | DOC_END | |
4326 | ||
4327 | NAME: digest_rebuild_chunk_percentage | |
4328 | COMMENT: (percent, 0-100) | |
4329 | IFDEF: USE_CACHE_DIGESTS | |
4330 | TYPE: int | |
4331 | LOC: Config.digest.rebuild_chunk_percentage | |
4332 | DEFAULT: 10 | |
4333 | DOC_START | |
4334 | This is the percentage of the Cache Digest to be scanned at a | |
4335 | time. By default it is set to 10% of the Cache Digest. | |
4336 | DOC_END | |
4337 | ||
1db9eacd | 4338 | COMMENT_START |
5473c134 | 4339 | SNMP OPTIONS |
1db9eacd | 4340 | ----------------------------------------------------------------------------- |
4341 | COMMENT_END | |
4342 | ||
5473c134 | 4343 | NAME: snmp_port |
4344 | TYPE: ushort | |
4345 | LOC: Config.Port.snmp | |
87630341 | 4346 | DEFAULT: 0 |
5473c134 | 4347 | IFDEF: SQUID_SNMP |
8d6275c0 | 4348 | DOC_START |
87630341 | 4349 | The port number where Squid listens for SNMP requests. To enable |
4350 | SNMP support set this to a suitable port number. Port number | |
4351 | 3401 is often used for the Squid SNMP agent. By default it's | |
4352 | set to "0" (disabled) | |
4353 | NOCOMMENT_START | |
4354 | #snmp_port 3401 | |
4355 | NOCOMMENT_END | |
8d6275c0 | 4356 | DOC_END |
4357 | ||
5473c134 | 4358 | NAME: snmp_access |
4359 | TYPE: acl_access | |
4360 | LOC: Config.accessList.snmp | |
8d6275c0 | 4361 | DEFAULT: none |
5473c134 | 4362 | DEFAULT_IF_NONE: deny all |
4363 | IFDEF: SQUID_SNMP | |
8d6275c0 | 4364 | DOC_START |
5473c134 | 4365 | Allowing or denying access to the SNMP port. |
8d6275c0 | 4366 | |
5473c134 | 4367 | All access to the agent is denied by default. |
4368 | usage: | |
8d6275c0 | 4369 | |
5473c134 | 4370 | snmp_access allow|deny [!]aclname ... |
8d6275c0 | 4371 | |
5473c134 | 4372 | Example: |
4373 | snmp_access allow snmppublic localhost | |
4374 | snmp_access deny all | |
cccac0a2 | 4375 | DOC_END |
4376 | ||
5473c134 | 4377 | NAME: snmp_incoming_address |
4378 | TYPE: address | |
4379 | LOC: Config.Addrs.snmp_incoming | |
4380 | DEFAULT: 0.0.0.0 | |
4381 | IFDEF: SQUID_SNMP | |
4382 | DOC_NONE | |
df2eec10 | 4383 | |
5473c134 | 4384 | NAME: snmp_outgoing_address |
4385 | TYPE: address | |
4386 | LOC: Config.Addrs.snmp_outgoing | |
4387 | DEFAULT: 255.255.255.255 | |
4388 | IFDEF: SQUID_SNMP | |
cccac0a2 | 4389 | DOC_START |
df2eec10 | 4390 | Just like 'udp_incoming_address', but for the SNMP port. |
cccac0a2 | 4391 | |
5473c134 | 4392 | snmp_incoming_address is used for the SNMP socket receiving |
4393 | messages from SNMP agents. | |
4394 | snmp_outgoing_address is used for SNMP packets returned to SNMP | |
4395 | agents. | |
cccac0a2 | 4396 | |
5473c134 | 4397 | The default snmp_incoming_address (0.0.0.0) is to listen on all |
4398 | available network interfaces. | |
cccac0a2 | 4399 | |
5473c134 | 4400 | If snmp_outgoing_address is set to 255.255.255.255 (the default) |
4401 | it will use the same socket as snmp_incoming_address. Only | |
4402 | change this if you want to have SNMP replies sent using another | |
4403 | address than where this Squid listens for SNMP queries. | |
cccac0a2 | 4404 | |
5473c134 | 4405 | NOTE, snmp_incoming_address and snmp_outgoing_address can not have |
4406 | the same value since they both use port 3401. | |
cccac0a2 | 4407 | DOC_END |
4408 | ||
5473c134 | 4409 | COMMENT_START |
4410 | ICP OPTIONS | |
4411 | ----------------------------------------------------------------------------- | |
4412 | COMMENT_END | |
4413 | ||
4414 | NAME: icp_port udp_port | |
4415 | TYPE: ushort | |
4416 | DEFAULT: 0 | |
4417 | LOC: Config.Port.icp | |
cccac0a2 | 4418 | DOC_START |
5473c134 | 4419 | The port number where Squid sends and receives ICP queries to |
4420 | and from neighbor caches. The standard UDP port for ICP is 3130. | |
4421 | Default is disabled (0). | |
4422 | NOCOMMENT_START | |
df2eec10 | 4423 | #icp_port @DEFAULT_ICP_PORT@ |
5473c134 | 4424 | NOCOMMENT_END |
cccac0a2 | 4425 | DOC_END |
4426 | ||
5473c134 | 4427 | NAME: htcp_port |
4428 | IFDEF: USE_HTCP | |
4429 | TYPE: ushort | |
87630341 | 4430 | DEFAULT: 0 |
5473c134 | 4431 | LOC: Config.Port.htcp |
cccac0a2 | 4432 | DOC_START |
5473c134 | 4433 | The port number where Squid sends and receives HTCP queries to |
87630341 | 4434 | and from neighbor caches. To turn it on you want to set it to |
4435 | 4827. By default it is set to "0" (disabled). | |
4436 | NOCOMMENT_START | |
4437 | #htcp_port 4827 | |
4438 | NOCOMMENT_END | |
cccac0a2 | 4439 | DOC_END |
4440 | ||
4441 | NAME: log_icp_queries | |
4442 | COMMENT: on|off | |
4443 | TYPE: onoff | |
4444 | DEFAULT: on | |
4445 | LOC: Config.onoff.log_udp | |
4446 | DOC_START | |
4447 | If set, ICP queries are logged to access.log. You may wish | |
4448 | do disable this if your ICP load is VERY high to speed things | |
4449 | up or to simplify log analysis. | |
4450 | DOC_END | |
4451 | ||
5473c134 | 4452 | NAME: udp_incoming_address |
4453 | TYPE: address | |
4454 | LOC:Config.Addrs.udp_incoming | |
4455 | DEFAULT: 0.0.0.0 | |
8524d4b2 | 4456 | DOC_START |
4457 | udp_incoming_address is used for UDP packets received from other | |
4458 | caches. | |
4459 | ||
4460 | The default behavior is to not bind to any specific address. | |
4461 | ||
4462 | Only change this if you want to have all UDP queries received on | |
4463 | a specific interface/address. | |
4464 | ||
4465 | NOTE: udp_incoming_address is used by the ICP, HTCP, and DNS | |
4466 | modules. Altering it will affect all of them in the same manner. | |
4467 | ||
4468 | see also; udp_outgoing_address | |
4469 | ||
4470 | NOTE, udp_incoming_address and udp_outgoing_address can not | |
4471 | have the same value since they both use the same port. | |
4472 | DOC_END | |
cccac0a2 | 4473 | |
5473c134 | 4474 | NAME: udp_outgoing_address |
4475 | TYPE: address | |
4476 | LOC: Config.Addrs.udp_outgoing | |
4477 | DEFAULT: 255.255.255.255 | |
cccac0a2 | 4478 | DOC_START |
8524d4b2 | 4479 | udp_outgoing_address is used for UDP packets sent out to other |
5473c134 | 4480 | caches. |
cccac0a2 | 4481 | |
5473c134 | 4482 | The default behavior is to not bind to any specific address. |
cccac0a2 | 4483 | |
8524d4b2 | 4484 | Instead it will use the same socket as udp_incoming_address. |
4485 | Only change this if you want to have UDP queries sent using another | |
4486 | address than where this Squid listens for UDP queries from other | |
5473c134 | 4487 | caches. |
4488 | ||
8524d4b2 | 4489 | NOTE: udp_outgoing_address is used by the ICP, HTCP, and DNS |
4490 | modules. Altering it will affect all of them in the same manner. | |
4491 | ||
4492 | see also; udp_incoming_address | |
4493 | ||
5473c134 | 4494 | NOTE, udp_incoming_address and udp_outgoing_address can not |
8524d4b2 | 4495 | have the same value since they both use the same port. |
cccac0a2 | 4496 | DOC_END |
4497 | ||
3d1e3e43 | 4498 | NAME: icp_hit_stale |
4499 | COMMENT: on|off | |
4500 | TYPE: onoff | |
4501 | DEFAULT: off | |
4502 | LOC: Config.onoff.icp_hit_stale | |
4503 | DOC_START | |
4504 | If you want to return ICP_HIT for stale cache objects, set this | |
4505 | option to 'on'. If you have sibling relationships with caches | |
4506 | in other administrative domains, this should be 'off'. If you only | |
4507 | have sibling relationships with caches under your control, | |
4508 | it is probably okay to set this to 'on'. | |
4509 | If set to 'on', your siblings should use the option "allow-miss" | |
4510 | on their cache_peer lines for connecting to you. | |
4511 | DOC_END | |
4512 | ||
5473c134 | 4513 | NAME: minimum_direct_hops |
cccac0a2 | 4514 | TYPE: int |
5473c134 | 4515 | DEFAULT: 4 |
4516 | LOC: Config.minDirectHops | |
cccac0a2 | 4517 | DOC_START |
5473c134 | 4518 | If using the ICMP pinging stuff, do direct fetches for sites |
4519 | which are no more than this many hops away. | |
cccac0a2 | 4520 | DOC_END |
4521 | ||
5473c134 | 4522 | NAME: minimum_direct_rtt |
4523 | TYPE: int | |
4524 | DEFAULT: 400 | |
4525 | LOC: Config.minDirectRtt | |
cccac0a2 | 4526 | DOC_START |
5473c134 | 4527 | If using the ICMP pinging stuff, do direct fetches for sites |
4528 | which are no more than this many rtt milliseconds away. | |
cccac0a2 | 4529 | DOC_END |
4530 | ||
cccac0a2 | 4531 | NAME: netdb_low |
4532 | TYPE: int | |
4533 | DEFAULT: 900 | |
4534 | LOC: Config.Netdb.low | |
4535 | DOC_NONE | |
4536 | ||
4537 | NAME: netdb_high | |
4538 | TYPE: int | |
4539 | DEFAULT: 1000 | |
4540 | LOC: Config.Netdb.high | |
4541 | DOC_START | |
4542 | The low and high water marks for the ICMP measurement | |
4543 | database. These are counts, not percents. The defaults are | |
4544 | 900 and 1000. When the high water mark is reached, database | |
4545 | entries will be deleted until the low mark is reached. | |
4546 | DOC_END | |
4547 | ||
cccac0a2 | 4548 | NAME: netdb_ping_period |
4549 | TYPE: time_t | |
4550 | LOC: Config.Netdb.period | |
4551 | DEFAULT: 5 minutes | |
4552 | DOC_START | |
4553 | The minimum period for measuring a site. There will be at | |
4554 | least this much delay between successive pings to the same | |
4555 | network. The default is five minutes. | |
4556 | DOC_END | |
4557 | ||
cccac0a2 | 4558 | NAME: query_icmp |
4559 | COMMENT: on|off | |
4560 | TYPE: onoff | |
4561 | DEFAULT: off | |
4562 | LOC: Config.onoff.query_icmp | |
4563 | DOC_START | |
4564 | If you want to ask your peers to include ICMP data in their ICP | |
4565 | replies, enable this option. | |
4566 | ||
4567 | If your peer has configured Squid (during compilation) with | |
7f7db318 | 4568 | '--enable-icmp' that peer will send ICMP pings to origin server |
4569 | sites of the URLs it receives. If you enable this option the | |
cccac0a2 | 4570 | ICP replies from that peer will include the ICMP data (if available). |
4571 | Then, when choosing a parent cache, Squid will choose the parent with | |
4572 | the minimal RTT to the origin server. When this happens, the | |
4573 | hierarchy field of the access.log will be | |
4574 | "CLOSEST_PARENT_MISS". This option is off by default. | |
4575 | DOC_END | |
4576 | ||
4577 | NAME: test_reachability | |
4578 | COMMENT: on|off | |
4579 | TYPE: onoff | |
4580 | DEFAULT: off | |
4581 | LOC: Config.onoff.test_reachability | |
4582 | DOC_START | |
4583 | When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH | |
4584 | instead of ICP_MISS if the target host is NOT in the ICMP | |
4585 | database, or has a zero RTT. | |
4586 | DOC_END | |
4587 | ||
5473c134 | 4588 | NAME: icp_query_timeout |
4589 | COMMENT: (msec) | |
4590 | DEFAULT: 0 | |
4591 | TYPE: int | |
4592 | LOC: Config.Timeout.icp_query | |
4c3ef9b2 | 4593 | DOC_START |
5473c134 | 4594 | Normally Squid will automatically determine an optimal ICP |
4595 | query timeout value based on the round-trip-time of recent ICP | |
4596 | queries. If you want to override the value determined by | |
4597 | Squid, set this 'icp_query_timeout' to a non-zero value. This | |
4598 | value is specified in MILLISECONDS, so, to use a 2-second | |
4599 | timeout (the old default), you would write: | |
4c3ef9b2 | 4600 | |
5473c134 | 4601 | icp_query_timeout 2000 |
4c3ef9b2 | 4602 | DOC_END |
4603 | ||
5473c134 | 4604 | NAME: maximum_icp_query_timeout |
4605 | COMMENT: (msec) | |
4606 | DEFAULT: 2000 | |
4607 | TYPE: int | |
4608 | LOC: Config.Timeout.icp_query_max | |
cccac0a2 | 4609 | DOC_START |
5473c134 | 4610 | Normally the ICP query timeout is determined dynamically. But |
4611 | sometimes it can lead to very large values (say 5 seconds). | |
4612 | Use this option to put an upper limit on the dynamic timeout | |
4613 | value. Do NOT use this option to always use a fixed (instead | |
4614 | of a dynamic) timeout value. To set a fixed timeout see the | |
4615 | 'icp_query_timeout' directive. | |
cccac0a2 | 4616 | DOC_END |
4617 | ||
5473c134 | 4618 | NAME: minimum_icp_query_timeout |
4619 | COMMENT: (msec) | |
4620 | DEFAULT: 5 | |
4621 | TYPE: int | |
4622 | LOC: Config.Timeout.icp_query_min | |
cccac0a2 | 4623 | DOC_START |
5473c134 | 4624 | Normally the ICP query timeout is determined dynamically. But |
4625 | sometimes it can lead to very small timeouts, even lower than | |
4626 | the normal latency variance on your link due to traffic. | |
4627 | Use this option to put an lower limit on the dynamic timeout | |
4628 | value. Do NOT use this option to always use a fixed (instead | |
4629 | of a dynamic) timeout value. To set a fixed timeout see the | |
4630 | 'icp_query_timeout' directive. | |
cccac0a2 | 4631 | DOC_END |
4632 | ||
5473c134 | 4633 | NAME: background_ping_rate |
4634 | COMMENT: time-units | |
4635 | TYPE: time_t | |
4636 | DEFAULT: 10 seconds | |
4637 | LOC: Config.backgroundPingRate | |
cccac0a2 | 4638 | DOC_START |
5473c134 | 4639 | Controls how often the ICP pings are sent to siblings that |
4640 | have background-ping set. | |
cccac0a2 | 4641 | DOC_END |
4642 | ||
5473c134 | 4643 | COMMENT_START |
4644 | MULTICAST ICP OPTIONS | |
4645 | ----------------------------------------------------------------------------- | |
4646 | COMMENT_END | |
4647 | ||
4648 | NAME: mcast_groups | |
4649 | TYPE: wordlist | |
4650 | LOC: Config.mcast_group_list | |
8c01ada0 | 4651 | DEFAULT: none |
4652 | DOC_START | |
5473c134 | 4653 | This tag specifies a list of multicast groups which your server |
4654 | should join to receive multicasted ICP queries. | |
8c01ada0 | 4655 | |
5473c134 | 4656 | NOTE! Be very careful what you put here! Be sure you |
4657 | understand the difference between an ICP _query_ and an ICP | |
4658 | _reply_. This option is to be set only if you want to RECEIVE | |
4659 | multicast queries. Do NOT set this option to SEND multicast | |
4660 | ICP (use cache_peer for that). ICP replies are always sent via | |
4661 | unicast, so this option does not affect whether or not you will | |
4662 | receive replies from multicast group members. | |
8c01ada0 | 4663 | |
5473c134 | 4664 | You must be very careful to NOT use a multicast address which |
4665 | is already in use by another group of caches. | |
8c01ada0 | 4666 | |
5473c134 | 4667 | If you are unsure about multicast, please read the Multicast |
4668 | chapter in the Squid FAQ (http://www.squid-cache.org/FAQ/). | |
8c01ada0 | 4669 | |
5473c134 | 4670 | Usage: mcast_groups 239.128.16.128 224.0.1.20 |
8c01ada0 | 4671 | |
5473c134 | 4672 | By default, Squid doesn't listen on any multicast groups. |
4673 | DOC_END | |
8c01ada0 | 4674 | |
5473c134 | 4675 | NAME: mcast_miss_addr |
4676 | IFDEF: MULTICAST_MISS_STREAM | |
4677 | TYPE: address | |
4678 | LOC: Config.mcast_miss.addr | |
4679 | DEFAULT: 255.255.255.255 | |
4680 | DOC_START | |
4681 | If you enable this option, every "cache miss" URL will | |
4682 | be sent out on the specified multicast address. | |
cccac0a2 | 4683 | |
5473c134 | 4684 | Do not enable this option unless you are are absolutely |
4685 | certain you understand what you are doing. | |
cccac0a2 | 4686 | DOC_END |
4687 | ||
5473c134 | 4688 | NAME: mcast_miss_ttl |
4689 | IFDEF: MULTICAST_MISS_STREAM | |
4690 | TYPE: ushort | |
4691 | LOC: Config.mcast_miss.ttl | |
4692 | DEFAULT: 16 | |
cccac0a2 | 4693 | DOC_START |
5473c134 | 4694 | This is the time-to-live value for packets multicasted |
4695 | when multicasting off cache miss URLs is enabled. By | |
4696 | default this is set to 'site scope', i.e. 16. | |
4697 | DOC_END | |
cccac0a2 | 4698 | |
5473c134 | 4699 | NAME: mcast_miss_port |
4700 | IFDEF: MULTICAST_MISS_STREAM | |
4701 | TYPE: ushort | |
4702 | LOC: Config.mcast_miss.port | |
4703 | DEFAULT: 3135 | |
4704 | DOC_START | |
4705 | This is the port number to be used in conjunction with | |
4706 | 'mcast_miss_addr'. | |
4707 | DOC_END | |
cccac0a2 | 4708 | |
5473c134 | 4709 | NAME: mcast_miss_encode_key |
4710 | IFDEF: MULTICAST_MISS_STREAM | |
4711 | TYPE: string | |
4712 | LOC: Config.mcast_miss.encode_key | |
4713 | DEFAULT: XXXXXXXXXXXXXXXX | |
4714 | DOC_START | |
4715 | The URLs that are sent in the multicast miss stream are | |
4716 | encrypted. This is the encryption key. | |
4717 | DOC_END | |
8c01ada0 | 4718 | |
5473c134 | 4719 | NAME: mcast_icp_query_timeout |
4720 | COMMENT: (msec) | |
4721 | DEFAULT: 2000 | |
4722 | TYPE: int | |
4723 | LOC: Config.Timeout.mcast_icp_query | |
4724 | DOC_START | |
4725 | For multicast peers, Squid regularly sends out ICP "probes" to | |
4726 | count how many other peers are listening on the given multicast | |
4727 | address. This value specifies how long Squid should wait to | |
4728 | count all the replies. The default is 2000 msec, or 2 | |
4729 | seconds. | |
cccac0a2 | 4730 | DOC_END |
4731 | ||
5473c134 | 4732 | COMMENT_START |
4733 | INTERNAL ICON OPTIONS | |
4734 | ----------------------------------------------------------------------------- | |
4735 | COMMENT_END | |
4736 | ||
cccac0a2 | 4737 | NAME: icon_directory |
4738 | TYPE: string | |
4739 | LOC: Config.icons.directory | |
4740 | DEFAULT: @DEFAULT_ICON_DIR@ | |
4741 | DOC_START | |
4742 | Where the icons are stored. These are normally kept in | |
4743 | @DEFAULT_ICON_DIR@ | |
4744 | DOC_END | |
4745 | ||
f024c970 | 4746 | NAME: global_internal_static |
4747 | TYPE: onoff | |
4748 | LOC: Config.onoff.global_internal_static | |
4749 | DEFAULT: on | |
4750 | DOC_START | |
4751 | This directive controls is Squid should intercept all requests for | |
4752 | /squid-internal-static/ no matter which host the URL is requesting | |
4753 | (default on setting), or if nothing special should be done for | |
4754 | such URLs (off setting). The purpose of this directive is to make | |
4755 | icons etc work better in complex cache hierarchies where it may | |
4756 | not always be possible for all corners in the cache mesh to reach | |
4757 | the server generating a directory listing. | |
4758 | DOC_END | |
4759 | ||
5473c134 | 4760 | NAME: short_icon_urls |
4761 | TYPE: onoff | |
4762 | LOC: Config.icons.use_short_names | |
4763 | DEFAULT: on | |
4764 | DOC_START | |
4765 | If this is enabled Squid will use short URLs for icons. | |
4766 | If disabled it will revert to the old behavior of including | |
4767 | it's own name and port in the URL. | |
4768 | ||
4769 | If you run a complex cache hierarchy with a mix of Squid and | |
4770 | other proxies you may need to disable this directive. | |
4771 | DOC_END | |
4772 | ||
4773 | COMMENT_START | |
4774 | ERROR PAGE OPTIONS | |
4775 | ----------------------------------------------------------------------------- | |
4776 | COMMENT_END | |
4777 | ||
4778 | NAME: error_directory | |
4779 | TYPE: string | |
4780 | LOC: Config.errorDirectory | |
43000484 | 4781 | DEFAULT: none |
5473c134 | 4782 | DOC_START |
4783 | If you wish to create your own versions of the default | |
43000484 AJ |
4784 | error files to customize them to suit your company copy |
4785 | the error/template files to another directory and point | |
4786 | this tag at them. | |
4787 | ||
4788 | WARNING: This option will disable multi-language support | |
4789 | on error pages if used. | |
5473c134 | 4790 | |
4791 | The squid developers are interested in making squid available in | |
4792 | a wide variety of languages. If you are making translations for a | |
43000484 | 4793 | language that Squid does not currently provide please consider |
5473c134 | 4794 | contributing your translation back to the project. |
43000484 AJ |
4795 | http://wiki.squid-cache.org/Translations |
4796 | ||
4797 | The squid developers working on translations are happy to supply drop-in | |
4798 | translated error files in exchange for any new language contributions. | |
4799 | DOC_END | |
4800 | ||
4801 | NAME: error_default_language | |
4802 | IFDEF: USE_ERR_LOCALES | |
4803 | TYPE: string | |
4804 | LOC: Config.errorDefaultLanguage | |
4805 | DEFAULT: none | |
4806 | DOC_START | |
4807 | Set the default language which squid will send error pages in | |
4808 | if no existing translation matches the clients language | |
4809 | preferences. | |
4810 | ||
4811 | If unset (default) generic English will be used. | |
4812 | ||
4813 | The squid developers are interested in making squid available in | |
4814 | a wide variety of languages. If you are interested in making | |
4815 | translations for any language see the squid wiki for details. | |
4816 | http://wiki.squid-cache.org/Translations | |
5473c134 | 4817 | DOC_END |
4818 | ||
c411820c AJ |
4819 | NAME: error_log_languages |
4820 | IFDEF: USE_ERR_LOCALES | |
4821 | TYPE: onoff | |
4822 | LOC: Config.errorLogMissingLanguages | |
4823 | DEFAULT: on | |
4824 | DOC_START | |
4825 | Log to cache.log what languages users are attempting to | |
4826 | auto-negotiate for translations. | |
4827 | ||
4828 | Successful negotiations are not logged. Only failures | |
4829 | have meaning to indicate that Squid may need an upgrade | |
0c49f10e | 4830 | of its error page translations. |
c411820c AJ |
4831 | DOC_END |
4832 | ||
5b52cb6c AJ |
4833 | NAME: err_page_stylesheet |
4834 | TYPE: string | |
4835 | LOC: Config.errorStylesheet | |
4836 | DEFAULT: @DEFAULT_CONFIG_DIR@/errorpage.css | |
4837 | DOC_START | |
4838 | CSS Stylesheet to pattern the display of Squid default error pages. | |
4839 | ||
4840 | For information on CSS see http://www.w3.org/Style/CSS/ | |
4841 | DOC_END | |
4842 | ||
5473c134 | 4843 | NAME: err_html_text |
4844 | TYPE: eol | |
4845 | LOC: Config.errHtmlText | |
4846 | DEFAULT: none | |
4847 | DOC_START | |
4848 | HTML text to include in error messages. Make this a "mailto" | |
4849 | URL to your admin address, or maybe just a link to your | |
4850 | organizations Web page. | |
4851 | ||
4852 | To include this in your error messages, you must rewrite | |
4853 | the error template files (found in the "errors" directory). | |
4854 | Wherever you want the 'err_html_text' line to appear, | |
4855 | insert a %L tag in the error template file. | |
4856 | DOC_END | |
4857 | ||
4858 | NAME: email_err_data | |
4859 | COMMENT: on|off | |
4860 | TYPE: onoff | |
4861 | LOC: Config.onoff.emailErrData | |
4862 | DEFAULT: on | |
4863 | DOC_START | |
4864 | If enabled, information about the occurred error will be | |
4865 | included in the mailto links of the ERR pages (if %W is set) | |
4866 | so that the email body contains the data. | |
4867 | Syntax is <A HREF="mailto:%w%W">%w</A> | |
4868 | DOC_END | |
4869 | ||
4870 | NAME: deny_info | |
4871 | TYPE: denyinfo | |
4872 | LOC: Config.denyInfoList | |
4873 | DEFAULT: none | |
4874 | DOC_START | |
4875 | Usage: deny_info err_page_name acl | |
4876 | or deny_info http://... acl | |
43000484 | 4877 | or deny_info TCP_RESET acl |
5473c134 | 4878 | |
4879 | This can be used to return a ERR_ page for requests which | |
4880 | do not pass the 'http_access' rules. Squid remembers the last | |
4881 | acl it evaluated in http_access, and if a 'deny_info' line exists | |
4882 | for that ACL Squid returns a corresponding error page. | |
4883 | ||
4884 | The acl is typically the last acl on the http_access deny line which | |
4885 | denied access. The exceptions to this rule are: | |
4886 | - When Squid needs to request authentication credentials. It's then | |
4887 | the first authentication related acl encountered | |
4888 | - When none of the http_access lines matches. It's then the last | |
4889 | acl processed on the last http_access line. | |
4890 | ||
43000484 AJ |
4891 | NP: If providing your own custom error pages with error_directory |
4892 | you may also specify them by your custom file name: | |
4893 | Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys | |
5473c134 | 4894 | |
4895 | Alternatively you can specify an error URL. The browsers will | |
4896 | get redirected (302) to the specified URL. %s in the redirection | |
4897 | URL will be replaced by the requested URL. | |
4898 | ||
4899 | Alternatively you can tell Squid to reset the TCP connection | |
4900 | by specifying TCP_RESET. | |
4901 | DOC_END | |
4902 | ||
4903 | COMMENT_START | |
4904 | OPTIONS INFLUENCING REQUEST FORWARDING | |
4905 | ----------------------------------------------------------------------------- | |
4906 | COMMENT_END | |
4907 | ||
4908 | NAME: nonhierarchical_direct | |
e72a0ec0 | 4909 | TYPE: onoff |
5473c134 | 4910 | LOC: Config.onoff.nonhierarchical_direct |
e72a0ec0 | 4911 | DEFAULT: on |
4912 | DOC_START | |
5473c134 | 4913 | By default, Squid will send any non-hierarchical requests |
4914 | (matching hierarchy_stoplist or not cacheable request type) direct | |
4915 | to origin servers. | |
e72a0ec0 | 4916 | |
5473c134 | 4917 | If you set this to off, Squid will prefer to send these |
4918 | requests to parents. | |
0b0cfcf2 | 4919 | |
5473c134 | 4920 | Note that in most configurations, by turning this off you will only |
4921 | add latency to these request without any improvement in global hit | |
4922 | ratio. | |
0b0cfcf2 | 4923 | |
5473c134 | 4924 | If you are inside an firewall see never_direct instead of |
4925 | this directive. | |
8d6275c0 | 4926 | DOC_END |
0b0cfcf2 | 4927 | |
5473c134 | 4928 | NAME: prefer_direct |
8d6275c0 | 4929 | TYPE: onoff |
5473c134 | 4930 | LOC: Config.onoff.prefer_direct |
8d6275c0 | 4931 | DEFAULT: off |
4932 | DOC_START | |
5473c134 | 4933 | Normally Squid tries to use parents for most requests. If you for some |
4934 | reason like it to first try going direct and only use a parent if | |
4935 | going direct fails set this to on. | |
0b0cfcf2 | 4936 | |
5473c134 | 4937 | By combining nonhierarchical_direct off and prefer_direct on you |
4938 | can set up Squid to use a parent as a backup path if going direct | |
4939 | fails. | |
4940 | ||
4941 | Note: If you want Squid to use parents for all requests see | |
4942 | the never_direct directive. prefer_direct only modifies how Squid | |
4943 | acts on cacheable requests. | |
cccac0a2 | 4944 | DOC_END |
4945 | ||
5473c134 | 4946 | NAME: always_direct |
8d6275c0 | 4947 | TYPE: acl_access |
5473c134 | 4948 | LOC: Config.accessList.AlwaysDirect |
0b0cfcf2 | 4949 | DEFAULT: none |
0b0cfcf2 | 4950 | DOC_START |
5473c134 | 4951 | Usage: always_direct allow|deny [!]aclname ... |
0b0cfcf2 | 4952 | |
5473c134 | 4953 | Here you can use ACL elements to specify requests which should |
4954 | ALWAYS be forwarded by Squid to the origin servers without using | |
4955 | any peers. For example, to always directly forward requests for | |
4956 | local servers ignoring any parents or siblings you may have use | |
4957 | something like: | |
0b0cfcf2 | 4958 | |
5473c134 | 4959 | acl local-servers dstdomain my.domain.net |
4960 | always_direct allow local-servers | |
0b0cfcf2 | 4961 | |
5473c134 | 4962 | To always forward FTP requests directly, use |
f16fbc82 | 4963 | |
5473c134 | 4964 | acl FTP proto FTP |
4965 | always_direct allow FTP | |
cccac0a2 | 4966 | |
5473c134 | 4967 | NOTE: There is a similar, but opposite option named |
4968 | 'never_direct'. You need to be aware that "always_direct deny | |
4969 | foo" is NOT the same thing as "never_direct allow foo". You | |
4970 | may need to use a deny rule to exclude a more-specific case of | |
4971 | some other rule. Example: | |
8d6275c0 | 4972 | |
5473c134 | 4973 | acl local-external dstdomain external.foo.net |
4974 | acl local-servers dstdomain .foo.net | |
4975 | always_direct deny local-external | |
4976 | always_direct allow local-servers | |
8d6275c0 | 4977 | |
5473c134 | 4978 | NOTE: If your goal is to make the client forward the request |
4979 | directly to the origin server bypassing Squid then this needs | |
4980 | to be done in the client configuration. Squid configuration | |
4981 | can only tell Squid how Squid should fetch the object. | |
8d6275c0 | 4982 | |
5473c134 | 4983 | NOTE: This directive is not related to caching. The replies |
4984 | is cached as usual even if you use always_direct. To not cache | |
4985 | the replies see no_cache. | |
4986 | ||
4987 | This option replaces some v1.1 options such as local_domain | |
4988 | and local_ip. | |
cccac0a2 | 4989 | DOC_END |
0976f8db | 4990 | |
5473c134 | 4991 | NAME: never_direct |
4992 | TYPE: acl_access | |
4993 | LOC: Config.accessList.NeverDirect | |
4994 | DEFAULT: none | |
8d6275c0 | 4995 | DOC_START |
5473c134 | 4996 | Usage: never_direct allow|deny [!]aclname ... |
4997 | ||
4998 | never_direct is the opposite of always_direct. Please read | |
4999 | the description for always_direct if you have not already. | |
5000 | ||
5001 | With 'never_direct' you can use ACL elements to specify | |
5002 | requests which should NEVER be forwarded directly to origin | |
5003 | servers. For example, to force the use of a proxy for all | |
5004 | requests, except those in your local domain use something like: | |
5005 | ||
5006 | acl local-servers dstdomain .foo.net | |
5473c134 | 5007 | never_direct deny local-servers |
5008 | never_direct allow all | |
5009 | ||
5010 | or if Squid is inside a firewall and there are local intranet | |
5011 | servers inside the firewall use something like: | |
5012 | ||
5013 | acl local-intranet dstdomain .foo.net | |
5014 | acl local-external dstdomain external.foo.net | |
5015 | always_direct deny local-external | |
5016 | always_direct allow local-intranet | |
5017 | never_direct allow all | |
5018 | ||
5019 | This option replaces some v1.1 options such as inside_firewall | |
5020 | and firewall_ip. | |
8d6275c0 | 5021 | DOC_END |
0976f8db | 5022 | |
5473c134 | 5023 | COMMENT_START |
5024 | ADVANCED NETWORKING OPTIONS | |
5025 | ----------------------------------------------------------------------------- | |
5026 | COMMENT_END | |
5027 | ||
cccac0a2 | 5028 | NAME: incoming_icp_average |
5029 | TYPE: int | |
5030 | DEFAULT: 6 | |
5031 | LOC: Config.comm_incoming.icp_average | |
5032 | DOC_NONE | |
5033 | ||
5034 | NAME: incoming_http_average | |
5035 | TYPE: int | |
5036 | DEFAULT: 4 | |
5037 | LOC: Config.comm_incoming.http_average | |
5038 | DOC_NONE | |
5039 | ||
5040 | NAME: incoming_dns_average | |
5041 | TYPE: int | |
5042 | DEFAULT: 4 | |
5043 | LOC: Config.comm_incoming.dns_average | |
5044 | DOC_NONE | |
5045 | ||
5046 | NAME: min_icp_poll_cnt | |
5047 | TYPE: int | |
5048 | DEFAULT: 8 | |
5049 | LOC: Config.comm_incoming.icp_min_poll | |
5050 | DOC_NONE | |
5051 | ||
5052 | NAME: min_dns_poll_cnt | |
5053 | TYPE: int | |
5054 | DEFAULT: 8 | |
5055 | LOC: Config.comm_incoming.dns_min_poll | |
5056 | DOC_NONE | |
5057 | ||
5058 | NAME: min_http_poll_cnt | |
5059 | TYPE: int | |
5060 | DEFAULT: 8 | |
5061 | LOC: Config.comm_incoming.http_min_poll | |
5062 | DOC_START | |
5473c134 | 5063 | Heavy voodoo here. I can't even believe you are reading this. |
5064 | Are you crazy? Don't even think about adjusting these unless | |
5065 | you understand the algorithms in comm_select.c first! | |
5066 | DOC_END | |
5067 | ||
5068 | NAME: accept_filter | |
5473c134 | 5069 | TYPE: string |
5070 | DEFAULT: none | |
5071 | LOC: Config.accept_filter | |
5072 | DOC_START | |
0b4d4be5 | 5073 | FreeBSD: |
5074 | ||
5473c134 | 5075 | The name of an accept(2) filter to install on Squid's |
5076 | listen socket(s). This feature is perhaps specific to | |
5077 | FreeBSD and requires support in the kernel. | |
5078 | ||
5079 | The 'httpready' filter delays delivering new connections | |
2324cda2 | 5080 | to Squid until a full HTTP request has been received. |
0b4d4be5 | 5081 | See the accf_http(9) man page for details. |
5082 | ||
5083 | The 'dataready' filter delays delivering new connections | |
5084 | to Squid until there is some data to process. | |
5085 | See the accf_dataready(9) man page for details. | |
5086 | ||
5087 | Linux: | |
5088 | ||
5089 | The 'data' filter delays delivering of new connections | |
5090 | to Squid until there is some data to process by TCP_ACCEPT_DEFER. | |
5091 | You may optionally specify a number of seconds to wait by | |
5092 | 'data=N' where N is the number of seconds. Defaults to 30 | |
5093 | if not specified. See the tcp(7) man page for details. | |
5473c134 | 5094 | EXAMPLE: |
0b4d4be5 | 5095 | # FreeBSD |
5473c134 | 5096 | accept_filter httpready |
0b4d4be5 | 5097 | # Linux |
5098 | accept_filter data | |
5473c134 | 5099 | DOC_END |
5100 | ||
5101 | NAME: tcp_recv_bufsize | |
5102 | COMMENT: (bytes) | |
5103 | TYPE: b_size_t | |
5104 | DEFAULT: 0 bytes | |
5105 | LOC: Config.tcpRcvBufsz | |
5106 | DOC_START | |
5107 | Size of receive buffer to set for TCP sockets. Probably just | |
5108 | as easy to change your kernel's default. Set to zero to use | |
5109 | the default buffer size. | |
5110 | DOC_END | |
5111 | ||
5112 | COMMENT_START | |
5113 | ICAP OPTIONS | |
5114 | ----------------------------------------------------------------------------- | |
5115 | COMMENT_END | |
5116 | ||
5117 | NAME: icap_enable | |
5118 | TYPE: onoff | |
5119 | IFDEF: ICAP_CLIENT | |
5120 | COMMENT: on|off | |
5121 | LOC: TheICAPConfig.onoff | |
5122 | DEFAULT: off | |
5123 | DOC_START | |
53e738c6 | 5124 | If you want to enable the ICAP module support, set this to on. |
5473c134 | 5125 | DOC_END |
5126 | ||
5127 | NAME: icap_connect_timeout | |
5128 | TYPE: time_t | |
5129 | DEFAULT: none | |
5130 | LOC: TheICAPConfig.connect_timeout_raw | |
5131 | IFDEF: ICAP_CLIENT | |
5132 | DOC_START | |
5133 | This parameter specifies how long to wait for the TCP connect to | |
5134 | the requested ICAP server to complete before giving up and either | |
5135 | terminating the HTTP transaction or bypassing the failure. | |
5136 | ||
5137 | The default for optional services is peer_connect_timeout. | |
5138 | The default for essential services is connect_timeout. | |
5139 | If this option is explicitly set, its value applies to all services. | |
5140 | DOC_END | |
5141 | ||
5142 | NAME: icap_io_timeout | |
5143 | COMMENT: time-units | |
5144 | TYPE: time_t | |
5145 | DEFAULT: none | |
5146 | LOC: TheICAPConfig.io_timeout_raw | |
5147 | IFDEF: ICAP_CLIENT | |
5148 | DOC_START | |
5149 | This parameter specifies how long to wait for an I/O activity on | |
5150 | an established, active ICAP connection before giving up and | |
5151 | either terminating the HTTP transaction or bypassing the | |
5152 | failure. | |
5153 | ||
5154 | The default is read_timeout. | |
5155 | DOC_END | |
5156 | ||
5157 | NAME: icap_service_failure_limit | |
5158 | TYPE: int | |
5159 | IFDEF: ICAP_CLIENT | |
5160 | LOC: TheICAPConfig.service_failure_limit | |
5161 | DEFAULT: 10 | |
5162 | DOC_START | |
5163 | The limit specifies the number of failures that Squid tolerates | |
5164 | when establishing a new TCP connection with an ICAP service. If | |
5165 | the number of failures exceeds the limit, the ICAP service is | |
5166 | not used for new ICAP requests until it is time to refresh its | |
5167 | OPTIONS. The per-service failure counter is reset to zero each | |
5168 | time Squid fetches new service OPTIONS. | |
5169 | ||
5170 | A negative value disables the limit. Without the limit, an ICAP | |
5171 | service will not be considered down due to connectivity failures | |
5172 | between ICAP OPTIONS requests. | |
cccac0a2 | 5173 | DOC_END |
5174 | ||
5473c134 | 5175 | NAME: icap_service_revival_delay |
cccac0a2 | 5176 | TYPE: int |
5473c134 | 5177 | IFDEF: ICAP_CLIENT |
5178 | LOC: TheICAPConfig.service_revival_delay | |
5179 | DEFAULT: 180 | |
cccac0a2 | 5180 | DOC_START |
5473c134 | 5181 | The delay specifies the number of seconds to wait after an ICAP |
5182 | OPTIONS request failure before requesting the options again. The | |
5183 | failed ICAP service is considered "down" until fresh OPTIONS are | |
5184 | fetched. | |
cccac0a2 | 5185 | |
5473c134 | 5186 | The actual delay cannot be smaller than the hardcoded minimum |
5187 | delay of 30 seconds. | |
cccac0a2 | 5188 | DOC_END |
5189 | ||
5473c134 | 5190 | NAME: icap_preview_enable |
cccac0a2 | 5191 | TYPE: onoff |
5473c134 | 5192 | IFDEF: ICAP_CLIENT |
5193 | COMMENT: on|off | |
5194 | LOC: TheICAPConfig.preview_enable | |
ac7a62f9 | 5195 | DEFAULT: on |
cccac0a2 | 5196 | DOC_START |
ac7a62f9 | 5197 | The ICAP Preview feature allows the ICAP server to handle the |
5198 | HTTP message by looking only at the beginning of the message body | |
5199 | or even without receiving the body at all. In some environments, | |
5200 | previews greatly speedup ICAP processing. | |
5201 | ||
5202 | During an ICAP OPTIONS transaction, the server may tell Squid what | |
5203 | HTTP messages should be previewed and how big the preview should be. | |
5204 | Squid will not use Preview if the server did not request one. | |
5205 | ||
5206 | To disable ICAP Preview for all ICAP services, regardless of | |
5207 | individual ICAP server OPTIONS responses, set this option to "off". | |
5208 | Example: | |
5209 | icap_preview_enable off | |
cccac0a2 | 5210 | DOC_END |
5211 | ||
5473c134 | 5212 | NAME: icap_preview_size |
5213 | TYPE: int | |
5214 | IFDEF: ICAP_CLIENT | |
5215 | LOC: TheICAPConfig.preview_size | |
5216 | DEFAULT: -1 | |
cccac0a2 | 5217 | DOC_START |
53e738c6 | 5218 | The default size of preview data to be sent to the ICAP server. |
5219 | -1 means no preview. This value might be overwritten on a per server | |
5220 | basis by OPTIONS requests. | |
cccac0a2 | 5221 | DOC_END |
5222 | ||
5473c134 | 5223 | NAME: icap_default_options_ttl |
5224 | TYPE: int | |
5225 | IFDEF: ICAP_CLIENT | |
5226 | LOC: TheICAPConfig.default_options_ttl | |
5227 | DEFAULT: 60 | |
cccac0a2 | 5228 | DOC_START |
53e738c6 | 5229 | The default TTL value for ICAP OPTIONS responses that don't have |
5473c134 | 5230 | an Options-TTL header. |
cccac0a2 | 5231 | DOC_END |
5232 | ||
5473c134 | 5233 | NAME: icap_persistent_connections |
5234 | TYPE: onoff | |
5235 | IFDEF: ICAP_CLIENT | |
5236 | COMMENT: on|off | |
5237 | LOC: TheICAPConfig.reuse_connections | |
5238 | DEFAULT: on | |
cccac0a2 | 5239 | DOC_START |
5473c134 | 5240 | Whether or not Squid should use persistent connections to |
5241 | an ICAP server. | |
cccac0a2 | 5242 | DOC_END |
5243 | ||
5473c134 | 5244 | NAME: icap_send_client_ip |
5245 | TYPE: onoff | |
5246 | IFDEF: ICAP_CLIENT | |
5247 | COMMENT: on|off | |
5248 | LOC: TheICAPConfig.send_client_ip | |
5249 | DEFAULT: off | |
cccac0a2 | 5250 | DOC_START |
53e738c6 | 5251 | This adds the header "X-Client-IP" to ICAP requests. |
cccac0a2 | 5252 | DOC_END |
5253 | ||
5473c134 | 5254 | NAME: icap_send_client_username |
5255 | TYPE: onoff | |
5256 | IFDEF: ICAP_CLIENT | |
5257 | COMMENT: on|off | |
5258 | LOC: TheICAPConfig.send_client_username | |
5259 | DEFAULT: off | |
cccac0a2 | 5260 | DOC_START |
5473c134 | 5261 | This sends authenticated HTTP client username (if available) to |
5262 | the ICAP service. The username value is encoded based on the | |
5263 | icap_client_username_encode option and is sent using the header | |
5264 | specified by the icap_client_username_header option. | |
cccac0a2 | 5265 | DOC_END |
5266 | ||
5473c134 | 5267 | NAME: icap_client_username_header |
cccac0a2 | 5268 | TYPE: string |
5473c134 | 5269 | IFDEF: ICAP_CLIENT |
5270 | LOC: TheICAPConfig.client_username_header | |
5271 | DEFAULT: X-Client-Username | |
cccac0a2 | 5272 | DOC_START |
5473c134 | 5273 | ICAP request header name to use for send_client_username. |
cccac0a2 | 5274 | DOC_END |
5275 | ||
5473c134 | 5276 | NAME: icap_client_username_encode |
cccac0a2 | 5277 | TYPE: onoff |
5473c134 | 5278 | IFDEF: ICAP_CLIENT |
5279 | COMMENT: on|off | |
5280 | LOC: TheICAPConfig.client_username_encode | |
5281 | DEFAULT: off | |
cccac0a2 | 5282 | DOC_START |
5473c134 | 5283 | Whether to base64 encode the authenticated client username. |
cccac0a2 | 5284 | DOC_END |
5285 | ||
5473c134 | 5286 | NAME: icap_service |
5287 | TYPE: icap_service_type | |
5288 | IFDEF: ICAP_CLIENT | |
5289 | LOC: TheICAPConfig | |
5290 | DEFAULT: none | |
cccac0a2 | 5291 | DOC_START |
53e738c6 | 5292 | Defines a single ICAP service |
cccac0a2 | 5293 | |
53e738c6 | 5294 | icap_service servicename vectoring_point bypass service_url |
7d90757b | 5295 | |
53e738c6 | 5296 | vectoring_point = reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache |
f3db09e2 | 5297 | This specifies at which point of transaction processing the |
5298 | ICAP service should be activated. *_postcache vectoring points | |
5299 | are not yet supported. | |
53e738c6 | 5300 | bypass = 1|0 |
f3db09e2 | 5301 | If set to 1, the ICAP service is treated as optional. If the |
5302 | service cannot be reached or malfunctions, Squid will try to | |
5303 | ignore any errors and process the message as if the service | |
5304 | was not enabled. No all ICAP errors can be bypassed. | |
5305 | If set to 0, the ICAP service is treated as essential and all | |
5306 | ICAP errors will result in an error page returned to the | |
5307 | HTTP client. | |
53e738c6 | 5308 | service_url = icap://servername:port/service |
5473c134 | 5309 | |
5473c134 | 5310 | Example: |
5311 | icap_service service_1 reqmod_precache 0 icap://icap1.mydomain.net:1344/reqmod | |
5312 | icap_service service_2 respmod_precache 0 icap://icap2.mydomain.net:1344/respmod | |
cccac0a2 | 5313 | DOC_END |
5314 | ||
5473c134 | 5315 | NAME: icap_class |
5316 | TYPE: icap_class_type | |
5317 | IFDEF: ICAP_CLIENT | |
21a26d31 | 5318 | LOC: none |
5473c134 | 5319 | DEFAULT: none |
cccac0a2 | 5320 | DOC_START |
62c7f90e AR |
5321 | This depricated option was documented to define an ICAP service |
5322 | chain, even though it actually defined a set of similar, redundant | |
5323 | services, and the chains were not supported. | |
5473c134 | 5324 | |
62c7f90e AR |
5325 | To define a set of redundant services, please use the |
5326 | adaptation_service_set directive. | |
5473c134 | 5327 | |
62c7f90e AR |
5328 | If you need adaptation service chains, patches or sponsorship |
5329 | is welcome. | |
cccac0a2 | 5330 | DOC_END |
5331 | ||
5473c134 | 5332 | NAME: icap_access |
5333 | TYPE: icap_access_type | |
5334 | IFDEF: ICAP_CLIENT | |
21a26d31 | 5335 | LOC: none |
cccac0a2 | 5336 | DEFAULT: none |
cccac0a2 | 5337 | DOC_START |
62c7f90e AR |
5338 | This option is depricated. Please use adaptation_access, which |
5339 | has the same ICAP functionality, but comes with better | |
5340 | documentation, and eCAP support. | |
cccac0a2 | 5341 | DOC_END |
5342 | ||
57afc994 AR |
5343 | COMMENT_START |
5344 | eCAP OPTIONS | |
5345 | ----------------------------------------------------------------------------- | |
5346 | COMMENT_END | |
5347 | ||
21a26d31 AR |
5348 | NAME: ecap_enable |
5349 | TYPE: onoff | |
5350 | IFDEF: USE_ECAP | |
5351 | COMMENT: on|off | |
5352 | LOC: Ecap::TheConfig.onoff | |
5353 | DEFAULT: off | |
5354 | DOC_START | |
5355 | Controls whether eCAP support is enabled. | |
5356 | DOC_END | |
5357 | ||
5358 | NAME: ecap_service | |
5359 | TYPE: ecap_service_type | |
5360 | IFDEF: USE_ECAP | |
5361 | LOC: Ecap::TheConfig | |
5362 | DEFAULT: none | |
5363 | DOC_START | |
5364 | Defines a single eCAP service | |
5365 | ||
5366 | ecap_service servicename vectoring_point bypass service_url | |
5367 | ||
5368 | vectoring_point = reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache | |
5369 | This specifies at which point of transaction processing the | |
5370 | eCAP service should be activated. *_postcache vectoring points | |
5371 | are not yet supported. | |
5372 | bypass = 1|0 | |
5373 | If set to 1, the eCAP service is treated as optional. If the | |
5374 | service cannot be reached or malfunctions, Squid will try to | |
5375 | ignore any errors and process the message as if the service | |
5376 | was not enabled. No all eCAP errors can be bypassed. | |
5377 | If set to 0, the eCAP service is treated as essential and all | |
5378 | eCAP errors will result in an error page returned to the | |
5379 | HTTP client. | |
5380 | service_url = ecap://vendor/service_name?custom&cgi=style¶meters=optional | |
5381 | ||
5382 | Example: | |
5383 | ecap_service service_1 reqmod_precache 0 ecap://filters-R-us/leakDetector?on_error=block | |
5384 | ecap_service service_2 respmod_precache 1 icap://filters-R-us/virusFilter?config=/etc/vf.cfg | |
5385 | DOC_END | |
5386 | ||
57afc994 AR |
5387 | NAME: loadable_modules |
5388 | TYPE: wordlist | |
5389 | IFDEF: USE_LOADABLE_MODULES | |
5390 | LOC: Config.loadable_module_names | |
5391 | DEFAULT: none | |
5392 | DOC_START | |
5393 | Instructs Squid to load the specified dynamic module(s) or activate | |
5394 | preloaded module(s). | |
5395 | Example: | |
5396 | loadable_modules @DEFAULT_PREFIX@/lib/MinimalAdapter.so | |
5397 | DOC_END | |
5398 | ||
62c7f90e AR |
5399 | COMMENT_START |
5400 | MESSAGE ADAPTATION OPTIONS | |
5401 | ----------------------------------------------------------------------------- | |
5402 | COMMENT_END | |
5403 | ||
5404 | NAME: adaptation_service_set | |
5405 | TYPE: adaptation_service_set_type | |
5406 | IFDEF: USE_ADAPTATION | |
5407 | LOC: none | |
5408 | DEFAULT: none | |
5409 | DOC_START | |
5410 | ||
5411 | Defines a named adaptation service set. The set is populated in | |
5412 | the order of adaptation_service_set directives in this file. | |
5413 | When adaptation ACLs are processed, the first and only the first | |
5414 | applicable adaptation service from the set will be used. Thus, | |
5415 | the set should group similar, redundant services, rather than a | |
5416 | chain of complementary services. | |
5417 | ||
5418 | If you have a single adaptation service, you do not need to | |
5419 | define a set containing it because adaptation_access accepts | |
5420 | service names. | |
5421 | ||
5422 | See also: adaptation_access | |
5423 | ||
5424 | Example: | |
5425 | adaptation_service_set svcBlocker urlFilterPrimary urlFilterBackup | |
5426 | adaptation service_set svcLogger loggerLocal loggerRemote | |
5427 | DOC_END | |
5428 | ||
5429 | NAME: adaptation_access | |
5430 | TYPE: adaptation_access_type | |
5431 | IFDEF: USE_ADAPTATION | |
5432 | LOC: none | |
5433 | DEFAULT: none | |
5434 | DOC_START | |
5435 | Sends an HTTP transaction to an ICAP or eCAP adaptation service. | |
5436 | ||
5437 | adaptation_access service_name allow|deny [!]aclname... | |
5438 | adaptation_access set_name allow|deny [!]aclname... | |
5439 | ||
5440 | At each supported vectoring point, the adaptation_access | |
5441 | statements are processed in the order they appear in this | |
5442 | configuration file. Statements pointing to the following services | |
5443 | are ignored (i.e., skipped without checking their ACL): | |
5444 | ||
5445 | - services serving different vectoring points | |
5446 | - "broken-but-bypassable" services | |
5447 | - "up" services configured to ignore such transactions | |
5448 | (e.g., based on the ICAP Transfer-Ignore header). | |
5449 | ||
5450 | When a set_name is used, all services in the set are checked | |
5451 | using the same rules, to find the first applicable one. See | |
5452 | adaptation_service_set for details. | |
5453 | ||
5454 | If an access list is checked and there is a match, the | |
5455 | processing stops: For an "allow" rule, the corresponding | |
5456 | adaptation service is used for the transaction. For a "deny" | |
5457 | rule, no adaptation service is activated. | |
5458 | ||
5459 | It is currently not possible to apply more than one adaptation | |
5460 | service at the same vectoring point to the same HTTP transaction. | |
5461 | ||
5462 | See also: icap_service and ecap_service | |
5463 | ||
5464 | Example: | |
5465 | adaptation_access service_1 allow all | |
5466 | DOC_END | |
5467 | ||
5473c134 | 5468 | COMMENT_START |
5469 | DNS OPTIONS | |
5470 | ----------------------------------------------------------------------------- | |
5471 | COMMENT_END | |
5472 | ||
5473 | NAME: check_hostnames | |
cccac0a2 | 5474 | TYPE: onoff |
cccac0a2 | 5475 | DEFAULT: off |
5473c134 | 5476 | LOC: Config.onoff.check_hostnames |
cccac0a2 | 5477 | DOC_START |
5473c134 | 5478 | For security and stability reasons Squid can check |
5479 | hostnames for Internet standard RFC compliance. If you want | |
5480 | Squid to perform these checks turn this directive on. | |
cccac0a2 | 5481 | DOC_END |
5482 | ||
5473c134 | 5483 | NAME: allow_underscore |
cccac0a2 | 5484 | TYPE: onoff |
cccac0a2 | 5485 | DEFAULT: on |
5473c134 | 5486 | LOC: Config.onoff.allow_underscore |
cccac0a2 | 5487 | DOC_START |
5473c134 | 5488 | Underscore characters is not strictly allowed in Internet hostnames |
5489 | but nevertheless used by many sites. Set this to off if you want | |
5490 | Squid to be strict about the standard. | |
5491 | This check is performed only when check_hostnames is set to on. | |
cccac0a2 | 5492 | DOC_END |
5493 | ||
5473c134 | 5494 | NAME: cache_dns_program |
cccac0a2 | 5495 | TYPE: string |
5473c134 | 5496 | IFDEF: USE_DNSSERVERS |
5497 | DEFAULT: @DEFAULT_DNSSERVER@ | |
5498 | LOC: Config.Program.dnsserver | |
cccac0a2 | 5499 | DOC_START |
5473c134 | 5500 | Specify the location of the executable for dnslookup process. |
cccac0a2 | 5501 | DOC_END |
5502 | ||
5473c134 | 5503 | NAME: dns_children |
5504 | TYPE: int | |
5505 | IFDEF: USE_DNSSERVERS | |
5506 | DEFAULT: 5 | |
5507 | LOC: Config.dnsChildren | |
58850d15 | 5508 | DOC_START |
5473c134 | 5509 | The number of processes spawn to service DNS name lookups. |
5510 | For heavily loaded caches on large servers, you should | |
5511 | probably increase this value to at least 10. The maximum | |
5512 | is 32. The default is 5. | |
58850d15 | 5513 | |
5473c134 | 5514 | You must have at least one dnsserver process. |
58850d15 | 5515 | DOC_END |
5516 | ||
5473c134 | 5517 | NAME: dns_retransmit_interval |
5518 | TYPE: time_t | |
5519 | DEFAULT: 5 seconds | |
5520 | LOC: Config.Timeout.idns_retransmit | |
5521 | IFDEF: !USE_DNSSERVERS | |
cccac0a2 | 5522 | DOC_START |
5473c134 | 5523 | Initial retransmit interval for DNS queries. The interval is |
5524 | doubled each time all configured DNS servers have been tried. | |
cccac0a2 | 5525 | |
cccac0a2 | 5526 | DOC_END |
5527 | ||
5473c134 | 5528 | NAME: dns_timeout |
5529 | TYPE: time_t | |
5530 | DEFAULT: 2 minutes | |
5531 | LOC: Config.Timeout.idns_query | |
5532 | IFDEF: !USE_DNSSERVERS | |
cccac0a2 | 5533 | DOC_START |
5473c134 | 5534 | DNS Query timeout. If no response is received to a DNS query |
5535 | within this time all DNS servers for the queried domain | |
5536 | are assumed to be unavailable. | |
cccac0a2 | 5537 | DOC_END |
5538 | ||
5473c134 | 5539 | NAME: dns_defnames |
5540 | COMMENT: on|off | |
cccac0a2 | 5541 | TYPE: onoff |
cccac0a2 | 5542 | DEFAULT: off |
5473c134 | 5543 | LOC: Config.onoff.res_defnames |
cccac0a2 | 5544 | DOC_START |
5473c134 | 5545 | Normally the RES_DEFNAMES resolver option is disabled |
5546 | (see res_init(3)). This prevents caches in a hierarchy | |
5547 | from interpreting single-component hostnames locally. To allow | |
5548 | Squid to handle single-component names, enable this option. | |
cccac0a2 | 5549 | DOC_END |
5550 | ||
5473c134 | 5551 | NAME: dns_nameservers |
5552 | TYPE: wordlist | |
5553 | DEFAULT: none | |
5554 | LOC: Config.dns_nameservers | |
cccac0a2 | 5555 | DOC_START |
5473c134 | 5556 | Use this if you want to specify a list of DNS name servers |
5557 | (IP addresses) to use instead of those given in your | |
5558 | /etc/resolv.conf file. | |
5559 | On Windows platforms, if no value is specified here or in | |
5560 | the /etc/resolv.conf file, the list of DNS name servers are | |
5561 | taken from the Windows registry, both static and dynamic DHCP | |
5562 | configurations are supported. | |
cccac0a2 | 5563 | |
5473c134 | 5564 | Example: dns_nameservers 10.0.0.1 192.172.0.4 |
cccac0a2 | 5565 | DOC_END |
5566 | ||
5473c134 | 5567 | NAME: hosts_file |
cccac0a2 | 5568 | TYPE: string |
5473c134 | 5569 | DEFAULT: @DEFAULT_HOSTS@ |
5570 | LOC: Config.etcHostsPath | |
cccac0a2 | 5571 | DOC_START |
5473c134 | 5572 | Location of the host-local IP name-address associations |
5573 | database. Most Operating Systems have such a file on different | |
5574 | default locations: | |
5575 | - Un*X & Linux: /etc/hosts | |
5576 | - Windows NT/2000: %SystemRoot%\system32\drivers\etc\hosts | |
5577 | (%SystemRoot% value install default is c:\winnt) | |
5578 | - Windows XP/2003: %SystemRoot%\system32\drivers\etc\hosts | |
5579 | (%SystemRoot% value install default is c:\windows) | |
5580 | - Windows 9x/Me: %windir%\hosts | |
5581 | (%windir% value is usually c:\windows) | |
5582 | - Cygwin: /etc/hosts | |
cccac0a2 | 5583 | |
5473c134 | 5584 | The file contains newline-separated definitions, in the |
5585 | form ip_address_in_dotted_form name [name ...] names are | |
5586 | whitespace-separated. Lines beginning with an hash (#) | |
5587 | character are comments. | |
cccac0a2 | 5588 | |
5473c134 | 5589 | The file is checked at startup and upon configuration. |
5590 | If set to 'none', it won't be checked. | |
5591 | If append_domain is used, that domain will be added to | |
5592 | domain-local (i.e. not containing any dot character) host | |
5593 | definitions. | |
cccac0a2 | 5594 | DOC_END |
5595 | ||
5473c134 | 5596 | NAME: append_domain |
5597 | TYPE: string | |
5598 | LOC: Config.appendDomain | |
5599 | DEFAULT: none | |
6a2f3fcf | 5600 | DOC_START |
5473c134 | 5601 | Appends local domain name to hostnames without any dots in |
5602 | them. append_domain must begin with a period. | |
5603 | ||
5604 | Be warned there are now Internet names with no dots in | |
5605 | them using only top-domain names, so setting this may | |
5606 | cause some Internet sites to become unavailable. | |
5607 | ||
5608 | Example: | |
5609 | append_domain .yourdomain.com | |
6a2f3fcf | 5610 | DOC_END |
5611 | ||
5473c134 | 5612 | NAME: ignore_unknown_nameservers |
5613 | TYPE: onoff | |
5614 | LOC: Config.onoff.ignore_unknown_nameservers | |
df6fd596 | 5615 | DEFAULT: on |
5616 | DOC_START | |
5473c134 | 5617 | By default Squid checks that DNS responses are received |
5618 | from the same IP addresses they are sent to. If they | |
5619 | don't match, Squid ignores the response and writes a warning | |
5620 | message to cache.log. You can allow responses from unknown | |
5621 | nameservers by setting this option to 'off'. | |
df6fd596 | 5622 | DOC_END |
5623 | ||
cc192b50 | 5624 | NAME: dns_v4_fallback |
5625 | TYPE: onoff | |
5626 | DEFAULT: on | |
5627 | LOC: Config.onoff.dns_require_A | |
5628 | DOC_START | |
5629 | Standard practice with DNS is to lookup either A or AAAA records | |
5630 | and use the results if it succeeds. Only looking up the other if | |
5631 | the first attempt fails or otherwise produces no results. | |
5632 | ||
5633 | That policy however will cause squid to produce error pages for some | |
5634 | servers that advertise AAAA but are unreachable over IPv6. | |
5635 | ||
5636 | If this is ON squid will always lookup both AAAA and A, using both. | |
5637 | If this is OFF squid will lookup AAAA and only try A if none found. | |
5638 | ||
5639 | WARNING: There are some possibly unwanted side-effects with this on: | |
5640 | *) Doubles the load placed by squid on the DNS network. | |
5641 | *) May negatively impact connection delay times. | |
5642 | DOC_END | |
5643 | ||
6bc15a4f | 5644 | NAME: ipcache_size |
5645 | COMMENT: (number of entries) | |
5646 | TYPE: int | |
5647 | DEFAULT: 1024 | |
5648 | LOC: Config.ipcache.size | |
5649 | DOC_NONE | |
5650 | ||
5651 | NAME: ipcache_low | |
5652 | COMMENT: (percent) | |
5653 | TYPE: int | |
5654 | DEFAULT: 90 | |
5655 | LOC: Config.ipcache.low | |
5656 | DOC_NONE | |
5657 | ||
5658 | NAME: ipcache_high | |
5659 | COMMENT: (percent) | |
5660 | TYPE: int | |
5661 | DEFAULT: 95 | |
5662 | LOC: Config.ipcache.high | |
5663 | DOC_START | |
5664 | The size, low-, and high-water marks for the IP cache. | |
5665 | DOC_END | |
5666 | ||
5667 | NAME: fqdncache_size | |
5668 | COMMENT: (number of entries) | |
5669 | TYPE: int | |
5670 | DEFAULT: 1024 | |
5671 | LOC: Config.fqdncache.size | |
5672 | DOC_START | |
5673 | Maximum number of FQDN cache entries. | |
5674 | DOC_END | |
5675 | ||
a58ff010 | 5676 | COMMENT_START |
5473c134 | 5677 | MISCELLANEOUS |
a58ff010 | 5678 | ----------------------------------------------------------------------------- |
5679 | COMMENT_END | |
5680 | ||
5473c134 | 5681 | NAME: memory_pools |
a58ff010 | 5682 | COMMENT: on|off |
5473c134 | 5683 | TYPE: onoff |
5684 | DEFAULT: on | |
5685 | LOC: Config.onoff.mem_pools | |
a58ff010 | 5686 | DOC_START |
5473c134 | 5687 | If set, Squid will keep pools of allocated (but unused) memory |
5688 | available for future use. If memory is a premium on your | |
5689 | system and you believe your malloc library outperforms Squid | |
5690 | routines, disable this. | |
a58ff010 | 5691 | DOC_END |
5692 | ||
5473c134 | 5693 | NAME: memory_pools_limit |
5694 | COMMENT: (bytes) | |
5695 | TYPE: b_size_t | |
5696 | DEFAULT: 5 MB | |
5697 | LOC: Config.MemPools.limit | |
ec1245f8 | 5698 | DOC_START |
5473c134 | 5699 | Used only with memory_pools on: |
5700 | memory_pools_limit 50 MB | |
ec1245f8 | 5701 | |
5473c134 | 5702 | If set to a non-zero value, Squid will keep at most the specified |
5703 | limit of allocated (but unused) memory in memory pools. All free() | |
5704 | requests that exceed this limit will be handled by your malloc | |
5705 | library. Squid does not pre-allocate any memory, just safe-keeps | |
5706 | objects that otherwise would be free()d. Thus, it is safe to set | |
5707 | memory_pools_limit to a reasonably high value even if your | |
5708 | configuration will use less memory. | |
ec1245f8 | 5709 | |
5473c134 | 5710 | If set to zero, Squid will keep all memory it can. That is, there |
5711 | will be no limit on the total amount of memory used for safe-keeping. | |
ec1245f8 | 5712 | |
5473c134 | 5713 | To disable memory allocation optimization, do not set |
5714 | memory_pools_limit to 0. Set memory_pools to "off" instead. | |
5715 | ||
5716 | An overhead for maintaining memory pools is not taken into account | |
5717 | when the limit is checked. This overhead is close to four bytes per | |
5718 | object kept. However, pools may actually _save_ memory because of | |
5719 | reduced memory thrashing in your malloc library. | |
ec1245f8 | 5720 | DOC_END |
5721 | ||
5473c134 | 5722 | NAME: forwarded_for |
67c06f0d AJ |
5723 | COMMENT: on|off|transparent|truncate|delete |
5724 | TYPE: string | |
5473c134 | 5725 | DEFAULT: on |
5726 | LOC: opt_forwarded_for | |
5f8252d2 | 5727 | DOC_START |
67c06f0d AJ |
5728 | If set to "on", Squid will append your client's IP address |
5729 | in the HTTP requests it forwards. By default it looks like: | |
5f8252d2 | 5730 | |
5473c134 | 5731 | X-Forwarded-For: 192.1.2.3 |
5732 | ||
67c06f0d | 5733 | If set to "off", it will appear as |
5473c134 | 5734 | |
5735 | X-Forwarded-For: unknown | |
67c06f0d AJ |
5736 | |
5737 | If set to "transparent", Squid will not alter the | |
5738 | X-Forwarded-For header in any way. | |
5739 | ||
5740 | If set to "delete", Squid will delete the entire | |
5741 | X-Forwarded-For header. | |
5742 | ||
5743 | If set to "truncate", Squid will remove all existing | |
5744 | X-Forwarded-For entries, and place itself as the sole entry. | |
5f8252d2 | 5745 | DOC_END |
5746 | ||
5473c134 | 5747 | NAME: cachemgr_passwd |
5748 | TYPE: cachemgrpasswd | |
5749 | DEFAULT: none | |
5750 | LOC: Config.passwd_list | |
5f8252d2 | 5751 | DOC_START |
5473c134 | 5752 | Specify passwords for cachemgr operations. |
5f8252d2 | 5753 | |
5473c134 | 5754 | Usage: cachemgr_passwd password action action ... |
5755 | ||
5756 | Some valid actions are (see cache manager menu for a full list): | |
5757 | 5min | |
5758 | 60min | |
5759 | asndb | |
5760 | authenticator | |
5761 | cbdata | |
5762 | client_list | |
5763 | comm_incoming | |
5764 | config * | |
5765 | counters | |
5766 | delay | |
5767 | digest_stats | |
5768 | dns | |
5769 | events | |
5770 | filedescriptors | |
5771 | fqdncache | |
5772 | histograms | |
5773 | http_headers | |
5774 | info | |
5775 | io | |
5776 | ipcache | |
5777 | mem | |
5778 | menu | |
5779 | netdb | |
5780 | non_peers | |
5781 | objects | |
5782 | offline_toggle * | |
5783 | pconn | |
5784 | peer_select | |
b360c477 | 5785 | reconfigure * |
5473c134 | 5786 | redirector |
5787 | refresh | |
5788 | server_list | |
5789 | shutdown * | |
5790 | store_digest | |
5791 | storedir | |
5792 | utilization | |
5793 | via_headers | |
5794 | vm_objects | |
5795 | ||
5796 | * Indicates actions which will not be performed without a | |
5797 | valid password, others can be performed if not listed here. | |
5798 | ||
5799 | To disable an action, set the password to "disable". | |
5800 | To allow performing an action without a password, set the | |
5801 | password to "none". | |
5802 | ||
5803 | Use the keyword "all" to set the same password for all actions. | |
5804 | ||
5805 | Example: | |
5806 | cachemgr_passwd secret shutdown | |
5807 | cachemgr_passwd lesssssssecret info stats/objects | |
5808 | cachemgr_passwd disable all | |
5f8252d2 | 5809 | DOC_END |
5810 | ||
5473c134 | 5811 | NAME: client_db |
a58ff010 | 5812 | COMMENT: on|off |
5473c134 | 5813 | TYPE: onoff |
5814 | DEFAULT: on | |
5815 | LOC: Config.onoff.client_db | |
a58ff010 | 5816 | DOC_START |
5473c134 | 5817 | If you want to disable collecting per-client statistics, |
5818 | turn off client_db here. | |
a58ff010 | 5819 | DOC_END |
5820 | ||
5473c134 | 5821 | NAME: refresh_all_ims |
5822 | COMMENT: on|off | |
5823 | TYPE: onoff | |
5824 | DEFAULT: off | |
5825 | LOC: Config.onoff.refresh_all_ims | |
a58ff010 | 5826 | DOC_START |
5473c134 | 5827 | When you enable this option, squid will always check |
5828 | the origin server for an update when a client sends an | |
5829 | If-Modified-Since request. Many browsers use IMS | |
5830 | requests when the user requests a reload, and this | |
5831 | ensures those clients receive the latest version. | |
a58ff010 | 5832 | |
5473c134 | 5833 | By default (off), squid may return a Not Modified response |
5834 | based on the age of the cached version. | |
78e8cfc4 | 5835 | DOC_END |
5836 | ||
5473c134 | 5837 | NAME: reload_into_ims |
5838 | IFDEF: HTTP_VIOLATIONS | |
12b91c99 | 5839 | COMMENT: on|off |
5473c134 | 5840 | TYPE: onoff |
5841 | DEFAULT: off | |
5842 | LOC: Config.onoff.reload_into_ims | |
12b91c99 | 5843 | DOC_START |
5473c134 | 5844 | When you enable this option, client no-cache or ``reload'' |
5845 | requests will be changed to If-Modified-Since requests. | |
5846 | Doing this VIOLATES the HTTP standard. Enabling this | |
5847 | feature could make you liable for problems which it | |
5848 | causes. | |
5849 | ||
5850 | see also refresh_pattern for a more selective approach. | |
12b91c99 | 5851 | DOC_END |
5852 | ||
5473c134 | 5853 | NAME: maximum_single_addr_tries |
5854 | TYPE: int | |
5855 | LOC: Config.retry.maxtries | |
5856 | DEFAULT: 1 | |
a58ff010 | 5857 | DOC_START |
5473c134 | 5858 | This sets the maximum number of connection attempts for a |
5859 | host that only has one address (for multiple-address hosts, | |
5860 | each address is tried once). | |
5861 | ||
5862 | The default value is one attempt, the (not recommended) | |
5863 | maximum is 255 tries. A warning message will be generated | |
5864 | if it is set to a value greater than ten. | |
5865 | ||
5866 | Note: This is in addition to the request re-forwarding which | |
5867 | takes place if Squid fails to get a satisfying response. | |
a58ff010 | 5868 | DOC_END |
5869 | ||
5473c134 | 5870 | NAME: retry_on_error |
a58ff010 | 5871 | TYPE: onoff |
5473c134 | 5872 | LOC: Config.retry.onerror |
a58ff010 | 5873 | DEFAULT: off |
5874 | DOC_START | |
5473c134 | 5875 | If set to on Squid will automatically retry requests when |
5876 | receiving an error response. This is mainly useful if you | |
5877 | are in a complex cache hierarchy to work around access | |
5878 | control errors. | |
5f8252d2 | 5879 | DOC_END |
5880 | ||
5473c134 | 5881 | NAME: as_whois_server |
5f8252d2 | 5882 | TYPE: string |
5473c134 | 5883 | LOC: Config.as_whois_server |
5884 | DEFAULT: whois.ra.net | |
5885 | DEFAULT_IF_NONE: whois.ra.net | |
5f8252d2 | 5886 | DOC_START |
5473c134 | 5887 | WHOIS server to query for AS numbers. NOTE: AS numbers are |
5888 | queried only when Squid starts up, not for every request. | |
5f8252d2 | 5889 | DOC_END |
5890 | ||
5473c134 | 5891 | NAME: offline_mode |
5f8252d2 | 5892 | TYPE: onoff |
5473c134 | 5893 | LOC: Config.onoff.offline |
5f8252d2 | 5894 | DEFAULT: off |
5895 | DOC_START | |
5473c134 | 5896 | Enable this option and Squid will never try to validate cached |
5897 | objects. | |
a58ff010 | 5898 | DOC_END |
5899 | ||
5473c134 | 5900 | NAME: uri_whitespace |
5901 | TYPE: uri_whitespace | |
5902 | LOC: Config.uri_whitespace | |
5903 | DEFAULT: strip | |
a58ff010 | 5904 | DOC_START |
5473c134 | 5905 | What to do with requests that have whitespace characters in the |
5906 | URI. Options: | |
a58ff010 | 5907 | |
5473c134 | 5908 | strip: The whitespace characters are stripped out of the URL. |
5909 | This is the behavior recommended by RFC2396. | |
5910 | deny: The request is denied. The user receives an "Invalid | |
5911 | Request" message. | |
5912 | allow: The request is allowed and the URI is not changed. The | |
5913 | whitespace characters remain in the URI. Note the | |
5914 | whitespace is passed to redirector processes if they | |
5915 | are in use. | |
5916 | encode: The request is allowed and the whitespace characters are | |
5917 | encoded according to RFC1738. This could be considered | |
5918 | a violation of the HTTP/1.1 | |
5919 | RFC because proxies are not allowed to rewrite URI's. | |
5920 | chop: The request is allowed and the URI is chopped at the | |
5921 | first whitespace. This might also be considered a | |
5922 | violation. | |
5923 | DOC_END | |
a58ff010 | 5924 | |
5473c134 | 5925 | NAME: coredump_dir |
5926 | TYPE: string | |
5927 | LOC: Config.coredump_dir | |
5928 | DEFAULT: none | |
5929 | DEFAULT_IF_NONE: none | |
5930 | DOC_START | |
5931 | By default Squid leaves core files in the directory from where | |
5932 | it was started. If you set 'coredump_dir' to a directory | |
5933 | that exists, Squid will chdir() to that directory at startup | |
5934 | and coredump files will be left there. | |
a58ff010 | 5935 | |
5473c134 | 5936 | NOCOMMENT_START |
5937 | # Leave coredumps in the first cache dir | |
5938 | coredump_dir @DEFAULT_SWAP_DIR@ | |
5939 | NOCOMMENT_END | |
5940 | DOC_END | |
a58ff010 | 5941 | |
5473c134 | 5942 | NAME: chroot |
5943 | TYPE: string | |
5944 | LOC: Config.chroot_dir | |
a58ff010 | 5945 | DEFAULT: none |
5946 | DOC_START | |
5473c134 | 5947 | Use this to have Squid do a chroot() while initializing. This |
5948 | also causes Squid to fully drop root privileges after | |
5949 | initializing. This means, for example, if you use a HTTP | |
5950 | port less than 1024 and try to reconfigure, you will may get an | |
5951 | error saying that Squid can not open the port. | |
5952 | DOC_END | |
a58ff010 | 5953 | |
5473c134 | 5954 | NAME: balance_on_multiple_ip |
5955 | TYPE: onoff | |
5956 | LOC: Config.onoff.balance_on_multiple_ip | |
cc192b50 | 5957 | DEFAULT: off |
5473c134 | 5958 | DOC_START |
cc192b50 | 5959 | Modern IP resolvers in squid sort lookup results by preferred access. |
5960 | By default squid will use these IP in order and only rotates to | |
5961 | the next listed when the most preffered fails. | |
5962 | ||
5473c134 | 5963 | Some load balancing servers based on round robin DNS have been |
5964 | found not to preserve user session state across requests | |
5965 | to different IP addresses. | |
a58ff010 | 5966 | |
cc192b50 | 5967 | Enabling this directive Squid rotates IP's per request. |
a58ff010 | 5968 | DOC_END |
5969 | ||
5473c134 | 5970 | NAME: pipeline_prefetch |
5971 | TYPE: onoff | |
5972 | LOC: Config.onoff.pipeline_prefetch | |
5973 | DEFAULT: off | |
a58ff010 | 5974 | DOC_START |
5473c134 | 5975 | To boost the performance of pipelined requests to closer |
5976 | match that of a non-proxied environment Squid can try to fetch | |
5977 | up to two requests in parallel from a pipeline. | |
a58ff010 | 5978 | |
5473c134 | 5979 | Defaults to off for bandwidth management and access logging |
5980 | reasons. | |
5981 | DOC_END | |
a58ff010 | 5982 | |
5473c134 | 5983 | NAME: high_response_time_warning |
5984 | TYPE: int | |
5985 | COMMENT: (msec) | |
5986 | LOC: Config.warnings.high_rptm | |
5987 | DEFAULT: 0 | |
5988 | DOC_START | |
5989 | If the one-minute median response time exceeds this value, | |
5990 | Squid prints a WARNING with debug level 0 to get the | |
5991 | administrators attention. The value is in milliseconds. | |
a58ff010 | 5992 | DOC_END |
5993 | ||
5473c134 | 5994 | NAME: high_page_fault_warning |
5995 | TYPE: int | |
5996 | LOC: Config.warnings.high_pf | |
5997 | DEFAULT: 0 | |
cc9f92d4 | 5998 | DOC_START |
5473c134 | 5999 | If the one-minute average page fault rate exceeds this |
6000 | value, Squid prints a WARNING with debug level 0 to get | |
6001 | the administrators attention. The value is in page faults | |
6002 | per second. | |
6003 | DOC_END | |
cc9f92d4 | 6004 | |
5473c134 | 6005 | NAME: high_memory_warning |
6006 | TYPE: b_size_t | |
6007 | LOC: Config.warnings.high_memory | |
904971da | 6008 | DEFAULT: 0 KB |
5473c134 | 6009 | DOC_START |
6010 | If the memory usage (as determined by mallinfo) exceeds | |
904971da | 6011 | this amount, Squid prints a WARNING with debug level 0 to get |
5473c134 | 6012 | the administrators attention. |
6013 | DOC_END | |
cc9f92d4 | 6014 | |
5473c134 | 6015 | NAME: sleep_after_fork |
6016 | COMMENT: (microseconds) | |
6017 | TYPE: int | |
6018 | LOC: Config.sleep_after_fork | |
6019 | DEFAULT: 0 | |
6020 | DOC_START | |
6021 | When this is set to a non-zero value, the main Squid process | |
6022 | sleeps the specified number of microseconds after a fork() | |
6023 | system call. This sleep may help the situation where your | |
6024 | system reports fork() failures due to lack of (virtual) | |
6025 | memory. Note, however, if you have a lot of child | |
6026 | processes, these sleep delays will add up and your | |
6027 | Squid will not service requests for some amount of time | |
6028 | until all the child processes have been started. | |
6029 | On Windows value less then 1000 (1 milliseconds) are | |
6030 | rounded to 1000. | |
cc9f92d4 | 6031 | DOC_END |
6032 | ||
b6696974 | 6033 | NAME: windows_ipaddrchangemonitor |
6b0516c6 | 6034 | IFDEF: _SQUID_MSWIN_ |
b6696974 GS |
6035 | COMMENT: on|off |
6036 | TYPE: onoff | |
6037 | DEFAULT: on | |
6038 | LOC: Config.onoff.WIN32_IpAddrChangeMonitor | |
6039 | DOC_START | |
6040 | On Windows Squid by default will monitor IP address changes and will | |
6041 | reconfigure itself after any detected event. This is very useful for | |
6042 | proxies connected to internet with dial-up interfaces. | |
6043 | In some cases (a Proxy server acting as VPN gateway is one) it could be | |
6044 | desiderable to disable this behaviour setting this to 'off'. | |
6045 | Note: after changing this, Squid service must be restarted. | |
6046 | DOC_END | |
6047 | ||
cccac0a2 | 6048 | EOF |