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