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