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