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