]>
Commit | Line | Data |
---|---|---|
ef57eb7b | 1 | ## Copyright (C) 1996-2016 The Squid Software Foundation and contributors |
5d28d44b AJ |
2 | ## |
3 | ## Squid software is distributed under GPLv2+ license and includes | |
4 | ## contributions from numerous individuals and organizations. | |
5 | ## Please see the COPYING and CONTRIBUTORS files for details. | |
6 | ## | |
9cef6668 | 7 | |
0f74202c | 8 | COMMENT_START |
ad12fb4b | 9 | WELCOME TO @SQUID@ |
cccac0a2 | 10 | ---------------------------- |
5945964d AJ |
11 | |
12 | This is the documentation for the Squid configuration file. | |
13 | This documentation can also be found online at: | |
14 | http://www.squid-cache.org/Doc/config/ | |
15 | ||
16 | You may wish to look at the Squid home page and wiki for the | |
17 | FAQ and other documentation: | |
18 | http://www.squid-cache.org/ | |
19 | http://wiki.squid-cache.org/SquidFaq | |
20 | http://wiki.squid-cache.org/ConfigExamples | |
21 | ||
22 | This documentation shows what the defaults for various directives | |
23 | happen to be. If you don't need to change the default, you should | |
24 | leave the line out of your squid.conf in most cases. | |
25 | ||
26 | In some cases "none" refers to no default setting at all, | |
27 | while in other cases it refers to the value of the option | |
28 | - the comments for that keyword indicate if this is the case. | |
debd9a31 | 29 | |
cccac0a2 | 30 | COMMENT_END |
3a278cb8 | 31 | |
592a09dc | 32 | COMMENT_START |
33 | Configuration options can be included using the "include" directive. | |
5945964d | 34 | Include takes a list of files to include. Quoting and wildcards are |
592a09dc | 35 | supported. |
36 | ||
37 | For example, | |
38 | ||
39 | include /path/to/included/file/squid.acl.config | |
40 | ||
41 | Includes can be nested up to a hard-coded depth of 16 levels. | |
42 | This arbitrary restriction is to prevent recursive include references | |
43 | from causing Squid entering an infinite loop whilst trying to load | |
44 | configuration files. | |
d4a3e179 | 45 | |
a345387f AJ |
46 | Values with byte units |
47 | ||
a01a87d9 AJ |
48 | Squid accepts size units on some size related directives. All |
49 | such directives are documented with a default value displaying | |
50 | a unit. | |
a345387f AJ |
51 | |
52 | Units accepted by Squid are: | |
a01a87d9 AJ |
53 | bytes - byte |
54 | KB - Kilobyte (1024 bytes) | |
a345387f AJ |
55 | MB - Megabyte |
56 | GB - Gigabyte | |
d4a3e179 | 57 | |
2eceb328 CT |
58 | Values with spaces, quotes, and other special characters |
59 | ||
60 | Squid supports directive parameters with spaces, quotes, and other | |
61 | special characters. Surround such parameters with "double quotes". Use | |
62 | the configuration_includes_quoted_values directive to enable or | |
63 | disable that support. | |
64 | ||
65 | Squid supports reading configuration option parameters from external | |
66 | files using the syntax: | |
67 | parameters("/path/filename") | |
68 | For example: | |
69 | acl whitelist dstdomain parameters("/etc/squid/whitelist.txt") | |
70 | ||
5735d30b AR |
71 | Conditional configuration |
72 | ||
73 | If-statements can be used to make configuration directives | |
74 | depend on conditions: | |
75 | ||
76 | if <CONDITION> | |
77 | ... regular configuration directives ... | |
78 | [else | |
79 | ... regular configuration directives ...] | |
80 | endif | |
81 | ||
82 | The else part is optional. The keywords "if", "else", and "endif" | |
83 | must be typed on their own lines, as if they were regular | |
84 | configuration directives. | |
85 | ||
5945964d AJ |
86 | NOTE: An else-if condition is not supported. |
87 | ||
5735d30b AR |
88 | These individual conditions types are supported: |
89 | ||
90 | true | |
91 | Always evaluates to true. | |
92 | false | |
93 | Always evaluates to false. | |
94 | <integer> = <integer> | |
95 | Equality comparison of two integer numbers. | |
96 | ||
97 | ||
d4a3e179 AR |
98 | SMP-Related Macros |
99 | ||
100 | The following SMP-related preprocessor macros can be used. | |
101 | ||
102 | ${process_name} expands to the current Squid process "name" | |
103 | (e.g., squid1, squid2, or cache1). | |
104 | ||
105 | ${process_number} expands to the current Squid process | |
106 | identifier, which is an integer number (e.g., 1, 2, 3) unique | |
6fe8c876 AJ |
107 | across all Squid processes of the current service instance. |
108 | ||
109 | ${service_name} expands into the current Squid service instance | |
110 | name identifier which is provided by -n on the command line. | |
111 | ||
592a09dc | 112 | COMMENT_END |
113 | ||
25234ebd AJ |
114 | # options still not yet ported from 2.7 to 3.x |
115 | NAME: broken_vary_encoding | |
116 | TYPE: obsolete | |
117 | DOC_START | |
118 | This option is not yet supported by Squid-3. | |
119 | DOC_END | |
120 | ||
121 | NAME: cache_vary | |
122 | TYPE: obsolete | |
123 | DOC_START | |
124 | This option is not yet supported by Squid-3. | |
125 | DOC_END | |
126 | ||
25234ebd AJ |
127 | NAME: error_map |
128 | TYPE: obsolete | |
129 | DOC_START | |
130 | This option is not yet supported by Squid-3. | |
131 | DOC_END | |
132 | ||
133 | NAME: external_refresh_check | |
134 | TYPE: obsolete | |
135 | DOC_START | |
136 | This option is not yet supported by Squid-3. | |
137 | DOC_END | |
138 | ||
96598f93 | 139 | NAME: location_rewrite_program location_rewrite_access location_rewrite_children location_rewrite_concurrency |
25234ebd AJ |
140 | TYPE: obsolete |
141 | DOC_START | |
142 | This option is not yet supported by Squid-3. | |
143 | DOC_END | |
144 | ||
96598f93 | 145 | NAME: refresh_stale_hit |
25234ebd AJ |
146 | TYPE: obsolete |
147 | DOC_START | |
148 | This option is not yet supported by Squid-3. | |
149 | DOC_END | |
150 | ||
7e62a74f | 151 | # Options removed in 3.6 |
f1a5d071 AJ |
152 | NAME: cache_peer_domain cache_host_domain |
153 | TYPE: obsolete | |
154 | DOC_START | |
155 | Replace with dstdomain ACLs and cache_peer_access. | |
156 | DOC_END | |
157 | ||
7e62a74f AJ |
158 | NAME: sslproxy_cafile |
159 | TYPE: obsolete | |
160 | DOC_START | |
161 | Remove this line. Use tls_outgoing_options cafile= instead. | |
162 | DOC_END | |
163 | ||
164 | NAME: sslproxy_capath | |
165 | TYPE: obsolete | |
166 | DOC_START | |
167 | Remove this line. Use tls_outgoing_options capath= instead. | |
168 | DOC_END | |
169 | ||
170 | NAME: sslproxy_cipher | |
171 | TYPE: obsolete | |
172 | DOC_START | |
173 | Remove this line. Use tls_outgoing_options cipher= instead. | |
174 | DOC_END | |
175 | ||
176 | NAME: sslproxy_client_certificate | |
177 | TYPE: obsolete | |
178 | DOC_START | |
179 | Remove this line. Use tls_outgoing_options cert= instead. | |
180 | DOC_END | |
181 | ||
182 | NAME: sslproxy_client_key | |
183 | TYPE: obsolete | |
184 | DOC_START | |
185 | Remove this line. Use tls_outgoing_options key= instead. | |
186 | DOC_END | |
187 | ||
188 | NAME: sslproxy_flags | |
189 | TYPE: obsolete | |
190 | DOC_START | |
191 | Remove this line. Use tls_outgoing_options flags= instead. | |
192 | DOC_END | |
193 | ||
194 | NAME: sslproxy_options | |
195 | TYPE: obsolete | |
196 | DOC_START | |
197 | Remove this line. Use tls_outgoing_options options= instead. | |
198 | DOC_END | |
199 | ||
200 | NAME: sslproxy_version | |
201 | TYPE: obsolete | |
202 | DOC_START | |
1cc44095 | 203 | Remove this line. Use tls_outgoing_options options= instead. |
7e62a74f AJ |
204 | DOC_END |
205 | ||
9967aef6 AJ |
206 | # Options removed in 3.5 |
207 | NAME: hierarchy_stoplist | |
208 | TYPE: obsolete | |
209 | DOC_START | |
210 | Remove this line. Use always_direct or cache_peer_access ACLs instead if you need to prevent cache_peer use. | |
211 | DOC_END | |
212 | ||
a8f70484 | 213 | # Options removed in 3.4 |
74d81220 AJ |
214 | NAME: log_access |
215 | TYPE: obsolete | |
216 | DOC_START | |
217 | Remove this line. Use acls with access_log directives to control access logging | |
218 | DOC_END | |
219 | ||
220 | NAME: log_icap | |
221 | TYPE: obsolete | |
222 | DOC_START | |
223 | Remove this line. Use acls with icap_log directives to control icap logging | |
224 | DOC_END | |
225 | ||
96598f93 AJ |
226 | # Options Removed in 3.3 |
227 | NAME: ignore_ims_on_miss | |
25234ebd AJ |
228 | TYPE: obsolete |
229 | DOC_START | |
2d4eefd9 | 230 | Remove this line. The HTTP/1.1 feature is now configured by 'cache_miss_revalidate'. |
25234ebd AJ |
231 | DOC_END |
232 | ||
76f44481 | 233 | # Options Removed in 3.2 |
16cd62b7 AJ |
234 | NAME: chunked_request_body_max_size |
235 | TYPE: obsolete | |
236 | DOC_START | |
237 | Remove this line. Squid is now HTTP/1.1 compliant. | |
238 | DOC_END | |
239 | ||
74d81220 | 240 | NAME: dns_v4_fallback |
76f44481 AJ |
241 | TYPE: obsolete |
242 | DOC_START | |
74d81220 | 243 | Remove this line. Squid performs a 'Happy Eyeballs' algorithm, the 'fallback' algorithm is no longer relevant. |
76f44481 AJ |
244 | DOC_END |
245 | ||
74d81220 | 246 | NAME: emulate_httpd_log |
6e095b46 AJ |
247 | TYPE: obsolete |
248 | DOC_START | |
74d81220 AJ |
249 | Replace this with an access_log directive using the format 'common' or 'combined'. |
250 | DOC_END | |
251 | ||
252 | NAME: forward_log | |
253 | TYPE: obsolete | |
254 | DOC_START | |
255 | Use a regular access.log with ACL limiting it to MISS events. | |
6e095b46 AJ |
256 | DOC_END |
257 | ||
76f44481 AJ |
258 | NAME: ftp_list_width |
259 | TYPE: obsolete | |
260 | DOC_START | |
261 | Remove this line. Configure FTP page display using the CSS controls in errorpages.css instead. | |
262 | DOC_END | |
263 | ||
74d81220 AJ |
264 | NAME: ignore_expect_100 |
265 | TYPE: obsolete | |
266 | DOC_START | |
267 | Remove this line. The HTTP/1.1 feature is now fully supported by default. | |
268 | DOC_END | |
269 | ||
270 | NAME: log_fqdn | |
271 | TYPE: obsolete | |
272 | DOC_START | |
273 | Remove this option from your config. To log FQDN use %>A in the log format. | |
274 | DOC_END | |
275 | ||
276 | NAME: log_ip_on_direct | |
277 | TYPE: obsolete | |
278 | DOC_START | |
279 | Remove this option from your config. To log server or peer names use %<A in the log format. | |
280 | DOC_END | |
281 | ||
38493d67 AJ |
282 | NAME: maximum_single_addr_tries |
283 | TYPE: obsolete | |
284 | DOC_START | |
285 | Replaced by connect_retries. The behaviour has changed, please read the documentation before altering. | |
286 | DOC_END | |
287 | ||
74d81220 AJ |
288 | NAME: referer_log referrer_log |
289 | TYPE: obsolete | |
290 | DOC_START | |
291 | Replace this with an access_log directive using the format 'referrer'. | |
292 | DOC_END | |
293 | ||
4ded749e AJ |
294 | NAME: update_headers |
295 | TYPE: obsolete | |
296 | DOC_START | |
297 | Remove this line. The feature is supported by default in storage types where update is implemented. | |
298 | DOC_END | |
299 | ||
76f44481 AJ |
300 | NAME: url_rewrite_concurrency |
301 | TYPE: obsolete | |
302 | DOC_START | |
303 | Remove this line. Set the 'concurrency=' option of url_rewrite_children instead. | |
304 | DOC_END | |
305 | ||
74d81220 AJ |
306 | NAME: useragent_log |
307 | TYPE: obsolete | |
308 | DOC_START | |
309 | Replace this with an access_log directive using the format 'useragent'. | |
310 | DOC_END | |
311 | ||
76f44481 AJ |
312 | # Options Removed in 3.1 |
313 | NAME: dns_testnames | |
314 | TYPE: obsolete | |
315 | DOC_START | |
316 | Remove this line. DNS is no longer tested on startup. | |
317 | DOC_END | |
318 | ||
319 | NAME: extension_methods | |
320 | TYPE: obsolete | |
321 | DOC_START | |
322 | Remove this line. All valid methods for HTTP are accepted by default. | |
323 | DOC_END | |
324 | ||
c72a2049 AJ |
325 | # 2.7 Options Removed/Replaced in 3.2 |
326 | NAME: zero_buffers | |
327 | TYPE: obsolete | |
328 | DOC_NONE | |
329 | ||
76f44481 AJ |
330 | # 2.7 Options Removed/Replaced in 3.1 |
331 | NAME: incoming_rate | |
332 | TYPE: obsolete | |
333 | DOC_NONE | |
334 | ||
335 | NAME: server_http11 | |
336 | TYPE: obsolete | |
337 | DOC_START | |
338 | Remove this line. HTTP/1.1 is supported by default. | |
339 | DOC_END | |
340 | ||
341 | NAME: upgrade_http0.9 | |
342 | TYPE: obsolete | |
343 | DOC_START | |
344 | Remove this line. ICY/1.0 streaming protocol is supported by default. | |
345 | DOC_END | |
346 | ||
347 | NAME: zph_local zph_mode zph_option zph_parent zph_sibling | |
348 | TYPE: obsolete | |
349 | DOC_START | |
350 | Alter these entries. Use the qos_flows directive instead. | |
351 | DOC_END | |
352 | ||
353 | # Options Removed in 3.0 | |
354 | NAME: header_access | |
355 | TYPE: obsolete | |
356 | DOC_START | |
357 | Since squid-3.0 replace with request_header_access or reply_header_access | |
358 | depending on whether you wish to match client requests or server replies. | |
359 | DOC_END | |
360 | ||
361 | NAME: httpd_accel_no_pmtu_disc | |
362 | TYPE: obsolete | |
363 | DOC_START | |
364 | Since squid-3.0 use the 'disable-pmtu-discovery' flag on http_port instead. | |
365 | DOC_END | |
366 | ||
3b31a711 AJ |
367 | NAME: wais_relay_host |
368 | TYPE: obsolete | |
369 | DOC_START | |
370 | Replace this line with 'cache_peer' configuration. | |
371 | DOC_END | |
372 | ||
373 | NAME: wais_relay_port | |
374 | TYPE: obsolete | |
375 | DOC_START | |
376 | Replace this line with 'cache_peer' configuration. | |
377 | DOC_END | |
378 | ||
50ff42a2 AJ |
379 | COMMENT_START |
380 | OPTIONS FOR SMP | |
381 | ----------------------------------------------------------------------------- | |
382 | COMMENT_END | |
383 | ||
384 | NAME: workers | |
385 | TYPE: int | |
386 | LOC: Config.workers | |
387 | DEFAULT: 1 | |
388 | DEFAULT_DOC: SMP support disabled. | |
389 | DOC_START | |
390 | Number of main Squid processes or "workers" to fork and maintain. | |
391 | 0: "no daemon" mode, like running "squid -N ..." | |
392 | 1: "no SMP" mode, start one main Squid process daemon (default) | |
393 | N: start N main Squid process daemons (i.e., SMP mode) | |
394 | ||
395 | In SMP mode, each worker does nearly all what a single Squid daemon | |
396 | does (e.g., listen on http_port and forward HTTP requests). | |
397 | DOC_END | |
398 | ||
399 | NAME: cpu_affinity_map | |
400 | TYPE: CpuAffinityMap | |
401 | LOC: Config.cpuAffinityMap | |
402 | DEFAULT: none | |
403 | DEFAULT_DOC: Let operating system decide. | |
404 | DOC_START | |
405 | Usage: cpu_affinity_map process_numbers=P1,P2,... cores=C1,C2,... | |
406 | ||
407 | Sets 1:1 mapping between Squid processes and CPU cores. For example, | |
408 | ||
409 | cpu_affinity_map process_numbers=1,2,3,4 cores=1,3,5,7 | |
410 | ||
411 | affects processes 1 through 4 only and places them on the first | |
412 | four even cores, starting with core #1. | |
413 | ||
414 | CPU cores are numbered starting from 1. Requires support for | |
415 | sched_getaffinity(2) and sched_setaffinity(2) system calls. | |
416 | ||
417 | Multiple cpu_affinity_map options are merged. | |
418 | ||
419 | See also: workers | |
420 | DOC_END | |
421 | ||
5473c134 | 422 | COMMENT_START |
41bd17a4 | 423 | OPTIONS FOR AUTHENTICATION |
5473c134 | 424 | ----------------------------------------------------------------------------- |
425 | COMMENT_END | |
426 | ||
41bd17a4 | 427 | NAME: auth_param |
428 | TYPE: authparam | |
2f1431ea | 429 | IFDEF: USE_AUTH |
5817ee13 | 430 | LOC: Auth::TheConfig |
cccac0a2 | 431 | DEFAULT: none |
432 | DOC_START | |
41bd17a4 | 433 | This is used to define parameters for the various authentication |
434 | schemes supported by Squid. | |
cccac0a2 | 435 | |
66c583dc | 436 | format: auth_param scheme parameter [setting] |
cccac0a2 | 437 | |
41bd17a4 | 438 | The order in which authentication schemes are presented to the client is |
439 | dependent on the order the scheme first appears in config file. IE | |
440 | has a bug (it's not RFC 2617 compliant) in that it will use the basic | |
441 | scheme if basic is the first entry presented, even if more secure | |
442 | schemes are presented. For now use the order in the recommended | |
443 | settings section below. If other browsers have difficulties (don't | |
444 | recognize the schemes offered even if you are using basic) either | |
445 | put basic first, or disable the other schemes (by commenting out their | |
446 | program entry). | |
cccac0a2 | 447 | |
41bd17a4 | 448 | Once an authentication scheme is fully configured, it can only be |
449 | shutdown by shutting squid down and restarting. Changes can be made on | |
450 | the fly and activated with a reconfigure. I.E. You can change to a | |
451 | different helper, but not unconfigure the helper completely. | |
cccac0a2 | 452 | |
41bd17a4 | 453 | Please note that while this directive defines how Squid processes |
454 | authentication it does not automatically activate authentication. | |
455 | To use authentication you must in addition make use of ACLs based | |
456 | on login name in http_access (proxy_auth, proxy_auth_regex or | |
457 | external with %LOGIN used in the format tag). The browser will be | |
458 | challenged for authentication on the first such acl encountered | |
459 | in http_access processing and will also be re-challenged for new | |
460 | login credentials if the request is being denied by a proxy_auth | |
461 | type acl. | |
cccac0a2 | 462 | |
41bd17a4 | 463 | WARNING: authentication can't be used in a transparently intercepting |
464 | proxy as the client then thinks it is talking to an origin server and | |
465 | not the proxy. This is a limitation of bending the TCP/IP protocol to | |
466 | transparently intercepting port 80, not a limitation in Squid. | |
b3567eb5 FC |
467 | Ports flagged 'transparent', 'intercept', or 'tproxy' have |
468 | authentication disabled. | |
cccac0a2 | 469 | |
d4806c91 CT |
470 | === Parameters common to all schemes. === |
471 | ||
472 | "program" cmdline | |
66c583dc | 473 | Specifies the command for the external authenticator. |
d4806c91 | 474 | |
66c583dc AJ |
475 | By default, each authentication scheme is not used unless a |
476 | program is specified. | |
cccac0a2 | 477 | |
66c583dc AJ |
478 | See http://wiki.squid-cache.org/Features/AddonHelpers for |
479 | more details on helper operations and creating your own. | |
5269ec0e | 480 | |
66c583dc AJ |
481 | "key_extras" format |
482 | Specifies a string to be append to request line format for | |
483 | the authentication helper. "Quoted" format values may contain | |
484 | spaces and logformat %macros. In theory, any logformat %macro | |
485 | can be used. In practice, a %macro expands as a dash (-) if | |
486 | the helper request is sent before the required macro | |
487 | information is available to Squid. | |
488 | ||
489 | By default, Squid uses request formats provided in | |
490 | scheme-specific examples below (search for %credentials). | |
491 | ||
492 | The expanded key_extras value is added to the Squid credentials | |
493 | cache and, hence, will affect authentication. It can be used to | |
494 | autenticate different users with identical user names (e.g., | |
495 | when user authentication depends on http_port). | |
496 | ||
497 | Avoid adding frequently changing information to key_extras. For | |
498 | example, if you add user source IP, and it changes frequently | |
499 | in your environment, then max_user_ip ACL is going to treat | |
500 | every user+IP combination as a unique "user", breaking the ACL | |
501 | and wasting a lot of memory on those user records. It will also | |
502 | force users to authenticate from scratch whenever their IP | |
503 | changes. | |
504 | ||
505 | "realm" string | |
506 | Specifies the protection scope (aka realm name) which is to be | |
507 | reported to the client for the authentication scheme. It is | |
508 | commonly part of the text the user will see when prompted for | |
509 | their username and password. | |
510 | ||
511 | For Basic the default is "Squid proxy-caching web server". | |
512 | For Digest there is no default, this parameter is mandatory. | |
513 | For NTLM and Negotiate this parameter is ignored. | |
5269ec0e | 514 | |
6825b101 | 515 | "children" numberofchildren [startup=N] [idle=N] [concurrency=N] [queue-size=N] |
5269ec0e | 516 | |
66c583dc AJ |
517 | The maximum number of authenticator processes to spawn. If |
518 | you start too few Squid will have to wait for them to process | |
519 | a backlog of credential verifications, slowing it down. When | |
520 | password verifications are done via a (slow) network you are | |
521 | likely to need lots of authenticator processes. | |
5269ec0e | 522 | |
66c583dc AJ |
523 | The startup= and idle= options permit some skew in the exact |
524 | amount run. A minimum of startup=N will begin during startup | |
525 | and reconfigure. Squid will start more in groups of up to | |
526 | idle=N in an attempt to meet traffic needs and to keep idle=N | |
527 | free above those traffic needs up to the maximum. | |
5269ec0e | 528 | |
66c583dc AJ |
529 | The concurrency= option sets the number of concurrent requests |
530 | the helper can process. The default of 0 is used for helpers | |
531 | who only supports one request at a time. Setting this to a | |
532 | number greater than 0 changes the protocol used to include a | |
533 | channel ID field first on the request/response line, allowing | |
534 | multiple requests to be sent to the same helper in parallel | |
535 | without waiting for the response. | |
cccac0a2 | 536 | |
66c583dc AJ |
537 | Concurrency must not be set unless it's known the helper |
538 | supports the input format with channel-ID fields. | |
cccac0a2 | 539 | |
6825b101 CT |
540 | The queue-size= option sets the maximum number of queued |
541 | requests. If the queued requests exceed queue size for more | |
542 | than 3 minutes then squid aborts its operation. | |
543 | The default value is set to 2*numberofchildren/ | |
544 | ||
66c583dc AJ |
545 | NOTE: NTLM and Negotiate schemes do not support concurrency |
546 | in the Squid code module even though some helpers can. | |
307b83b7 | 547 | |
9e7dbc51 | 548 | |
66c583dc AJ |
549 | IF HAVE_AUTH_MODULE_BASIC |
550 | === Basic authentication parameters === | |
d2a89ac1 | 551 | |
66c583dc AJ |
552 | "utf8" on|off |
553 | HTTP uses iso-latin-1 as character set, while some | |
554 | authentication backends such as LDAP expects UTF-8. If this is | |
555 | set to on Squid will translate the HTTP iso-latin-1 charset to | |
556 | UTF-8 before sending the username and password to the helper. | |
d1b63fc8 | 557 | |
41bd17a4 | 558 | "credentialsttl" timetolive |
66c583dc AJ |
559 | Specifies how long squid assumes an externally validated |
560 | username:password pair is valid for - in other words how | |
561 | often the helper program is called for that user. Set this | |
562 | low to force revalidation with short lived passwords. | |
cccac0a2 | 563 | |
66c583dc AJ |
564 | NOTE: setting this high does not impact your susceptibility |
565 | to replay attacks unless you are using an one-time password | |
566 | system (such as SecureID). If you are using such a system, | |
567 | you will be vulnerable to replay attacks unless you also | |
568 | use the max_user_ip ACL in an http_access rule. | |
cccac0a2 | 569 | |
66c583dc AJ |
570 | "casesensitive" on|off |
571 | Specifies if usernames are case sensitive. Most user databases | |
572 | are case insensitive allowing the same username to be spelled | |
573 | using both lower and upper case letters, but some are case | |
574 | sensitive. This makes a big difference for user_max_ip ACL | |
575 | processing and similar. | |
cccac0a2 | 576 | |
66c583dc AJ |
577 | ENDIF |
578 | IF HAVE_AUTH_MODULE_DIGEST | |
579 | === Digest authentication parameters === | |
cccac0a2 | 580 | |
d2a89ac1 | 581 | "utf8" on|off |
66c583dc AJ |
582 | HTTP uses iso-latin-1 as character set, while some |
583 | authentication backends such as LDAP expects UTF-8. If this is | |
584 | set to on Squid will translate the HTTP iso-latin-1 charset to | |
585 | UTF-8 before sending the username and password to the helper. | |
cccac0a2 | 586 | |
41bd17a4 | 587 | "nonce_garbage_interval" timeinterval |
66c583dc AJ |
588 | Specifies the interval that nonces that have been issued |
589 | to client_agent's are checked for validity. | |
cccac0a2 | 590 | |
41bd17a4 | 591 | "nonce_max_duration" timeinterval |
66c583dc AJ |
592 | Specifies the maximum length of time a given nonce will be |
593 | valid for. | |
cccac0a2 | 594 | |
41bd17a4 | 595 | "nonce_max_count" number |
66c583dc AJ |
596 | Specifies the maximum number of times a given nonce can be |
597 | used. | |
cccac0a2 | 598 | |
41bd17a4 | 599 | "nonce_strictness" on|off |
66c583dc AJ |
600 | Determines if squid requires strict increment-by-1 behavior |
601 | for nonce counts, or just incrementing (off - for use when | |
602 | user agents generate nonce counts that occasionally miss 1 | |
603 | (ie, 1,2,4,6)). Default off. | |
cccac0a2 | 604 | |
41bd17a4 | 605 | "check_nonce_count" on|off |
66c583dc AJ |
606 | This directive if set to off can disable the nonce count check |
607 | completely to work around buggy digest qop implementations in | |
608 | certain mainstream browser versions. Default on to check the | |
609 | nonce count to protect from authentication replay attacks. | |
cccac0a2 | 610 | |
41bd17a4 | 611 | "post_workaround" on|off |
66c583dc AJ |
612 | This is a workaround to certain buggy browsers who send an |
613 | incorrect request digest in POST requests when reusing the | |
614 | same nonce as acquired earlier on a GET request. | |
cccac0a2 | 615 | |
66c583dc AJ |
616 | ENDIF |
617 | IF HAVE_AUTH_MODULE_NEGOTIATE | |
618 | === Negotiate authentication parameters === | |
cccac0a2 | 619 | |
41bd17a4 | 620 | "keep_alive" on|off |
66c583dc AJ |
621 | If you experience problems with PUT/POST requests when using |
622 | the this authentication scheme then you can try setting this | |
623 | to off. This will cause Squid to forcibly close the connection | |
624 | on the initial request where the browser asks which schemes | |
625 | are supported by the proxy. | |
cccac0a2 | 626 | |
66c583dc AJ |
627 | ENDIF |
628 | IF HAVE_AUTH_MODULE_NTLM | |
629 | === NTLM authentication parameters === | |
d3803853 | 630 | |
41bd17a4 | 631 | "keep_alive" on|off |
66c583dc AJ |
632 | If you experience problems with PUT/POST requests when using |
633 | the this authentication scheme then you can try setting this | |
634 | to off. This will cause Squid to forcibly close the connection | |
635 | on the initial request where the browser asks which schemes | |
636 | are supported by the proxy. | |
637 | ENDIF | |
527ee50d | 638 | |
66c583dc AJ |
639 | === Example Configuration === |
640 | ||
641 | This configuration displays the recommended authentication scheme | |
642 | order from most to least secure with recommended minimum configuration | |
643 | settings for each scheme: | |
e0855596 | 644 | |
41bd17a4 | 645 | #auth_param negotiate program <uncomment and complete this line to activate> |
48d54e4d | 646 | #auth_param negotiate children 20 startup=0 idle=1 |
41bd17a4 | 647 | #auth_param negotiate keep_alive on |
e0855596 | 648 | # |
66c583dc | 649 | #auth_param digest program <uncomment and complete this line to activate> |
48d54e4d | 650 | #auth_param digest children 20 startup=0 idle=1 |
41bd17a4 | 651 | #auth_param digest realm Squid proxy-caching web server |
652 | #auth_param digest nonce_garbage_interval 5 minutes | |
653 | #auth_param digest nonce_max_duration 30 minutes | |
654 | #auth_param digest nonce_max_count 50 | |
e0855596 | 655 | # |
66c583dc AJ |
656 | #auth_param ntlm program <uncomment and complete this line to activate> |
657 | #auth_param ntlm children 20 startup=0 idle=1 | |
658 | #auth_param ntlm keep_alive on | |
659 | # | |
41bd17a4 | 660 | #auth_param basic program <uncomment and complete this line> |
6f4d3ed6 | 661 | #auth_param basic children 5 startup=5 idle=1 |
41bd17a4 | 662 | #auth_param basic realm Squid proxy-caching web server |
663 | #auth_param basic credentialsttl 2 hours | |
41bd17a4 | 664 | DOC_END |
cccac0a2 | 665 | |
41bd17a4 | 666 | NAME: authenticate_cache_garbage_interval |
667 | TYPE: time_t | |
668 | DEFAULT: 1 hour | |
669 | LOC: Config.authenticateGCInterval | |
670 | DOC_START | |
671 | The time period between garbage collection across the username cache. | |
4ded749e | 672 | This is a trade-off between memory utilization (long intervals - say |
41bd17a4 | 673 | 2 days) and CPU (short intervals - say 1 minute). Only change if you |
674 | have good reason to. | |
675 | DOC_END | |
cccac0a2 | 676 | |
41bd17a4 | 677 | NAME: authenticate_ttl |
678 | TYPE: time_t | |
679 | DEFAULT: 1 hour | |
680 | LOC: Config.authenticateTTL | |
681 | DOC_START | |
682 | The time a user & their credentials stay in the logged in | |
683 | user cache since their last request. When the garbage | |
684 | interval passes, all user credentials that have passed their | |
685 | TTL are removed from memory. | |
686 | DOC_END | |
cccac0a2 | 687 | |
41bd17a4 | 688 | NAME: authenticate_ip_ttl |
689 | TYPE: time_t | |
690 | LOC: Config.authenticateIpTTL | |
c35dd848 | 691 | DEFAULT: 1 second |
41bd17a4 | 692 | DOC_START |
693 | If you use proxy authentication and the 'max_user_ip' ACL, | |
694 | this directive controls how long Squid remembers the IP | |
695 | addresses associated with each user. Use a small value | |
696 | (e.g., 60 seconds) if your users might change addresses | |
4ded749e | 697 | quickly, as is the case with dialup. You might be safe |
41bd17a4 | 698 | using a larger value (e.g., 2 hours) in a corporate LAN |
699 | environment with relatively static address assignments. | |
700 | DOC_END | |
cccac0a2 | 701 | |
3d1e3e43 | 702 | COMMENT_START |
703 | ACCESS CONTROLS | |
704 | ----------------------------------------------------------------------------- | |
705 | COMMENT_END | |
706 | ||
41bd17a4 | 707 | NAME: external_acl_type |
708 | TYPE: externalAclHelper | |
709 | LOC: Config.externalAclHelperList | |
cccac0a2 | 710 | DEFAULT: none |
cccac0a2 | 711 | DOC_START |
41bd17a4 | 712 | This option defines external acl classes using a helper program |
713 | to look up the status | |
cccac0a2 | 714 | |
41bd17a4 | 715 | external_acl_type name [options] FORMAT.. /path/to/helper [helper arguments..] |
cccac0a2 | 716 | |
41bd17a4 | 717 | Options: |
cccac0a2 | 718 | |
41bd17a4 | 719 | ttl=n TTL in seconds for cached results (defaults to 3600 |
cd0fd8a9 | 720 | for 1 hour) |
4f8d0a65 | 721 | |
41bd17a4 | 722 | negative_ttl=n |
cd0fd8a9 AJ |
723 | TTL for cached negative lookups (default same |
724 | as ttl) | |
4f8d0a65 AJ |
725 | |
726 | grace=n Percentage remaining of TTL where a refresh of a | |
727 | cached entry should be initiated without needing to | |
728 | wait for a new reply. (default is for no grace period) | |
729 | ||
eef8bf2d AR |
730 | cache=n The maximum number of entries in the result cache. The |
731 | default limit is 262144 entries. Each cache entry usually | |
732 | consumes at least 256 bytes. Squid currently does not remove | |
733 | expired cache entries until the limit is reached, so a proxy | |
734 | will sooner or later reach the limit. The expanded FORMAT | |
735 | value is used as the cache key, so if the details in FORMAT | |
736 | are highly variable, a larger cache may be needed to produce | |
737 | reduction in helper load. | |
4f8d0a65 | 738 | |
48d54e4d AJ |
739 | children-max=n |
740 | Maximum number of acl helper processes spawned to service | |
741 | external acl lookups of this type. (default 20) | |
4f8d0a65 | 742 | |
48d54e4d AJ |
743 | children-startup=n |
744 | Minimum number of acl helper processes to spawn during | |
745 | startup and reconfigure to service external acl lookups | |
746 | of this type. (default 0) | |
4f8d0a65 | 747 | |
48d54e4d AJ |
748 | children-idle=n |
749 | Number of acl helper processes to keep ahead of traffic | |
750 | loads. Squid will spawn this many at once whenever load | |
751 | rises above the capabilities of existing processes. | |
752 | Up to the value of children-max. (default 1) | |
4f8d0a65 | 753 | |
41bd17a4 | 754 | concurrency=n concurrency level per process. Only used with helpers |
755 | capable of processing more than one query at a time. | |
4f8d0a65 | 756 | |
6825b101 CT |
757 | queue-size=N The queue-size= option sets the maximum number of queued |
758 | requests. If the queued requests exceed queue size | |
4f8d0a65 | 759 | the acl is ignored. |
6825b101 | 760 | The default value is set to 2*children-max. |
4f8d0a65 AJ |
761 | |
762 | protocol=2.5 Compatibility mode for Squid-2.5 external acl helpers. | |
763 | ||
91e64de9 AJ |
764 | ipv4 / ipv6 IP protocol used to communicate with this helper. |
765 | The default is to auto-detect IPv6 and use it when available. | |
cccac0a2 | 766 | |
4f8d0a65 | 767 | |
cd0fd8a9 AJ |
768 | FORMAT is a series of %macro codes. See logformat directive for a full list |
769 | of the accepted codes. Although note that at the time of any external ACL | |
770 | being tested data may not be available and thus some %macro expand to '-'. | |
771 | ||
772 | In addition to the logformat codes; when processing external ACLs these | |
773 | additional macros are made available: | |
7b0ca1e8 | 774 | |
ec2d5242 | 775 | %ACL The name of the ACL being tested. |
ec2d5242 | 776 | |
cd0fd8a9 AJ |
777 | %DATA The ACL arguments. If a logformat encoding modifier |
778 | is used it will encode the whole set of arguments | |
779 | as a single token. | |
780 | ||
781 | If not used; then any arguments are automatically | |
782 | added at the end of the line sent to the helper | |
783 | as separately URL-encoded fields. | |
784 | ||
785 | If SSL is enabled, the following formating codes become available: | |
786 | ||
787 | %USER_CERT SSL User certificate in PEM format | |
788 | %USER_CERTCHAIN SSL User certificate chain in PEM format | |
789 | %USER_CERT_xx SSL User certificate subject attribute xx | |
790 | %USER_CA_CERT_xx SSL User certificate issuer attribute xx | |
791 | ||
792 | ||
793 | NOTE: all other format codes accepted by older Squid versions | |
794 | are deprecated. | |
0db8942f | 795 | |
cccac0a2 | 796 | |
5269ec0e AJ |
797 | General request syntax: |
798 | ||
799 | [channel-ID] FORMAT-values [acl-values ...] | |
800 | ||
801 | ||
802 | FORMAT-values consists of transaction details expanded with | |
803 | whitespace separation per the config file FORMAT specification | |
804 | using the FORMAT macros listed above. | |
805 | ||
806 | acl-values consists of any string specified in the referencing | |
807 | config 'acl ... external' line. see the "acl external" directive. | |
808 | ||
809 | Request values sent to the helper are URL escaped to protect | |
810 | each value in requests against whitespaces. | |
811 | ||
812 | If using protocol=2.5 then the request sent to the helper is not | |
813 | URL escaped to protect against whitespace. | |
814 | ||
815 | NOTE: protocol=3.0 is deprecated as no longer necessary. | |
816 | ||
817 | When using the concurrency= option the protocol is changed by | |
818 | introducing a query channel tag in front of the request/response. | |
819 | The query channel tag is a number between 0 and concurrency-1. | |
820 | This value must be echoed back unchanged to Squid as the first part | |
821 | of the response relating to its request. | |
822 | ||
823 | ||
824 | The helper receives lines expanded per the above format specification | |
825 | and for each input line returns 1 line starting with OK/ERR/BH result | |
826 | code and optionally followed by additional keywords with more details. | |
827 | ||
cccac0a2 | 828 | |
41bd17a4 | 829 | General result syntax: |
cccac0a2 | 830 | |
5269ec0e AJ |
831 | [channel-ID] result keyword=value ... |
832 | ||
833 | Result consists of one of the codes: | |
834 | ||
835 | OK | |
836 | the ACL test produced a match. | |
837 | ||
838 | ERR | |
839 | the ACL test does not produce a match. | |
840 | ||
841 | BH | |
4ded749e | 842 | An internal error occurred in the helper, preventing |
5269ec0e AJ |
843 | a result being identified. |
844 | ||
845 | The meaning of 'a match' is determined by your squid.conf | |
846 | access control configuration. See the Squid wiki for details. | |
cccac0a2 | 847 | |
41bd17a4 | 848 | Defined keywords: |
cccac0a2 | 849 | |
41bd17a4 | 850 | user= The users name (login) |
5269ec0e | 851 | |
41bd17a4 | 852 | password= The users password (for login= cache_peer option) |
5269ec0e | 853 | |
05e52854 | 854 | message= Message describing the reason for this response. |
5269ec0e AJ |
855 | Available as %o in error pages. |
856 | Useful on (ERR and BH results). | |
857 | ||
05e52854 AJ |
858 | tag= Apply a tag to a request. Only sets a tag once, |
859 | does not alter existing tags. | |
5269ec0e | 860 | |
41bd17a4 | 861 | log= String to be logged in access.log. Available as |
cd0fd8a9 | 862 | %ea in logformat specifications. |
934b03fc | 863 | |
cd0fd8a9 | 864 | clt_conn_tag= Associates a TAG with the client TCP connection. |
4f8d0a65 AJ |
865 | Please see url_rewrite_program related documentation |
866 | for this kv-pair. | |
457857fe | 867 | |
05e52854 | 868 | Any keywords may be sent on any response whether OK, ERR or BH. |
6a566b9c | 869 | |
05e52854 AJ |
870 | All response keyword values need to be a single token with URL |
871 | escaping, or enclosed in double quotes (") and escaped using \ on | |
24eac830 AJ |
872 | any double quotes or \ characters within the value. The wrapping |
873 | double quotes are removed before the value is interpreted by Squid. | |
874 | \r and \n are also replace by CR and LF. | |
1e5562e3 | 875 | |
24eac830 AJ |
876 | Some example key values: |
877 | ||
5269ec0e | 878 | user=John%20Smith |
24eac830 AJ |
879 | user="John Smith" |
880 | user="J. \"Bob\" Smith" | |
cccac0a2 | 881 | DOC_END |
882 | ||
41bd17a4 | 883 | NAME: acl |
884 | TYPE: acl | |
885 | LOC: Config.aclList | |
cb4f4424 | 886 | IF USE_OPENSSL |
cf1c09f6 CT |
887 | DEFAULT: ssl::certHasExpired ssl_error X509_V_ERR_CERT_HAS_EXPIRED |
888 | DEFAULT: ssl::certNotYetValid ssl_error X509_V_ERR_CERT_NOT_YET_VALID | |
889 | DEFAULT: ssl::certDomainMismatch ssl_error SQUID_X509_V_ERR_DOMAIN_MISMATCH | |
890 | DEFAULT: ssl::certUntrusted ssl_error X509_V_ERR_INVALID_CA X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY X509_V_ERR_CERT_UNTRUSTED | |
891 | DEFAULT: ssl::certSelfSigned ssl_error X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT | |
892 | ENDIF | |
1f5bd0a4 | 893 | DEFAULT: all src all |
b8a25eaa AJ |
894 | DEFAULT: manager url_regex -i ^cache_object:// +i ^https?://[^/]+/squid-internal-mgr/ |
895 | DEFAULT: localhost src 127.0.0.1/32 ::1 | |
896 | DEFAULT: to_localhost dst 127.0.0.0/8 0.0.0.0/32 ::1 | |
897 | DEFAULT_DOC: ACLs all, manager, localhost, and to_localhost are predefined. | |
cccac0a2 | 898 | DOC_START |
41bd17a4 | 899 | Defining an Access List |
cccac0a2 | 900 | |
375eeb3b AJ |
901 | Every access list definition must begin with an aclname and acltype, |
902 | followed by either type-specific arguments or a quoted filename that | |
903 | they are read from. | |
cccac0a2 | 904 | |
375eeb3b AJ |
905 | acl aclname acltype argument ... |
906 | acl aclname acltype "file" ... | |
cccac0a2 | 907 | |
375eeb3b | 908 | When using "file", the file should contain one item per line. |
cccac0a2 | 909 | |
76ee67ac CT |
910 | |
911 | ACL Options | |
912 | ||
913 | Some acl types supports options which changes their default behaviour: | |
0f987978 CT |
914 | |
915 | -i,+i By default, regular expressions are CASE-SENSITIVE. To make them | |
916 | case-insensitive, use the -i option. To return case-sensitive | |
917 | use the +i option between patterns, or make a new ACL line | |
918 | without -i. | |
919 | ||
920 | -n Disable lookups and address type conversions. If lookup or | |
921 | conversion is required because the parameter type (IP or | |
922 | domain name) does not match the message address type (domain | |
923 | name or IP), then the ACL would immediately declare a mismatch | |
924 | without any warnings or lookups. | |
925 | ||
76ee67ac CT |
926 | -m[=delimiters] |
927 | Perform a list membership test, interpreting values as | |
928 | comma-separated token lists and matching against individual | |
929 | tokens instead of whole values. | |
930 | The optional "delimiters" parameter specifies one or more | |
931 | alternative non-alphanumeric delimiter characters. | |
932 | non-alphanumeric delimiter characters. | |
933 | ||
0f987978 CT |
934 | -- Used to stop processing all options, in the case the first acl |
935 | value has '-' character as first character (for example the '-' | |
936 | is a valid domain name) | |
cccac0a2 | 937 | |
b3567eb5 FC |
938 | Some acl types require suspending the current request in order |
939 | to access some external data source. | |
940 | Those which do are marked with the tag [slow], those which | |
941 | don't are marked as [fast]. | |
942 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl | |
943 | for further information | |
e988aa40 AJ |
944 | |
945 | ***** ACL TYPES AVAILABLE ***** | |
946 | ||
1e40905d AJ |
947 | acl aclname src ip-address/mask ... # clients IP address [fast] |
948 | acl aclname src addr1-addr2/mask ... # range of addresses [fast] | |
0f987978 | 949 | acl aclname dst [-n] ip-address/mask ... # URL host's IP address [slow] |
1e40905d | 950 | acl aclname localip ip-address/mask ... # IP address the client connected to [fast] |
cccac0a2 | 951 | |
41bd17a4 | 952 | acl aclname arp mac-address ... (xx:xx:xx:xx:xx:xx notation) |
b3567eb5 | 953 | # [fast] |
abe01913 AJ |
954 | # The 'arp' ACL code is not portable to all operating systems. |
955 | # It works on Linux, Solaris, Windows, FreeBSD, and some other | |
956 | # BSD variants. | |
41bd17a4 | 957 | # |
abe01913 AJ |
958 | # NOTE: Squid can only determine the MAC/EUI address for IPv4 |
959 | # clients that are on the same subnet. If the client is on a | |
960 | # different subnet, then Squid cannot find out its address. | |
961 | # | |
962 | # NOTE 2: IPv6 protocol does not contain ARP. MAC/EUI is either | |
963 | # encoded directly in the IPv6 address or not available. | |
b3567eb5 FC |
964 | |
965 | acl aclname srcdomain .foo.com ... | |
966 | # reverse lookup, from client IP [slow] | |
0f987978 | 967 | acl aclname dstdomain [-n] .foo.com ... |
e38c7724 | 968 | # Destination server from URL [fast] |
b3567eb5 FC |
969 | acl aclname srcdom_regex [-i] \.foo\.com ... |
970 | # regex matching client name [slow] | |
0f987978 | 971 | acl aclname dstdom_regex [-n] [-i] \.foo\.com ... |
e38c7724 | 972 | # regex matching server [fast] |
b3567eb5 | 973 | # |
41bd17a4 | 974 | # For dstdomain and dstdom_regex a reverse lookup is tried if a IP |
975 | # based URL is used and no match is found. The name "none" is used | |
976 | # if the reverse lookup fails. | |
9bc73deb | 977 | |
375eeb3b AJ |
978 | acl aclname src_as number ... |
979 | acl aclname dst_as number ... | |
b3567eb5 | 980 | # [fast] |
e988aa40 AJ |
981 | # Except for access control, AS numbers can be used for |
982 | # routing of requests to specific caches. Here's an | |
983 | # example for routing all requests for AS#1241 and only | |
984 | # those to mycache.mydomain.net: | |
985 | # acl asexample dst_as 1241 | |
986 | # cache_peer_access mycache.mydomain.net allow asexample | |
987 | # cache_peer_access mycache_mydomain.net deny all | |
7f7db318 | 988 | |
6db78a1a | 989 | acl aclname peername myPeer ... |
b3567eb5 | 990 | # [fast] |
6db78a1a AJ |
991 | # match against a named cache_peer entry |
992 | # set unique name= on cache_peer lines for reliable use. | |
993 | ||
375eeb3b | 994 | acl aclname time [day-abbrevs] [h1:m1-h2:m2] |
b3567eb5 | 995 | # [fast] |
375eeb3b AJ |
996 | # day-abbrevs: |
997 | # S - Sunday | |
998 | # M - Monday | |
999 | # T - Tuesday | |
1000 | # W - Wednesday | |
1001 | # H - Thursday | |
1002 | # F - Friday | |
1003 | # A - Saturday | |
1004 | # h1:m1 must be less than h2:m2 | |
1005 | ||
b3567eb5 FC |
1006 | acl aclname url_regex [-i] ^http:// ... |
1007 | # regex matching on whole URL [fast] | |
9d35fe37 AJ |
1008 | acl aclname urllogin [-i] [^a-zA-Z0-9] ... |
1009 | # regex matching on URL login field | |
b3567eb5 FC |
1010 | acl aclname urlpath_regex [-i] \.gif$ ... |
1011 | # regex matching on URL path [fast] | |
e988aa40 | 1012 | |
b3567eb5 FC |
1013 | acl aclname port 80 70 21 0-1024... # destination TCP port [fast] |
1014 | # ranges are alloed | |
1e40905d AJ |
1015 | acl aclname localport 3128 ... # TCP port the client connected to [fast] |
1016 | # NP: for interception mode this is usually '80' | |
1017 | ||
3cc0f4e7 | 1018 | acl aclname myportname 3128 ... # *_port name [fast] |
e988aa40 | 1019 | |
b3567eb5 FC |
1020 | acl aclname proto HTTP FTP ... # request protocol [fast] |
1021 | ||
1022 | acl aclname method GET POST ... # HTTP request method [fast] | |
e988aa40 | 1023 | |
b3567eb5 FC |
1024 | acl aclname http_status 200 301 500- 400-403 ... |
1025 | # status code in reply [fast] | |
e988aa40 | 1026 | |
375eeb3b | 1027 | acl aclname browser [-i] regexp ... |
b3567eb5 | 1028 | # pattern match on User-Agent header (see also req_header below) [fast] |
e988aa40 | 1029 | |
375eeb3b | 1030 | acl aclname referer_regex [-i] regexp ... |
b3567eb5 | 1031 | # pattern match on Referer header [fast] |
41bd17a4 | 1032 | # Referer is highly unreliable, so use with care |
e988aa40 | 1033 | |
375eeb3b | 1034 | acl aclname ident username ... |
41bd17a4 | 1035 | acl aclname ident_regex [-i] pattern ... |
b3567eb5 | 1036 | # string match on ident output [slow] |
41bd17a4 | 1037 | # use REQUIRED to accept any non-null ident. |
cf5cc17e | 1038 | |
41bd17a4 | 1039 | acl aclname proxy_auth [-i] username ... |
1040 | acl aclname proxy_auth_regex [-i] pattern ... | |
b3567eb5 FC |
1041 | # perform http authentication challenge to the client and match against |
1042 | # supplied credentials [slow] | |
1043 | # | |
1044 | # takes a list of allowed usernames. | |
41bd17a4 | 1045 | # use REQUIRED to accept any valid username. |
1046 | # | |
b3567eb5 FC |
1047 | # Will use proxy authentication in forward-proxy scenarios, and plain |
1048 | # http authenticaiton in reverse-proxy scenarios | |
1049 | # | |
41bd17a4 | 1050 | # NOTE: when a Proxy-Authentication header is sent but it is not |
1051 | # needed during ACL checking the username is NOT logged | |
1052 | # in access.log. | |
1053 | # | |
1054 | # NOTE: proxy_auth requires a EXTERNAL authentication program | |
1055 | # to check username/password combinations (see | |
1056 | # auth_param directive). | |
1057 | # | |
e988aa40 AJ |
1058 | # NOTE: proxy_auth can't be used in a transparent/intercepting proxy |
1059 | # as the browser needs to be configured for using a proxy in order | |
41bd17a4 | 1060 | # to respond to proxy authentication. |
8e8d4f30 | 1061 | |
41bd17a4 | 1062 | acl aclname snmp_community string ... |
b3567eb5 | 1063 | # A community string to limit access to your SNMP Agent [fast] |
41bd17a4 | 1064 | # Example: |
1065 | # | |
1066 | # acl snmppublic snmp_community public | |
934b03fc | 1067 | |
41bd17a4 | 1068 | acl aclname maxconn number |
1069 | # This will be matched when the client's IP address has | |
55d0fae8 AJ |
1070 | # more than <number> TCP connections established. [fast] |
1071 | # NOTE: This only measures direct TCP links so X-Forwarded-For | |
1072 | # indirect clients are not counted. | |
1e5562e3 | 1073 | |
41bd17a4 | 1074 | acl aclname max_user_ip [-s] number |
1075 | # This will be matched when the user attempts to log in from more | |
1076 | # than <number> different ip addresses. The authenticate_ip_ttl | |
b3567eb5 | 1077 | # parameter controls the timeout on the ip entries. [fast] |
41bd17a4 | 1078 | # If -s is specified the limit is strict, denying browsing |
1079 | # from any further IP addresses until the ttl has expired. Without | |
1080 | # -s Squid will just annoy the user by "randomly" denying requests. | |
1081 | # (the counter is reset each time the limit is reached and a | |
1082 | # request is denied) | |
1083 | # NOTE: in acceleration mode or where there is mesh of child proxies, | |
1084 | # clients may appear to come from multiple addresses if they are | |
1085 | # going through proxy farms, so a limit of 1 may cause user problems. | |
cccac0a2 | 1086 | |
cb1b906f AJ |
1087 | acl aclname random probability |
1088 | # Pseudo-randomly match requests. Based on the probability given. | |
1089 | # Probability may be written as a decimal (0.333), fraction (1/3) | |
1090 | # or ratio of matches:non-matches (3:5). | |
1091 | ||
375eeb3b | 1092 | acl aclname req_mime_type [-i] mime-type ... |
41bd17a4 | 1093 | # regex match against the mime type of the request generated |
1094 | # by the client. Can be used to detect file upload or some | |
b3567eb5 | 1095 | # types HTTP tunneling requests [fast] |
41bd17a4 | 1096 | # NOTE: This does NOT match the reply. You cannot use this |
1097 | # to match the returned file type. | |
cccac0a2 | 1098 | |
41bd17a4 | 1099 | acl aclname req_header header-name [-i] any\.regex\.here |
1100 | # regex match against any of the known request headers. May be | |
1101 | # thought of as a superset of "browser", "referer" and "mime-type" | |
b3567eb5 | 1102 | # ACL [fast] |
cccac0a2 | 1103 | |
375eeb3b | 1104 | acl aclname rep_mime_type [-i] mime-type ... |
41bd17a4 | 1105 | # regex match against the mime type of the reply received by |
1106 | # squid. Can be used to detect file download or some | |
b3567eb5 | 1107 | # types HTTP tunneling requests. [fast] |
41bd17a4 | 1108 | # NOTE: This has no effect in http_access rules. It only has |
1109 | # effect in rules that affect the reply data stream such as | |
1110 | # http_reply_access. | |
cccac0a2 | 1111 | |
41bd17a4 | 1112 | acl aclname rep_header header-name [-i] any\.regex\.here |
1113 | # regex match against any of the known reply headers. May be | |
1114 | # thought of as a superset of "browser", "referer" and "mime-type" | |
b3567eb5 | 1115 | # ACLs [fast] |
cccac0a2 | 1116 | |
375eeb3b | 1117 | acl aclname external class_name [arguments...] |
41bd17a4 | 1118 | # external ACL lookup via a helper class defined by the |
b3567eb5 | 1119 | # external_acl_type directive [slow] |
cccac0a2 | 1120 | |
41bd17a4 | 1121 | acl aclname user_cert attribute values... |
1122 | # match against attributes in a user SSL certificate | |
2927ae41 | 1123 | # attribute is one of DN/C/O/CN/L/ST or a numerical OID [fast] |
cccac0a2 | 1124 | |
41bd17a4 | 1125 | acl aclname ca_cert attribute values... |
1126 | # match against attributes a users issuing CA SSL certificate | |
2927ae41 | 1127 | # attribute is one of DN/C/O/CN/L/ST or a numerical OID [fast] |
cccac0a2 | 1128 | |
41bd17a4 | 1129 | acl aclname ext_user username ... |
1130 | acl aclname ext_user_regex [-i] pattern ... | |
b3567eb5 | 1131 | # string match on username returned by external acl helper [slow] |
41bd17a4 | 1132 | # use REQUIRED to accept any non-null user name. |
b3567eb5 | 1133 | |
0ab50441 | 1134 | acl aclname tag tagvalue ... |
94da12c8 AJ |
1135 | # string match on tag returned by external acl helper [fast] |
1136 | # DEPRECATED. Only the first tag will match with this ACL. | |
1137 | # Use the 'note' ACL instead for handling multiple tag values. | |
cccac0a2 | 1138 | |
bbaf2685 AJ |
1139 | acl aclname hier_code codename ... |
1140 | # string match against squid hierarchy code(s); [fast] | |
1141 | # e.g., DIRECT, PARENT_HIT, NONE, etc. | |
1142 | # | |
1143 | # NOTE: This has no effect in http_access rules. It only has | |
1144 | # effect in rules that affect the reply data stream such as | |
1145 | # http_reply_access. | |
1146 | ||
76ee67ac | 1147 | acl aclname note [-m[=delimiters]] name [value ...] |
39baccc8 CT |
1148 | # match transaction annotation [fast] |
1149 | # Without values, matches any annotation with a given name. | |
1150 | # With value(s), matches any annotation with a given name that | |
1151 | # also has one of the given values. | |
76ee67ac CT |
1152 | # If the -m flag is used, then the value of the named |
1153 | # annotation is interpreted as a list of tokens, and the ACL | |
1154 | # matches individual name=token pairs rather than whole | |
1155 | # name=value pairs. See "ACL Options" above for more info. | |
39baccc8 CT |
1156 | # Annotation sources include note and adaptation_meta directives |
1157 | # as well as helper and eCAP responses. | |
1158 | ||
c302ddb5 CT |
1159 | acl aclname adaptation_service service ... |
1160 | # Matches the name of any icap_service, ecap_service, | |
1161 | # adaptation_service_set, or adaptation_service_chain that Squid | |
1162 | # has used (or attempted to use) for the master transaction. | |
1163 | # This ACL must be defined after the corresponding adaptation | |
1164 | # service is named in squid.conf. This ACL is usable with | |
1165 | # adaptation_meta because it starts matching immediately after | |
1166 | # the service has been selected for adaptation. | |
1167 | ||
cb4f4424 | 1168 | IF USE_OPENSSL |
cf1c09f6 CT |
1169 | acl aclname ssl_error errorname |
1170 | # match against SSL certificate validation error [fast] | |
cf1c09f6 | 1171 | # |
7a957a93 AR |
1172 | # For valid error names see in @DEFAULT_ERROR_DIR@/templates/error-details.txt |
1173 | # template file. | |
cf1c09f6 | 1174 | # |
7a957a93 AR |
1175 | # The following can be used as shortcuts for certificate properties: |
1176 | # [ssl::]certHasExpired: the "not after" field is in the past | |
1177 | # [ssl::]certNotYetValid: the "not before" field is in the future | |
1178 | # [ssl::]certUntrusted: The certificate issuer is not to be trusted. | |
1179 | # [ssl::]certSelfSigned: The certificate is self signed. | |
1180 | # [ssl::]certDomainMismatch: The certificate CN domain does not | |
1181 | # match the name the name of the host we are connecting to. | |
1182 | # | |
1183 | # The ssl::certHasExpired, ssl::certNotYetValid, ssl::certDomainMismatch, | |
1184 | # ssl::certUntrusted, and ssl::certSelfSigned can also be used as | |
1185 | # predefined ACLs, just like the 'all' ACL. | |
1186 | # | |
1187 | # NOTE: The ssl_error ACL is only supported with sslproxy_cert_error, | |
1188 | # sslproxy_cert_sign, and sslproxy_cert_adapt options. | |
00352183 | 1189 | |
72b12f9e | 1190 | acl aclname server_cert_fingerprint [-sha1] fingerprint |
00352183 AR |
1191 | # match against server SSL certificate fingerprint [fast] |
1192 | # | |
1193 | # The fingerprint is the digest of the DER encoded version | |
1194 | # of the whole certificate. The user should use the form: XX:XX:... | |
1195 | # Optional argument specifies the digest algorithm to use. | |
1196 | # The SHA1 digest algorithm is the default and is currently | |
1197 | # the only algorithm supported (-sha1). | |
5d65362c | 1198 | |
652fcffd | 1199 | acl aclname at_step step |
8f165829 AR |
1200 | # match against the current step during ssl_bump evaluation [fast] |
1201 | # Never matches and should not be used outside the ssl_bump context. | |
1202 | # | |
1203 | # At each SslBump step, Squid evaluates ssl_bump directives to find | |
1204 | # the next bumping action (e.g., peek or splice). Valid SslBump step | |
1205 | # values and the corresponding ssl_bump evaluation moments are: | |
1110989a CT |
1206 | # SslBump1: After getting TCP-level and HTTP CONNECT info. |
1207 | # SslBump2: After getting SSL Client Hello info. | |
1208 | # SslBump3: After getting SSL Server Hello info. | |
69f69080 CT |
1209 | |
1210 | acl aclname ssl::server_name .foo.com ... | |
1211 | # matches server name obtained from various sources [fast] | |
1212 | # | |
1213 | # The server name is obtained during Ssl-Bump steps from such sources | |
1214 | # as CONNECT request URI, client SNI, and SSL server certificate CN. | |
1215 | # During each Ssl-Bump step, Squid may improve its understanding of a | |
1216 | # "true server name". Unlike dstdomain, this ACL does not perform | |
1217 | # DNS lookups. | |
1218 | ||
1219 | acl aclname ssl::server_name_regex [-i] \.foo\.com ... | |
1220 | # regex matches server name obtained from various sources [fast] | |
88df846b CT |
1221 | |
1222 | acl aclname connections_encrypted | |
1223 | # matches transactions with all HTTP messages received over TLS | |
1224 | # transport connections. [fast] | |
1225 | # | |
1226 | # The master transaction deals with HTTP messages received from | |
1227 | # various sources. All sources used by the master transaction in the | |
1228 | # past are considered by the ACL. The following rules define whether | |
1229 | # a given message source taints the entire master transaction, | |
1230 | # resulting in ACL mismatches: | |
1231 | # | |
1232 | # * The HTTP client transport connection is not TLS. | |
1233 | # * An adaptation service connection-encryption flag is off. | |
1234 | # * The peer or origin server transport connection is not TLS. | |
1235 | # | |
1236 | # Caching currently does not affect these rules. This cache ignorance | |
1237 | # implies that only the current HTTP client transport and REQMOD | |
1238 | # services status determine whether this ACL matches a from-cache | |
1239 | # transaction. The source of the cached response does not have any | |
1240 | # effect on future transaction that use the cached response without | |
1241 | # revalidation. This may change. | |
1242 | # | |
1243 | # DNS, ICP, and HTCP exchanges during the master transaction do not | |
1244 | # affect these rules. | |
cf1c09f6 | 1245 | ENDIF |
6f58d7d7 AR |
1246 | acl aclname any-of acl1 acl2 ... |
1247 | # match any one of the acls [fast or slow] | |
1248 | # The first matching ACL stops further ACL evaluation. | |
1249 | # | |
1250 | # ACLs from multiple any-of lines with the same name are ORed. | |
1251 | # For example, A = (a1 or a2) or (a3 or a4) can be written as | |
1252 | # acl A any-of a1 a2 | |
1253 | # acl A any-of a3 a4 | |
1254 | # | |
1255 | # This group ACL is fast if all evaluated ACLs in the group are fast | |
1256 | # and slow otherwise. | |
1257 | ||
1258 | acl aclname all-of acl1 acl2 ... | |
1259 | # match all of the acls [fast or slow] | |
1260 | # The first mismatching ACL stops further ACL evaluation. | |
1261 | # | |
1262 | # ACLs from multiple all-of lines with the same name are ORed. | |
1263 | # For example, B = (b1 and b2) or (b3 and b4) can be written as | |
1264 | # acl B all-of b1 b2 | |
1265 | # acl B all-of b3 b4 | |
1266 | # | |
1267 | # This group ACL is fast if all evaluated ACLs in the group are fast | |
1268 | # and slow otherwise. | |
cf1c09f6 | 1269 | |
e0855596 AJ |
1270 | Examples: |
1271 | acl macaddress arp 09:00:2b:23:45:67 | |
1272 | acl myexample dst_as 1241 | |
1273 | acl password proxy_auth REQUIRED | |
1274 | acl fileupload req_mime_type -i ^multipart/form-data$ | |
1275 | acl javascript rep_mime_type -i ^application/x-javascript$ | |
cccac0a2 | 1276 | |
41bd17a4 | 1277 | NOCOMMENT_START |
e0855596 AJ |
1278 | # |
1279 | # Recommended minimum configuration: | |
1280 | # | |
e0855596 | 1281 | |
ee776778 | 1282 | # Example rule allowing access from your local networks. |
1283 | # Adapt to list your (internal) IP networks from where browsing | |
1284 | # should be allowed | |
fe204e1d AJ |
1285 | acl localnet src 0.0.0.1-0.255.255.255 # RFC 1122 "this" network (LAN) |
1286 | acl localnet src 10.0.0.0/8 # RFC 1918 local private network (LAN) | |
1287 | acl localnet src 100.64.0.0/10 # RFC 6598 shared address space (CGN) | |
1288 | acl localhet src 169.254.0.0/16 # RFC 3927 link-local (directly plugged) machines | |
1289 | acl localnet src 172.16.0.0/12 # RFC 1918 local private network (LAN) | |
1290 | acl localnet src 192.168.0.0/16 # RFC 1918 local private network (LAN) | |
1291 | acl localnet src fc00::/7 # RFC 4193 local private network range | |
1292 | acl localnet src fe80::/10 # RFC 4291 link-local (directly plugged) machines | |
e0855596 | 1293 | |
41bd17a4 | 1294 | acl SSL_ports port 443 |
1295 | acl Safe_ports port 80 # http | |
1296 | acl Safe_ports port 21 # ftp | |
1297 | acl Safe_ports port 443 # https | |
1298 | acl Safe_ports port 70 # gopher | |
1299 | acl Safe_ports port 210 # wais | |
1300 | acl Safe_ports port 1025-65535 # unregistered ports | |
1301 | acl Safe_ports port 280 # http-mgmt | |
1302 | acl Safe_ports port 488 # gss-http | |
1303 | acl Safe_ports port 591 # filemaker | |
1304 | acl Safe_ports port 777 # multiling http | |
1305 | acl CONNECT method CONNECT | |
1306 | NOCOMMENT_END | |
1307 | DOC_END | |
cccac0a2 | 1308 | |
d3d92daa | 1309 | NAME: proxy_protocol_access |
3d674977 | 1310 | TYPE: acl_access |
d3d92daa AJ |
1311 | LOC: Config.accessList.proxyProtocol |
1312 | DEFAULT: none | |
c390580b | 1313 | DEFAULT_DOC: all TCP connections to ports with require-proxy-header will be denied |
d3d92daa AJ |
1314 | DOC_START |
1315 | Determine which client proxies can be trusted to provide correct | |
1316 | information regarding real client IP address using PROXY protocol. | |
1317 | ||
1318 | Requests may pass through a chain of several other proxies | |
1319 | before reaching us. The original source details may by sent in: | |
1320 | * HTTP message Forwarded header, or | |
1321 | * HTTP message X-Forwarded-For header, or | |
1322 | * PROXY protocol connection header. | |
1323 | ||
1324 | This directive is solely for validating new PROXY protocol | |
1325 | connections received from a port flagged with require-proxy-header. | |
1326 | It is checked only once after TCP connection setup. | |
1327 | ||
1328 | A deny match results in TCP connection closure. | |
1329 | ||
1330 | An allow match is required for Squid to permit the corresponding | |
1331 | TCP connection, before Squid even looks for HTTP request headers. | |
1332 | If there is an allow match, Squid starts using PROXY header information | |
1333 | to determine the source address of the connection for all future ACL | |
1334 | checks, logging, etc. | |
1335 | ||
1336 | SECURITY CONSIDERATIONS: | |
1337 | ||
c390580b | 1338 | Any host from which we accept client IP details can place |
d3d92daa AJ |
1339 | incorrect information in the relevant header, and Squid |
1340 | will use the incorrect information as if it were the | |
1341 | source address of the request. This may enable remote | |
1342 | hosts to bypass any access control restrictions that are | |
1343 | based on the client's source addresses. | |
1344 | ||
1345 | This clause only supports fast acl types. | |
1346 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
1347 | DOC_END | |
1348 | ||
1349 | NAME: follow_x_forwarded_for | |
1350 | TYPE: acl_access | |
1351 | IFDEF: FOLLOW_X_FORWARDED_FOR | |
3d674977 | 1352 | LOC: Config.accessList.followXFF |
3d674977 | 1353 | DEFAULT_IF_NONE: deny all |
9353df52 | 1354 | DEFAULT_DOC: X-Forwarded-For header will be ignored. |
3d674977 | 1355 | DOC_START |
00d0ce87 AJ |
1356 | Determine which client proxies can be trusted to provide correct |
1357 | information regarding real client IP address. | |
1358 | ||
3d674977 | 1359 | Requests may pass through a chain of several other proxies |
70a16fea AJ |
1360 | before reaching us. The original source details may by sent in: |
1361 | * HTTP message Forwarded header, or | |
1362 | * HTTP message X-Forwarded-For header, or | |
1363 | * PROXY protocol connection header. | |
3d674977 | 1364 | |
d3d92daa AJ |
1365 | PROXY protocol connections are controlled by the proxy_protocol_access |
1366 | directive which is checked before this. | |
1367 | ||
3d674977 | 1368 | If a request reaches us from a source that is allowed by this |
70a16fea AJ |
1369 | directive, then we trust the information it provides regarding |
1370 | the IP of the client it received from (if any). | |
1371 | ||
1372 | For the purpose of ACLs used in this directive the src ACL type always | |
1373 | matches the address we are testing and srcdomain matches its rDNS. | |
1374 | ||
70a16fea AJ |
1375 | On each HTTP request Squid checks for X-Forwarded-For header fields. |
1376 | If found the header values are iterated in reverse order and an allow | |
1377 | match is required for Squid to continue on to the next value. | |
1378 | The verification ends when a value receives a deny match, cannot be | |
1379 | tested, or there are no more values to test. | |
1380 | NOTE: Squid does not yet follow the Forwarded HTTP header. | |
3d674977 AJ |
1381 | |
1382 | The end result of this process is an IP address that we will | |
1383 | refer to as the indirect client address. This address may | |
57d76dd4 | 1384 | be treated as the client address for access control, ICAP, delay |
3d674977 | 1385 | pools and logging, depending on the acl_uses_indirect_client, |
96d64448 AJ |
1386 | icap_uses_indirect_client, delay_pool_uses_indirect_client, |
1387 | log_uses_indirect_client and tproxy_uses_indirect_client options. | |
3d674977 | 1388 | |
b3567eb5 FC |
1389 | This clause only supports fast acl types. |
1390 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
1391 | ||
3d674977 AJ |
1392 | SECURITY CONSIDERATIONS: |
1393 | ||
c390580b | 1394 | Any host from which we accept client IP details can place |
70a16fea | 1395 | incorrect information in the relevant header, and Squid |
3d674977 AJ |
1396 | will use the incorrect information as if it were the |
1397 | source address of the request. This may enable remote | |
1398 | hosts to bypass any access control restrictions that are | |
1399 | based on the client's source addresses. | |
1400 | ||
1401 | For example: | |
1402 | ||
1403 | acl localhost src 127.0.0.1 | |
1404 | acl my_other_proxy srcdomain .proxy.example.com | |
1405 | follow_x_forwarded_for allow localhost | |
1406 | follow_x_forwarded_for allow my_other_proxy | |
1407 | DOC_END | |
1408 | ||
1409 | NAME: acl_uses_indirect_client | |
1410 | COMMENT: on|off | |
1411 | TYPE: onoff | |
1412 | IFDEF: FOLLOW_X_FORWARDED_FOR | |
1413 | DEFAULT: on | |
1414 | LOC: Config.onoff.acl_uses_indirect_client | |
1415 | DOC_START | |
1416 | Controls whether the indirect client address | |
1417 | (see follow_x_forwarded_for) is used instead of the | |
1418 | direct client address in acl matching. | |
55d0fae8 AJ |
1419 | |
1420 | NOTE: maxconn ACL considers direct TCP links and indirect | |
1421 | clients will always have zero. So no match. | |
3d674977 AJ |
1422 | DOC_END |
1423 | ||
1424 | NAME: delay_pool_uses_indirect_client | |
1425 | COMMENT: on|off | |
1426 | TYPE: onoff | |
9a0a18de | 1427 | IFDEF: FOLLOW_X_FORWARDED_FOR&&USE_DELAY_POOLS |
3d674977 AJ |
1428 | DEFAULT: on |
1429 | LOC: Config.onoff.delay_pool_uses_indirect_client | |
1430 | DOC_START | |
1431 | Controls whether the indirect client address | |
1432 | (see follow_x_forwarded_for) is used instead of the | |
1433 | direct client address in delay pools. | |
1434 | DOC_END | |
1435 | ||
1436 | NAME: log_uses_indirect_client | |
1437 | COMMENT: on|off | |
1438 | TYPE: onoff | |
1439 | IFDEF: FOLLOW_X_FORWARDED_FOR | |
1440 | DEFAULT: on | |
1441 | LOC: Config.onoff.log_uses_indirect_client | |
1442 | DOC_START | |
1443 | Controls whether the indirect client address | |
1444 | (see follow_x_forwarded_for) is used instead of the | |
1445 | direct client address in the access log. | |
1446 | DOC_END | |
1447 | ||
96d64448 AJ |
1448 | NAME: tproxy_uses_indirect_client |
1449 | COMMENT: on|off | |
1450 | TYPE: onoff | |
1451 | IFDEF: FOLLOW_X_FORWARDED_FOR&&LINUX_NETFILTER | |
4d7ab5a2 | 1452 | DEFAULT: off |
96d64448 AJ |
1453 | LOC: Config.onoff.tproxy_uses_indirect_client |
1454 | DOC_START | |
1455 | Controls whether the indirect client address | |
1456 | (see follow_x_forwarded_for) is used instead of the | |
1457 | direct client address when spoofing the outgoing client. | |
4d7ab5a2 AJ |
1458 | |
1459 | This has no effect on requests arriving in non-tproxy | |
1460 | mode ports. | |
1461 | ||
1462 | SECURITY WARNING: Usage of this option is dangerous | |
1463 | and should not be used trivially. Correct configuration | |
16ae256c | 1464 | of follow_x_forwarded_for with a limited set of trusted |
4d7ab5a2 | 1465 | sources is required to prevent abuse of your proxy. |
96d64448 AJ |
1466 | DOC_END |
1467 | ||
0d901ef4 SH |
1468 | NAME: spoof_client_ip |
1469 | TYPE: acl_access | |
1470 | LOC: Config.accessList.spoof_client_ip | |
1471 | DEFAULT: none | |
1472 | DEFAULT_DOC: Allow spoofing on all TPROXY traffic. | |
1473 | DOC_START | |
1474 | Control client IP address spoofing of TPROXY traffic based on | |
1475 | defined access lists. | |
1476 | ||
1477 | spoof_client_ip allow|deny [!]aclname ... | |
1478 | ||
1479 | If there are no "spoof_client_ip" lines present, the default | |
1480 | is to "allow" spoofing of any suitable request. | |
1481 | ||
1482 | Note that the cache_peer "no-tproxy" option overrides this ACL. | |
1483 | ||
1484 | This clause supports fast acl types. | |
1485 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
1486 | DOC_END | |
1487 | ||
41bd17a4 | 1488 | NAME: http_access |
1489 | TYPE: acl_access | |
1490 | LOC: Config.accessList.http | |
41bd17a4 | 1491 | DEFAULT_IF_NONE: deny all |
638402dd | 1492 | DEFAULT_DOC: Deny, unless rules exist in squid.conf. |
41bd17a4 | 1493 | DOC_START |
1494 | Allowing or Denying access based on defined access lists | |
cccac0a2 | 1495 | |
8a2f40dd | 1496 | To allow or deny a message received on an HTTP, HTTPS, or FTP port: |
41bd17a4 | 1497 | http_access allow|deny [!]aclname ... |
cccac0a2 | 1498 | |
41bd17a4 | 1499 | NOTE on default values: |
cccac0a2 | 1500 | |
41bd17a4 | 1501 | If there are no "access" lines present, the default is to deny |
1502 | the request. | |
cccac0a2 | 1503 | |
41bd17a4 | 1504 | If none of the "access" lines cause a match, the default is the |
1505 | opposite of the last line in the list. If the last line was | |
1506 | deny, the default is allow. Conversely, if the last line | |
1507 | is allow, the default will be deny. For these reasons, it is a | |
51ae86b2 HN |
1508 | good idea to have an "deny all" entry at the end of your access |
1509 | lists to avoid potential confusion. | |
cccac0a2 | 1510 | |
b3567eb5 FC |
1511 | This clause supports both fast and slow acl types. |
1512 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
1513 | ||
41bd17a4 | 1514 | NOCOMMENT_START |
e0855596 AJ |
1515 | |
1516 | # | |
1517 | # Recommended minimum Access Permission configuration: | |
41bd17a4 | 1518 | # |
e0855596 | 1519 | # Deny requests to certain unsafe ports |
41bd17a4 | 1520 | http_access deny !Safe_ports |
e0855596 AJ |
1521 | |
1522 | # Deny CONNECT to other than secure SSL ports | |
41bd17a4 | 1523 | http_access deny CONNECT !SSL_ports |
e0855596 | 1524 | |
baa3ea7e AJ |
1525 | # Only allow cachemgr access from localhost |
1526 | http_access allow localhost manager | |
1527 | http_access deny manager | |
1528 | ||
41bd17a4 | 1529 | # We strongly recommend the following be uncommented to protect innocent |
1530 | # web applications running on the proxy server who think the only | |
1531 | # one who can access services on "localhost" is a local user | |
1532 | #http_access deny to_localhost | |
e0855596 | 1533 | |
41bd17a4 | 1534 | # |
1535 | # INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS | |
e0855596 | 1536 | # |
c8f4eac4 | 1537 | |
ee776778 | 1538 | # Example rule allowing access from your local networks. |
1539 | # Adapt localnet in the ACL section to list your (internal) IP networks | |
1540 | # from where browsing should be allowed | |
1541 | http_access allow localnet | |
afb33856 | 1542 | http_access allow localhost |
7d90757b | 1543 | |
41bd17a4 | 1544 | # And finally deny all other access to this proxy |
1545 | http_access deny all | |
1546 | NOCOMMENT_END | |
1547 | DOC_END | |
7d90757b | 1548 | |
533493da AJ |
1549 | NAME: adapted_http_access http_access2 |
1550 | TYPE: acl_access | |
1551 | LOC: Config.accessList.adapted_http | |
1552 | DEFAULT: none | |
638402dd | 1553 | DEFAULT_DOC: Allow, unless rules exist in squid.conf. |
533493da AJ |
1554 | DOC_START |
1555 | Allowing or Denying access based on defined access lists | |
1556 | ||
1557 | Essentially identical to http_access, but runs after redirectors | |
1558 | and ICAP/eCAP adaptation. Allowing access control based on their | |
1559 | output. | |
1560 | ||
1561 | If not set then only http_access is used. | |
1562 | DOC_END | |
1563 | ||
41bd17a4 | 1564 | NAME: http_reply_access |
1565 | TYPE: acl_access | |
1566 | LOC: Config.accessList.reply | |
1567 | DEFAULT: none | |
638402dd | 1568 | DEFAULT_DOC: Allow, unless rules exist in squid.conf. |
41bd17a4 | 1569 | DOC_START |
1570 | Allow replies to client requests. This is complementary to http_access. | |
cccac0a2 | 1571 | |
41bd17a4 | 1572 | http_reply_access allow|deny [!] aclname ... |
cccac0a2 | 1573 | |
41bd17a4 | 1574 | NOTE: if there are no access lines present, the default is to allow |
638402dd | 1575 | all replies. |
1a224843 | 1576 | |
41bd17a4 | 1577 | If none of the access lines cause a match the opposite of the |
1578 | last line will apply. Thus it is good practice to end the rules | |
1579 | with an "allow all" or "deny all" entry. | |
b3567eb5 FC |
1580 | |
1581 | This clause supports both fast and slow acl types. | |
1582 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
cccac0a2 | 1583 | DOC_END |
1584 | ||
41bd17a4 | 1585 | NAME: icp_access |
1586 | TYPE: acl_access | |
1587 | LOC: Config.accessList.icp | |
638402dd AJ |
1588 | DEFAULT: none |
1589 | DEFAULT_DOC: Deny, unless rules exist in squid.conf. | |
5473c134 | 1590 | DOC_START |
41bd17a4 | 1591 | Allowing or Denying access to the ICP port based on defined |
1592 | access lists | |
5473c134 | 1593 | |
41bd17a4 | 1594 | icp_access allow|deny [!]aclname ... |
5473c134 | 1595 | |
638402dd AJ |
1596 | NOTE: The default if no icp_access lines are present is to |
1597 | deny all traffic. This default may cause problems with peers | |
1598 | using ICP. | |
41bd17a4 | 1599 | |
b3567eb5 FC |
1600 | This clause only supports fast acl types. |
1601 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
e0855596 AJ |
1602 | |
1603 | # Allow ICP queries from local networks only | |
df2eec10 AJ |
1604 | #icp_access allow localnet |
1605 | #icp_access deny all | |
5473c134 | 1606 | DOC_END |
1607 | ||
41bd17a4 | 1608 | NAME: htcp_access |
1609 | IFDEF: USE_HTCP | |
1610 | TYPE: acl_access | |
1611 | LOC: Config.accessList.htcp | |
638402dd AJ |
1612 | DEFAULT: none |
1613 | DEFAULT_DOC: Deny, unless rules exist in squid.conf. | |
5473c134 | 1614 | DOC_START |
41bd17a4 | 1615 | Allowing or Denying access to the HTCP port based on defined |
1616 | access lists | |
5473c134 | 1617 | |
41bd17a4 | 1618 | htcp_access allow|deny [!]aclname ... |
5473c134 | 1619 | |
638402dd AJ |
1620 | See also htcp_clr_access for details on access control for |
1621 | cache purge (CLR) HTCP messages. | |
5473c134 | 1622 | |
0b48417e | 1623 | NOTE: The default if no htcp_access lines are present is to |
1624 | deny all traffic. This default may cause problems with peers | |
18191440 | 1625 | using the htcp option. |
0b48417e | 1626 | |
b3567eb5 FC |
1627 | This clause only supports fast acl types. |
1628 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
e0855596 AJ |
1629 | |
1630 | # Allow HTCP queries from local networks only | |
df2eec10 AJ |
1631 | #htcp_access allow localnet |
1632 | #htcp_access deny all | |
41bd17a4 | 1633 | DOC_END |
5473c134 | 1634 | |
41bd17a4 | 1635 | NAME: htcp_clr_access |
1636 | IFDEF: USE_HTCP | |
1637 | TYPE: acl_access | |
1638 | LOC: Config.accessList.htcp_clr | |
638402dd AJ |
1639 | DEFAULT: none |
1640 | DEFAULT_DOC: Deny, unless rules exist in squid.conf. | |
41bd17a4 | 1641 | DOC_START |
1642 | Allowing or Denying access to purge content using HTCP based | |
638402dd AJ |
1643 | on defined access lists. |
1644 | See htcp_access for details on general HTCP access control. | |
5473c134 | 1645 | |
41bd17a4 | 1646 | htcp_clr_access allow|deny [!]aclname ... |
5473c134 | 1647 | |
b3567eb5 FC |
1648 | This clause only supports fast acl types. |
1649 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
e0855596 AJ |
1650 | |
1651 | # Allow HTCP CLR requests from trusted peers | |
638402dd | 1652 | acl htcp_clr_peer src 192.0.2.2 2001:DB8::2 |
41bd17a4 | 1653 | htcp_clr_access allow htcp_clr_peer |
638402dd | 1654 | htcp_clr_access deny all |
5473c134 | 1655 | DOC_END |
1656 | ||
41bd17a4 | 1657 | NAME: miss_access |
1658 | TYPE: acl_access | |
1659 | LOC: Config.accessList.miss | |
b8a25eaa | 1660 | DEFAULT: none |
638402dd | 1661 | DEFAULT_DOC: Allow, unless rules exist in squid.conf. |
5473c134 | 1662 | DOC_START |
18d1eddf | 1663 | Determines whether network access is permitted when satisfying a request. |
0b4fb91a AJ |
1664 | |
1665 | For example; | |
1666 | to force your neighbors to use you as a sibling instead of | |
1667 | a parent. | |
5473c134 | 1668 | |
638402dd | 1669 | acl localclients src 192.0.2.0/24 2001:DB8::a:0/64 |
41bd17a4 | 1670 | miss_access deny !localclients |
638402dd | 1671 | miss_access allow all |
5473c134 | 1672 | |
0b4fb91a AJ |
1673 | This means only your local clients are allowed to fetch relayed/MISS |
1674 | replies from the network and all other clients can only fetch cached | |
1675 | objects (HITs). | |
1676 | ||
0b4fb91a AJ |
1677 | The default for this setting allows all clients who passed the |
1678 | http_access rules to relay via this proxy. | |
b3567eb5 FC |
1679 | |
1680 | This clause only supports fast acl types. | |
1681 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
41bd17a4 | 1682 | DOC_END |
1683 | ||
1684 | NAME: ident_lookup_access | |
1685 | TYPE: acl_access | |
1686 | IFDEF: USE_IDENT | |
638402dd AJ |
1687 | DEFAULT: none |
1688 | DEFAULT_DOC: Unless rules exist in squid.conf, IDENT is not fetched. | |
4daaf3cb | 1689 | LOC: Ident::TheConfig.identLookup |
5473c134 | 1690 | DOC_START |
41bd17a4 | 1691 | A list of ACL elements which, if matched, cause an ident |
1692 | (RFC 931) lookup to be performed for this request. For | |
1693 | example, you might choose to always perform ident lookups | |
1694 | for your main multi-user Unix boxes, but not for your Macs | |
1695 | and PCs. By default, ident lookups are not performed for | |
1696 | any requests. | |
5473c134 | 1697 | |
41bd17a4 | 1698 | To enable ident lookups for specific client addresses, you |
1699 | can follow this example: | |
5473c134 | 1700 | |
4daaf3cb | 1701 | acl ident_aware_hosts src 198.168.1.0/24 |
41bd17a4 | 1702 | ident_lookup_access allow ident_aware_hosts |
1703 | ident_lookup_access deny all | |
5473c134 | 1704 | |
4daaf3cb | 1705 | Only src type ACL checks are fully supported. A srcdomain |
41bd17a4 | 1706 | ACL might work at times, but it will not always provide |
1707 | the correct result. | |
b3567eb5 FC |
1708 | |
1709 | This clause only supports fast acl types. | |
1710 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
41bd17a4 | 1711 | DOC_END |
5473c134 | 1712 | |
5b0f5383 | 1713 | NAME: reply_body_max_size |
1714 | COMMENT: size [acl acl...] | |
1715 | TYPE: acl_b_size_t | |
1716 | DEFAULT: none | |
638402dd | 1717 | DEFAULT_DOC: No limit is applied. |
5b0f5383 | 1718 | LOC: Config.ReplyBodySize |
1719 | DOC_START | |
1720 | This option specifies the maximum size of a reply body. It can be | |
1721 | used to prevent users from downloading very large files, such as | |
1722 | MP3's and movies. When the reply headers are received, the | |
1723 | reply_body_max_size lines are processed, and the first line where | |
1724 | all (if any) listed ACLs are true is used as the maximum body size | |
1725 | for this reply. | |
1726 | ||
1727 | This size is checked twice. First when we get the reply headers, | |
1728 | we check the content-length value. If the content length value exists | |
1729 | and is larger than the allowed size, the request is denied and the | |
1730 | user receives an error message that says "the request or reply | |
1731 | is too large." If there is no content-length, and the reply | |
1732 | size exceeds this limit, the client's connection is just closed | |
1733 | and they will receive a partial reply. | |
1734 | ||
1735 | WARNING: downstream caches probably can not detect a partial reply | |
1736 | if there is no content-length header, so they will cache | |
1737 | partial responses and give them out as hits. You should NOT | |
1738 | use this option if you have downstream caches. | |
1739 | ||
1740 | WARNING: A maximum size smaller than the size of squid's error messages | |
1741 | will cause an infinite loop and crash squid. Ensure that the smallest | |
1742 | non-zero value you use is greater that the maximum header size plus | |
1743 | the size of your largest error page. | |
1744 | ||
1745 | If you set this parameter none (the default), there will be | |
1746 | no limit imposed. | |
3bc32f2f AJ |
1747 | |
1748 | Configuration Format is: | |
1749 | reply_body_max_size SIZE UNITS [acl ...] | |
1750 | ie. | |
1751 | reply_body_max_size 10 MB | |
1752 | ||
5b0f5383 | 1753 | DOC_END |
1754 | ||
3248e962 CT |
1755 | NAME: on_unsupported_protocol |
1756 | TYPE: on_unsupported_protocol | |
1757 | LOC: Config.accessList.on_unsupported_protocol | |
1758 | DEFAULT: none | |
1759 | DEFAULT_DOC: Respond with an error message to unidentifiable traffic | |
1760 | DOC_START | |
1761 | Determines Squid behavior when encountering strange requests at the | |
56d089f3 CT |
1762 | beginning of an accepted TCP connection or the beginning of a bumped |
1763 | CONNECT tunnel. Controlling Squid reaction to unexpected traffic is | |
1764 | especially useful in interception environments where Squid is likely | |
1765 | to see connections for unsupported protocols that Squid should either | |
1766 | terminate or tunnel at TCP level. | |
3248e962 CT |
1767 | |
1768 | on_unsupported_protocol <action> [!]acl ... | |
1769 | ||
56d089f3 | 1770 | The first matching action wins. Only fast ACLs are supported. |
3248e962 CT |
1771 | |
1772 | Supported actions are: | |
1773 | ||
1774 | tunnel: Establish a TCP connection with the intended server and | |
1775 | blindly shovel TCP packets between the client and server. | |
1776 | ||
1777 | respond: Respond with an error message, using the transfer protocol | |
1778 | for the Squid port that received the request (e.g., HTTP | |
1779 | for connections intercepted at the http_port). This is the | |
1780 | default. | |
56d089f3 CT |
1781 | |
1782 | Squid expects the following traffic patterns: | |
1783 | ||
1784 | http_port: a plain HTTP request | |
1785 | https_port: SSL/TLS handshake followed by an [encrypted] HTTP request | |
1786 | ftp_port: a plain FTP command (no on_unsupported_protocol support yet!) | |
1787 | CONNECT tunnel on http_port: same as https_port | |
1788 | CONNECT tunnel on https_port: same as https_port | |
1789 | ||
9155253a | 1790 | Currently, this directive has effect on intercepted connections and |
56d089f3 CT |
1791 | bumped tunnels only. Other cases are not supported because Squid |
1792 | cannot know the intended destination of other traffic. | |
3248e962 CT |
1793 | |
1794 | For example: | |
1795 | # define what Squid errors indicate receiving non-HTTP traffic: | |
1796 | acl foreignProtocol squid_error ERR_PROTOCOL_UNKNOWN ERR_TOO_BIG | |
1797 | # define what Squid errors indicate receiving nothing: | |
1798 | acl serverTalksFirstProtocol squid_error ERR_REQUEST_START_TIMEOUT | |
1799 | # tunnel everything that does not look like HTTP: | |
1800 | on_unsupported_protocol tunnel foreignProtocol | |
1801 | # tunnel if we think the client waits for the server to talk first: | |
1802 | on_unsupported_protocol tunnel serverTalksFirstProtocol | |
1803 | # in all other error cases, just send an HTTP "error page" response: | |
1804 | on_unsupported_protocol respond all | |
1805 | ||
1806 | See also: squid_error ACL | |
1807 | DOC_END | |
1808 | ||
5b0f5383 | 1809 | COMMENT_START |
1810 | NETWORK OPTIONS | |
1811 | ----------------------------------------------------------------------------- | |
1812 | COMMENT_END | |
1813 | ||
1814 | NAME: http_port ascii_port | |
65d448bc | 1815 | TYPE: PortCfg |
5b0f5383 | 1816 | DEFAULT: none |
fa720bfb | 1817 | LOC: HttpPortList |
5b0f5383 | 1818 | DOC_START |
c7b1dd5d AJ |
1819 | Usage: port [mode] [options] |
1820 | hostname:port [mode] [options] | |
1821 | 1.2.3.4:port [mode] [options] | |
5b0f5383 | 1822 | |
1823 | The socket addresses where Squid will listen for HTTP client | |
1824 | requests. You may specify multiple socket addresses. | |
1825 | There are three forms: port alone, hostname with port, and | |
1826 | IP address with port. If you specify a hostname or IP | |
1827 | address, Squid binds the socket to that specific | |
c7b1dd5d | 1828 | address. Most likely, you do not need to bind to a specific |
5b0f5383 | 1829 | address, so you can use the port number alone. |
1830 | ||
1831 | If you are running Squid in accelerator mode, you | |
1832 | probably want to listen on port 80 also, or instead. | |
1833 | ||
1834 | The -a command line option may be used to specify additional | |
1835 | port(s) where Squid listens for proxy request. Such ports will | |
1836 | be plain proxy ports with no options. | |
1837 | ||
1838 | You may specify multiple socket addresses on multiple lines. | |
1839 | ||
c7b1dd5d | 1840 | Modes: |
5b0f5383 | 1841 | |
16ae256c AJ |
1842 | intercept Support for IP-Layer NAT interception delivering |
1843 | traffic to this Squid port. | |
1844 | NP: disables authentication on the port. | |
5b0f5383 | 1845 | |
16ae256c AJ |
1846 | tproxy Support Linux TPROXY (or BSD divert-to) with spoofing |
1847 | of outgoing connections using the client IP address. | |
1848 | NP: disables authentication on the port. | |
5b0f5383 | 1849 | |
7f45065d | 1850 | accel Accelerator / reverse proxy mode |
5b0f5383 | 1851 | |
caf3666d | 1852 | ssl-bump For each CONNECT request allowed by ssl_bump ACLs, |
c7b1dd5d | 1853 | establish secure connection with the client and with |
caf3666d | 1854 | the server, decrypt HTTPS messages as they pass through |
c7b1dd5d AJ |
1855 | Squid, and treat them as unencrypted HTTP messages, |
1856 | becoming the man-in-the-middle. | |
1857 | ||
7a957a93 | 1858 | The ssl_bump option is required to fully enable |
caf3666d | 1859 | bumping of CONNECT requests. |
c7b1dd5d AJ |
1860 | |
1861 | Omitting the mode flag causes default forward proxy mode to be used. | |
1862 | ||
1863 | ||
1864 | Accelerator Mode Options: | |
1865 | ||
5b0f5383 | 1866 | defaultsite=domainname |
1867 | What to use for the Host: header if it is not present | |
1868 | in a request. Determines what site (not origin server) | |
1869 | accelerators should consider the default. | |
5b0f5383 | 1870 | |
cf673853 | 1871 | no-vhost Disable using HTTP/1.1 Host header for virtual domain support. |
5b0f5383 | 1872 | |
a9f60805 AJ |
1873 | protocol= Protocol to reconstruct accelerated and intercepted |
1874 | requests with. Defaults to HTTP/1.1 for http_port and | |
1875 | HTTPS/1.1 for https_port. | |
1876 | When an unsupported value is configured Squid will | |
1877 | produce a FATAL error. | |
1878 | Values: HTTP or HTTP/1.1, HTTPS or HTTPS/1.1 | |
5b0f5383 | 1879 | |
cf673853 AJ |
1880 | vport Virtual host port support. Using the http_port number |
1881 | instead of the port passed on Host: headers. | |
5b0f5383 | 1882 | |
cf673853 AJ |
1883 | vport=NN Virtual host port support. Using the specified port |
1884 | number instead of the port passed on Host: headers. | |
5b0f5383 | 1885 | |
7f45065d HN |
1886 | act-as-origin |
1887 | Act as if this Squid is the origin server. | |
1888 | This currently means generate new Date: and Expires: | |
1889 | headers on HIT instead of adding Age:. | |
5b0f5383 | 1890 | |
432bc83c HN |
1891 | ignore-cc Ignore request Cache-Control headers. |
1892 | ||
7f45065d | 1893 | WARNING: This option violates HTTP specifications if |
432bc83c HN |
1894 | used in non-accelerator setups. |
1895 | ||
7f45065d HN |
1896 | allow-direct Allow direct forwarding in accelerator mode. Normally |
1897 | accelerated requests are denied direct forwarding as if | |
1898 | never_direct was used. | |
1899 | ||
1900 | WARNING: this option opens accelerator mode to security | |
1901 | vulnerabilities usually only affecting in interception | |
1902 | mode. Make sure to protect forwarding with suitable | |
1903 | http_access rules when using this. | |
1904 | ||
c7b1dd5d AJ |
1905 | |
1906 | SSL Bump Mode Options: | |
859741ed AJ |
1907 | In addition to these options ssl-bump requires TLS/SSL options. |
1908 | ||
1909 | generate-host-certificates[=<on|off>] | |
1910 | Dynamically create SSL server certificates for the | |
1911 | destination hosts of bumped CONNECT requests.When | |
1912 | enabled, the cert and key options are used to sign | |
1913 | generated certificates. Otherwise generated | |
1914 | certificate will be selfsigned. | |
1915 | If there is a CA certificate lifetime of the generated | |
1916 | certificate equals lifetime of the CA certificate. If | |
1917 | generated certificate is selfsigned lifetime is three | |
1918 | years. | |
1919 | This option is enabled by default when ssl-bump is used. | |
1920 | See the ssl-bump option above for more information. | |
1921 | ||
1922 | dynamic_cert_mem_cache_size=SIZE | |
1923 | Approximate total RAM size spent on cached generated | |
1924 | certificates. If set to zero, caching is disabled. The | |
23bb0ebf | 1925 | default value is 4MB. |
859741ed AJ |
1926 | |
1927 | TLS / SSL Options: | |
c7b1dd5d AJ |
1928 | |
1929 | cert= Path to SSL certificate (PEM format). | |
1930 | ||
1931 | key= Path to SSL private key file (PEM format) | |
1932 | if not specified, the certificate file is | |
1933 | assumed to be a combined certificate and | |
1934 | key file. | |
1935 | ||
c7b1dd5d | 1936 | cipher= Colon separated list of supported ciphers. |
bebdc6fb AJ |
1937 | NOTE: some ciphers such as EDH ciphers depend on |
1938 | additional settings. If those settings are | |
1939 | omitted the ciphers may be silently ignored | |
1940 | by the OpenSSL library. | |
c7b1dd5d | 1941 | |
943c5f16 | 1942 | options= Various SSL implementation options. The most important |
c7b1dd5d | 1943 | being: |
7905e7be | 1944 | |
3d96b0e8 | 1945 | NO_SSLv3 Disallow the use of SSLv3 |
1f1f29e8 | 1946 | |
3d96b0e8 | 1947 | NO_TLSv1 Disallow the use of TLSv1.0 |
1f1f29e8 | 1948 | |
3d96b0e8 | 1949 | NO_TLSv1_1 Disallow the use of TLSv1.1 |
1f1f29e8 | 1950 | |
3d96b0e8 | 1951 | NO_TLSv1_2 Disallow the use of TLSv1.2 |
1f1f29e8 | 1952 | |
7905e7be AJ |
1953 | SINGLE_DH_USE |
1954 | Always create a new key when using | |
c7b1dd5d | 1955 | temporary/ephemeral DH key exchanges |
1f1f29e8 | 1956 | |
54fbe371 PM |
1957 | SINGLE_ECDH_USE |
1958 | Enable ephemeral ECDH key exchange. | |
1959 | The adopted curve should be specified | |
1960 | using the tls-dh option. | |
1961 | ||
36092741 | 1962 | NO_TICKET |
1f1f29e8 AJ |
1963 | Disable use of RFC5077 session tickets. |
1964 | Some servers may have problems | |
1965 | understanding the TLS extension due | |
1966 | to ambiguous specification in RFC4507. | |
1967 | ||
943c5f16 HN |
1968 | ALL Enable various bug workarounds |
1969 | suggested as "harmless" by OpenSSL | |
1970 | Be warned that this reduces SSL/TLS | |
1971 | strength to some attacks. | |
7905e7be AJ |
1972 | |
1973 | See the OpenSSL SSL_CTX_set_options documentation for a | |
1974 | more complete list. | |
c7b1dd5d AJ |
1975 | |
1976 | clientca= File containing the list of CAs to use when | |
1977 | requesting a client certificate. | |
1978 | ||
86a84cc0 AJ |
1979 | tls-cafile= PEM file containing CA certificates to use when verifying |
1980 | client certificates. If not configured clientca will be | |
1981 | used. May be repeated to load multiple files. | |
c7b1dd5d AJ |
1982 | |
1983 | capath= Directory containing additional CA certificates | |
1984 | and CRL lists to use when verifying client certificates. | |
86a84cc0 | 1985 | Requires OpenSSL or LibreSSL. |
c7b1dd5d AJ |
1986 | |
1987 | crlfile= File of additional CRL lists to use when verifying | |
1988 | the client certificate, in addition to CRLs stored in | |
1989 | the capath. Implies VERIFY_CRL flag below. | |
1990 | ||
54fbe371 PM |
1991 | tls-dh=[curve:]file |
1992 | File containing DH parameters for temporary/ephemeral DH key | |
1993 | exchanges, optionally prefixed by a curve for ephemeral ECDH | |
1994 | key exchanges. | |
1995 | See OpenSSL documentation for details on how to create the | |
1996 | DH parameter file. Supported curves for ECDH can be listed | |
1997 | using the "openssl ecparam -list_curves" command. | |
1998 | WARNING: EDH and EECDH ciphers will be silently disabled if | |
1999 | this option is not set. | |
c7b1dd5d AJ |
2000 | |
2001 | sslflags= Various flags modifying the use of SSL: | |
2002 | DELAYED_AUTH | |
2003 | Don't request client certificates | |
2004 | immediately, but wait until acl processing | |
2005 | requires a certificate (not yet implemented). | |
c7b1dd5d AJ |
2006 | NO_SESSION_REUSE |
2007 | Don't allow for session reuse. Each connection | |
2008 | will result in a new SSL session. | |
2009 | VERIFY_CRL | |
2010 | Verify CRL lists when accepting client | |
2011 | certificates. | |
2012 | VERIFY_CRL_ALL | |
2013 | Verify CRL lists for all certificates in the | |
2014 | client certificate chain. | |
2015 | ||
8b253b83 AJ |
2016 | tls-no-default-ca |
2017 | Do not use the system default Trusted CA. | |
2018 | ||
b05d749d AJ |
2019 | tls-no-npn Do not use the TLS NPN extension to advertise HTTP/1.1. |
2020 | ||
c7b1dd5d AJ |
2021 | sslcontext= SSL session ID context identifier. |
2022 | ||
c7b1dd5d AJ |
2023 | Other Options: |
2024 | ||
6b185b50 AJ |
2025 | connection-auth[=on|off] |
2026 | use connection-auth=off to tell Squid to prevent | |
2027 | forwarding Microsoft connection oriented authentication | |
d67acb4e AJ |
2028 | (NTLM, Negotiate and Kerberos) |
2029 | ||
5b0f5383 | 2030 | disable-pmtu-discovery= |
2031 | Control Path-MTU discovery usage: | |
2032 | off lets OS decide on what to do (default). | |
2033 | transparent disable PMTU discovery when transparent | |
2034 | support is enabled. | |
2035 | always disable always PMTU discovery. | |
2036 | ||
2037 | In many setups of transparently intercepting proxies | |
2038 | Path-MTU discovery can not work on traffic towards the | |
2039 | clients. This is the case when the intercepting device | |
2040 | does not fully track connections and fails to forward | |
2041 | ICMP must fragment messages to the cache server. If you | |
2042 | have such setup and experience that certain clients | |
2043 | sporadically hang or never complete requests set | |
2044 | disable-pmtu-discovery option to 'transparent'. | |
2045 | ||
81b6e9a7 | 2046 | name= Specifies a internal name for the port. Defaults to |
2047 | the port specification (port or addr:port) | |
2048 | ||
68924b6d | 2049 | tcpkeepalive[=idle,interval,timeout] |
fb6c6dbe AJ |
2050 | Enable TCP keepalive probes of idle connections. |
2051 | In seconds; idle is the initial time before TCP starts | |
2052 | probing the connection, interval how often to probe, and | |
b2130d58 | 2053 | timeout the time before giving up. |
2054 | ||
d3d92daa | 2055 | require-proxy-header |
151ba0d4 | 2056 | Require PROXY protocol version 1 or 2 connections. |
d3d92daa | 2057 | The proxy_protocol_access is required to whitelist |
151ba0d4 AJ |
2058 | downstream proxies which can be trusted. |
2059 | ||
5b0f5383 | 2060 | If you run Squid on a dual-homed machine with an internal |
2061 | and an external interface we recommend you to specify the | |
2062 | internal address:port in http_port. This way Squid will only be | |
2063 | visible on the internal address. | |
2064 | ||
2065 | NOCOMMENT_START | |
e0855596 | 2066 | |
5b0f5383 | 2067 | # Squid normally listens to port 3128 |
2068 | http_port @DEFAULT_HTTP_PORT@ | |
2069 | NOCOMMENT_END | |
2070 | DOC_END | |
2071 | ||
2072 | NAME: https_port | |
339e4d7a | 2073 | IFDEF: USE_GNUTLS||USE_OPENSSL |
65d448bc | 2074 | TYPE: PortCfg |
5b0f5383 | 2075 | DEFAULT: none |
339e4d7a | 2076 | LOC: HttpPortList |
5b0f5383 | 2077 | DOC_START |
9155253a | 2078 | Usage: [ip:]port [mode] cert=certificate.pem [options] |
5b0f5383 | 2079 | |
859741ed AJ |
2080 | The socket address where Squid will listen for client requests made |
2081 | over TLS or SSL connections. Commonly referred to as HTTPS. | |
5b0f5383 | 2082 | |
859741ed | 2083 | This is most useful for situations where you are running squid in |
9155253a | 2084 | accelerator mode and you want to do the TLS work at the accelerator level. |
5b0f5383 | 2085 | |
2086 | You may specify multiple socket addresses on multiple lines, | |
9155253a | 2087 | each with their own certificate and/or options. |
5b0f5383 | 2088 | |
9155253a | 2089 | The TLS cert= option is mandatory on HTTPS ports. |
379e8c1c | 2090 | |
9155253a | 2091 | See http_port for a list of modes and options. |
5b0f5383 | 2092 | DOC_END |
2093 | ||
434a79b0 DK |
2094 | NAME: ftp_port |
2095 | TYPE: PortCfg | |
2096 | DEFAULT: none | |
8ea0d847 | 2097 | LOC: FtpPortList |
434a79b0 | 2098 | DOC_START |
8a2f40dd AR |
2099 | Enables Native FTP proxy by specifying the socket address where Squid |
2100 | listens for FTP client requests. See http_port directive for various | |
2101 | ways to specify the listening address and mode. | |
2102 | ||
2103 | Usage: ftp_port address [mode] [options] | |
2104 | ||
2105 | WARNING: This is a new, experimental, complex feature that has seen | |
2106 | limited production exposure. Some Squid modules (e.g., caching) do not | |
2107 | currently work with native FTP proxying, and many features have not | |
2108 | even been tested for compatibility. Test well before deploying! | |
2109 | ||
2110 | Native FTP proxying differs substantially from proxying HTTP requests | |
2111 | with ftp:// URIs because Squid works as an FTP server and receives | |
2112 | actual FTP commands (rather than HTTP requests with FTP URLs). | |
2113 | ||
2114 | Native FTP commands accepted at ftp_port are internally converted or | |
2115 | wrapped into HTTP-like messages. The same happens to Native FTP | |
2116 | responses received from FTP origin servers. Those HTTP-like messages | |
2117 | are shoveled through regular access control and adaptation layers | |
2118 | between the FTP client and the FTP origin server. This allows Squid to | |
2119 | examine, adapt, block, and log FTP exchanges. Squid reuses most HTTP | |
2120 | mechanisms when shoveling wrapped FTP messages. For example, | |
2121 | http_access and adaptation_access directives are used. | |
2122 | ||
2123 | Modes: | |
2124 | ||
3cc0f4e7 | 2125 | intercept Same as http_port intercept. The FTP origin address is |
8a2f40dd AR |
2126 | determined based on the intended destination of the |
2127 | intercepted connection. | |
2128 | ||
3cc0f4e7 AR |
2129 | tproxy Support Linux TPROXY for spoofing outgoing |
2130 | connections using the client IP address. | |
2131 | NP: disables authentication and maybe IPv6 on the port. | |
2132 | ||
8a2f40dd AR |
2133 | By default (i.e., without an explicit mode option), Squid extracts the |
2134 | FTP origin address from the login@origin parameter of the FTP USER | |
2135 | command. Many popular FTP clients support such native FTP proxying. | |
2136 | ||
2137 | Options: | |
2138 | ||
3cc0f4e7 AR |
2139 | name=token Specifies an internal name for the port. Defaults to |
2140 | the port address. Usable with myportname ACL. | |
2141 | ||
aea65fec | 2142 | ftp-track-dirs |
8a2f40dd AR |
2143 | Enables tracking of FTP directories by injecting extra |
2144 | PWD commands and adjusting Request-URI (in wrapping | |
2145 | HTTP requests) to reflect the current FTP server | |
aea65fec | 2146 | directory. Tracking is disabled by default. |
8a2f40dd | 2147 | |
3cc0f4e7 AR |
2148 | protocol=FTP Protocol to reconstruct accelerated and intercepted |
2149 | requests with. Defaults to FTP. No other accepted | |
2150 | values have been tested with. An unsupported value | |
2151 | results in a FATAL error. Accepted values are FTP, | |
2152 | HTTP (or HTTP/1.1), and HTTPS (or HTTPS/1.1). | |
2153 | ||
8a2f40dd AR |
2154 | Other http_port modes and options that are not specific to HTTP and |
2155 | HTTPS may also work. | |
2156 | DOC_END | |
434a79b0 | 2157 | |
41bd17a4 | 2158 | NAME: tcp_outgoing_tos tcp_outgoing_ds tcp_outgoing_dscp |
2159 | TYPE: acl_tos | |
5473c134 | 2160 | DEFAULT: none |
425de4c8 | 2161 | LOC: Ip::Qos::TheConfig.tosToServer |
5473c134 | 2162 | DOC_START |
425de4c8 AJ |
2163 | Allows you to select a TOS/Diffserv value for packets outgoing |
2164 | on the server side, based on an ACL. | |
5473c134 | 2165 | |
41bd17a4 | 2166 | tcp_outgoing_tos ds-field [!]aclname ... |
cccac0a2 | 2167 | |
41bd17a4 | 2168 | Example where normal_service_net uses the TOS value 0x00 |
7def7206 | 2169 | and good_service_net uses 0x20 |
cccac0a2 | 2170 | |
864a62b5 AJ |
2171 | acl normal_service_net src 10.0.0.0/24 |
2172 | acl good_service_net src 10.0.1.0/24 | |
2c73de90 | 2173 | tcp_outgoing_tos 0x00 normal_service_net |
41bd17a4 | 2174 | tcp_outgoing_tos 0x20 good_service_net |
fa38076e | 2175 | |
41bd17a4 | 2176 | TOS/DSCP values really only have local significance - so you should |
575cb927 AJ |
2177 | know what you're specifying. For more information, see RFC2474, |
2178 | RFC2475, and RFC3260. | |
cccac0a2 | 2179 | |
41bd17a4 | 2180 | The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or |
5f53baab SM |
2181 | "default" to use whatever default your host has. |
2182 | Note that only multiples of 4 are usable as the two rightmost bits have | |
2183 | been redefined for use by ECN (RFC 3168 section 23.1). | |
2184 | The squid parser will enforce this by masking away the ECN bits. | |
cccac0a2 | 2185 | |
41bd17a4 | 2186 | Processing proceeds in the order specified, and stops at first fully |
2187 | matching line. | |
c6f168c1 CT |
2188 | |
2189 | Only fast ACLs are supported. | |
cccac0a2 | 2190 | DOC_END |
2191 | ||
41bd17a4 | 2192 | NAME: clientside_tos |
2193 | TYPE: acl_tos | |
cccac0a2 | 2194 | DEFAULT: none |
425de4c8 AJ |
2195 | LOC: Ip::Qos::TheConfig.tosToClient |
2196 | DOC_START | |
5f53baab | 2197 | Allows you to select a TOS/DSCP value for packets being transmitted |
425de4c8 AJ |
2198 | on the client-side, based on an ACL. |
2199 | ||
2200 | clientside_tos ds-field [!]aclname ... | |
2201 | ||
2202 | Example where normal_service_net uses the TOS value 0x00 | |
2203 | and good_service_net uses 0x20 | |
2204 | ||
2205 | acl normal_service_net src 10.0.0.0/24 | |
2206 | acl good_service_net src 10.0.1.0/24 | |
2207 | clientside_tos 0x00 normal_service_net | |
2208 | clientside_tos 0x20 good_service_net | |
2209 | ||
2210 | Note: This feature is incompatible with qos_flows. Any TOS values set here | |
2211 | will be overwritten by TOS values in qos_flows. | |
5f53baab SM |
2212 | |
2213 | The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or | |
2214 | "default" to use whatever default your host has. | |
2215 | Note that only multiples of 4 are usable as the two rightmost bits have | |
2216 | been redefined for use by ECN (RFC 3168 section 23.1). | |
2217 | The squid parser will enforce this by masking away the ECN bits. | |
2218 | ||
425de4c8 AJ |
2219 | DOC_END |
2220 | ||
2221 | NAME: tcp_outgoing_mark | |
2222 | TYPE: acl_nfmark | |
11e8cfe3 | 2223 | IFDEF: SO_MARK&&USE_LIBCAP |
425de4c8 AJ |
2224 | DEFAULT: none |
2225 | LOC: Ip::Qos::TheConfig.nfmarkToServer | |
2226 | DOC_START | |
2227 | Allows you to apply a Netfilter mark value to outgoing packets | |
2228 | on the server side, based on an ACL. | |
2229 | ||
2230 | tcp_outgoing_mark mark-value [!]aclname ... | |
2231 | ||
2232 | Example where normal_service_net uses the mark value 0x00 | |
2233 | and good_service_net uses 0x20 | |
2234 | ||
2235 | acl normal_service_net src 10.0.0.0/24 | |
2236 | acl good_service_net src 10.0.1.0/24 | |
2237 | tcp_outgoing_mark 0x00 normal_service_net | |
2238 | tcp_outgoing_mark 0x20 good_service_net | |
c6f168c1 CT |
2239 | |
2240 | Only fast ACLs are supported. | |
425de4c8 AJ |
2241 | DOC_END |
2242 | ||
2243 | NAME: clientside_mark | |
2244 | TYPE: acl_nfmark | |
11e8cfe3 | 2245 | IFDEF: SO_MARK&&USE_LIBCAP |
425de4c8 AJ |
2246 | DEFAULT: none |
2247 | LOC: Ip::Qos::TheConfig.nfmarkToClient | |
cccac0a2 | 2248 | DOC_START |
425de4c8 AJ |
2249 | Allows you to apply a Netfilter mark value to packets being transmitted |
2250 | on the client-side, based on an ACL. | |
2251 | ||
2252 | clientside_mark mark-value [!]aclname ... | |
2253 | ||
2254 | Example where normal_service_net uses the mark value 0x00 | |
2255 | and good_service_net uses 0x20 | |
2256 | ||
2257 | acl normal_service_net src 10.0.0.0/24 | |
2258 | acl good_service_net src 10.0.1.0/24 | |
2259 | clientside_mark 0x00 normal_service_net | |
2260 | clientside_mark 0x20 good_service_net | |
2261 | ||
2262 | Note: This feature is incompatible with qos_flows. Any mark values set here | |
2263 | will be overwritten by mark values in qos_flows. | |
41bd17a4 | 2264 | DOC_END |
cccac0a2 | 2265 | |
575cb927 AJ |
2266 | NAME: qos_flows |
2267 | TYPE: QosConfig | |
425de4c8 | 2268 | IFDEF: USE_QOS_TOS |
575cb927 | 2269 | DEFAULT: none |
b7ac5457 | 2270 | LOC: Ip::Qos::TheConfig |
7172612f | 2271 | DOC_START |
575cb927 | 2272 | Allows you to select a TOS/DSCP value to mark outgoing |
196a7776 AB |
2273 | connections to the client, based on where the reply was sourced. |
2274 | For platforms using netfilter, allows you to set a netfilter mark | |
425de4c8 | 2275 | value instead of, or in addition to, a TOS value. |
7172612f | 2276 | |
196a7776 AB |
2277 | By default this functionality is disabled. To enable it with the default |
2278 | settings simply use "qos_flows mark" or "qos_flows tos". Default | |
2279 | settings will result in the netfilter mark or TOS value being copied | |
2280 | from the upstream connection to the client. Note that it is the connection | |
2281 | CONNMARK value not the packet MARK value that is copied. | |
2282 | ||
2283 | It is not currently possible to copy the mark or TOS value from the | |
2284 | client to the upstream connection request. | |
2285 | ||
575cb927 AJ |
2286 | TOS values really only have local significance - so you should |
2287 | know what you're specifying. For more information, see RFC2474, | |
2288 | RFC2475, and RFC3260. | |
7172612f | 2289 | |
5f53baab SM |
2290 | The TOS/DSCP byte must be exactly that - a octet value 0 - 255. |
2291 | Note that only multiples of 4 are usable as the two rightmost bits have | |
2292 | been redefined for use by ECN (RFC 3168 section 23.1). | |
2293 | The squid parser will enforce this by masking away the ECN bits. | |
425de4c8 AJ |
2294 | |
2295 | Mark values can be any unsigned 32-bit integer value. | |
7172612f | 2296 | |
425de4c8 AJ |
2297 | This setting is configured by setting the following values: |
2298 | ||
2299 | tos|mark Whether to set TOS or netfilter mark values | |
575cb927 AJ |
2300 | |
2301 | local-hit=0xFF Value to mark local cache hits. | |
2302 | ||
2303 | sibling-hit=0xFF Value to mark hits from sibling peers. | |
2304 | ||
2305 | parent-hit=0xFF Value to mark hits from parent peers. | |
2306 | ||
a29d2a95 AB |
2307 | miss=0xFF[/mask] Value to mark cache misses. Takes precedence |
2308 | over the preserve-miss feature (see below), unless | |
2309 | mask is specified, in which case only the bits | |
2310 | specified in the mask are written. | |
575cb927 | 2311 | |
425de4c8 AJ |
2312 | The TOS variant of the following features are only possible on Linux |
2313 | and require your kernel to be patched with the TOS preserving ZPH | |
2314 | patch, available from http://zph.bratcheda.org | |
2315 | No patch is needed to preserve the netfilter mark, which will work | |
2316 | with all variants of netfilter. | |
575cb927 | 2317 | |
575cb927 | 2318 | disable-preserve-miss |
425de4c8 AJ |
2319 | This option disables the preservation of the TOS or netfilter |
2320 | mark. By default, the existing TOS or netfilter mark value of | |
2321 | the response coming from the remote server will be retained | |
2322 | and masked with miss-mark. | |
2323 | NOTE: in the case of a netfilter mark, the mark must be set on | |
2324 | the connection (using the CONNMARK target) not on the packet | |
2325 | (MARK target). | |
575cb927 AJ |
2326 | |
2327 | miss-mask=0xFF | |
425de4c8 AJ |
2328 | Allows you to mask certain bits in the TOS or mark value |
2329 | received from the remote server, before copying the value to | |
2330 | the TOS sent towards clients. | |
2331 | Default for tos: 0xFF (TOS from server is not changed). | |
2332 | Default for mark: 0xFFFFFFFF (mark from server is not changed). | |
2333 | ||
2334 | All of these features require the --enable-zph-qos compilation flag | |
2335 | (enabled by default). Netfilter marking also requires the | |
2336 | libnetfilter_conntrack libraries (--with-netfilter-conntrack) and | |
2337 | libcap 2.09+ (--with-libcap). | |
7172612f | 2338 | |
7172612f AJ |
2339 | DOC_END |
2340 | ||
41bd17a4 | 2341 | NAME: tcp_outgoing_address |
2342 | TYPE: acl_address | |
2343 | DEFAULT: none | |
638402dd | 2344 | DEFAULT_DOC: Address selection is performed by the operating system. |
41bd17a4 | 2345 | LOC: Config.accessList.outgoing_address |
2346 | DOC_START | |
2347 | Allows you to map requests to different outgoing IP addresses | |
2348 | based on the username or source address of the user making | |
2349 | the request. | |
7f7db318 | 2350 | |
41bd17a4 | 2351 | tcp_outgoing_address ipaddr [[!]aclname] ... |
c33aa074 | 2352 | |
2dd51400 AJ |
2353 | For example; |
2354 | Forwarding clients with dedicated IPs for certain subnets. | |
9197cd13 | 2355 | |
2dd51400 AJ |
2356 | acl normal_service_net src 10.0.0.0/24 |
2357 | acl good_service_net src 10.0.2.0/24 | |
2358 | ||
2359 | tcp_outgoing_address 2001:db8::c001 good_service_net | |
2360 | tcp_outgoing_address 10.1.0.2 good_service_net | |
2361 | ||
2362 | tcp_outgoing_address 2001:db8::beef normal_service_net | |
2363 | tcp_outgoing_address 10.1.0.1 normal_service_net | |
2364 | ||
2365 | tcp_outgoing_address 2001:db8::1 | |
2366 | tcp_outgoing_address 10.1.0.3 | |
9197cd13 | 2367 | |
41bd17a4 | 2368 | Processing proceeds in the order specified, and stops at first fully |
2369 | matching line. | |
cccac0a2 | 2370 | |
2dd51400 AJ |
2371 | Squid will add an implicit IP version test to each line. |
2372 | Requests going to IPv4 websites will use the outgoing 10.1.0.* addresses. | |
2373 | Requests going to IPv6 websites will use the outgoing 2001:db8:* addresses. | |
2374 | ||
2375 | ||
2376 | NOTE: The use of this directive using client dependent ACLs is | |
41bd17a4 | 2377 | incompatible with the use of server side persistent connections. To |
2378 | ensure correct results it is best to set server_persistent_connections | |
2379 | to off when using this directive in such configurations. | |
cc192b50 | 2380 | |
2dd51400 | 2381 | NOTE: The use of this directive to set a local IP on outgoing TCP links |
4ed968be | 2382 | is incompatible with using TPROXY to set client IP out outbound TCP links. |
2dd51400 AJ |
2383 | When needing to contact peers use the no-tproxy cache_peer option and the |
2384 | client_dst_passthru directive re-enable normal forwarding such as this. | |
cc192b50 | 2385 | |
cccac0a2 | 2386 | DOC_END |
6db78a1a | 2387 | |
90529125 AJ |
2388 | NAME: host_verify_strict |
2389 | TYPE: onoff | |
2390 | DEFAULT: off | |
2391 | LOC: Config.onoff.hostStrictVerify | |
2392 | DOC_START | |
d8821934 AR |
2393 | Regardless of this option setting, when dealing with intercepted |
2394 | traffic, Squid always verifies that the destination IP address matches | |
2962f8b8 | 2395 | the Host header domain or IP (called 'authority form URL'). |
d8821934 AR |
2396 | |
2397 | This enforcement is performed to satisfy a MUST-level requirement in | |
2398 | RFC 2616 section 14.23: "The Host field value MUST represent the naming | |
2399 | authority of the origin server or gateway given by the original URL". | |
2962f8b8 AJ |
2400 | |
2401 | When set to ON: | |
2402 | Squid always responds with an HTTP 409 (Conflict) error | |
2403 | page and logs a security warning if there is no match. | |
2404 | ||
2405 | Squid verifies that the destination IP address matches | |
2406 | the Host header for forward-proxy and reverse-proxy traffic | |
2407 | as well. For those traffic types, Squid also enables the | |
2408 | following checks, comparing the corresponding Host header | |
2409 | and Request-URI components: | |
2410 | ||
2411 | * The host names (domain or IP) must be identical, | |
2412 | but valueless or missing Host header disables all checks. | |
2413 | For the two host names to match, both must be either IP | |
2414 | or FQDN. | |
2415 | ||
2416 | * Port numbers must be identical, but if a port is missing | |
2417 | the scheme-default port is assumed. | |
2418 | ||
2419 | ||
2420 | When set to OFF (the default): | |
2421 | Squid allows suspicious requests to continue but logs a | |
2422 | security warning and blocks caching of the response. | |
2423 | ||
2424 | * Forward-proxy traffic is not checked at all. | |
2425 | ||
2426 | * Reverse-proxy traffic is not checked at all. | |
2427 | ||
2428 | * Intercepted traffic which passes verification is handled | |
32c32865 | 2429 | according to client_dst_passthru. |
2962f8b8 | 2430 | |
7177edfb AJ |
2431 | * Intercepted requests which fail verification are sent |
2432 | to the client original destination instead of DIRECT. | |
2433 | This overrides 'client_dst_passthru off'. | |
2962f8b8 AJ |
2434 | |
2435 | For now suspicious intercepted CONNECT requests are always | |
2436 | responded to with an HTTP 409 (Conflict) error page. | |
bfe4e2fe | 2437 | |
bfe4e2fe | 2438 | |
7177edfb | 2439 | SECURITY NOTE: |
bfe4e2fe AJ |
2440 | |
2441 | As described in CVE-2009-0801 when the Host: header alone is used | |
2442 | to determine the destination of a request it becomes trivial for | |
2443 | malicious scripts on remote websites to bypass browser same-origin | |
2444 | security policy and sandboxing protections. | |
2445 | ||
2446 | The cause of this is that such applets are allowed to perform their | |
2447 | own HTTP stack, in which case the same-origin policy of the browser | |
2448 | sandbox only verifies that the applet tries to contact the same IP | |
2449 | as from where it was loaded at the IP level. The Host: header may | |
2450 | be different from the connected IP and approved origin. | |
7177edfb AJ |
2451 | |
2452 | DOC_END | |
6b185b50 | 2453 | |
7177edfb AJ |
2454 | NAME: client_dst_passthru |
2455 | TYPE: onoff | |
2456 | DEFAULT: on | |
2457 | LOC: Config.onoff.client_dst_passthru | |
2458 | DOC_START | |
2459 | With NAT or TPROXY intercepted traffic Squid may pass the request | |
2460 | directly to the original client destination IP or seek a faster | |
2461 | source using the HTTP Host header. | |
2462 | ||
2463 | Using Host to locate alternative servers can provide faster | |
2464 | connectivity with a range of failure recovery options. | |
2465 | But can also lead to connectivity trouble when the client and | |
2466 | server are attempting stateful interactions unaware of the proxy. | |
2467 | ||
2468 | This option (on by default) prevents alternative DNS entries being | |
2469 | located to send intercepted traffic DIRECT to an origin server. | |
2470 | The clients original destination IP and port will be used instead. | |
2471 | ||
2472 | Regardless of this option setting, when dealing with intercepted | |
2473 | traffic Squid will verify the Host: header and any traffic which | |
2474 | fails Host verification will be treated as if this option were ON. | |
2475 | ||
2476 | see host_verify_strict for details on the verification process. | |
cccac0a2 | 2477 | DOC_END |
2478 | ||
195f8adb AJ |
2479 | COMMENT_START |
2480 | TLS OPTIONS | |
2481 | ----------------------------------------------------------------------------- | |
2482 | COMMENT_END | |
2483 | ||
2484 | NAME: tls_outgoing_options | |
2485 | IFDEF: USE_GNUTLS||USE_OPENSSL | |
2486 | TYPE: securePeerOptions | |
2fbb02b1 | 2487 | DEFAULT: min-version=1.0 |
7e62a74f | 2488 | LOC: Security::ProxyOutgoingConfig |
195f8adb AJ |
2489 | DOC_START |
2490 | disable Do not support https:// URLs. | |
2491 | ||
2492 | cert=/path/to/client/certificate | |
2493 | A client TLS certificate to use when connecting. | |
2494 | ||
2495 | key=/path/to/client/private_key | |
2496 | The private TLS key corresponding to the cert= above. | |
2497 | If key= is not specified cert= is assumed to reference | |
2498 | a PEM file containing both the certificate and the key. | |
2499 | ||
195f8adb | 2500 | cipher=... The list of valid TLS ciphers to use. |
1cc44095 AJ |
2501 | |
2502 | min-version=1.N | |
2fbb02b1 AJ |
2503 | The minimum TLS protocol version to permit. |
2504 | To control SSLv3 use the options= parameter. | |
1cc44095 AJ |
2505 | Supported Values: 1.0 (default), 1.1, 1.2 |
2506 | ||
195f8adb AJ |
2507 | options=... Specify various TLS/SSL implementation options: |
2508 | ||
2509 | NO_SSLv3 Disallow the use of SSLv3 | |
7905e7be | 2510 | |
195f8adb | 2511 | NO_TLSv1 Disallow the use of TLSv1.0 |
7905e7be | 2512 | |
195f8adb | 2513 | NO_TLSv1_1 Disallow the use of TLSv1.1 |
7905e7be | 2514 | |
195f8adb | 2515 | NO_TLSv1_2 Disallow the use of TLSv1.2 |
7905e7be | 2516 | |
195f8adb AJ |
2517 | SINGLE_DH_USE |
2518 | Always create a new key when using | |
2519 | temporary/ephemeral DH key exchanges | |
7905e7be AJ |
2520 | |
2521 | SSL_OP_NO_TICKET | |
2522 | Disable use of RFC5077 session tickets. | |
2523 | Some servers may have problems | |
2524 | understanding the TLS extension due | |
2525 | to ambiguous specification in RFC4507. | |
2526 | ||
195f8adb AJ |
2527 | ALL Enable various bug workarounds |
2528 | suggested as "harmless" by OpenSSL | |
7905e7be | 2529 | Be warned that this reduces SSL/TLS |
195f8adb AJ |
2530 | strength to some attacks. |
2531 | ||
2532 | See the OpenSSL SSL_CTX_set_options documentation for a | |
2533 | more complete list. | |
2534 | ||
86a84cc0 AJ |
2535 | cafile= PEM file containing CA certificates to use when verifying |
2536 | the peer certificate. May be repeated to load multiple files. | |
2537 | ||
2538 | capath= A directory containing additional CA certificates to | |
195f8adb | 2539 | use when verifying the peer certificate. |
86a84cc0 | 2540 | Requires OpenSSL or LibreSSL. |
195f8adb AJ |
2541 | |
2542 | crlfile=... A certificate revocation list file to use when | |
2543 | verifying the peer certificate. | |
2544 | ||
2545 | flags=... Specify various flags modifying the TLS implementation: | |
2546 | ||
2547 | DONT_VERIFY_PEER | |
2548 | Accept certificates even if they fail to | |
2549 | verify. | |
195f8adb AJ |
2550 | DONT_VERIFY_DOMAIN |
2551 | Don't verify the peer certificate | |
2552 | matches the server name | |
2553 | ||
8b253b83 AJ |
2554 | no-default-ca Do not use the system default Trusted CA. |
2555 | ||
195f8adb AJ |
2556 | domain= The peer name as advertised in its certificate. |
2557 | Used for verifying the correctness of the received peer | |
2558 | certificate. If not specified the peer hostname will be | |
2559 | used. | |
2560 | DOC_END | |
2561 | ||
41bd17a4 | 2562 | COMMENT_START |
2563 | SSL OPTIONS | |
2564 | ----------------------------------------------------------------------------- | |
2565 | COMMENT_END | |
2566 | ||
2567 | NAME: ssl_unclean_shutdown | |
cb4f4424 | 2568 | IFDEF: USE_OPENSSL |
cccac0a2 | 2569 | TYPE: onoff |
2570 | DEFAULT: off | |
41bd17a4 | 2571 | LOC: Config.SSL.unclean_shutdown |
cccac0a2 | 2572 | DOC_START |
41bd17a4 | 2573 | Some browsers (especially MSIE) bugs out on SSL shutdown |
2574 | messages. | |
cccac0a2 | 2575 | DOC_END |
2576 | ||
41bd17a4 | 2577 | NAME: ssl_engine |
cb4f4424 | 2578 | IFDEF: USE_OPENSSL |
cccac0a2 | 2579 | TYPE: string |
41bd17a4 | 2580 | LOC: Config.SSL.ssl_engine |
2581 | DEFAULT: none | |
cccac0a2 | 2582 | DOC_START |
41bd17a4 | 2583 | The OpenSSL engine to use. You will need to set this if you |
2584 | would like to use hardware SSL acceleration for example. | |
cccac0a2 | 2585 | DOC_END |
2586 | ||
10a69fc0 | 2587 | NAME: sslproxy_session_ttl |
cb4f4424 | 2588 | IFDEF: USE_OPENSSL |
10a69fc0 CT |
2589 | DEFAULT: 300 |
2590 | LOC: Config.SSL.session_ttl | |
2591 | TYPE: int | |
2592 | DOC_START | |
2593 | Sets the timeout value for SSL sessions | |
2594 | DOC_END | |
2595 | ||
2596 | NAME: sslproxy_session_cache_size | |
cb4f4424 | 2597 | IFDEF: USE_OPENSSL |
10a69fc0 CT |
2598 | DEFAULT: 2 MB |
2599 | LOC: Config.SSL.sessionCacheSize | |
2600 | TYPE: b_size_t | |
2601 | DOC_START | |
2602 | Sets the cache size to use for ssl session | |
2603 | DOC_END | |
2604 | ||
866be11c CT |
2605 | NAME: sslproxy_foreign_intermediate_certs |
2606 | IFDEF: USE_OPENSSL | |
2607 | DEFAULT: none | |
2608 | LOC: Config.ssl_client.foreignIntermediateCertsPath | |
2609 | TYPE: string | |
2610 | DOC_START | |
2611 | Many origin servers fail to send their full server certificate | |
2612 | chain for verification, assuming the client already has or can | |
2613 | easily locate any missing intermediate certificates. | |
2614 | ||
2615 | Squid uses the certificates from the specified file to fill in | |
2616 | these missing chains when trying to validate origin server | |
2617 | certificate chains. | |
2618 | ||
2619 | The file is expected to contain zero or more PEM-encoded | |
2620 | intermediate certificates. These certificates are not treated | |
2621 | as trusted root certificates, and any self-signed certificate in | |
2622 | this file will be ignored. | |
866be11c CT |
2623 | DOC_END |
2624 | ||
3c26b00a CT |
2625 | NAME: sslproxy_cert_sign_hash |
2626 | IFDEF: USE_OPENSSL | |
2627 | DEFAULT: none | |
2628 | LOC: Config.SSL.certSignHash | |
2629 | TYPE: string | |
2630 | DOC_START | |
2631 | Sets the hashing algorithm to use when signing generated certificates. | |
2632 | Valid algorithm names depend on the OpenSSL library used. The following | |
2633 | names are usually available: sha1, sha256, sha512, and md5. Please see | |
2634 | your OpenSSL library manual for the available hashes. By default, Squids | |
2635 | that support this option use sha256 hashes. | |
2636 | ||
2637 | Squid does not forcefully purge cached certificates that were generated | |
2638 | with an algorithm other than the currently configured one. They remain | |
2639 | in the cache, subject to the regular cache eviction policy, and become | |
2640 | useful if the algorithm changes again. | |
2641 | DOC_END | |
2642 | ||
4c9da963 | 2643 | NAME: ssl_bump |
cb4f4424 | 2644 | IFDEF: USE_OPENSSL |
caf3666d | 2645 | TYPE: sslproxy_ssl_bump |
4c9da963 | 2646 | LOC: Config.accessList.ssl_bump |
8f165829 | 2647 | DEFAULT_DOC: Become a TCP tunnel without decrypting proxied traffic. |
4c9da963 | 2648 | DEFAULT: none |
2649 | DOC_START | |
caf3666d AR |
2650 | This option is consulted when a CONNECT request is received on |
2651 | an http_port (or a new connection is intercepted at an | |
2652 | https_port), provided that port was configured with an ssl-bump | |
2653 | flag. The subsequent data on the connection is either treated as | |
2654 | HTTPS and decrypted OR tunneled at TCP level without decryption, | |
8f165829 AR |
2655 | depending on the first matching bumping "action". |
2656 | ||
2657 | ssl_bump <action> [!]acl ... | |
caf3666d | 2658 | |
8f165829 | 2659 | The following bumping actions are currently supported: |
caf3666d | 2660 | |
5d65362c | 2661 | splice |
8f165829 AR |
2662 | Become a TCP tunnel without decrypting proxied traffic. |
2663 | This is the default action. | |
5d65362c CT |
2664 | |
2665 | bump | |
2666 | Establish a secure connection with the server and, using a | |
2667 | mimicked server certificate, with the client. | |
caf3666d | 2668 | |
5d65362c | 2669 | peek |
1110989a | 2670 | Receive client (step SslBump1) or server (step SslBump2) |
8f165829 AR |
2671 | certificate while preserving the possibility of splicing the |
2672 | connection. Peeking at the server certificate (during step 2) | |
2673 | usually precludes bumping of the connection at step 3. | |
caf3666d | 2674 | |
5d65362c | 2675 | stare |
1110989a | 2676 | Receive client (step SslBump1) or server (step SslBump2) |
8f165829 AR |
2677 | certificate while preserving the possibility of bumping the |
2678 | connection. Staring at the server certificate (during step 2) | |
2679 | usually precludes splicing of the connection at step 3. | |
5d65362c CT |
2680 | |
2681 | terminate | |
2682 | Close client and server connections. | |
2683 | ||
1110989a | 2684 | Backward compatibility actions available at step SslBump1: |
caf3666d AR |
2685 | |
2686 | client-first | |
8f165829 AR |
2687 | Bump the connection. Establish a secure connection with the |
2688 | client first, then connect to the server. This old mode does | |
2689 | not allow Squid to mimic server SSL certificate and does not | |
2690 | work with intercepted SSL connections. | |
caf3666d AR |
2691 | |
2692 | server-first | |
8f165829 AR |
2693 | Bump the connection. Establish a secure connection with the |
2694 | server first, then establish a secure connection with the | |
2695 | client, using a mimicked server certificate. Works with both | |
2696 | CONNECT requests and intercepted SSL connections, but does | |
2697 | not allow to make decisions based on SSL handshake info. | |
caf3666d | 2698 | |
8f165829 AR |
2699 | peek-and-splice |
2700 | Decide whether to bump or splice the connection based on | |
d620ae0e | 2701 | client-to-squid and server-to-squid SSL hello messages. |
8f165829 | 2702 | XXX: Remove. |
caf3666d | 2703 | |
caf3666d | 2704 | none |
8f165829 | 2705 | Same as the "splice" action. |
caf3666d | 2706 | |
8f165829 AR |
2707 | All ssl_bump rules are evaluated at each of the supported bumping |
2708 | steps. Rules with actions that are impossible at the current step are | |
2709 | ignored. The first matching ssl_bump action wins and is applied at the | |
2710 | end of the current step. If no rules match, the splice action is used. | |
652fcffd | 2711 | See the at_step ACL for a list of the supported SslBump steps. |
4c9da963 | 2712 | |
e0c0d54c | 2713 | This clause supports both fast and slow acl types. |
b3567eb5 | 2714 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. |
e0855596 | 2715 | |
652fcffd | 2716 | See also: http_port ssl-bump, https_port ssl-bump, and acl at_step. |
caf3666d | 2717 | |
e0855596 | 2718 | |
caf3666d | 2719 | # Example: Bump all requests except those originating from |
638402dd | 2720 | # localhost or those going to example.com. |
e0855596 | 2721 | |
e0855596 | 2722 | acl broken_sites dstdomain .example.com |
8f165829 AR |
2723 | ssl_bump splice localhost |
2724 | ssl_bump splice broken_sites | |
2725 | ssl_bump bump all | |
4c9da963 | 2726 | DOC_END |
2727 | ||
4c9da963 | 2728 | NAME: sslproxy_cert_error |
cb4f4424 | 2729 | IFDEF: USE_OPENSSL |
4c9da963 | 2730 | DEFAULT: none |
638402dd | 2731 | DEFAULT_DOC: Server certificate errors terminate the transaction. |
4c9da963 | 2732 | LOC: Config.ssl_client.cert_error |
2733 | TYPE: acl_access | |
2734 | DOC_START | |
2735 | Use this ACL to bypass server certificate validation errors. | |
2736 | ||
2737 | For example, the following lines will bypass all validation errors | |
3b8f558c | 2738 | when talking to servers for example.com. All other |
4c9da963 | 2739 | validation errors will result in ERR_SECURE_CONNECT_FAIL error. |
2740 | ||
a87bfd3b AR |
2741 | acl BrokenButTrustedServers dstdomain example.com |
2742 | sslproxy_cert_error allow BrokenButTrustedServers | |
4c9da963 | 2743 | sslproxy_cert_error deny all |
2744 | ||
b3567eb5 FC |
2745 | This clause only supports fast acl types. |
2746 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
2747 | Using slow acl types may result in server crashes | |
4c9da963 | 2748 | |
2749 | Without this option, all server certificate validation errors | |
638402dd | 2750 | terminate the transaction to protect Squid and the client. |
4c9da963 | 2751 | |
0ad3ff51 CT |
2752 | SQUID_X509_V_ERR_INFINITE_VALIDATION error cannot be bypassed |
2753 | but should not happen unless your OpenSSL library is buggy. | |
2754 | ||
638402dd AJ |
2755 | SECURITY WARNING: |
2756 | Bypassing validation errors is dangerous because an | |
2757 | error usually implies that the server cannot be trusted | |
2758 | and the connection may be insecure. | |
4c9da963 | 2759 | |
638402dd | 2760 | See also: sslproxy_flags and DONT_VERIFY_PEER. |
4c9da963 | 2761 | DOC_END |
2762 | ||
aebe6888 | 2763 | NAME: sslproxy_cert_sign |
cb4f4424 | 2764 | IFDEF: USE_OPENSSL |
aebe6888 | 2765 | DEFAULT: none |
10d914f6 CT |
2766 | POSTSCRIPTUM: signUntrusted ssl::certUntrusted |
2767 | POSTSCRIPTUM: signSelf ssl::certSelfSigned | |
2768 | POSTSCRIPTUM: signTrusted all | |
aebe6888 CT |
2769 | TYPE: sslproxy_cert_sign |
2770 | LOC: Config.ssl_client.cert_sign | |
2771 | DOC_START | |
2772 | ||
69742b76 | 2773 | sslproxy_cert_sign <signing algorithm> acl ... |
aebe6888 | 2774 | |
69742b76 | 2775 | The following certificate signing algorithms are supported: |
638402dd | 2776 | |
aebe6888 | 2777 | signTrusted |
69742b76 AR |
2778 | Sign using the configured CA certificate which is usually |
2779 | placed in and trusted by end-user browsers. This is the | |
2780 | default for trusted origin server certificates. | |
638402dd | 2781 | |
aebe6888 | 2782 | signUntrusted |
69742b76 AR |
2783 | Sign to guarantee an X509_V_ERR_CERT_UNTRUSTED browser error. |
2784 | This is the default for untrusted origin server certificates | |
2785 | that are not self-signed (see ssl::certUntrusted). | |
638402dd | 2786 | |
aebe6888 | 2787 | signSelf |
69742b76 | 2788 | Sign using a self-signed certificate with the right CN to |
aebe6888 | 2789 | generate a X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT error in the |
69742b76 AR |
2790 | browser. This is the default for self-signed origin server |
2791 | certificates (see ssl::certSelfSigned). | |
aebe6888 | 2792 | |
cf1c09f6 CT |
2793 | This clause only supports fast acl types. |
2794 | ||
69742b76 AR |
2795 | When sslproxy_cert_sign acl(s) match, Squid uses the corresponding |
2796 | signing algorithm to generate the certificate and ignores all | |
2797 | subsequent sslproxy_cert_sign options (the first match wins). If no | |
2798 | acl(s) match, the default signing algorithm is determined by errors | |
2799 | detected when obtaining and validating the origin server certificate. | |
cf1c09f6 | 2800 | |
4b0d23b7 CT |
2801 | WARNING: SQUID_X509_V_ERR_DOMAIN_MISMATCH and ssl:certDomainMismatch can |
2802 | be used with sslproxy_cert_adapt, but if and only if Squid is bumping a | |
2803 | CONNECT request that carries a domain name. In all other cases (CONNECT | |
2804 | to an IP address or an intercepted SSL connection), Squid cannot detect | |
2805 | the domain mismatch at certificate generation time when | |
2806 | bump-server-first is used. | |
aebe6888 CT |
2807 | DOC_END |
2808 | ||
638402dd | 2809 | NAME: sslproxy_cert_adapt |
cb4f4424 | 2810 | IFDEF: USE_OPENSSL |
fb2178bb CT |
2811 | DEFAULT: none |
2812 | TYPE: sslproxy_cert_adapt | |
2813 | LOC: Config.ssl_client.cert_adapt | |
2814 | DOC_START | |
2815 | ||
2816 | sslproxy_cert_adapt <adaptation algorithm> acl ... | |
2817 | ||
69742b76 | 2818 | The following certificate adaptation algorithms are supported: |
638402dd | 2819 | |
fb2178bb | 2820 | setValidAfter |
69742b76 AR |
2821 | Sets the "Not After" property to the "Not After" property of |
2822 | the CA certificate used to sign generated certificates. | |
638402dd | 2823 | |
fb2178bb | 2824 | setValidBefore |
69742b76 AR |
2825 | Sets the "Not Before" property to the "Not Before" property of |
2826 | the CA certificate used to sign generated certificates. | |
638402dd | 2827 | |
69742b76 AR |
2828 | setCommonName or setCommonName{CN} |
2829 | Sets Subject.CN property to the host name specified as a | |
2830 | CN parameter or, if no explicit CN parameter was specified, | |
2831 | extracted from the CONNECT request. It is a misconfiguration | |
2832 | to use setCommonName without an explicit parameter for | |
2833 | intercepted or tproxied SSL connections. | |
fb2178bb | 2834 | |
cf1c09f6 CT |
2835 | This clause only supports fast acl types. |
2836 | ||
69742b76 AR |
2837 | Squid first groups sslproxy_cert_adapt options by adaptation algorithm. |
2838 | Within a group, when sslproxy_cert_adapt acl(s) match, Squid uses the | |
2839 | corresponding adaptation algorithm to generate the certificate and | |
2840 | ignores all subsequent sslproxy_cert_adapt options in that algorithm's | |
2841 | group (i.e., the first match wins within each algorithm group). If no | |
2842 | acl(s) match, the default mimicking action takes place. | |
cf1c09f6 | 2843 | |
4b0d23b7 CT |
2844 | WARNING: SQUID_X509_V_ERR_DOMAIN_MISMATCH and ssl:certDomainMismatch can |
2845 | be used with sslproxy_cert_adapt, but if and only if Squid is bumping a | |
2846 | CONNECT request that carries a domain name. In all other cases (CONNECT | |
2847 | to an IP address or an intercepted SSL connection), Squid cannot detect | |
2848 | the domain mismatch at certificate generation time when | |
2849 | bump-server-first is used. | |
fb2178bb CT |
2850 | DOC_END |
2851 | ||
41bd17a4 | 2852 | NAME: sslpassword_program |
cb4f4424 | 2853 | IFDEF: USE_OPENSSL |
41bd17a4 | 2854 | DEFAULT: none |
2855 | LOC: Config.Program.ssl_password | |
2856 | TYPE: string | |
5473c134 | 2857 | DOC_START |
41bd17a4 | 2858 | Specify a program used for entering SSL key passphrases |
2859 | when using encrypted SSL certificate keys. If not specified | |
2860 | keys must either be unencrypted, or Squid started with the -N | |
2861 | option to allow it to query interactively for the passphrase. | |
7acb9ddd HN |
2862 | |
2863 | The key file name is given as argument to the program allowing | |
2864 | selection of the right password if you have multiple encrypted | |
2865 | keys. | |
5473c134 | 2866 | DOC_END |
2867 | ||
95d2589c CT |
2868 | COMMENT_START |
2869 | OPTIONS RELATING TO EXTERNAL SSL_CRTD | |
2870 | ----------------------------------------------------------------------------- | |
2871 | COMMENT_END | |
2872 | ||
2873 | NAME: sslcrtd_program | |
2874 | TYPE: eol | |
2875 | IFDEF: USE_SSL_CRTD | |
2876 | DEFAULT: @DEFAULT_SSL_CRTD@ -s @DEFAULT_SSL_DB_DIR@ -M 4MB | |
2877 | LOC: Ssl::TheConfig.ssl_crtd | |
2878 | DOC_START | |
2879 | Specify the location and options of the executable for ssl_crtd process. | |
2880 | @DEFAULT_SSL_CRTD@ program requires -s and -M parameters | |
2881 | For more information use: | |
2882 | @DEFAULT_SSL_CRTD@ -h | |
2883 | DOC_END | |
2884 | ||
2885 | NAME: sslcrtd_children | |
2886 | TYPE: HelperChildConfig | |
2887 | IFDEF: USE_SSL_CRTD | |
2888 | DEFAULT: 32 startup=5 idle=1 | |
2889 | LOC: Ssl::TheConfig.ssl_crtdChildren | |
2890 | DOC_START | |
2891 | The maximum number of processes spawn to service ssl server. | |
2892 | The maximum this may be safely set to is 32. | |
2893 | ||
2894 | The startup= and idle= options allow some measure of skew in your | |
2895 | tuning. | |
2896 | ||
2897 | startup=N | |
2898 | ||
2899 | Sets the minimum number of processes to spawn when Squid | |
2900 | starts or reconfigures. When set to zero the first request will | |
2901 | cause spawning of the first child process to handle it. | |
2902 | ||
2903 | Starting too few children temporary slows Squid under load while it | |
2904 | tries to spawn enough additional processes to cope with traffic. | |
2905 | ||
2906 | idle=N | |
2907 | ||
2908 | Sets a minimum of how many processes Squid is to try and keep available | |
2909 | at all times. When traffic begins to rise above what the existing | |
2910 | processes can handle this many more will be spawned up to the maximum | |
2911 | configured. A minimum setting of 1 is required. | |
6825b101 CT |
2912 | |
2913 | queue-size=N | |
2914 | ||
2915 | Sets the maximum number of queued requests. | |
2916 | If the queued requests exceed queue size for more than 3 minutes | |
2917 | squid aborts its operation. | |
2918 | The default value is set to 2*numberofchildren. | |
95d2589c CT |
2919 | |
2920 | You must have at least one ssl_crtd process. | |
2921 | DOC_END | |
2922 | ||
2cef0ca6 AR |
2923 | NAME: sslcrtvalidator_program |
2924 | TYPE: eol | |
cb4f4424 | 2925 | IFDEF: USE_OPENSSL |
2cef0ca6 AR |
2926 | DEFAULT: none |
2927 | LOC: Ssl::TheConfig.ssl_crt_validator | |
2928 | DOC_START | |
2929 | Specify the location and options of the executable for ssl_crt_validator | |
638402dd AJ |
2930 | process. |
2931 | ||
2932 | Usage: sslcrtvalidator_program [ttl=n] [cache=n] path ... | |
14798e73 CT |
2933 | |
2934 | Options: | |
638402dd | 2935 | ttl=n TTL in seconds for cached results. The default is 60 secs |
14798e73 | 2936 | cache=n limit the result cache size. The default value is 2048 |
2cef0ca6 AR |
2937 | DOC_END |
2938 | ||
2939 | NAME: sslcrtvalidator_children | |
2940 | TYPE: HelperChildConfig | |
cb4f4424 | 2941 | IFDEF: USE_OPENSSL |
413bb969 | 2942 | DEFAULT: 32 startup=5 idle=1 concurrency=1 |
2cef0ca6 AR |
2943 | LOC: Ssl::TheConfig.ssl_crt_validator_Children |
2944 | DOC_START | |
638402dd | 2945 | The maximum number of processes spawn to service SSL server. |
2cef0ca6 AR |
2946 | The maximum this may be safely set to is 32. |
2947 | ||
2948 | The startup= and idle= options allow some measure of skew in your | |
2949 | tuning. | |
2950 | ||
2951 | startup=N | |
2952 | ||
2953 | Sets the minimum number of processes to spawn when Squid | |
2954 | starts or reconfigures. When set to zero the first request will | |
2955 | cause spawning of the first child process to handle it. | |
2956 | ||
2957 | Starting too few children temporary slows Squid under load while it | |
2958 | tries to spawn enough additional processes to cope with traffic. | |
2959 | ||
2960 | idle=N | |
2961 | ||
2962 | Sets a minimum of how many processes Squid is to try and keep available | |
2963 | at all times. When traffic begins to rise above what the existing | |
2964 | processes can handle this many more will be spawned up to the maximum | |
2965 | configured. A minimum setting of 1 is required. | |
4a77bb4e CT |
2966 | |
2967 | concurrency= | |
2968 | ||
2969 | The number of requests each certificate validator helper can handle in | |
dffc462a CT |
2970 | parallel. A value of 0 indicates the certficate validator does not |
2971 | support concurrency. Defaults to 1. | |
4a77bb4e CT |
2972 | |
2973 | When this directive is set to a value >= 1 then the protocol | |
2974 | used to communicate with the helper is modified to include | |
2975 | a request ID in front of the request/response. The request | |
2976 | ID from the request must be echoed back with the response | |
2977 | to that request. | |
6825b101 CT |
2978 | |
2979 | queue-size=N | |
2980 | ||
2981 | Sets the maximum number of queued requests. | |
2982 | If the queued requests exceed queue size for more than 3 minutes | |
2983 | squid aborts its operation. | |
2984 | The default value is set to 2*numberofchildren. | |
2cef0ca6 AR |
2985 | |
2986 | You must have at least one ssl_crt_validator process. | |
2987 | DOC_END | |
2988 | ||
cccac0a2 | 2989 | COMMENT_START |
41bd17a4 | 2990 | OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM |
cccac0a2 | 2991 | ----------------------------------------------------------------------------- |
2992 | COMMENT_END | |
2993 | ||
41bd17a4 | 2994 | NAME: cache_peer |
2995 | TYPE: peer | |
2996 | DEFAULT: none | |
2997 | LOC: Config.peers | |
cccac0a2 | 2998 | DOC_START |
41bd17a4 | 2999 | To specify other caches in a hierarchy, use the format: |
2b94f655 | 3000 | |
41bd17a4 | 3001 | cache_peer hostname type http-port icp-port [options] |
2b94f655 | 3002 | |
41bd17a4 | 3003 | For example, |
2b94f655 | 3004 | |
41bd17a4 | 3005 | # proxy icp |
3006 | # hostname type port port options | |
3007 | # -------------------- -------- ----- ----- ----------- | |
2b94f655 | 3008 | cache_peer parent.foo.net parent 3128 3130 default |
41bd17a4 | 3009 | cache_peer sib1.foo.net sibling 3128 3130 proxy-only |
3010 | cache_peer sib2.foo.net sibling 3128 3130 proxy-only | |
2e9993e1 | 3011 | cache_peer example.com parent 80 0 default |
2b94f655 AJ |
3012 | cache_peer cdn.example.com sibling 3128 0 |
3013 | ||
3014 | type: either 'parent', 'sibling', or 'multicast'. | |
3015 | ||
3016 | proxy-port: The port number where the peer accept HTTP requests. | |
3017 | For other Squid proxies this is usually 3128 | |
3018 | For web servers this is usually 80 | |
3019 | ||
3020 | icp-port: Used for querying neighbor caches about objects. | |
3021 | Set to 0 if the peer does not support ICP or HTCP. | |
3022 | See ICP and HTCP options below for additional details. | |
3023 | ||
3024 | ||
3025 | ==== ICP OPTIONS ==== | |
3026 | ||
3027 | You MUST also set icp_port and icp_access explicitly when using these options. | |
3028 | The defaults will prevent peer traffic using ICP. | |
3029 | ||
3030 | ||
3031 | no-query Disable ICP queries to this neighbor. | |
3032 | ||
3033 | multicast-responder | |
3034 | Indicates the named peer is a member of a multicast group. | |
3035 | ICP queries will not be sent directly to the peer, but ICP | |
3036 | replies will be accepted from it. | |
3037 | ||
3038 | closest-only Indicates that, for ICP_OP_MISS replies, we'll only forward | |
3039 | CLOSEST_PARENT_MISSes and never FIRST_PARENT_MISSes. | |
3040 | ||
3041 | background-ping | |
3042 | To only send ICP queries to this neighbor infrequently. | |
3043 | This is used to keep the neighbor round trip time updated | |
3044 | and is usually used in conjunction with weighted-round-robin. | |
3045 | ||
3046 | ||
3047 | ==== HTCP OPTIONS ==== | |
3048 | ||
3049 | You MUST also set htcp_port and htcp_access explicitly when using these options. | |
3050 | The defaults will prevent peer traffic using HTCP. | |
3051 | ||
3052 | ||
3053 | htcp Send HTCP, instead of ICP, queries to the neighbor. | |
3054 | You probably also want to set the "icp-port" to 4827 | |
18191440 AJ |
3055 | instead of 3130. This directive accepts a comma separated |
3056 | list of options described below. | |
2b94f655 | 3057 | |
18191440 | 3058 | htcp=oldsquid Send HTCP to old Squid versions (2.5 or earlier). |
2b94f655 | 3059 | |
18191440 | 3060 | htcp=no-clr Send HTCP to the neighbor but without |
2b94f655 | 3061 | sending any CLR requests. This cannot be used with |
18191440 | 3062 | only-clr. |
2b94f655 | 3063 | |
18191440 AJ |
3064 | htcp=only-clr Send HTCP to the neighbor but ONLY CLR requests. |
3065 | This cannot be used with no-clr. | |
2b94f655 | 3066 | |
18191440 | 3067 | htcp=no-purge-clr |
2b94f655 AJ |
3068 | Send HTCP to the neighbor including CLRs but only when |
3069 | they do not result from PURGE requests. | |
3070 | ||
18191440 | 3071 | htcp=forward-clr |
2b94f655 AJ |
3072 | Forward any HTCP CLR requests this proxy receives to the peer. |
3073 | ||
3074 | ||
3075 | ==== PEER SELECTION METHODS ==== | |
3076 | ||
3077 | The default peer selection method is ICP, with the first responding peer | |
3078 | being used as source. These options can be used for better load balancing. | |
3079 | ||
3080 | ||
3081 | default This is a parent cache which can be used as a "last-resort" | |
3082 | if a peer cannot be located by any of the peer-selection methods. | |
3083 | If specified more than once, only the first is used. | |
3084 | ||
3085 | round-robin Load-Balance parents which should be used in a round-robin | |
3086 | fashion in the absence of any ICP queries. | |
3087 | weight=N can be used to add bias. | |
3088 | ||
3089 | weighted-round-robin | |
3090 | Load-Balance parents which should be used in a round-robin | |
3091 | fashion with the frequency of each parent being based on the | |
3092 | round trip time. Closer parents are used more often. | |
3093 | Usually used for background-ping parents. | |
3094 | weight=N can be used to add bias. | |
3095 | ||
3096 | carp Load-Balance parents which should be used as a CARP array. | |
3097 | The requests will be distributed among the parents based on the | |
3098 | CARP load balancing hash function based on their weight. | |
3099 | ||
3100 | userhash Load-balance parents based on the client proxy_auth or ident username. | |
3101 | ||
3102 | sourcehash Load-balance parents based on the client source IP. | |
8a368316 AJ |
3103 | |
3104 | multicast-siblings | |
3105 | To be used only for cache peers of type "multicast". | |
3106 | ALL members of this multicast group have "sibling" | |
2e9993e1 | 3107 | relationship with it, not "parent". This is to a multicast |
8a368316 AJ |
3108 | group when the requested object would be fetched only from |
3109 | a "parent" cache, anyway. It's useful, e.g., when | |
3110 | configuring a pool of redundant Squid proxies, being | |
3111 | members of the same multicast group. | |
2b94f655 AJ |
3112 | |
3113 | ||
3114 | ==== PEER SELECTION OPTIONS ==== | |
3115 | ||
3116 | weight=N use to affect the selection of a peer during any weighted | |
3117 | peer-selection mechanisms. | |
3118 | The weight must be an integer; default is 1, | |
3119 | larger weights are favored more. | |
3120 | This option does not affect parent selection if a peering | |
3121 | protocol is not in use. | |
3122 | ||
3123 | basetime=N Specify a base amount to be subtracted from round trip | |
3124 | times of parents. | |
3125 | It is subtracted before division by weight in calculating | |
3126 | which parent to fectch from. If the rtt is less than the | |
3127 | base time the rtt is set to a minimal value. | |
3128 | ||
3c72389f AJ |
3129 | ttl=N Specify a TTL to use when sending multicast ICP queries |
3130 | to this address. | |
2b94f655 AJ |
3131 | Only useful when sending to a multicast group. |
3132 | Because we don't accept ICP replies from random | |
3133 | hosts, you must configure other group members as | |
3134 | peers with the 'multicast-responder' option. | |
3135 | ||
3136 | no-delay To prevent access to this neighbor from influencing the | |
3137 | delay pools. | |
3138 | ||
3139 | digest-url=URL Tell Squid to fetch the cache digest (if digests are | |
3140 | enabled) for this host from the specified URL rather | |
3141 | than the Squid default location. | |
3142 | ||
3143 | ||
de03b596 FC |
3144 | ==== CARP OPTIONS ==== |
3145 | ||
3146 | carp-key=key-specification | |
3147 | use a different key than the full URL to hash against the peer. | |
3148 | the key-specification is a comma-separated list of the keywords | |
3149 | scheme, host, port, path, params | |
3150 | Order is not important. | |
3151 | ||
2b94f655 AJ |
3152 | ==== ACCELERATOR / REVERSE-PROXY OPTIONS ==== |
3153 | ||
3154 | originserver Causes this parent to be contacted as an origin server. | |
3155 | Meant to be used in accelerator setups when the peer | |
3156 | is a web server. | |
3157 | ||
3158 | forceddomain=name | |
3159 | Set the Host header of requests forwarded to this peer. | |
3160 | Useful in accelerator setups where the server (peer) | |
3161 | expects a certain domain name but clients may request | |
3162 | others. ie example.com or www.example.com | |
3163 | ||
3164 | no-digest Disable request of cache digests. | |
3165 | ||
3166 | no-netdb-exchange | |
3167 | Disables requesting ICMP RTT database (NetDB). | |
3168 | ||
3169 | ||
3170 | ==== AUTHENTICATION OPTIONS ==== | |
3171 | ||
3172 | login=user:password | |
3173 | If this is a personal/workgroup proxy and your parent | |
3174 | requires proxy authentication. | |
3175 | ||
3176 | Note: The string can include URL escapes (i.e. %20 for | |
3177 | spaces). This also means % must be written as %%. | |
3178 | ||
11e4c5e5 AJ |
3179 | login=PASSTHRU |
3180 | Send login details received from client to this peer. | |
3181 | Both Proxy- and WWW-Authorization headers are passed | |
3182 | without alteration to the peer. | |
3183 | Authentication is not required by Squid for this to work. | |
3184 | ||
3185 | Note: This will pass any form of authentication but | |
3186 | only Basic auth will work through a proxy unless the | |
3187 | connection-auth options are also used. | |
ee0b94f4 | 3188 | |
2b94f655 AJ |
3189 | login=PASS Send login details received from client to this peer. |
3190 | Authentication is not required by this option. | |
11e4c5e5 | 3191 | |
2b94f655 AJ |
3192 | If there are no client-provided authentication headers |
3193 | to pass on, but username and password are available | |
ee0b94f4 HN |
3194 | from an external ACL user= and password= result tags |
3195 | they may be sent instead. | |
2b94f655 AJ |
3196 | |
3197 | Note: To combine this with proxy_auth both proxies must | |
3198 | share the same user database as HTTP only allows for | |
3199 | a single login (one for proxy, one for origin server). | |
3200 | Also be warned this will expose your users proxy | |
3201 | password to the peer. USE WITH CAUTION | |
3202 | ||
3203 | login=*:password | |
3204 | Send the username to the upstream cache, but with a | |
3205 | fixed password. This is meant to be used when the peer | |
3206 | is in another administrative domain, but it is still | |
3207 | needed to identify each user. | |
3208 | The star can optionally be followed by some extra | |
3209 | information which is added to the username. This can | |
3210 | be used to identify this proxy to the peer, similar to | |
3211 | the login=username:password option above. | |
3212 | ||
9ca29d23 AJ |
3213 | login=NEGOTIATE |
3214 | If this is a personal/workgroup proxy and your parent | |
3215 | requires a secure proxy authentication. | |
3216 | The first principal from the default keytab or defined by | |
3217 | the environment variable KRB5_KTNAME will be used. | |
3218 | ||
63f03f79 PL |
3219 | WARNING: The connection may transmit requests from multiple |
3220 | clients. Negotiate often assumes end-to-end authentication | |
3221 | and a single-client. Which is not strictly true here. | |
3222 | ||
9ca29d23 AJ |
3223 | login=NEGOTIATE:principal_name |
3224 | If this is a personal/workgroup proxy and your parent | |
3225 | requires a secure proxy authentication. | |
3226 | The principal principal_name from the default keytab or | |
3227 | defined by the environment variable KRB5_KTNAME will be | |
3228 | used. | |
3229 | ||
63f03f79 PL |
3230 | WARNING: The connection may transmit requests from multiple |
3231 | clients. Negotiate often assumes end-to-end authentication | |
3232 | and a single-client. Which is not strictly true here. | |
3233 | ||
2b94f655 AJ |
3234 | connection-auth=on|off |
3235 | Tell Squid that this peer does or not support Microsoft | |
3236 | connection oriented authentication, and any such | |
3237 | challenges received from there should be ignored. | |
3238 | Default is auto to automatically determine the status | |
3239 | of the peer. | |
3240 | ||
9825b398 AJ |
3241 | auth-no-keytab |
3242 | Do not use a keytab to authenticate to a peer when | |
3243 | login=NEGOTIATE is specified. Let the GSSAPI | |
3244 | implementation determine which already existing | |
3245 | credentials cache to use instead. | |
3246 | ||
2b94f655 AJ |
3247 | |
3248 | ==== SSL / HTTPS / TLS OPTIONS ==== | |
3249 | ||
3250 | ssl Encrypt connections to this peer with SSL/TLS. | |
3251 | ||
3252 | sslcert=/path/to/ssl/certificate | |
3253 | A client SSL certificate to use when connecting to | |
3254 | this peer. | |
3255 | ||
3256 | sslkey=/path/to/ssl/key | |
3257 | The private SSL key corresponding to sslcert above. | |
3258 | If 'sslkey' is not specified 'sslcert' is assumed to | |
3259 | reference a combined file containing both the | |
3260 | certificate and the key. | |
3261 | ||
2b94f655 AJ |
3262 | sslcipher=... The list of valid SSL ciphers to use when connecting |
3263 | to this peer. | |
1cc44095 AJ |
3264 | |
3265 | tls-min-version=1.N | |
3266 | The minimum TLS protocol version to permit. To control | |
3267 | SSLv3 use the ssloptions= parameter. | |
3268 | Supported Values: 1.0 (default), 1.1, 1.2 | |
3269 | ||
943c5f16 HN |
3270 | ssloptions=... Specify various SSL implementation options: |
3271 | ||
3d96b0e8 | 3272 | NO_SSLv3 Disallow the use of SSLv3 |
1f1f29e8 | 3273 | |
3d96b0e8 | 3274 | NO_TLSv1 Disallow the use of TLSv1.0 |
1f1f29e8 | 3275 | |
3d96b0e8 | 3276 | NO_TLSv1_1 Disallow the use of TLSv1.1 |
1f1f29e8 | 3277 | |
3d96b0e8 | 3278 | NO_TLSv1_2 Disallow the use of TLSv1.2 |
1f1f29e8 | 3279 | |
943c5f16 HN |
3280 | SINGLE_DH_USE |
3281 | Always create a new key when using | |
3282 | temporary/ephemeral DH key exchanges | |
1f1f29e8 AJ |
3283 | |
3284 | SSL_OP_NO_TICKET | |
3285 | Disable use of RFC5077 session tickets. | |
3286 | Some servers may have problems | |
3287 | understanding the TLS extension due | |
3288 | to ambiguous specification in RFC4507. | |
3289 | ||
943c5f16 HN |
3290 | ALL Enable various bug workarounds |
3291 | suggested as "harmless" by OpenSSL | |
3292 | Be warned that this reduces SSL/TLS | |
3293 | strength to some attacks. | |
3294 | ||
3295 | See the OpenSSL SSL_CTX_set_options documentation for a | |
3296 | more complete list. | |
2b94f655 | 3297 | |
86a84cc0 AJ |
3298 | tls-cafile= PEM file containing CA certificates to use when verifying |
3299 | the peer certificate. May be repeated to load multiple files. | |
2b94f655 AJ |
3300 | |
3301 | sslcapath=... A directory containing additional CA certificates to | |
3302 | use when verifying the peer certificate. | |
86a84cc0 | 3303 | Requires OpenSSL or LibreSSL. |
2b94f655 AJ |
3304 | |
3305 | sslcrlfile=... A certificate revocation list file to use when | |
3306 | verifying the peer certificate. | |
3307 | ||
3308 | sslflags=... Specify various flags modifying the SSL implementation: | |
3309 | ||
41bd17a4 | 3310 | DONT_VERIFY_PEER |
3311 | Accept certificates even if they fail to | |
3312 | verify. | |
1f1f29e8 | 3313 | |
41bd17a4 | 3314 | DONT_VERIFY_DOMAIN |
3315 | Don't verify the peer certificate | |
3316 | matches the server name | |
2b94f655 AJ |
3317 | |
3318 | ssldomain= The peer name as advertised in it's certificate. | |
3319 | Used for verifying the correctness of the received peer | |
3320 | certificate. If not specified the peer hostname will be | |
3321 | used. | |
3322 | ||
3323 | front-end-https | |
3324 | Enable the "Front-End-Https: On" header needed when | |
3325 | using Squid as a SSL frontend in front of Microsoft OWA. | |
3326 | See MS KB document Q307347 for details on this header. | |
3327 | If set to auto the header will only be added if the | |
3328 | request is forwarded as a https:// URL. | |
8b253b83 AJ |
3329 | |
3330 | tls-no-default-ca | |
3331 | Do not use the system default Trusted CA. | |
2b94f655 | 3332 | |
b05d749d AJ |
3333 | tls-no-npn Do not use the TLS NPN extension to advertise HTTP/1.1. |
3334 | ||
2b94f655 AJ |
3335 | ==== GENERAL OPTIONS ==== |
3336 | ||
3337 | connect-timeout=N | |
3338 | A peer-specific connect timeout. | |
3339 | Also see the peer_connect_timeout directive. | |
3340 | ||
3341 | connect-fail-limit=N | |
3342 | How many times connecting to a peer must fail before | |
e8dca475 CT |
3343 | it is marked as down. Standby connection failures |
3344 | count towards this limit. Default is 10. | |
2b94f655 AJ |
3345 | |
3346 | allow-miss Disable Squid's use of only-if-cached when forwarding | |
3347 | requests to siblings. This is primarily useful when | |
a5bb0c26 AR |
3348 | icp_hit_stale is used by the sibling. Excessive use |
3349 | of this option may result in forwarding loops. One way | |
3350 | to prevent peering loops when using this option, is to | |
3351 | deny cache peer usage on requests from a peer: | |
3352 | acl fromPeer ... | |
3353 | cache_peer_access peerName deny fromPeer | |
2b94f655 | 3354 | |
e8dca475 CT |
3355 | max-conn=N Limit the number of concurrent connections the Squid |
3356 | may open to this peer, including already opened idle | |
3357 | and standby connections. There is no peer-specific | |
3358 | connection limit by default. | |
3359 | ||
3360 | A peer exceeding the limit is not used for new | |
3361 | requests unless a standby connection is available. | |
3362 | ||
3363 | max-conn currently works poorly with idle persistent | |
3364 | connections: When a peer reaches its max-conn limit, | |
3365 | and there are idle persistent connections to the peer, | |
3366 | the peer may not be selected because the limiting code | |
3367 | does not know whether Squid can reuse those idle | |
3368 | connections. | |
3369 | ||
3370 | standby=N Maintain a pool of N "hot standby" connections to an | |
3371 | UP peer, available for requests when no idle | |
3372 | persistent connection is available (or safe) to use. | |
3373 | By default and with zero N, no such pool is maintained. | |
3374 | N must not exceed the max-conn limit (if any). | |
3375 | ||
3376 | At start or after reconfiguration, Squid opens new TCP | |
3377 | standby connections until there are N connections | |
3378 | available and then replenishes the standby pool as | |
3379 | opened connections are used up for requests. A used | |
3380 | connection never goes back to the standby pool, but | |
3381 | may go to the regular idle persistent connection pool | |
3382 | shared by all peers and origin servers. | |
3383 | ||
3384 | Squid never opens multiple new standby connections | |
3385 | concurrently. This one-at-a-time approach minimizes | |
3386 | flooding-like effect on peers. Furthermore, just a few | |
3387 | standby connections should be sufficient in most cases | |
3388 | to supply most new requests with a ready-to-use | |
3389 | connection. | |
3390 | ||
3391 | Standby connections obey server_idle_pconn_timeout. | |
3392 | For the feature to work as intended, the peer must be | |
3393 | configured to accept and keep them open longer than | |
3394 | the idle timeout at the connecting Squid, to minimize | |
3395 | race conditions typical to idle used persistent | |
3396 | connections. Default request_timeout and | |
3397 | server_idle_pconn_timeout values ensure such a | |
3398 | configuration. | |
2b94f655 AJ |
3399 | |
3400 | name=xxx Unique name for the peer. | |
3401 | Required if you have multiple peers on the same host | |
3402 | but different ports. | |
3403 | This name can be used in cache_peer_access and similar | |
a5bb0c26 | 3404 | directives to identify the peer. |
2b94f655 AJ |
3405 | Can be used by outgoing access controls through the |
3406 | peername ACL type. | |
3407 | ||
b0758e04 AJ |
3408 | no-tproxy Do not use the client-spoof TPROXY support when forwarding |
3409 | requests to this peer. Use normal address selection instead. | |
0d901ef4 | 3410 | This overrides the spoof_client_ip ACL. |
b0758e04 | 3411 | |
2b94f655 AJ |
3412 | proxy-only objects fetched from the peer will not be stored locally. |
3413 | ||
41bd17a4 | 3414 | DOC_END |
cccac0a2 | 3415 | |
41bd17a4 | 3416 | NAME: cache_peer_access |
3417 | TYPE: peer_access | |
3418 | DEFAULT: none | |
a5bb0c26 | 3419 | DEFAULT_DOC: No peer usage restrictions. |
41bd17a4 | 3420 | LOC: none |
3421 | DOC_START | |
a5bb0c26 | 3422 | Restricts usage of cache_peer proxies. |
cccac0a2 | 3423 | |
638402dd | 3424 | Usage: |
a5bb0c26 AR |
3425 | cache_peer_access peer-name allow|deny [!]aclname ... |
3426 | ||
3427 | For the required peer-name parameter, use either the value of the | |
3428 | cache_peer name=value parameter or, if name=value is missing, the | |
3429 | cache_peer hostname parameter. | |
3430 | ||
3431 | This directive narrows down the selection of peering candidates, but | |
3432 | does not determine the order in which the selected candidates are | |
3433 | contacted. That order is determined by the peer selection algorithms | |
3434 | (see PEER SELECTION sections in the cache_peer documentation). | |
3435 | ||
3436 | If a deny rule matches, the corresponding peer will not be contacted | |
3437 | for the current transaction -- Squid will not send ICP queries and | |
3438 | will not forward HTTP requests to that peer. An allow match leaves | |
3439 | the corresponding peer in the selection. The first match for a given | |
3440 | peer wins for that peer. | |
3441 | ||
3442 | The relative order of cache_peer_access directives for the same peer | |
3443 | matters. The relative order of any two cache_peer_access directives | |
3444 | for different peers does not matter. To ease interpretation, it is a | |
3445 | good idea to group cache_peer_access directives for the same peer | |
3446 | together. | |
3447 | ||
3448 | A single cache_peer_access directive may be evaluated multiple times | |
3449 | for a given transaction because individual peer selection algorithms | |
3450 | may check it independently from each other. These redundant checks | |
3451 | may be optimized away in future Squid versions. | |
3452 | ||
3453 | This clause only supports fast acl types. | |
3454 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
dd9b1776 | 3455 | |
41bd17a4 | 3456 | DOC_END |
dd9b1776 | 3457 | |
41bd17a4 | 3458 | NAME: neighbor_type_domain |
3459 | TYPE: hostdomaintype | |
3460 | DEFAULT: none | |
638402dd | 3461 | DEFAULT_DOC: The peer type from cache_peer directive is used for all requests to that peer. |
41bd17a4 | 3462 | LOC: none |
3463 | DOC_START | |
638402dd AJ |
3464 | Modify the cache_peer neighbor type when passing requests |
3465 | about specific domains to the peer. | |
cccac0a2 | 3466 | |
638402dd AJ |
3467 | Usage: |
3468 | neighbor_type_domain neighbor parent|sibling domain domain ... | |
6bf4f823 | 3469 | |
638402dd AJ |
3470 | For example: |
3471 | cache_peer foo.example.com parent 3128 3130 | |
3472 | neighbor_type_domain foo.example.com sibling .au .de | |
6bf4f823 | 3473 | |
638402dd AJ |
3474 | The above configuration treats all requests to foo.example.com as a |
3475 | parent proxy unless the request is for a .au or .de ccTLD domain name. | |
41bd17a4 | 3476 | DOC_END |
6bf4f823 | 3477 | |
41bd17a4 | 3478 | NAME: dead_peer_timeout |
3479 | COMMENT: (seconds) | |
3480 | DEFAULT: 10 seconds | |
3481 | TYPE: time_t | |
3482 | LOC: Config.Timeout.deadPeer | |
3483 | DOC_START | |
3484 | This controls how long Squid waits to declare a peer cache | |
3485 | as "dead." If there are no ICP replies received in this | |
3486 | amount of time, Squid will declare the peer dead and not | |
3487 | expect to receive any further ICP replies. However, it | |
3488 | continues to send ICP queries, and will mark the peer as | |
3489 | alive upon receipt of the first subsequent ICP reply. | |
699acd19 | 3490 | |
41bd17a4 | 3491 | This timeout also affects when Squid expects to receive ICP |
3492 | replies from peers. If more than 'dead_peer' seconds have | |
3493 | passed since the last ICP reply was received, Squid will not | |
3494 | expect to receive an ICP reply on the next query. Thus, if | |
3495 | your time between requests is greater than this timeout, you | |
3496 | will see a lot of requests sent DIRECT to origin servers | |
3497 | instead of to your parents. | |
3498 | DOC_END | |
cccac0a2 | 3499 | |
437823b4 | 3500 | NAME: forward_max_tries |
6c367206 | 3501 | DEFAULT: 25 |
437823b4 AJ |
3502 | TYPE: int |
3503 | LOC: Config.forward_max_tries | |
3504 | DOC_START | |
3505 | Controls how many different forward paths Squid will try | |
3506 | before giving up. See also forward_timeout. | |
31ef19cd AJ |
3507 | |
3508 | NOTE: connect_retries (default: none) can make each of these | |
3509 | possible forwarding paths be tried multiple times. | |
437823b4 AJ |
3510 | DOC_END |
3511 | ||
41bd17a4 | 3512 | COMMENT_START |
3513 | MEMORY CACHE OPTIONS | |
3514 | ----------------------------------------------------------------------------- | |
3515 | COMMENT_END | |
3516 | ||
3517 | NAME: cache_mem | |
3518 | COMMENT: (bytes) | |
3519 | TYPE: b_size_t | |
df2eec10 | 3520 | DEFAULT: 256 MB |
41bd17a4 | 3521 | LOC: Config.memMaxSize |
6b698a21 | 3522 | DOC_START |
41bd17a4 | 3523 | NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS SIZE. |
3524 | IT ONLY PLACES A LIMIT ON HOW MUCH ADDITIONAL MEMORY SQUID WILL | |
3525 | USE AS A MEMORY CACHE OF OBJECTS. SQUID USES MEMORY FOR OTHER | |
3526 | THINGS AS WELL. SEE THE SQUID FAQ SECTION 8 FOR DETAILS. | |
3527 | ||
3528 | 'cache_mem' specifies the ideal amount of memory to be used | |
3529 | for: | |
3530 | * In-Transit objects | |
3531 | * Hot Objects | |
3532 | * Negative-Cached objects | |
3533 | ||
3534 | Data for these objects are stored in 4 KB blocks. This | |
3535 | parameter specifies the ideal upper limit on the total size of | |
3536 | 4 KB blocks allocated. In-Transit objects take the highest | |
3537 | priority. | |
3538 | ||
3539 | In-transit objects have priority over the others. When | |
3540 | additional space is needed for incoming data, negative-cached | |
3541 | and hot objects will be released. In other words, the | |
3542 | negative-cached and hot objects will fill up any unused space | |
3543 | not needed for in-transit objects. | |
3544 | ||
3545 | If circumstances require, this limit will be exceeded. | |
3546 | Specifically, if your incoming request rate requires more than | |
3547 | 'cache_mem' of memory to hold in-transit objects, Squid will | |
3548 | exceed this limit to satisfy the new requests. When the load | |
3549 | decreases, blocks will be freed until the high-water mark is | |
3550 | reached. Thereafter, blocks will be used to store hot | |
3551 | objects. | |
29f35ca5 AR |
3552 | |
3553 | If shared memory caching is enabled, Squid does not use the shared | |
3554 | cache space for in-transit objects, but they still consume as much | |
3555 | local memory as they need. For more details about the shared memory | |
3556 | cache, see memory_cache_shared. | |
6b698a21 | 3557 | DOC_END |
0976f8db | 3558 | |
41bd17a4 | 3559 | NAME: maximum_object_size_in_memory |
3560 | COMMENT: (bytes) | |
3561 | TYPE: b_size_t | |
df2eec10 | 3562 | DEFAULT: 512 KB |
41bd17a4 | 3563 | LOC: Config.Store.maxInMemObjSize |
6b698a21 | 3564 | DOC_START |
41bd17a4 | 3565 | Objects greater than this size will not be attempted to kept in |
3566 | the memory cache. This should be set high enough to keep objects | |
3567 | accessed frequently in memory to improve performance whilst low | |
3568 | enough to keep larger objects from hoarding cache_mem. | |
6b698a21 | 3569 | DOC_END |
0976f8db | 3570 | |
57af1e3f AR |
3571 | NAME: memory_cache_shared |
3572 | COMMENT: on|off | |
3573 | TYPE: YesNoNone | |
3574 | LOC: Config.memShared | |
3575 | DEFAULT: none | |
70f856bc | 3576 | DEFAULT_DOC: "on" where supported if doing memory caching with multiple SMP workers. |
57af1e3f AR |
3577 | DOC_START |
3578 | Controls whether the memory cache is shared among SMP workers. | |
3579 | ||
70f856bc AR |
3580 | The shared memory cache is meant to occupy cache_mem bytes and replace |
3581 | the non-shared memory cache, although some entities may still be | |
3582 | cached locally by workers for now (e.g., internal and in-transit | |
3583 | objects may be served from a local memory cache even if shared memory | |
3584 | caching is enabled). | |
3585 | ||
65b81b27 | 3586 | By default, the memory cache is shared if and only if all of the |
70f856bc AR |
3587 | following conditions are satisfied: Squid runs in SMP mode with |
3588 | multiple workers, cache_mem is positive, and Squid environment | |
3589 | supports required IPC primitives (e.g., POSIX shared memory segments | |
3590 | and GCC-style atomic operations). | |
3591 | ||
3592 | To avoid blocking locks, shared memory uses opportunistic algorithms | |
3593 | that do not guarantee that every cachable entity that could have been | |
3594 | shared among SMP workers will actually be shared. | |
3595 | ||
3596 | Currently, entities exceeding 32KB in size cannot be shared. | |
57af1e3f AR |
3597 | DOC_END |
3598 | ||
ea21d497 HN |
3599 | NAME: memory_cache_mode |
3600 | TYPE: memcachemode | |
3601 | LOC: Config | |
3602 | DEFAULT: always | |
638402dd | 3603 | DEFAULT_DOC: Keep the most recently fetched objects in memory |
ff4b33f4 | 3604 | DOC_START |
ea21d497 | 3605 | Controls which objects to keep in the memory cache (cache_mem) |
ff4b33f4 | 3606 | |
ea21d497 HN |
3607 | always Keep most recently fetched objects in memory (default) |
3608 | ||
3609 | disk Only disk cache hits are kept in memory, which means | |
3610 | an object must first be cached on disk and then hit | |
3611 | a second time before cached in memory. | |
3612 | ||
3613 | network Only objects fetched from network is kept in memory | |
ff4b33f4 HN |
3614 | DOC_END |
3615 | ||
41bd17a4 | 3616 | NAME: memory_replacement_policy |
3617 | TYPE: removalpolicy | |
3618 | LOC: Config.memPolicy | |
3619 | DEFAULT: lru | |
6b698a21 | 3620 | DOC_START |
41bd17a4 | 3621 | The memory replacement policy parameter determines which |
3622 | objects are purged from memory when memory space is needed. | |
7f7db318 | 3623 | |
638402dd | 3624 | See cache_replacement_policy for details on algorithms. |
41bd17a4 | 3625 | DOC_END |
6b698a21 | 3626 | |
41bd17a4 | 3627 | COMMENT_START |
3628 | DISK CACHE OPTIONS | |
3629 | ----------------------------------------------------------------------------- | |
3630 | COMMENT_END | |
6b698a21 | 3631 | |
41bd17a4 | 3632 | NAME: cache_replacement_policy |
3633 | TYPE: removalpolicy | |
3634 | LOC: Config.replPolicy | |
3635 | DEFAULT: lru | |
3636 | DOC_START | |
3637 | The cache replacement policy parameter determines which | |
3638 | objects are evicted (replaced) when disk space is needed. | |
6b698a21 | 3639 | |
41bd17a4 | 3640 | lru : Squid's original list based LRU policy |
3641 | heap GDSF : Greedy-Dual Size Frequency | |
3642 | heap LFUDA: Least Frequently Used with Dynamic Aging | |
3643 | heap LRU : LRU policy implemented using a heap | |
6b698a21 | 3644 | |
638402dd | 3645 | Applies to any cache_dir lines listed below this directive. |
7f7db318 | 3646 | |
41bd17a4 | 3647 | The LRU policies keeps recently referenced objects. |
0976f8db | 3648 | |
41bd17a4 | 3649 | The heap GDSF policy optimizes object hit rate by keeping smaller |
3650 | popular objects in cache so it has a better chance of getting a | |
3651 | hit. It achieves a lower byte hit rate than LFUDA though since | |
3652 | it evicts larger (possibly popular) objects. | |
0976f8db | 3653 | |
41bd17a4 | 3654 | The heap LFUDA policy keeps popular objects in cache regardless of |
3655 | their size and thus optimizes byte hit rate at the expense of | |
3656 | hit rate since one large, popular object will prevent many | |
3657 | smaller, slightly less popular objects from being cached. | |
0976f8db | 3658 | |
41bd17a4 | 3659 | Both policies utilize a dynamic aging mechanism that prevents |
3660 | cache pollution that can otherwise occur with frequency-based | |
3661 | replacement policies. | |
7d90757b | 3662 | |
41bd17a4 | 3663 | NOTE: if using the LFUDA replacement policy you should increase |
b51ec8c8 | 3664 | the value of maximum_object_size above its default of 4 MB to |
41bd17a4 | 3665 | to maximize the potential byte hit rate improvement of LFUDA. |
dc1af3cf | 3666 | |
41bd17a4 | 3667 | For more information about the GDSF and LFUDA cache replacement |
3668 | policies see http://www.hpl.hp.com/techreports/1999/HPL-1999-69.html | |
3669 | and http://fog.hpl.external.hp.com/techreports/98/HPL-98-173.html. | |
6b698a21 | 3670 | DOC_END |
0976f8db | 3671 | |
a345387f AJ |
3672 | NAME: minimum_object_size |
3673 | COMMENT: (bytes) | |
3674 | TYPE: b_int64_t | |
3675 | DEFAULT: 0 KB | |
3676 | DEFAULT_DOC: no limit | |
3677 | LOC: Config.Store.minObjectSize | |
3678 | DOC_START | |
3679 | Objects smaller than this size will NOT be saved on disk. The | |
3680 | value is specified in bytes, and the default is 0 KB, which | |
3681 | means all responses can be stored. | |
3682 | DOC_END | |
3683 | ||
3684 | NAME: maximum_object_size | |
3685 | COMMENT: (bytes) | |
3686 | TYPE: b_int64_t | |
3687 | DEFAULT: 4 MB | |
3688 | LOC: Config.Store.maxObjectSize | |
3689 | DOC_START | |
499f852c | 3690 | Set the default value for max-size parameter on any cache_dir. |
a345387f AJ |
3691 | The value is specified in bytes, and the default is 4 MB. |
3692 | ||
3693 | If you wish to get a high BYTES hit ratio, you should probably | |
3694 | increase this (one 32 MB object hit counts for 3200 10KB | |
3695 | hits). | |
3696 | ||
3697 | If you wish to increase hit ratio more than you want to | |
3698 | save bandwidth you should leave this low. | |
3699 | ||
3700 | NOTE: if using the LFUDA replacement policy you should increase | |
3701 | this value to maximize the byte hit rate improvement of LFUDA! | |
3702 | See cache_replacement_policy for a discussion of this policy. | |
3703 | DOC_END | |
3704 | ||
41bd17a4 | 3705 | NAME: cache_dir |
3706 | TYPE: cachedir | |
3707 | DEFAULT: none | |
638402dd | 3708 | DEFAULT_DOC: No disk cache. Store cache ojects only in memory. |
41bd17a4 | 3709 | LOC: Config.cacheSwap |
6b698a21 | 3710 | DOC_START |
638402dd AJ |
3711 | Format: |
3712 | cache_dir Type Directory-Name Fs-specific-data [options] | |
0976f8db | 3713 | |
41bd17a4 | 3714 | You can specify multiple cache_dir lines to spread the |
3715 | cache among different disk partitions. | |
0976f8db | 3716 | |
41bd17a4 | 3717 | Type specifies the kind of storage system to use. Only "ufs" |
3718 | is built by default. To enable any of the other storage systems | |
3719 | see the --enable-storeio configure option. | |
0976f8db | 3720 | |
41bd17a4 | 3721 | 'Directory' is a top-level directory where cache swap |
3722 | files will be stored. If you want to use an entire disk | |
3723 | for caching, this can be the mount-point directory. | |
3724 | The directory must exist and be writable by the Squid | |
3725 | process. Squid will NOT create this directory for you. | |
0976f8db | 3726 | |
acf69d74 AJ |
3727 | In SMP configurations, cache_dir must not precede the workers option |
3728 | and should use configuration macros or conditionals to give each | |
3729 | worker interested in disk caching a dedicated cache directory. | |
3730 | ||
638402dd AJ |
3731 | |
3732 | ==== The ufs store type ==== | |
0976f8db | 3733 | |
41bd17a4 | 3734 | "ufs" is the old well-known Squid storage format that has always |
3735 | been there. | |
0976f8db | 3736 | |
638402dd AJ |
3737 | Usage: |
3738 | cache_dir ufs Directory-Name Mbytes L1 L2 [options] | |
0976f8db | 3739 | |
41bd17a4 | 3740 | 'Mbytes' is the amount of disk space (MB) to use under this |
3741 | directory. The default is 100 MB. Change this to suit your | |
3742 | configuration. Do NOT put the size of your disk drive here. | |
3743 | Instead, if you want Squid to use the entire disk drive, | |
3744 | subtract 20% and use that value. | |
0976f8db | 3745 | |
56fba4d0 | 3746 | 'L1' is the number of first-level subdirectories which |
41bd17a4 | 3747 | will be created under the 'Directory'. The default is 16. |
0976f8db | 3748 | |
56fba4d0 | 3749 | 'L2' is the number of second-level subdirectories which |
41bd17a4 | 3750 | will be created under each first-level directory. The default |
3751 | is 256. | |
0976f8db | 3752 | |
638402dd AJ |
3753 | |
3754 | ==== The aufs store type ==== | |
7f7db318 | 3755 | |
41bd17a4 | 3756 | "aufs" uses the same storage format as "ufs", utilizing |
3757 | POSIX-threads to avoid blocking the main Squid process on | |
3758 | disk-I/O. This was formerly known in Squid as async-io. | |
38f9c547 | 3759 | |
638402dd AJ |
3760 | Usage: |
3761 | cache_dir aufs Directory-Name Mbytes L1 L2 [options] | |
38f9c547 | 3762 | |
41bd17a4 | 3763 | see argument descriptions under ufs above |
38f9c547 | 3764 | |
638402dd AJ |
3765 | |
3766 | ==== The diskd store type ==== | |
38f9c547 | 3767 | |
41bd17a4 | 3768 | "diskd" uses the same storage format as "ufs", utilizing a |
3769 | separate process to avoid blocking the main Squid process on | |
3770 | disk-I/O. | |
4c3ef9b2 | 3771 | |
638402dd AJ |
3772 | Usage: |
3773 | cache_dir diskd Directory-Name Mbytes L1 L2 [options] [Q1=n] [Q2=n] | |
0976f8db | 3774 | |
41bd17a4 | 3775 | see argument descriptions under ufs above |
0976f8db | 3776 | |
41bd17a4 | 3777 | Q1 specifies the number of unacknowledged I/O requests when Squid |
3778 | stops opening new files. If this many messages are in the queues, | |
3779 | Squid won't open new files. Default is 64 | |
0976f8db | 3780 | |
41bd17a4 | 3781 | Q2 specifies the number of unacknowledged messages when Squid |
3782 | starts blocking. If this many messages are in the queues, | |
3783 | Squid blocks until it receives some replies. Default is 72 | |
0976f8db | 3784 | |
41bd17a4 | 3785 | When Q1 < Q2 (the default), the cache directory is optimized |
3786 | for lower response time at the expense of a decrease in hit | |
3787 | ratio. If Q1 > Q2, the cache directory is optimized for | |
3788 | higher hit ratio at the expense of an increase in response | |
3789 | time. | |
0976f8db | 3790 | |
e2851fe7 | 3791 | |
638402dd AJ |
3792 | ==== The rock store type ==== |
3793 | ||
3794 | Usage: | |
e51ce7da | 3795 | cache_dir rock Directory-Name Mbytes [options] |
e2851fe7 | 3796 | |
2e55f083 | 3797 | The Rock Store type is a database-style storage. All cached |
e51ce7da AR |
3798 | entries are stored in a "database" file, using fixed-size slots. |
3799 | A single entry occupies one or more slots. | |
e2851fe7 | 3800 | |
3e1dfe3d AR |
3801 | If possible, Squid using Rock Store creates a dedicated kid |
3802 | process called "disker" to avoid blocking Squid worker(s) on disk | |
3803 | I/O. One disker kid is created for each rock cache_dir. Diskers | |
3804 | are created only when Squid, running in daemon mode, has support | |
3805 | for the IpcIo disk I/O module. | |
3806 | ||
43ebbac3 AR |
3807 | swap-timeout=msec: Squid will not start writing a miss to or |
3808 | reading a hit from disk if it estimates that the swap operation | |
3809 | will take more than the specified number of milliseconds. By | |
3810 | default and when set to zero, disables the disk I/O time limit | |
3811 | enforcement. Ignored when using blocking I/O module because | |
3812 | blocking synchronous I/O does not allow Squid to estimate the | |
3813 | expected swap wait time. | |
3814 | ||
df881a0f | 3815 | max-swap-rate=swaps/sec: Artificially limits disk access using |
1e614370 | 3816 | the specified I/O rate limit. Swap out requests that |
df881a0f | 3817 | would cause the average I/O rate to exceed the limit are |
1e614370 DK |
3818 | delayed. Individual swap in requests (i.e., hits or reads) are |
3819 | not delayed, but they do contribute to measured swap rate and | |
3820 | since they are placed in the same FIFO queue as swap out | |
3821 | requests, they may wait longer if max-swap-rate is smaller. | |
3822 | This is necessary on file systems that buffer "too | |
df881a0f AR |
3823 | many" writes and then start blocking Squid and other processes |
3824 | while committing those writes to disk. Usually used together | |
3825 | with swap-timeout to avoid excessive delays and queue overflows | |
3826 | when disk demand exceeds available disk "bandwidth". By default | |
3827 | and when set to zero, disables the disk I/O rate limit | |
3828 | enforcement. Currently supported by IpcIo module only. | |
3829 | ||
e51ce7da AR |
3830 | slot-size=bytes: The size of a database "record" used for |
3831 | storing cached responses. A cached response occupies at least | |
3832 | one slot and all database I/O is done using individual slots so | |
3833 | increasing this parameter leads to more disk space waste while | |
3834 | decreasing it leads to more disk I/O overheads. Should be a | |
3835 | multiple of your operating system I/O page size. Defaults to | |
3836 | 16KBytes. A housekeeping header is stored with each slot and | |
3837 | smaller slot-sizes will be rejected. The header is smaller than | |
3838 | 100 bytes. | |
3839 | ||
df881a0f | 3840 | |
638402dd | 3841 | ==== COMMON OPTIONS ==== |
0976f8db | 3842 | |
638402dd AJ |
3843 | no-store no new objects should be stored to this cache_dir. |
3844 | ||
3845 | min-size=n the minimum object size in bytes this cache_dir | |
3846 | will accept. It's used to restrict a cache_dir | |
3847 | to only store large objects (e.g. AUFS) while | |
3848 | other stores are optimized for smaller objects | |
73656056 | 3849 | (e.g. Rock). |
638402dd | 3850 | Defaults to 0. |
0976f8db | 3851 | |
638402dd AJ |
3852 | max-size=n the maximum object size in bytes this cache_dir |
3853 | supports. | |
499f852c A |
3854 | The value in maximum_object_size directive sets |
3855 | the default unless more specific details are | |
3856 | available (ie a small store capacity). | |
b6662ffd | 3857 | |
41bd17a4 | 3858 | Note: To make optimal use of the max-size limits you should order |
638402dd | 3859 | the cache_dir lines with the smallest max-size value first. |
0976f8db | 3860 | |
bebc043b | 3861 | NOCOMMENT_START |
e0855596 AJ |
3862 | |
3863 | # Uncomment and adjust the following to add a disk cache directory. | |
3864 | #cache_dir ufs @DEFAULT_SWAP_DIR@ 100 16 256 | |
bebc043b | 3865 | NOCOMMENT_END |
6b698a21 | 3866 | DOC_END |
0976f8db | 3867 | |
41bd17a4 | 3868 | NAME: store_dir_select_algorithm |
3869 | TYPE: string | |
3870 | LOC: Config.store_dir_select_algorithm | |
3871 | DEFAULT: least-load | |
6b698a21 | 3872 | DOC_START |
638402dd AJ |
3873 | How Squid selects which cache_dir to use when the response |
3874 | object will fit into more than one. | |
3875 | ||
3876 | Regardless of which algorithm is used the cache_dir min-size | |
3877 | and max-size parameters are obeyed. As such they can affect | |
3878 | the selection algorithm by limiting the set of considered | |
3879 | cache_dir. | |
3880 | ||
3881 | Algorithms: | |
3882 | ||
3883 | least-load | |
3884 | ||
3885 | This algorithm is suited to caches with similar cache_dir | |
3886 | sizes and disk speeds. | |
3887 | ||
3888 | The disk with the least I/O pending is selected. | |
3889 | When there are multiple disks with the same I/O load ranking | |
3890 | the cache_dir with most available capacity is selected. | |
3891 | ||
3892 | When a mix of cache_dir sizes are configured the faster disks | |
3893 | have a naturally lower I/O loading and larger disks have more | |
3894 | capacity. So space used to store objects and data throughput | |
3895 | may be very unbalanced towards larger disks. | |
3896 | ||
3897 | ||
3898 | round-robin | |
3899 | ||
3900 | This algorithm is suited to caches with unequal cache_dir | |
3901 | disk sizes. | |
3902 | ||
3903 | Each cache_dir is selected in a rotation. The next suitable | |
3904 | cache_dir is used. | |
3905 | ||
3906 | Available cache_dir capacity is only considered in relation | |
3907 | to whether the object will fit and meets the min-size and | |
3908 | max-size parameters. | |
3909 | ||
3910 | Disk I/O loading is only considered to prevent overload on slow | |
3911 | disks. This algorithm does not spread objects by size, so any | |
3912 | I/O loading per-disk may appear very unbalanced and volatile. | |
3913 | ||
29a238a3 AR |
3914 | If several cache_dirs use similar min-size, max-size, or other |
3915 | limits to to reject certain responses, then do not group such | |
3916 | cache_dir lines together, to avoid round-robin selection bias | |
3917 | towards the first cache_dir after the group. Instead, interleave | |
3918 | cache_dir lines from different groups. For example: | |
3919 | ||
3920 | store_dir_select_algorithm round-robin | |
3921 | cache_dir rock /hdd1 ... min-size=100000 | |
3922 | cache_dir rock /ssd1 ... max-size=99999 | |
3923 | cache_dir rock /hdd2 ... min-size=100000 | |
3924 | cache_dir rock /ssd2 ... max-size=99999 | |
3925 | cache_dir rock /hdd3 ... min-size=100000 | |
3926 | cache_dir rock /ssd3 ... max-size=99999 | |
6b698a21 | 3927 | DOC_END |
0976f8db | 3928 | |
41bd17a4 | 3929 | NAME: max_open_disk_fds |
3930 | TYPE: int | |
3931 | LOC: Config.max_open_disk_fds | |
3932 | DEFAULT: 0 | |
638402dd | 3933 | DEFAULT_DOC: no limit |
6b698a21 | 3934 | DOC_START |
41bd17a4 | 3935 | To avoid having disk as the I/O bottleneck Squid can optionally |
3936 | bypass the on-disk cache if more than this amount of disk file | |
3937 | descriptors are open. | |
3938 | ||
3939 | A value of 0 indicates no limit. | |
6b698a21 | 3940 | DOC_END |
0976f8db | 3941 | |
41bd17a4 | 3942 | NAME: cache_swap_low |
3943 | COMMENT: (percent, 0-100) | |
5473c134 | 3944 | TYPE: int |
41bd17a4 | 3945 | DEFAULT: 90 |
3946 | LOC: Config.Swap.lowWaterMark | |
638402dd | 3947 | DOC_START |
5f662601 AJ |
3948 | The low-water mark for AUFS/UFS/diskd cache object eviction by |
3949 | the cache_replacement_policy algorithm. | |
3950 | ||
3951 | Removal begins when the swap (disk) usage of a cache_dir is | |
3952 | above this low-water mark and attempts to maintain utilization | |
3953 | near the low-water mark. | |
3954 | ||
3955 | As swap utilization increases towards the high-water mark set | |
3956 | by cache_swap_high object eviction becomes more agressive. | |
3957 | ||
3958 | The value difference in percentages between low- and high-water | |
7bcaf76f | 3959 | marks represent an eviction rate of 300 objects per second and |
5f662601 AJ |
3960 | the rate continues to scale in agressiveness by multiples of |
3961 | this above the high-water mark. | |
638402dd AJ |
3962 | |
3963 | Defaults are 90% and 95%. If you have a large cache, 5% could be | |
3964 | hundreds of MB. If this is the case you may wish to set these | |
3965 | numbers closer together. | |
3966 | ||
5f662601 | 3967 | See also cache_swap_high and cache_replacement_policy |
638402dd | 3968 | DOC_END |
41bd17a4 | 3969 | |
3970 | NAME: cache_swap_high | |
3971 | COMMENT: (percent, 0-100) | |
3972 | TYPE: int | |
3973 | DEFAULT: 95 | |
3974 | LOC: Config.Swap.highWaterMark | |
6b698a21 | 3975 | DOC_START |
5f662601 AJ |
3976 | The high-water mark for AUFS/UFS/diskd cache object eviction by |
3977 | the cache_replacement_policy algorithm. | |
3978 | ||
3979 | Removal begins when the swap (disk) usage of a cache_dir is | |
3980 | above the low-water mark set by cache_swap_low and attempts to | |
3981 | maintain utilization near the low-water mark. | |
3982 | ||
3983 | As swap utilization increases towards this high-water mark object | |
3984 | eviction becomes more agressive. | |
3985 | ||
3986 | The value difference in percentages between low- and high-water | |
7bcaf76f | 3987 | marks represent an eviction rate of 300 objects per second and |
5f662601 AJ |
3988 | the rate continues to scale in agressiveness by multiples of |
3989 | this above the high-water mark. | |
41bd17a4 | 3990 | |
3991 | Defaults are 90% and 95%. If you have a large cache, 5% could be | |
3992 | hundreds of MB. If this is the case you may wish to set these | |
3993 | numbers closer together. | |
638402dd | 3994 | |
5f662601 | 3995 | See also cache_swap_low and cache_replacement_policy |
6b698a21 | 3996 | DOC_END |
0976f8db | 3997 | |
5473c134 | 3998 | COMMENT_START |
41bd17a4 | 3999 | LOGFILE OPTIONS |
5473c134 | 4000 | ----------------------------------------------------------------------------- |
4001 | COMMENT_END | |
0976f8db | 4002 | |
41bd17a4 | 4003 | NAME: logformat |
4004 | TYPE: logformat | |
20efa1c2 | 4005 | LOC: Log::TheConfig |
5473c134 | 4006 | DEFAULT: none |
638402dd | 4007 | DEFAULT_DOC: The format definitions squid, common, combined, referrer, useragent are built in. |
6b698a21 | 4008 | DOC_START |
41bd17a4 | 4009 | Usage: |
0976f8db | 4010 | |
41bd17a4 | 4011 | logformat <name> <format specification> |
0976f8db | 4012 | |
41bd17a4 | 4013 | Defines an access log format. |
6b698a21 | 4014 | |
41bd17a4 | 4015 | The <format specification> is a string with embedded % format codes |
5473c134 | 4016 | |
41bd17a4 | 4017 | % format codes all follow the same basic structure where all but |
4018 | the formatcode is optional. Output strings are automatically escaped | |
4019 | as required according to their context and the output format | |
4020 | modifiers are usually not needed, but can be specified if an explicit | |
4021 | output format is desired. | |
6b698a21 | 4022 | |
95d78f10 | 4023 | % ["|[|'|#|/] [-] [[0]width] [{arg}] formatcode [{arg}] |
0976f8db | 4024 | |
41bd17a4 | 4025 | " output in quoted string format |
4026 | [ output in squid text log format as used by log_mime_hdrs | |
4027 | # output in URL quoted format | |
95d78f10 | 4028 | / output in shell \-escaped format |
41bd17a4 | 4029 | ' output as-is |
5473c134 | 4030 | |
41bd17a4 | 4031 | - left aligned |
c32c6db7 AR |
4032 | |
4033 | width minimum and/or maximum field width: | |
4034 | [width_min][.width_max] | |
e2851fe7 AR |
4035 | When minimum starts with 0, the field is zero-padded. |
4036 | String values exceeding maximum width are truncated. | |
c32c6db7 | 4037 | |
4e56d7f6 AJ |
4038 | {arg} argument such as header name etc. This field may be |
4039 | placed before or after the token, but not both at once. | |
5473c134 | 4040 | |
41bd17a4 | 4041 | Format codes: |
5473c134 | 4042 | |
3ff65596 | 4043 | % a literal % character |
f4b68e1a AJ |
4044 | sn Unique sequence number per log line entry |
4045 | err_code The ID of an error response served by Squid or | |
4046 | a similar internal error identifier. | |
4047 | err_detail Additional err_code-dependent error information. | |
c7bcf010 | 4048 | note The annotation specified by the argument. Also |
d7f4a0b7 CT |
4049 | logs the adaptation meta headers set by the |
4050 | adaptation_meta configuration parameter. | |
c7bcf010 CT |
4051 | If no argument given all annotations logged. |
4052 | The argument may include a separator to use with | |
4053 | annotation values: | |
4054 | name[:separator] | |
4055 | By default, multiple note values are separated with "," | |
4056 | and multiple notes are separated with "\r\n". | |
4057 | When logging named notes with %{name}note, the | |
4058 | explicitly configured separator is used between note | |
4059 | values. When logging all notes with %note, the | |
4060 | explicitly configured separator is used between | |
4061 | individual notes. There is currently no way to | |
4062 | specify both value and notes separators when logging | |
4063 | all notes with %note. | |
f4b68e1a AJ |
4064 | |
4065 | Connection related format codes: | |
4066 | ||
41bd17a4 | 4067 | >a Client source IP address |
4068 | >A Client FQDN | |
4069 | >p Client source port | |
8652f8e7 AJ |
4070 | >eui Client source EUI (MAC address, EUI-48 or EUI-64 identifier) |
4071 | >la Local IP address the client connected to | |
4072 | >lp Local port number the client connected to | |
f123f5e9 CT |
4073 | >qos Client connection TOS/DSCP value set by Squid |
4074 | >nfmark Client connection netfilter mark set by Squid | |
8652f8e7 | 4075 | |
28417506 CT |
4076 | la Local listening IP address the client connection was connected to. |
4077 | lp Local listening port number the client connection was connected to. | |
4078 | ||
8652f8e7 AJ |
4079 | <a Server IP address of the last server or peer connection |
4080 | <A Server FQDN or peer name | |
4081 | <p Server port number of the last server or peer connection | |
c3a082ae | 4082 | <la Local IP address of the last server or peer connection |
152e24b3 | 4083 | <lp Local port number of the last server or peer connection |
f123f5e9 CT |
4084 | <qos Server connection TOS/DSCP value set by Squid |
4085 | <nfmark Server connection netfilter mark set by Squid | |
f4b68e1a AJ |
4086 | |
4087 | Time related format codes: | |
4088 | ||
41bd17a4 | 4089 | ts Seconds since epoch |
4090 | tu subsecond time (milliseconds) | |
4091 | tl Local time. Optional strftime format argument | |
3ff65596 | 4092 | default %d/%b/%Y:%H:%M:%S %z |
41bd17a4 | 4093 | tg GMT time. Optional strftime format argument |
3ff65596 | 4094 | default %d/%b/%Y:%H:%M:%S %z |
41bd17a4 | 4095 | tr Response time (milliseconds) |
3ff65596 | 4096 | dt Total time spent making DNS lookups (milliseconds) |
af0ded40 CT |
4097 | tS Approximate master transaction start time in |
4098 | <full seconds since epoch>.<fractional seconds> format. | |
4099 | Currently, Squid considers the master transaction | |
4100 | started when a complete HTTP request header initiating | |
4101 | the transaction is received from the client. This is | |
4102 | the same value that Squid uses to calculate transaction | |
4103 | response time when logging %tr to access.log. Currently, | |
4104 | Squid uses millisecond resolution for %tS values, | |
4105 | similar to the default access.log "current time" field | |
4106 | (%ts.%03tu). | |
3ff65596 | 4107 | |
8652f8e7 AJ |
4108 | Access Control related format codes: |
4109 | ||
4110 | et Tag returned by external acl | |
4111 | ea Log string returned by external acl | |
4112 | un User name (any available) | |
4113 | ul User name from authentication | |
4114 | ue User name from external acl helper | |
4115 | ui User name from ident | |
50b5c983 AJ |
4116 | un A user name. Expands to the first available name |
4117 | from the following list of information sources: | |
4118 | - authenticated user name, like %ul | |
4119 | - user name supplied by an external ACL, like %ue | |
4120 | - SSL client name, like %us | |
4121 | - ident user name, like %ui | |
d4806c91 CT |
4122 | credentials Client credentials. The exact meaning depends on |
4123 | the authentication scheme: For Basic authentication, | |
4124 | it is the password; for Digest, the realm sent by the | |
4125 | client; for NTLM and Negotiate, the client challenge | |
4126 | or client credentials prefixed with "YR " or "KK ". | |
8652f8e7 AJ |
4127 | |
4128 | HTTP related format codes: | |
3ff65596 | 4129 | |
d6df21d2 AJ |
4130 | REQUEST |
4131 | ||
4132 | [http::]rm Request method (GET/POST etc) | |
4133 | [http::]>rm Request method from client | |
4134 | [http::]<rm Request method sent to server or peer | |
4135 | [http::]ru Request URL from client (historic, filtered for logging) | |
4136 | [http::]>ru Request URL from client | |
4137 | [http::]<ru Request URL sent to server or peer | |
5aca9cf2 AJ |
4138 | [http::]>rs Request URL scheme from client |
4139 | [http::]<rs Request URL scheme sent to server or peer | |
fa450988 | 4140 | [http::]>rd Request URL domain from client |
f42ac6e6 | 4141 | [http::]<rd Request URL domain sent to server or peer |
5aca9cf2 AJ |
4142 | [http::]>rP Request URL port from client |
4143 | [http::]<rP Request URL port sent to server or peer | |
4144 | [http::]rp Request URL path excluding hostname | |
4145 | [http::]>rp Request URL path excluding hostname from client | |
4146 | [http::]<rp Request URL path excluding hostname sent to server or peer | |
d6df21d2 AJ |
4147 | [http::]rv Request protocol version |
4148 | [http::]>rv Request protocol version from client | |
4149 | [http::]<rv Request protocol version sent to server or peer | |
4150 | ||
5aca9cf2 | 4151 | [http::]>h Original received request header. |
19483c50 AR |
4152 | Usually differs from the request header sent by |
4153 | Squid, although most fields are often preserved. | |
4154 | Accepts optional header field name/value filter | |
4155 | argument using name[:[separator]element] format. | |
4156 | [http::]>ha Received request header after adaptation and | |
4157 | redirection (pre-cache REQMOD vectoring point). | |
4158 | Usually differs from the request header sent by | |
4159 | Squid, although most fields are often preserved. | |
6fca33e0 | 4160 | Optional header name argument as for >h |
d6df21d2 | 4161 | |
d6df21d2 AJ |
4162 | RESPONSE |
4163 | ||
4164 | [http::]<Hs HTTP status code received from the next hop | |
4165 | [http::]>Hs HTTP status code sent to the client | |
4166 | ||
3ff65596 AR |
4167 | [http::]<h Reply header. Optional header name argument |
4168 | as for >h | |
d6df21d2 AJ |
4169 | |
4170 | [http::]mt MIME content type | |
4171 | ||
4172 | ||
4173 | SIZE COUNTERS | |
4174 | ||
4175 | [http::]st Total size of request + reply traffic with client | |
4176 | [http::]>st Total size of request received from client. | |
4177 | Excluding chunked encoding bytes. | |
4178 | [http::]<st Total size of reply sent to client (after adaptation) | |
4179 | ||
4180 | [http::]>sh Size of request headers received from client | |
4181 | [http::]<sh Size of reply headers sent to client (after adaptation) | |
4182 | ||
4183 | [http::]<sH Reply high offset sent | |
4184 | [http::]<sS Upstream object size | |
4185 | ||
bae917ac CT |
4186 | [http::]<bs Number of HTTP-equivalent message body bytes |
4187 | received from the next hop, excluding chunked | |
4188 | transfer encoding and control messages. | |
4189 | Generated FTP/Gopher listings are treated as | |
4190 | received bodies. | |
d6df21d2 | 4191 | |
d6df21d2 AJ |
4192 | TIMING |
4193 | ||
3ff65596 AR |
4194 | [http::]<pt Peer response time in milliseconds. The timer starts |
4195 | when the last request byte is sent to the next hop | |
4196 | and stops when the last response byte is received. | |
d5430dc8 | 4197 | [http::]<tt Total time in milliseconds. The timer |
3ff65596 AR |
4198 | starts with the first connect request (or write I/O) |
4199 | sent to the first selected peer. The timer stops | |
4200 | with the last I/O with the last peer. | |
4201 | ||
8652f8e7 AJ |
4202 | Squid handling related format codes: |
4203 | ||
4204 | Ss Squid request status (TCP_MISS etc) | |
4205 | Sh Squid hierarchy status (DEFAULT_PARENT etc) | |
4206 | ||
08097970 AR |
4207 | SSL-related format codes: |
4208 | ||
4209 | ssl::bump_mode SslBump decision for the transaction: | |
4210 | ||
4211 | For CONNECT requests that initiated bumping of | |
4212 | a connection and for any request received on | |
4213 | an already bumped connection, Squid logs the | |
4214 | corresponding SslBump mode ("server-first" or | |
4215 | "client-first"). See the ssl_bump option for | |
4216 | more information about these modes. | |
4217 | ||
4218 | A "none" token is logged for requests that | |
4219 | triggered "ssl_bump" ACL evaluation matching | |
4220 | either a "none" rule or no rules at all. | |
4221 | ||
4222 | In all other cases, a single dash ("-") is | |
4223 | logged. | |
4224 | ||
cedca6e7 CT |
4225 | ssl::>sni SSL client SNI sent to Squid. Available only |
4226 | after the peek, stare, or splice SSL bumping | |
4227 | actions. | |
4228 | ||
c28b9a0e AJ |
4229 | ssl::>cert_subject |
4230 | The Subject field of the received client | |
4231 | SSL certificate or a dash ('-') if Squid has | |
4232 | received an invalid/malformed certificate or | |
4233 | no certificate at all. Consider encoding the | |
4234 | logged value because Subject often has spaces. | |
4235 | ||
4236 | ssl::>cert_issuer | |
4237 | The Issuer field of the received client | |
4238 | SSL certificate or a dash ('-') if Squid has | |
4239 | received an invalid/malformed certificate or | |
4240 | no certificate at all. Consider encoding the | |
4241 | logged value because Issuer often has spaces. | |
4242 | ||
4243 | ssl::<cert_errors | |
4244 | The list of certificate validation errors | |
4245 | detected by Squid (including OpenSSL and | |
4246 | certificate validation helper components). The | |
4247 | errors are listed in the discovery order. By | |
4248 | default, the error codes are separated by ':'. | |
4249 | Accepts an optional separator argument. | |
4250 | ||
2bcab852 CT |
4251 | %ssl::>negotiated_version The negotiated TLS version of the |
4252 | client connection. | |
4253 | ||
4254 | %ssl::<negotiated_version The negotiated TLS version of the | |
4255 | last server or peer connection. | |
4256 | ||
4257 | %ssl::>received_hello_version The TLS version of the Hello | |
4258 | message received from TLS client. | |
4259 | ||
4260 | %ssl::<received_hello_version The TLS version of the Hello | |
4261 | message received from TLS server. | |
4262 | ||
4263 | %ssl::>received_supported_version The maximum TLS version | |
4264 | supported by the TLS client. | |
4265 | ||
4266 | %ssl::<received_supported_version The maximum TLS version | |
4267 | supported by the TLS server. | |
4268 | ||
4269 | %ssl::>negotiated_cipher The negotiated cipher of the | |
4270 | client connection. | |
4271 | ||
4272 | %ssl::<negotiated_cipher The negotiated cipher of the | |
4273 | last server or peer connection. | |
4274 | ||
5038f9d8 | 4275 | If ICAP is enabled, the following code becomes available (as |
3ff65596 AR |
4276 | well as ICAP log codes documented with the icap_log option): |
4277 | ||
4278 | icap::tt Total ICAP processing time for the HTTP | |
4279 | transaction. The timer ticks when ICAP | |
4280 | ACLs are checked and when ICAP | |
4281 | transaction is in progress. | |
4282 | ||
c28b9a0e | 4283 | If adaptation is enabled the following codes become available: |
3ff65596 | 4284 | |
5038f9d8 AR |
4285 | adapt::<last_h The header of the last ICAP response or |
4286 | meta-information from the last eCAP | |
4287 | transaction related to the HTTP transaction. | |
4288 | Like <h, accepts an optional header name | |
4289 | argument. | |
3ff65596 AR |
4290 | |
4291 | adapt::sum_trs Summed adaptation transaction response | |
4292 | times recorded as a comma-separated list in | |
4293 | the order of transaction start time. Each time | |
4294 | value is recorded as an integer number, | |
4295 | representing response time of one or more | |
4296 | adaptation (ICAP or eCAP) transaction in | |
4297 | milliseconds. When a failed transaction is | |
4298 | being retried or repeated, its time is not | |
4299 | logged individually but added to the | |
4300 | replacement (next) transaction. See also: | |
4301 | adapt::all_trs. | |
4302 | ||
4303 | adapt::all_trs All adaptation transaction response times. | |
4304 | Same as adaptation_strs but response times of | |
4305 | individual transactions are never added | |
4306 | together. Instead, all transaction response | |
4307 | times are recorded individually. | |
4308 | ||
4309 | You can prefix adapt::*_trs format codes with adaptation | |
4310 | service name in curly braces to record response time(s) specific | |
4311 | to that service. For example: %{my_service}adapt::sum_trs | |
5473c134 | 4312 | |
7d9acc3c AJ |
4313 | The default formats available (which do not need re-defining) are: |
4314 | ||
bd85ea1f AJ |
4315 | logformat squid %ts.%03tu %6tr %>a %Ss/%03>Hs %<st %rm %ru %[un %Sh/%<a %mt |
4316 | logformat common %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st %Ss:%Sh | |
4317 | logformat combined %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh | |
20efa1c2 AJ |
4318 | logformat referrer %ts.%03tu %>a %{Referer}>h %ru |
4319 | logformat useragent %>a [%tl] "%{User-Agent}>h" | |
4320 | ||
8652f8e7 AJ |
4321 | NOTE: When the log_mime_hdrs directive is set to ON. |
4322 | The squid, common and combined formats have a safely encoded copy | |
4323 | of the mime headers appended to each line within a pair of brackets. | |
4324 | ||
4325 | NOTE: The common and combined formats are not quite true to the Apache definition. | |
4326 | The logs from Squid contain an extra status and hierarchy code appended. | |
20efa1c2 | 4327 | |
5473c134 | 4328 | DOC_END |
4329 | ||
41bd17a4 | 4330 | NAME: access_log cache_access_log |
4331 | TYPE: access_log | |
4332 | LOC: Config.Log.accesslogs | |
82b7abe3 | 4333 | DEFAULT_IF_NONE: daemon:@DEFAULT_ACCESS_LOG@ squid |
5473c134 | 4334 | DOC_START |
fb0c2f17 NH |
4335 | Configures whether and how Squid logs HTTP and ICP transactions. |
4336 | If access logging is enabled, a single line is logged for every | |
4337 | matching HTTP or ICP request. The recommended directive formats are: | |
4338 | ||
4339 | access_log <module>:<place> [option ...] [acl acl ...] | |
4340 | access_log none [acl acl ...] | |
4341 | ||
4342 | The following directive format is accepted but may be deprecated: | |
82b7abe3 | 4343 | access_log <module>:<place> [<logformat name> [acl acl ...]] |
fb0c2f17 NH |
4344 | |
4345 | In most cases, the first ACL name must not contain the '=' character | |
4346 | and should not be equal to an existing logformat name. You can always | |
4347 | start with an 'all' ACL to work around those restrictions. | |
82b7abe3 AJ |
4348 | |
4349 | Will log to the specified module:place using the specified format (which | |
41bd17a4 | 4350 | must be defined in a logformat directive) those entries which match |
4351 | ALL the acl's specified (which must be defined in acl clauses). | |
82b7abe3 AJ |
4352 | If no acl is specified, all requests will be logged to this destination. |
4353 | ||
fb0c2f17 NH |
4354 | ===== Available options for the recommended directive format ===== |
4355 | ||
4356 | logformat=name Names log line format (either built-in or | |
4357 | defined by a logformat directive). Defaults | |
4358 | to 'squid'. | |
4359 | ||
4360 | buffer-size=64KB Defines approximate buffering limit for log | |
4361 | records (see buffered_logs). Squid should not | |
4362 | keep more than the specified size and, hence, | |
4363 | should flush records before the buffer becomes | |
4364 | full to avoid overflows under normal | |
4365 | conditions (the exact flushing algorithm is | |
4366 | module-dependent though). The on-error option | |
4367 | controls overflow handling. | |
4368 | ||
4369 | on-error=die|drop Defines action on unrecoverable errors. The | |
4370 | 'drop' action ignores (i.e., does not log) | |
4371 | affected log records. The default 'die' action | |
4372 | kills the affected worker. The drop action | |
4373 | support has not been tested for modules other | |
4374 | than tcp. | |
4375 | ||
efc23871 AJ |
4376 | rotate=N Specifies the number of log file rotations to |
4377 | make when you run 'squid -k rotate'. The default | |
4378 | is to obey the logfile_rotate directive. Setting | |
4379 | rotate=0 will disable the file name rotation, | |
4380 | but the log files are still closed and re-opened. | |
4381 | This will enable you to rename the logfiles | |
4382 | yourself just before sending the rotate signal. | |
4383 | Only supported by the stdio module. | |
4384 | ||
82b7abe3 AJ |
4385 | ===== Modules Currently available ===== |
4386 | ||
bb7a1781 | 4387 | none Do not log any requests matching these ACL. |
82b7abe3 AJ |
4388 | Do not specify Place or logformat name. |
4389 | ||
4390 | stdio Write each log line to disk immediately at the completion of | |
4391 | each request. | |
4392 | Place: the filename and path to be written. | |
4393 | ||
4394 | daemon Very similar to stdio. But instead of writing to disk the log | |
4395 | line is passed to a daemon helper for asychronous handling instead. | |
4396 | Place: varies depending on the daemon. | |
4397 | ||
4398 | log_file_daemon Place: the file name and path to be written. | |
4399 | ||
4400 | syslog To log each request via syslog facility. | |
4401 | Place: The syslog facility and priority level for these entries. | |
4402 | Place Format: facility.priority | |
5473c134 | 4403 | |
82b7abe3 AJ |
4404 | where facility could be any of: |
4405 | authpriv, daemon, local0 ... local7 or user. | |
5473c134 | 4406 | |
82b7abe3 AJ |
4407 | And priority could be any of: |
4408 | err, warning, notice, info, debug. | |
4409 | ||
4410 | udp To send each log line as text data to a UDP receiver. | |
4411 | Place: The destination host name or IP and port. | |
f4fc8610 | 4412 | Place Format: //host:port |
df2eec10 | 4413 | |
2bf4e8fa | 4414 | tcp To send each log line as text data to a TCP receiver. |
fb0c2f17 | 4415 | Lines may be accumulated before sending (see buffered_logs). |
2bf4e8fa | 4416 | Place: The destination host name or IP and port. |
f4fc8610 | 4417 | Place Format: //host:port |
df2eec10 AJ |
4418 | |
4419 | Default: | |
82b7abe3 | 4420 | access_log daemon:@DEFAULT_ACCESS_LOG@ squid |
41bd17a4 | 4421 | DOC_END |
5473c134 | 4422 | |
3ff65596 AR |
4423 | NAME: icap_log |
4424 | TYPE: access_log | |
4425 | IFDEF: ICAP_CLIENT | |
4426 | LOC: Config.Log.icaplogs | |
4427 | DEFAULT: none | |
4428 | DOC_START | |
4429 | ICAP log files record ICAP transaction summaries, one line per | |
4430 | transaction. | |
4431 | ||
4432 | The icap_log option format is: | |
4433 | icap_log <filepath> [<logformat name> [acl acl ...]] | |
4434 | icap_log none [acl acl ...]] | |
4435 | ||
4436 | Please see access_log option documentation for details. The two | |
4437 | kinds of logs share the overall configuration approach and many | |
4438 | features. | |
4439 | ||
4440 | ICAP processing of a single HTTP message or transaction may | |
4441 | require multiple ICAP transactions. In such cases, multiple | |
4442 | ICAP transaction log lines will correspond to a single access | |
4443 | log line. | |
4444 | ||
4445 | ICAP log uses logformat codes that make sense for an ICAP | |
4446 | transaction. Header-related codes are applied to the HTTP header | |
4447 | embedded in an ICAP server response, with the following caveats: | |
4448 | For REQMOD, there is no HTTP response header unless the ICAP | |
4449 | server performed request satisfaction. For RESPMOD, the HTTP | |
4450 | request header is the header sent to the ICAP server. For | |
4451 | OPTIONS, there are no HTTP headers. | |
4452 | ||
4453 | The following format codes are also available for ICAP logs: | |
4454 | ||
4455 | icap::<A ICAP server IP address. Similar to <A. | |
4456 | ||
4457 | icap::<service_name ICAP service name from the icap_service | |
4458 | option in Squid configuration file. | |
4459 | ||
4460 | icap::ru ICAP Request-URI. Similar to ru. | |
4461 | ||
4462 | icap::rm ICAP request method (REQMOD, RESPMOD, or | |
4463 | OPTIONS). Similar to existing rm. | |
4464 | ||
4465 | icap::>st Bytes sent to the ICAP server (TCP payload | |
4466 | only; i.e., what Squid writes to the socket). | |
4467 | ||
4468 | icap::<st Bytes received from the ICAP server (TCP | |
4469 | payload only; i.e., what Squid reads from | |
4470 | the socket). | |
4471 | ||
bae917ac CT |
4472 | icap::<bs Number of message body bytes received from the |
4473 | ICAP server. ICAP message body, if any, usually | |
4474 | includes encapsulated HTTP message headers and | |
4475 | possibly encapsulated HTTP message body. The | |
4476 | HTTP body part is dechunked before its size is | |
4477 | computed. | |
4478 | ||
3ff65596 AR |
4479 | icap::tr Transaction response time (in |
4480 | milliseconds). The timer starts when | |
4481 | the ICAP transaction is created and | |
4482 | stops when the transaction is completed. | |
4483 | Similar to tr. | |
4484 | ||
4485 | icap::tio Transaction I/O time (in milliseconds). The | |
4486 | timer starts when the first ICAP request | |
4487 | byte is scheduled for sending. The timers | |
4488 | stops when the last byte of the ICAP response | |
4489 | is received. | |
4490 | ||
4491 | icap::to Transaction outcome: ICAP_ERR* for all | |
4492 | transaction errors, ICAP_OPT for OPTION | |
4493 | transactions, ICAP_ECHO for 204 | |
4494 | responses, ICAP_MOD for message | |
4495 | modification, and ICAP_SAT for request | |
4496 | satisfaction. Similar to Ss. | |
4497 | ||
4498 | icap::Hs ICAP response status code. Similar to Hs. | |
4499 | ||
4500 | icap::>h ICAP request header(s). Similar to >h. | |
4501 | ||
4502 | icap::<h ICAP response header(s). Similar to <h. | |
4503 | ||
4504 | The default ICAP log format, which can be used without an explicit | |
4505 | definition, is called icap_squid: | |
4506 | ||
4507 | logformat icap_squid %ts.%03tu %6icap::tr %>a %icap::to/%03icap::Hs %icap::<size %icap::rm %icap::ru% %un -/%icap::<A - | |
4508 | ||
5038f9d8 | 4509 | See also: logformat, log_icap, and %adapt::<last_h |
3ff65596 AR |
4510 | DOC_END |
4511 | ||
82b7abe3 AJ |
4512 | NAME: logfile_daemon |
4513 | TYPE: string | |
4514 | DEFAULT: @DEFAULT_LOGFILED@ | |
4515 | LOC: Log::TheConfig.logfile_daemon | |
4516 | DOC_START | |
4517 | Specify the path to the logfile-writing daemon. This daemon is | |
4518 | used to write the access and store logs, if configured. | |
14b24caf HN |
4519 | |
4520 | Squid sends a number of commands to the log daemon: | |
4521 | L<data>\n - logfile data | |
4522 | R\n - rotate file | |
4523 | T\n - truncate file | |
dd68402f | 4524 | O\n - reopen file |
14b24caf HN |
4525 | F\n - flush file |
4526 | r<n>\n - set rotate count to <n> | |
4527 | b<n>\n - 1 = buffer output, 0 = don't buffer output | |
4528 | ||
4529 | No responses is expected. | |
82b7abe3 AJ |
4530 | DOC_END |
4531 | ||
8ebad780 | 4532 | NAME: stats_collection |
3ff65596 | 4533 | TYPE: acl_access |
8ebad780 | 4534 | LOC: Config.accessList.stats_collection |
3ff65596 | 4535 | DEFAULT: none |
638402dd | 4536 | DEFAULT_DOC: Allow logging for all transactions. |
5b0f5383 | 4537 | COMMENT: allow|deny acl acl... |
3ff65596 | 4538 | DOC_START |
8ebad780 CT |
4539 | This options allows you to control which requests gets accounted |
4540 | in performance counters. | |
b3567eb5 FC |
4541 | |
4542 | This clause only supports fast acl types. | |
4543 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
3ff65596 AR |
4544 | DOC_END |
4545 | ||
41bd17a4 | 4546 | NAME: cache_store_log |
4547 | TYPE: string | |
df2eec10 | 4548 | DEFAULT: none |
41bd17a4 | 4549 | LOC: Config.Log.store |
4550 | DOC_START | |
4551 | Logs the activities of the storage manager. Shows which | |
4552 | objects are ejected from the cache, and which objects are | |
6d1dfcfc | 4553 | saved and for how long. |
df2eec10 | 4554 | There are not really utilities to analyze this data, so you can safely |
6d1dfcfc AJ |
4555 | disable it (the default). |
4556 | ||
4557 | Store log uses modular logging outputs. See access_log for the list | |
4558 | of modules supported. | |
4559 | ||
e0855596 | 4560 | Example: |
6d1dfcfc AJ |
4561 | cache_store_log stdio:@DEFAULT_STORE_LOG@ |
4562 | cache_store_log daemon:@DEFAULT_STORE_LOG@ | |
5473c134 | 4563 | DOC_END |
4564 | ||
41bd17a4 | 4565 | NAME: cache_swap_state cache_swap_log |
4566 | TYPE: string | |
4567 | LOC: Config.Log.swap | |
5473c134 | 4568 | DEFAULT: none |
638402dd | 4569 | DEFAULT_DOC: Store the journal inside its cache_dir |
5473c134 | 4570 | DOC_START |
41bd17a4 | 4571 | Location for the cache "swap.state" file. This index file holds |
4572 | the metadata of objects saved on disk. It is used to rebuild | |
4573 | the cache during startup. Normally this file resides in each | |
4574 | 'cache_dir' directory, but you may specify an alternate | |
4575 | pathname here. Note you must give a full filename, not just | |
4576 | a directory. Since this is the index for the whole object | |
4577 | list you CANNOT periodically rotate it! | |
5473c134 | 4578 | |
41bd17a4 | 4579 | If %s can be used in the file name it will be replaced with a |
4580 | a representation of the cache_dir name where each / is replaced | |
4581 | with '.'. This is needed to allow adding/removing cache_dir | |
4582 | lines when cache_swap_log is being used. | |
5473c134 | 4583 | |
41bd17a4 | 4584 | If have more than one 'cache_dir', and %s is not used in the name |
4585 | these swap logs will have names such as: | |
5473c134 | 4586 | |
41bd17a4 | 4587 | cache_swap_log.00 |
4588 | cache_swap_log.01 | |
4589 | cache_swap_log.02 | |
5473c134 | 4590 | |
41bd17a4 | 4591 | The numbered extension (which is added automatically) |
4592 | corresponds to the order of the 'cache_dir' lines in this | |
4593 | configuration file. If you change the order of the 'cache_dir' | |
4594 | lines in this file, these index files will NOT correspond to | |
4595 | the correct 'cache_dir' entry (unless you manually rename | |
4596 | them). We recommend you do NOT use this option. It is | |
4597 | better to keep these index files in each 'cache_dir' directory. | |
5473c134 | 4598 | DOC_END |
4599 | ||
41bd17a4 | 4600 | NAME: logfile_rotate |
4601 | TYPE: int | |
4602 | DEFAULT: 10 | |
4603 | LOC: Config.Log.rotateNumber | |
5473c134 | 4604 | DOC_START |
efc23871 | 4605 | Specifies the default number of logfile rotations to make when you |
41bd17a4 | 4606 | type 'squid -k rotate'. The default is 10, which will rotate |
4607 | with extensions 0 through 9. Setting logfile_rotate to 0 will | |
4608 | disable the file name rotation, but the logfiles are still closed | |
4609 | and re-opened. This will enable you to rename the logfiles | |
4610 | yourself just before sending the rotate signal. | |
5473c134 | 4611 | |
efc23871 AJ |
4612 | Note, from Squid-3.1 this option is only a default for cache.log, |
4613 | that log can be rotated separately by using debug_options. | |
4614 | ||
4615 | Note, from Squid-3.6 this option is only a default for access.log | |
4616 | recorded by stdio: module. Those logs can be rotated separately by | |
4617 | using the rotate=N option on their access_log directive. | |
4618 | ||
41bd17a4 | 4619 | Note, the 'squid -k rotate' command normally sends a USR1 |
4620 | signal to the running squid process. In certain situations | |
4621 | (e.g. on Linux with Async I/O), USR1 is used for other | |
4622 | purposes, so -k rotate uses another signal. It is best to get | |
4623 | in the habit of using 'squid -k rotate' instead of 'kill -USR1 | |
4624 | <pid>'. | |
62493678 | 4625 | |
41bd17a4 | 4626 | DOC_END |
5473c134 | 4627 | |
41bd17a4 | 4628 | NAME: mime_table |
4629 | TYPE: string | |
4630 | DEFAULT: @DEFAULT_MIME_TABLE@ | |
4631 | LOC: Config.mimeTablePathname | |
4632 | DOC_START | |
638402dd AJ |
4633 | Path to Squid's icon configuration file. |
4634 | ||
4635 | You shouldn't need to change this, but the default file contains | |
4636 | examples and formatting information if you do. | |
5473c134 | 4637 | DOC_END |
4638 | ||
41bd17a4 | 4639 | NAME: log_mime_hdrs |
4640 | COMMENT: on|off | |
4641 | TYPE: onoff | |
4642 | LOC: Config.onoff.log_mime_hdrs | |
4643 | DEFAULT: off | |
4644 | DOC_START | |
4645 | The Cache can record both the request and the response MIME | |
4646 | headers for each HTTP transaction. The headers are encoded | |
4647 | safely and will appear as two bracketed fields at the end of | |
4648 | the access log (for either the native or httpd-emulated log | |
4649 | formats). To enable this logging set log_mime_hdrs to 'on'. | |
4650 | DOC_END | |
5473c134 | 4651 | |
41bd17a4 | 4652 | NAME: pid_filename |
4653 | TYPE: string | |
4654 | DEFAULT: @DEFAULT_PID_FILE@ | |
4655 | LOC: Config.pidFilename | |
5473c134 | 4656 | DOC_START |
41bd17a4 | 4657 | A filename to write the process-id to. To disable, enter "none". |
5473c134 | 4658 | DOC_END |
4659 | ||
41bd17a4 | 4660 | NAME: client_netmask |
4661 | TYPE: address | |
4662 | LOC: Config.Addrs.client_netmask | |
0eb08770 | 4663 | DEFAULT: no_addr |
638402dd | 4664 | DEFAULT_DOC: Log full client IP address |
5473c134 | 4665 | DOC_START |
41bd17a4 | 4666 | A netmask for client addresses in logfiles and cachemgr output. |
4667 | Change this to protect the privacy of your cache clients. | |
4668 | A netmask of 255.255.255.0 will log all IP's in that range with | |
4669 | the last digit set to '0'. | |
5473c134 | 4670 | DOC_END |
4671 | ||
41bd17a4 | 4672 | NAME: strip_query_terms |
5473c134 | 4673 | TYPE: onoff |
41bd17a4 | 4674 | LOC: Config.onoff.strip_query_terms |
5473c134 | 4675 | DEFAULT: on |
4676 | DOC_START | |
41bd17a4 | 4677 | By default, Squid strips query terms from requested URLs before |
638402dd AJ |
4678 | logging. This protects your user's privacy and reduces log size. |
4679 | ||
4680 | When investigating HIT/MISS or other caching behaviour you | |
4681 | will need to disable this to see the full URL used by Squid. | |
5473c134 | 4682 | DOC_END |
4683 | ||
41bd17a4 | 4684 | NAME: buffered_logs |
4685 | COMMENT: on|off | |
4686 | TYPE: onoff | |
4687 | DEFAULT: off | |
4688 | LOC: Config.onoff.buffered_logs | |
5473c134 | 4689 | DOC_START |
638402dd AJ |
4690 | Whether to write/send access_log records ASAP or accumulate them and |
4691 | then write/send them in larger chunks. Buffering may improve | |
4692 | performance because it decreases the number of I/Os. However, | |
4693 | buffering increases the delay before log records become available to | |
4694 | the final recipient (e.g., a disk file or logging daemon) and, | |
4695 | hence, increases the risk of log records loss. | |
4696 | ||
4697 | Note that even when buffered_logs are off, Squid may have to buffer | |
4698 | records if it cannot write/send them immediately due to pending I/Os | |
4699 | (e.g., the I/O writing the previous log record) or connectivity loss. | |
4700 | ||
fb0c2f17 | 4701 | Currently honored by 'daemon' and 'tcp' access_log modules only. |
6b698a21 | 4702 | DOC_END |
0976f8db | 4703 | |
2b753521 | 4704 | NAME: netdb_filename |
4705 | TYPE: string | |
221faecb | 4706 | DEFAULT: stdio:@DEFAULT_NETDB_FILE@ |
2b753521 | 4707 | LOC: Config.netdbFilename |
fb6a61d1 | 4708 | IFDEF: USE_ICMP |
2b753521 | 4709 | DOC_START |
638402dd AJ |
4710 | Where Squid stores it's netdb journal. |
4711 | When enabled this journal preserves netdb state between restarts. | |
4712 | ||
2b753521 | 4713 | To disable, enter "none". |
4714 | DOC_END | |
4715 | ||
62493678 AJ |
4716 | COMMENT_START |
4717 | OPTIONS FOR TROUBLESHOOTING | |
4718 | ----------------------------------------------------------------------------- | |
4719 | COMMENT_END | |
4720 | ||
4721 | NAME: cache_log | |
4722 | TYPE: string | |
62493678 AJ |
4723 | DEFAULT_IF_NONE: @DEFAULT_CACHE_LOG@ |
4724 | LOC: Debug::cache_log | |
4725 | DOC_START | |
638402dd AJ |
4726 | Squid administrative logging file. |
4727 | ||
4728 | This is where general information about Squid behavior goes. You can | |
4729 | increase the amount of data logged to this file and how often it is | |
4730 | rotated with "debug_options" | |
62493678 AJ |
4731 | DOC_END |
4732 | ||
4733 | NAME: debug_options | |
4734 | TYPE: eol | |
47df1aa7 | 4735 | DEFAULT: ALL,1 |
638402dd | 4736 | DEFAULT_DOC: Log all critical and important messages. |
62493678 AJ |
4737 | LOC: Debug::debugOptions |
4738 | DOC_START | |
4739 | Logging options are set as section,level where each source file | |
4740 | is assigned a unique section. Lower levels result in less | |
4741 | output, Full debugging (level 9) can result in a very large | |
4742 | log file, so be careful. | |
4743 | ||
4744 | The magic word "ALL" sets debugging levels for all sections. | |
638402dd | 4745 | The default is to run with "ALL,1" to record important warnings. |
62493678 | 4746 | |
47df1aa7 AJ |
4747 | The rotate=N option can be used to keep more or less of these logs |
4748 | than would otherwise be kept by logfile_rotate. | |
62493678 AJ |
4749 | For most uses a single log should be enough to monitor current |
4750 | events affecting Squid. | |
4751 | DOC_END | |
4752 | ||
4753 | NAME: coredump_dir | |
4754 | TYPE: string | |
4755 | LOC: Config.coredump_dir | |
62493678 | 4756 | DEFAULT_IF_NONE: none |
638402dd | 4757 | DEFAULT_DOC: Use the directory from where Squid was started. |
62493678 AJ |
4758 | DOC_START |
4759 | By default Squid leaves core files in the directory from where | |
4760 | it was started. If you set 'coredump_dir' to a directory | |
4761 | that exists, Squid will chdir() to that directory at startup | |
4762 | and coredump files will be left there. | |
4763 | ||
4764 | NOCOMMENT_START | |
e0855596 | 4765 | |
62493678 AJ |
4766 | # Leave coredumps in the first cache dir |
4767 | coredump_dir @DEFAULT_SWAP_DIR@ | |
4768 | NOCOMMENT_END | |
4769 | DOC_END | |
4770 | ||
4771 | ||
41bd17a4 | 4772 | COMMENT_START |
4773 | OPTIONS FOR FTP GATEWAYING | |
4774 | ----------------------------------------------------------------------------- | |
4775 | COMMENT_END | |
4776 | ||
4777 | NAME: ftp_user | |
4778 | TYPE: string | |
4779 | DEFAULT: Squid@ | |
4780 | LOC: Config.Ftp.anon_user | |
6b698a21 | 4781 | DOC_START |
41bd17a4 | 4782 | If you want the anonymous login password to be more informative |
638402dd | 4783 | (and enable the use of picky FTP servers), set this to something |
41bd17a4 | 4784 | reasonable for your domain, like wwwuser@somewhere.net |
7f7db318 | 4785 | |
41bd17a4 | 4786 | The reason why this is domainless by default is the |
4787 | request can be made on the behalf of a user in any domain, | |
4788 | depending on how the cache is used. | |
638402dd | 4789 | Some FTP server also validate the email address is valid |
41bd17a4 | 4790 | (for example perl.com). |
6b698a21 | 4791 | DOC_END |
0976f8db | 4792 | |
41bd17a4 | 4793 | NAME: ftp_passive |
4794 | TYPE: onoff | |
4795 | DEFAULT: on | |
4796 | LOC: Config.Ftp.passive | |
6b698a21 | 4797 | DOC_START |
41bd17a4 | 4798 | If your firewall does not allow Squid to use passive |
4799 | connections, turn off this option. | |
a689bd4e | 4800 | |
4801 | Use of ftp_epsv_all option requires this to be ON. | |
4802 | DOC_END | |
4803 | ||
4804 | NAME: ftp_epsv_all | |
4805 | TYPE: onoff | |
4806 | DEFAULT: off | |
4807 | LOC: Config.Ftp.epsv_all | |
4808 | DOC_START | |
4809 | FTP Protocol extensions permit the use of a special "EPSV ALL" command. | |
4810 | ||
4811 | NATs may be able to put the connection on a "fast path" through the | |
4812 | translator, as the EPRT command will never be used and therefore, | |
4813 | translation of the data portion of the segments will never be needed. | |
4814 | ||
b3567eb5 FC |
4815 | When a client only expects to do two-way FTP transfers this may be |
4816 | useful. | |
a689bd4e | 4817 | If squid finds that it must do a three-way FTP transfer after issuing |
4818 | an EPSV ALL command, the FTP session will fail. | |
4819 | ||
4820 | If you have any doubts about this option do not use it. | |
4821 | Squid will nicely attempt all other connection methods. | |
4822 | ||
51ee534d AJ |
4823 | Requires ftp_passive to be ON (default) for any effect. |
4824 | DOC_END | |
4825 | ||
4826 | NAME: ftp_epsv | |
ddf5aa2b CT |
4827 | TYPE: ftp_epsv |
4828 | DEFAULT: none | |
4829 | LOC: Config.accessList.ftp_epsv | |
51ee534d AJ |
4830 | DOC_START |
4831 | FTP Protocol extensions permit the use of a special "EPSV" command. | |
4832 | ||
4833 | NATs may be able to put the connection on a "fast path" through the | |
b3567eb5 FC |
4834 | translator using EPSV, as the EPRT command will never be used |
4835 | and therefore, translation of the data portion of the segments | |
4836 | will never be needed. | |
51ee534d | 4837 | |
ddf5aa2b CT |
4838 | EPSV is often required to interoperate with FTP servers on IPv6 |
4839 | networks. On the other hand, it may break some IPv4 servers. | |
4840 | ||
4841 | By default, EPSV may try EPSV with any FTP server. To fine tune | |
4842 | that decision, you may restrict EPSV to certain clients or servers | |
4843 | using ACLs: | |
4844 | ||
4845 | ftp_epsv allow|deny al1 acl2 ... | |
4846 | ||
4847 | WARNING: Disabling EPSV may cause problems with external NAT and IPv6. | |
51ee534d | 4848 | |
ddf5aa2b | 4849 | Only fast ACLs are supported. |
51ee534d | 4850 | Requires ftp_passive to be ON (default) for any effect. |
41bd17a4 | 4851 | DOC_END |
9e7dbc51 | 4852 | |
63ee5443 AJ |
4853 | NAME: ftp_eprt |
4854 | TYPE: onoff | |
4855 | DEFAULT: on | |
4856 | LOC: Config.Ftp.eprt | |
4857 | DOC_START | |
4858 | FTP Protocol extensions permit the use of a special "EPRT" command. | |
4859 | ||
4860 | This extension provides a protocol neutral alternative to the | |
4861 | IPv4-only PORT command. When supported it enables active FTP data | |
4862 | channels over IPv6 and efficient NAT handling. | |
4863 | ||
4864 | Turning this OFF will prevent EPRT being attempted and will skip | |
4865 | straight to using PORT for IPv4 servers. | |
4866 | ||
4867 | Some devices are known to not handle this extension correctly and | |
4868 | may result in crashes. Devices which suport EPRT enough to fail | |
4869 | cleanly will result in Squid attempting PORT anyway. This directive | |
4870 | should only be disabled when EPRT results in device failures. | |
4871 | ||
4872 | WARNING: Doing so will convert Squid back to the old behavior with all | |
4873 | the related problems with external NAT devices/layers and IPv4-only FTP. | |
4874 | DOC_END | |
4875 | ||
41bd17a4 | 4876 | NAME: ftp_sanitycheck |
4877 | TYPE: onoff | |
4878 | DEFAULT: on | |
4879 | LOC: Config.Ftp.sanitycheck | |
4880 | DOC_START | |
4881 | For security and data integrity reasons Squid by default performs | |
4882 | sanity checks of the addresses of FTP data connections ensure the | |
4883 | data connection is to the requested server. If you need to allow | |
4884 | FTP connections to servers using another IP address for the data | |
4885 | connection turn this off. | |
4886 | DOC_END | |
9e7dbc51 | 4887 | |
41bd17a4 | 4888 | NAME: ftp_telnet_protocol |
4889 | TYPE: onoff | |
4890 | DEFAULT: on | |
4891 | LOC: Config.Ftp.telnet | |
4892 | DOC_START | |
4893 | The FTP protocol is officially defined to use the telnet protocol | |
4894 | as transport channel for the control connection. However, many | |
4895 | implementations are broken and does not respect this aspect of | |
4896 | the FTP protocol. | |
4897 | ||
4898 | If you have trouble accessing files with ASCII code 255 in the | |
4899 | path or similar problems involving this ASCII code you can | |
4900 | try setting this directive to off. If that helps, report to the | |
4901 | operator of the FTP server in question that their FTP server | |
4902 | is broken and does not follow the FTP standard. | |
4903 | DOC_END | |
4904 | ||
4905 | COMMENT_START | |
4906 | OPTIONS FOR EXTERNAL SUPPORT PROGRAMS | |
4907 | ----------------------------------------------------------------------------- | |
4908 | COMMENT_END | |
4909 | ||
4910 | NAME: diskd_program | |
4911 | TYPE: string | |
4912 | DEFAULT: @DEFAULT_DISKD@ | |
4913 | LOC: Config.Program.diskd | |
4914 | DOC_START | |
4915 | Specify the location of the diskd executable. | |
4916 | Note this is only useful if you have compiled in | |
4917 | diskd as one of the store io modules. | |
4918 | DOC_END | |
4919 | ||
4920 | NAME: unlinkd_program | |
4921 | IFDEF: USE_UNLINKD | |
4922 | TYPE: string | |
4923 | DEFAULT: @DEFAULT_UNLINKD@ | |
4924 | LOC: Config.Program.unlinkd | |
4925 | DOC_START | |
4926 | Specify the location of the executable for file deletion process. | |
4927 | DOC_END | |
4928 | ||
4929 | NAME: pinger_program | |
41bd17a4 | 4930 | IFDEF: USE_ICMP |
7a9d36e3 AJ |
4931 | TYPE: icmp |
4932 | DEFAULT: @DEFAULT_PINGER@ | |
4933 | LOC: IcmpCfg | |
41bd17a4 | 4934 | DOC_START |
4935 | Specify the location of the executable for the pinger process. | |
4936 | DOC_END | |
4937 | ||
cc192b50 | 4938 | NAME: pinger_enable |
4939 | TYPE: onoff | |
4940 | DEFAULT: on | |
7a9d36e3 | 4941 | LOC: IcmpCfg.enable |
cc192b50 | 4942 | IFDEF: USE_ICMP |
4943 | DOC_START | |
4944 | Control whether the pinger is active at run-time. | |
b3567eb5 FC |
4945 | Enables turning ICMP pinger on and off with a simple |
4946 | squid -k reconfigure. | |
cc192b50 | 4947 | DOC_END |
4948 | ||
4949 | ||
41bd17a4 | 4950 | COMMENT_START |
4951 | OPTIONS FOR URL REWRITING | |
4952 | ----------------------------------------------------------------------------- | |
4953 | COMMENT_END | |
4954 | ||
4955 | NAME: url_rewrite_program redirect_program | |
4956 | TYPE: wordlist | |
4957 | LOC: Config.Program.redirect | |
4958 | DEFAULT: none | |
4959 | DOC_START | |
2c7aad89 | 4960 | Specify the location of the executable URL rewriter to use. |
41bd17a4 | 4961 | Since they can perform almost any function there isn't one included. |
4962 | ||
2c7aad89 | 4963 | For each requested URL, the rewriter will receive on line with the format |
41bd17a4 | 4964 | |
b11724bb | 4965 | [channel-ID <SP>] URL [<SP> extras]<NL> |
5269ec0e | 4966 | |
457857fe CT |
4967 | See url_rewrite_extras on how to send "extras" with optional values to |
4968 | the helper. | |
5269ec0e AJ |
4969 | After processing the request the helper must reply using the following format: |
4970 | ||
24eac830 | 4971 | [channel-ID <SP>] result [<SP> kv-pairs] |
5269ec0e AJ |
4972 | |
4973 | The result code can be: | |
4974 | ||
4975 | OK status=30N url="..." | |
4976 | Redirect the URL to the one supplied in 'url='. | |
4977 | 'status=' is optional and contains the status code to send | |
4978 | the client in Squids HTTP response. It must be one of the | |
4979 | HTTP redirect status codes: 301, 302, 303, 307, 308. | |
4980 | When no status is given Squid will use 302. | |
c71adec1 | 4981 | |
5269ec0e AJ |
4982 | OK rewrite-url="..." |
4983 | Rewrite the URL to the one supplied in 'rewrite-url='. | |
4984 | The new URL is fetched directly by Squid and returned to | |
4985 | the client as the response to its request. | |
4986 | ||
c2cbbb02 AJ |
4987 | OK |
4988 | When neither of url= and rewrite-url= are sent Squid does | |
4989 | not change the URL. | |
4990 | ||
5269ec0e AJ |
4991 | ERR |
4992 | Do not change the URL. | |
4993 | ||
4994 | BH | |
4ded749e | 4995 | An internal error occurred in the helper, preventing |
c2cbbb02 AJ |
4996 | a result being identified. The 'message=' key name is |
4997 | reserved for delivering a log message. | |
5269ec0e AJ |
4998 | |
4999 | ||
457857fe CT |
5000 | In addition to the above kv-pairs Squid also understands the following |
5001 | optional kv-pairs received from URL rewriters: | |
5002 | clt_conn_tag=TAG | |
5003 | Associates a TAG with the client TCP connection. | |
5004 | The TAG is treated as a regular annotation but persists across | |
5005 | future requests on the client connection rather than just the | |
5006 | current request. A helper may update the TAG during subsequent | |
5007 | requests be returning a new kv-pair. | |
41bd17a4 | 5008 | |
5269ec0e AJ |
5009 | When using the concurrency= option the protocol is changed by |
5010 | introducing a query channel tag in front of the request/response. | |
5011 | The query channel tag is a number between 0 and concurrency-1. | |
5012 | This value must be echoed back unchanged to Squid as the first part | |
5013 | of the response relating to its request. | |
5014 | ||
5015 | WARNING: URL re-writing ability should be avoided whenever possible. | |
5016 | Use the URL redirect form of response instead. | |
41bd17a4 | 5017 | |
5269ec0e AJ |
5018 | Re-write creates a difference in the state held by the client |
5019 | and server. Possibly causing confusion when the server response | |
5020 | contains snippets of its view state. Embeded URLs, response | |
5021 | and content Location headers, etc. are not re-written by this | |
5022 | interface. | |
41bd17a4 | 5023 | |
5024 | By default, a URL rewriter is not used. | |
5025 | DOC_END | |
5026 | ||
5027 | NAME: url_rewrite_children redirect_children | |
48d54e4d | 5028 | TYPE: HelperChildConfig |
5b708d95 | 5029 | DEFAULT: 20 startup=0 idle=1 concurrency=0 |
41bd17a4 | 5030 | LOC: Config.redirectChildren |
5031 | DOC_START | |
48d54e4d AJ |
5032 | The maximum number of redirector processes to spawn. If you limit |
5033 | it too few Squid will have to wait for them to process a backlog of | |
5034 | URLs, slowing it down. If you allow too many they will use RAM | |
5035 | and other system resources noticably. | |
5036 | ||
5037 | The startup= and idle= options allow some measure of skew in your | |
5038 | tuning. | |
5039 | ||
5040 | startup= | |
5041 | ||
5042 | Sets a minimum of how many processes are to be spawned when Squid | |
5043 | starts or reconfigures. When set to zero the first request will | |
5044 | cause spawning of the first child process to handle it. | |
5045 | ||
5046 | Starting too few will cause an initial slowdown in traffic as Squid | |
5047 | attempts to simultaneously spawn enough processes to cope. | |
5048 | ||
5049 | idle= | |
5050 | ||
5051 | Sets a minimum of how many processes Squid is to try and keep available | |
5052 | at all times. When traffic begins to rise above what the existing | |
5053 | processes can handle this many more will be spawned up to the maximum | |
5054 | configured. A minimum setting of 1 is required. | |
5055 | ||
5056 | concurrency= | |
41bd17a4 | 5057 | |
41bd17a4 | 5058 | The number of requests each redirector helper can handle in |
5059 | parallel. Defaults to 0 which indicates the redirector | |
5060 | is a old-style single threaded redirector. | |
6a171502 AJ |
5061 | |
5062 | When this directive is set to a value >= 1 then the protocol | |
5063 | used to communicate with the helper is modified to include | |
9bef05b1 AJ |
5064 | an ID in front of the request/response. The ID from the request |
5065 | must be echoed back with the response to that request. | |
6825b101 CT |
5066 | |
5067 | queue-size=N | |
5068 | ||
5069 | Sets the maximum number of queued requests. | |
5070 | If the queued requests exceed queue size and redirector_bypass | |
5071 | configuration option is set, then redirector is bypassed. Otherwise, if | |
5072 | overloading persists squid may abort its operation. | |
5073 | The default value is set to 2*numberofchildren. | |
41bd17a4 | 5074 | DOC_END |
5075 | ||
5076 | NAME: url_rewrite_host_header redirect_rewrites_host_header | |
5077 | TYPE: onoff | |
5078 | DEFAULT: on | |
5079 | LOC: Config.onoff.redir_rewrites_host | |
5080 | DOC_START | |
3ce33807 AJ |
5081 | To preserve same-origin security policies in browsers and |
5082 | prevent Host: header forgery by redirectors Squid rewrites | |
5083 | any Host: header in redirected requests. | |
5084 | ||
5085 | If you are running an accelerator this may not be a wanted | |
5086 | effect of a redirector. This directive enables you disable | |
5087 | Host: alteration in reverse-proxy traffic. | |
5088 | ||
41bd17a4 | 5089 | WARNING: Entries are cached on the result of the URL rewriting |
5090 | process, so be careful if you have domain-virtual hosts. | |
3ce33807 AJ |
5091 | |
5092 | WARNING: Squid and other software verifies the URL and Host | |
5093 | are matching, so be careful not to relay through other proxies | |
5094 | or inspecting firewalls with this disabled. | |
41bd17a4 | 5095 | DOC_END |
5096 | ||
5097 | NAME: url_rewrite_access redirector_access | |
5098 | TYPE: acl_access | |
5099 | DEFAULT: none | |
638402dd | 5100 | DEFAULT_DOC: Allow, unless rules exist in squid.conf. |
41bd17a4 | 5101 | LOC: Config.accessList.redirector |
5102 | DOC_START | |
5103 | If defined, this access list specifies which requests are | |
638402dd | 5104 | sent to the redirector processes. |
b3567eb5 FC |
5105 | |
5106 | This clause supports both fast and slow acl types. | |
5107 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
41bd17a4 | 5108 | DOC_END |
5109 | ||
5110 | NAME: url_rewrite_bypass redirector_bypass | |
5111 | TYPE: onoff | |
5112 | LOC: Config.onoff.redirector_bypass | |
5113 | DEFAULT: off | |
5114 | DOC_START | |
5115 | When this is 'on', a request will not go through the | |
638402dd | 5116 | redirector if all the helpers are busy. If this is 'off' |
41bd17a4 | 5117 | and the redirector queue grows too large, Squid will exit |
5118 | with a FATAL error and ask you to increase the number of | |
5119 | redirectors. You should only enable this if the redirectors | |
5120 | are not critical to your caching system. If you use | |
5121 | redirectors for access control, and you enable this option, | |
5122 | users may have access to pages they should not | |
5123 | be allowed to request. | |
6825b101 CT |
5124 | This options sets default queue-size option of the url_rewrite_children |
5125 | to 0. | |
41bd17a4 | 5126 | DOC_END |
5127 | ||
fe7966ec | 5128 | NAME: url_rewrite_extras |
b11724bb CT |
5129 | TYPE: TokenOrQuotedString |
5130 | LOC: Config.redirector_extras | |
5131 | DEFAULT: "%>a/%>A %un %>rm myip=%la myport=%lp" | |
5132 | DOC_START | |
5133 | Specifies a string to be append to request line format for the | |
5134 | rewriter helper. "Quoted" format values may contain spaces and | |
5135 | logformat %macros. In theory, any logformat %macro can be used. | |
5136 | In practice, a %macro expands as a dash (-) if the helper request is | |
5137 | sent before the required macro information is available to Squid. | |
5138 | DOC_END | |
5139 | ||
32fd6d8a | 5140 | NAME: url_rewrite_timeout |
ced8def3 AJ |
5141 | TYPE: UrlHelperTimeout |
5142 | LOC: Config.onUrlRewriteTimeout | |
32fd6d8a CT |
5143 | DEFAULT: none |
5144 | DEFAULT_DOC: Squid waits for the helper response forever | |
5145 | DOC_START | |
5146 | Squid times active requests to redirector. The timeout value and Squid | |
5147 | reaction to a timed out request are configurable using the following | |
5148 | format: | |
5149 | ||
ced8def3 | 5150 | url_rewrite_timeout timeout time-units on_timeout=<action> [response=<quoted-response>] |
32fd6d8a CT |
5151 | |
5152 | supported timeout actions: | |
ced8def3 | 5153 | fail Squid return a ERR_GATEWAY_FAILURE error page |
32fd6d8a | 5154 | |
ced8def3 | 5155 | bypass Do not re-write the URL |
32fd6d8a | 5156 | |
ced8def3 | 5157 | retry Send the lookup to the helper again |
32fd6d8a | 5158 | |
ced8def3 AJ |
5159 | use_configured_response |
5160 | Use the <quoted-response> as helper response | |
32fd6d8a CT |
5161 | DOC_END |
5162 | ||
a8a0b1c2 EC |
5163 | COMMENT_START |
5164 | OPTIONS FOR STORE ID | |
5165 | ----------------------------------------------------------------------------- | |
5166 | COMMENT_END | |
5167 | ||
5168 | NAME: store_id_program storeurl_rewrite_program | |
5169 | TYPE: wordlist | |
5170 | LOC: Config.Program.store_id | |
5171 | DEFAULT: none | |
5172 | DOC_START | |
5173 | Specify the location of the executable StoreID helper to use. | |
5174 | Since they can perform almost any function there isn't one included. | |
5175 | ||
5176 | For each requested URL, the helper will receive one line with the format | |
5177 | ||
b11724bb | 5178 | [channel-ID <SP>] URL [<SP> extras]<NL> |
a8a0b1c2 EC |
5179 | |
5180 | ||
5181 | After processing the request the helper must reply using the following format: | |
5182 | ||
5183 | [channel-ID <SP>] result [<SP> kv-pairs] | |
5184 | ||
5185 | The result code can be: | |
5186 | ||
5187 | OK store-id="..." | |
5188 | Use the StoreID supplied in 'store-id='. | |
5189 | ||
5190 | ERR | |
5191 | The default is to use HTTP request URL as the store ID. | |
5192 | ||
5193 | BH | |
5194 | An internal error occured in the helper, preventing | |
5195 | a result being identified. | |
5196 | ||
457857fe CT |
5197 | In addition to the above kv-pairs Squid also understands the following |
5198 | optional kv-pairs received from URL rewriters: | |
5199 | clt_conn_tag=TAG | |
5200 | Associates a TAG with the client TCP connection. | |
5201 | Please see url_rewrite_program related documentation for this | |
5202 | kv-pair | |
a8a0b1c2 | 5203 | |
b11724bb CT |
5204 | Helper programs should be prepared to receive and possibly ignore |
5205 | additional whitespace-separated tokens on each input line. | |
a8a0b1c2 EC |
5206 | |
5207 | When using the concurrency= option the protocol is changed by | |
5208 | introducing a query channel tag in front of the request/response. | |
5209 | The query channel tag is a number between 0 and concurrency-1. | |
5210 | This value must be echoed back unchanged to Squid as the first part | |
5211 | of the response relating to its request. | |
5212 | ||
5213 | NOTE: when using StoreID refresh_pattern will apply to the StoreID | |
5214 | returned from the helper and not the URL. | |
5215 | ||
5216 | WARNING: Wrong StoreID value returned by a careless helper may result | |
5217 | in the wrong cached response returned to the user. | |
5218 | ||
5219 | By default, a StoreID helper is not used. | |
5220 | DOC_END | |
5221 | ||
fe7966ec | 5222 | NAME: store_id_extras |
b11724bb CT |
5223 | TYPE: TokenOrQuotedString |
5224 | LOC: Config.storeId_extras | |
5225 | DEFAULT: "%>a/%>A %un %>rm myip=%la myport=%lp" | |
5226 | DOC_START | |
5227 | Specifies a string to be append to request line format for the | |
5228 | StoreId helper. "Quoted" format values may contain spaces and | |
5229 | logformat %macros. In theory, any logformat %macro can be used. | |
5230 | In practice, a %macro expands as a dash (-) if the helper request is | |
5231 | sent before the required macro information is available to Squid. | |
5232 | DOC_END | |
5233 | ||
a8a0b1c2 EC |
5234 | NAME: store_id_children storeurl_rewrite_children |
5235 | TYPE: HelperChildConfig | |
5236 | DEFAULT: 20 startup=0 idle=1 concurrency=0 | |
5237 | LOC: Config.storeIdChildren | |
5238 | DOC_START | |
5239 | The maximum number of StoreID helper processes to spawn. If you limit | |
5240 | it too few Squid will have to wait for them to process a backlog of | |
5241 | requests, slowing it down. If you allow too many they will use RAM | |
5242 | and other system resources noticably. | |
5243 | ||
5244 | The startup= and idle= options allow some measure of skew in your | |
5245 | tuning. | |
5246 | ||
5247 | startup= | |
5248 | ||
5249 | Sets a minimum of how many processes are to be spawned when Squid | |
5250 | starts or reconfigures. When set to zero the first request will | |
5251 | cause spawning of the first child process to handle it. | |
5252 | ||
5253 | Starting too few will cause an initial slowdown in traffic as Squid | |
5254 | attempts to simultaneously spawn enough processes to cope. | |
5255 | ||
5256 | idle= | |
5257 | ||
5258 | Sets a minimum of how many processes Squid is to try and keep available | |
5259 | at all times. When traffic begins to rise above what the existing | |
5260 | processes can handle this many more will be spawned up to the maximum | |
5261 | configured. A minimum setting of 1 is required. | |
5262 | ||
5263 | concurrency= | |
5264 | ||
5265 | The number of requests each storeID helper can handle in | |
5266 | parallel. Defaults to 0 which indicates the helper | |
5267 | is a old-style single threaded program. | |
5268 | ||
5269 | When this directive is set to a value >= 1 then the protocol | |
5270 | used to communicate with the helper is modified to include | |
5271 | an ID in front of the request/response. The ID from the request | |
5272 | must be echoed back with the response to that request. | |
6825b101 CT |
5273 | |
5274 | queue-size=N | |
5275 | ||
5276 | Sets the maximum number of queued requests. | |
5277 | If the queued requests exceed queue size and store_id_bypass | |
5278 | configuration option is set, then storeID helper is bypassed. Otherwise, | |
5279 | if overloading persists squid may abort its operation. | |
5280 | The default value is set to 2*numberofchildren. | |
a8a0b1c2 EC |
5281 | DOC_END |
5282 | ||
5283 | NAME: store_id_access storeurl_rewrite_access | |
5284 | TYPE: acl_access | |
5285 | DEFAULT: none | |
638402dd | 5286 | DEFAULT_DOC: Allow, unless rules exist in squid.conf. |
a8a0b1c2 EC |
5287 | LOC: Config.accessList.store_id |
5288 | DOC_START | |
5289 | If defined, this access list specifies which requests are | |
5290 | sent to the StoreID processes. By default all requests | |
5291 | are sent. | |
5292 | ||
5293 | This clause supports both fast and slow acl types. | |
5294 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
5295 | DOC_END | |
5296 | ||
5297 | NAME: store_id_bypass storeurl_rewrite_bypass | |
5298 | TYPE: onoff | |
5299 | LOC: Config.onoff.store_id_bypass | |
5300 | DEFAULT: on | |
5301 | DOC_START | |
5302 | When this is 'on', a request will not go through the | |
5303 | helper if all helpers are busy. If this is 'off' | |
5304 | and the helper queue grows too large, Squid will exit | |
5305 | with a FATAL error and ask you to increase the number of | |
5306 | helpers. You should only enable this if the helperss | |
5307 | are not critical to your caching system. If you use | |
5308 | helpers for critical caching components, and you enable this | |
5309 | option, users may not get objects from cache. | |
6825b101 CT |
5310 | This options sets default queue-size option of the store_id_children |
5311 | to 0. | |
a8a0b1c2 EC |
5312 | DOC_END |
5313 | ||
41bd17a4 | 5314 | COMMENT_START |
5315 | OPTIONS FOR TUNING THE CACHE | |
5316 | ----------------------------------------------------------------------------- | |
5317 | COMMENT_END | |
5318 | ||
f04b37d8 | 5319 | NAME: cache no_cache |
5320 | TYPE: acl_access | |
5321 | DEFAULT: none | |
70706149 | 5322 | DEFAULT_DOC: By default, this directive is unused and has no effect. |
f04b37d8 | 5323 | LOC: Config.accessList.noCache |
41bd17a4 | 5324 | DOC_START |
70706149 AR |
5325 | Requests denied by this directive will not be served from the cache |
5326 | and their responses will not be stored in the cache. This directive | |
5327 | has no effect on other transactions and on already cached responses. | |
f04b37d8 | 5328 | |
b3567eb5 FC |
5329 | This clause supports both fast and slow acl types. |
5330 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
70706149 AR |
5331 | |
5332 | This and the two other similar caching directives listed below are | |
5333 | checked at different transaction processing stages, have different | |
5334 | access to response information, affect different cache operations, | |
5335 | and differ in slow ACLs support: | |
5336 | ||
5337 | * cache: Checked before Squid makes a hit/miss determination. | |
5338 | No access to reply information! | |
5339 | Denies both serving a hit and storing a miss. | |
5340 | Supports both fast and slow ACLs. | |
5341 | * send_hit: Checked after a hit was detected. | |
5342 | Has access to reply (hit) information. | |
5343 | Denies serving a hit only. | |
5344 | Supports fast ACLs only. | |
5345 | * store_miss: Checked before storing a cachable miss. | |
5346 | Has access to reply (miss) information. | |
5347 | Denies storing a miss only. | |
5348 | Supports fast ACLs only. | |
5349 | ||
5350 | If you are not sure which of the three directives to use, apply the | |
5351 | following decision logic: | |
5352 | ||
5353 | * If your ACL(s) are of slow type _and_ need response info, redesign. | |
5354 | Squid does not support that particular combination at this time. | |
5355 | Otherwise: | |
5356 | * If your directive ACL(s) are of slow type, use "cache"; and/or | |
5357 | * if your directive ACL(s) need no response info, use "cache". | |
5358 | Otherwise: | |
5359 | * If you do not want the response cached, use store_miss; and/or | |
5360 | * if you do not want a hit on a cached response, use send_hit. | |
5361 | DOC_END | |
5362 | ||
5363 | NAME: send_hit | |
5364 | TYPE: acl_access | |
5365 | DEFAULT: none | |
5366 | DEFAULT_DOC: By default, this directive is unused and has no effect. | |
5367 | LOC: Config.accessList.sendHit | |
5368 | DOC_START | |
5369 | Responses denied by this directive will not be served from the cache | |
5370 | (but may still be cached, see store_miss). This directive has no | |
5371 | effect on the responses it allows and on the cached objects. | |
5372 | ||
5373 | Please see the "cache" directive for a summary of differences among | |
5374 | store_miss, send_hit, and cache directives. | |
5375 | ||
5376 | Unlike the "cache" directive, send_hit only supports fast acl | |
5377 | types. See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
5378 | ||
5379 | For example: | |
5380 | ||
5381 | # apply custom Store ID mapping to some URLs | |
5382 | acl MapMe dstdomain .c.example.com | |
5383 | store_id_program ... | |
5384 | store_id_access allow MapMe | |
5385 | ||
5386 | # but prevent caching of special responses | |
5387 | # such as 302 redirects that cause StoreID loops | |
5388 | acl Ordinary http_status 200-299 | |
5389 | store_miss deny MapMe !Ordinary | |
5390 | ||
5391 | # and do not serve any previously stored special responses | |
5392 | # from the cache (in case they were already cached before | |
5393 | # the above store_miss rule was in effect). | |
5394 | send_hit deny MapMe !Ordinary | |
5395 | DOC_END | |
5396 | ||
5397 | NAME: store_miss | |
5398 | TYPE: acl_access | |
5399 | DEFAULT: none | |
5400 | DEFAULT_DOC: By default, this directive is unused and has no effect. | |
5401 | LOC: Config.accessList.storeMiss | |
5402 | DOC_START | |
5403 | Responses denied by this directive will not be cached (but may still | |
5404 | be served from the cache, see send_hit). This directive has no | |
5405 | effect on the responses it allows and on the already cached responses. | |
5406 | ||
5407 | Please see the "cache" directive for a summary of differences among | |
5408 | store_miss, send_hit, and cache directives. See the | |
5409 | send_hit directive for a usage example. | |
5410 | ||
5411 | Unlike the "cache" directive, store_miss only supports fast acl | |
5412 | types. See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
41bd17a4 | 5413 | DOC_END |
5414 | ||
570d3f75 AJ |
5415 | NAME: max_stale |
5416 | COMMENT: time-units | |
5417 | TYPE: time_t | |
5418 | LOC: Config.maxStale | |
5419 | DEFAULT: 1 week | |
5420 | DOC_START | |
5421 | This option puts an upper limit on how stale content Squid | |
5422 | will serve from the cache if cache validation fails. | |
5423 | Can be overriden by the refresh_pattern max-stale option. | |
5424 | DOC_END | |
5425 | ||
41bd17a4 | 5426 | NAME: refresh_pattern |
5427 | TYPE: refreshpattern | |
5428 | LOC: Config.Refresh | |
5429 | DEFAULT: none | |
5430 | DOC_START | |
5431 | usage: refresh_pattern [-i] regex min percent max [options] | |
9e7dbc51 | 5432 | |
6b698a21 | 5433 | By default, regular expressions are CASE-SENSITIVE. To make |
5434 | them case-insensitive, use the -i option. | |
9e7dbc51 | 5435 | |
41bd17a4 | 5436 | 'Min' is the time (in minutes) an object without an explicit |
5437 | expiry time should be considered fresh. The recommended | |
5438 | value is 0, any higher values may cause dynamic applications | |
5439 | to be erroneously cached unless the application designer | |
5440 | has taken the appropriate actions. | |
9e7dbc51 | 5441 | |
41bd17a4 | 5442 | 'Percent' is a percentage of the objects age (time since last |
5443 | modification age) an object without explicit expiry time | |
5444 | will be considered fresh. | |
5b807763 | 5445 | |
41bd17a4 | 5446 | 'Max' is an upper limit on how long objects without an explicit |
5447 | expiry time will be considered fresh. | |
9e7dbc51 | 5448 | |
41bd17a4 | 5449 | options: override-expire |
5450 | override-lastmod | |
5451 | reload-into-ims | |
5452 | ignore-reload | |
41bd17a4 | 5453 | ignore-no-store |
5454 | ignore-private | |
570d3f75 | 5455 | max-stale=NN |
41bd17a4 | 5456 | refresh-ims |
3d8b6ba4 | 5457 | store-stale |
a0ec9f68 | 5458 | |
41bd17a4 | 5459 | override-expire enforces min age even if the server |
9b2ad080 HN |
5460 | sent an explicit expiry time (e.g., with the |
5461 | Expires: header or Cache-Control: max-age). Doing this | |
5462 | VIOLATES the HTTP standard. Enabling this feature | |
5463 | could make you liable for problems which it causes. | |
6468fe10 | 5464 | |
04925576 AJ |
5465 | Note: override-expire does not enforce staleness - it only extends |
5466 | freshness / min. If the server returns a Expires time which | |
5467 | is longer than your max time, Squid will still consider | |
5468 | the object fresh for that period of time. | |
5469 | ||
41bd17a4 | 5470 | override-lastmod enforces min age even on objects |
5471 | that were modified recently. | |
934b03fc | 5472 | |
46017fdd CT |
5473 | reload-into-ims changes a client no-cache or ``reload'' |
5474 | request for a cached entry into a conditional request using | |
5475 | If-Modified-Since and/or If-None-Match headers, provided the | |
5476 | cached entry has a Last-Modified and/or a strong ETag header. | |
5477 | Doing this VIOLATES the HTTP standard. Enabling this feature | |
5478 | could make you liable for problems which it causes. | |
dba79ac5 | 5479 | |
41bd17a4 | 5480 | ignore-reload ignores a client no-cache or ``reload'' |
5481 | header. Doing this VIOLATES the HTTP standard. Enabling | |
5482 | this feature could make you liable for problems which | |
5483 | it causes. | |
9bc73deb | 5484 | |
41bd17a4 | 5485 | ignore-no-store ignores any ``Cache-control: no-store'' |
5486 | headers received from a server. Doing this VIOLATES | |
5487 | the HTTP standard. Enabling this feature could make you | |
5488 | liable for problems which it causes. | |
5489 | ||
5490 | ignore-private ignores any ``Cache-control: private'' | |
5491 | headers received from a server. Doing this VIOLATES | |
5492 | the HTTP standard. Enabling this feature could make you | |
5493 | liable for problems which it causes. | |
5494 | ||
41bd17a4 | 5495 | refresh-ims causes squid to contact the origin server |
5496 | when a client issues an If-Modified-Since request. This | |
5497 | ensures that the client will receive an updated version | |
5498 | if one is available. | |
5499 | ||
3d8b6ba4 AJ |
5500 | store-stale stores responses even if they don't have explicit |
5501 | freshness or a validator (i.e., Last-Modified or an ETag) | |
5502 | present, or if they're already stale. By default, Squid will | |
5503 | not cache such responses because they usually can't be | |
5504 | reused. Note that such responses will be stale by default. | |
5505 | ||
570d3f75 AJ |
5506 | max-stale=NN provide a maximum staleness factor. Squid won't |
5507 | serve objects more stale than this even if it failed to | |
5508 | validate the object. Default: use the max_stale global limit. | |
5509 | ||
41bd17a4 | 5510 | Basically a cached object is: |
5511 | ||
fb41bbb2 | 5512 | FRESH if expire > now, else STALE |
41bd17a4 | 5513 | STALE if age > max |
5514 | FRESH if lm-factor < percent, else STALE | |
5515 | FRESH if age < min | |
5516 | else STALE | |
5517 | ||
5518 | The refresh_pattern lines are checked in the order listed here. | |
5519 | The first entry which matches is used. If none of the entries | |
5520 | match the default will be used. | |
5521 | ||
5522 | Note, you must uncomment all the default lines if you want | |
5523 | to change one. The default setting is only active if none is | |
5524 | used. | |
5525 | ||
41bd17a4 | 5526 | NOCOMMENT_START |
e0855596 | 5527 | |
638402dd | 5528 | # |
e0855596 | 5529 | # Add any of your own refresh_pattern entries above these. |
638402dd | 5530 | # |
41bd17a4 | 5531 | refresh_pattern ^ftp: 1440 20% 10080 |
5532 | refresh_pattern ^gopher: 1440 0% 1440 | |
89db45fa | 5533 | refresh_pattern -i (/cgi-bin/|\?) 0 0% 0 |
41bd17a4 | 5534 | refresh_pattern . 0 20% 4320 |
5535 | NOCOMMENT_END | |
5536 | DOC_END | |
5537 | ||
5538 | NAME: quick_abort_min | |
5539 | COMMENT: (KB) | |
5540 | TYPE: kb_int64_t | |
5541 | DEFAULT: 16 KB | |
5542 | LOC: Config.quickAbort.min | |
5543 | DOC_NONE | |
5544 | ||
5545 | NAME: quick_abort_max | |
5546 | COMMENT: (KB) | |
5547 | TYPE: kb_int64_t | |
5548 | DEFAULT: 16 KB | |
5549 | LOC: Config.quickAbort.max | |
5550 | DOC_NONE | |
5551 | ||
5552 | NAME: quick_abort_pct | |
5553 | COMMENT: (percent) | |
5554 | TYPE: int | |
5555 | DEFAULT: 95 | |
5556 | LOC: Config.quickAbort.pct | |
5557 | DOC_START | |
5558 | The cache by default continues downloading aborted requests | |
5559 | which are almost completed (less than 16 KB remaining). This | |
5560 | may be undesirable on slow (e.g. SLIP) links and/or very busy | |
5561 | caches. Impatient users may tie up file descriptors and | |
5562 | bandwidth by repeatedly requesting and immediately aborting | |
5563 | downloads. | |
5564 | ||
5565 | When the user aborts a request, Squid will check the | |
2d4eefd9 | 5566 | quick_abort values to the amount of data transferred until |
41bd17a4 | 5567 | then. |
5568 | ||
5569 | If the transfer has less than 'quick_abort_min' KB remaining, | |
5570 | it will finish the retrieval. | |
5571 | ||
5572 | If the transfer has more than 'quick_abort_max' KB remaining, | |
5573 | it will abort the retrieval. | |
5574 | ||
5575 | If more than 'quick_abort_pct' of the transfer has completed, | |
5576 | it will finish the retrieval. | |
5577 | ||
5578 | If you do not want any retrieval to continue after the client | |
5579 | has aborted, set both 'quick_abort_min' and 'quick_abort_max' | |
5580 | to '0 KB'. | |
5581 | ||
5582 | If you want retrievals to always continue if they are being | |
5583 | cached set 'quick_abort_min' to '-1 KB'. | |
5584 | DOC_END | |
60d096f4 | 5585 | |
41bd17a4 | 5586 | NAME: read_ahead_gap |
5587 | COMMENT: buffer-size | |
5588 | TYPE: b_int64_t | |
5589 | LOC: Config.readAheadGap | |
5590 | DEFAULT: 16 KB | |
5591 | DOC_START | |
5592 | The amount of data the cache will buffer ahead of what has been | |
5593 | sent to the client when retrieving an object from another server. | |
5594 | DOC_END | |
53e738c6 | 5595 | |
41bd17a4 | 5596 | NAME: negative_ttl |
626096be | 5597 | IFDEF: USE_HTTP_VIOLATIONS |
41bd17a4 | 5598 | COMMENT: time-units |
5599 | TYPE: time_t | |
5600 | LOC: Config.negativeTtl | |
ac9cc053 | 5601 | DEFAULT: 0 seconds |
41bd17a4 | 5602 | DOC_START |
ac9cc053 AJ |
5603 | Set the Default Time-to-Live (TTL) for failed requests. |
5604 | Certain types of failures (such as "connection refused" and | |
5605 | "404 Not Found") are able to be negatively-cached for a short time. | |
5606 | Modern web servers should provide Expires: header, however if they | |
5607 | do not this can provide a minimum TTL. | |
5608 | The default is not to cache errors with unknown expiry details. | |
5609 | ||
5610 | Note that this is different from negative caching of DNS lookups. | |
39956c7c AJ |
5611 | |
5612 | WARNING: Doing this VIOLATES the HTTP standard. Enabling | |
5613 | this feature could make you liable for problems which it | |
5614 | causes. | |
41bd17a4 | 5615 | DOC_END |
53e738c6 | 5616 | |
41bd17a4 | 5617 | NAME: positive_dns_ttl |
5618 | COMMENT: time-units | |
5619 | TYPE: time_t | |
5620 | LOC: Config.positiveDnsTtl | |
5621 | DEFAULT: 6 hours | |
5622 | DOC_START | |
5623 | Upper limit on how long Squid will cache positive DNS responses. | |
5624 | Default is 6 hours (360 minutes). This directive must be set | |
5625 | larger than negative_dns_ttl. | |
5626 | DOC_END | |
c4ab8329 | 5627 | |
41bd17a4 | 5628 | NAME: negative_dns_ttl |
5629 | COMMENT: time-units | |
5630 | TYPE: time_t | |
5631 | LOC: Config.negativeDnsTtl | |
5632 | DEFAULT: 1 minutes | |
5633 | DOC_START | |
5634 | Time-to-Live (TTL) for negative caching of failed DNS lookups. | |
5635 | This also sets the lower cache limit on positive lookups. | |
5636 | Minimum value is 1 second, and it is not recommendable to go | |
5637 | much below 10 seconds. | |
5638 | DOC_END | |
7df0bfd7 | 5639 | |
41bd17a4 | 5640 | NAME: range_offset_limit |
11e3fa1c AJ |
5641 | COMMENT: size [acl acl...] |
5642 | TYPE: acl_b_size_t | |
41bd17a4 | 5643 | LOC: Config.rangeOffsetLimit |
11e3fa1c | 5644 | DEFAULT: none |
41bd17a4 | 5645 | DOC_START |
11e3fa1c AJ |
5646 | usage: (size) [units] [[!]aclname] |
5647 | ||
5648 | Sets an upper limit on how far (number of bytes) into the file | |
5649 | a Range request may be to cause Squid to prefetch the whole file. | |
5650 | If beyond this limit, Squid forwards the Range request as it is and | |
5651 | the result is NOT cached. | |
5652 | ||
41bd17a4 | 5653 | This is to stop a far ahead range request (lets say start at 17MB) |
5654 | from making Squid fetch the whole object up to that point before | |
5655 | sending anything to the client. | |
11e3fa1c AJ |
5656 | |
5657 | Multiple range_offset_limit lines may be specified, and they will | |
5658 | be searched from top to bottom on each request until a match is found. | |
5659 | The first match found will be used. If no line matches a request, the | |
5660 | default limit of 0 bytes will be used. | |
5661 | ||
5662 | 'size' is the limit specified as a number of units. | |
5663 | ||
5664 | 'units' specifies whether to use bytes, KB, MB, etc. | |
5665 | If no units are specified bytes are assumed. | |
5666 | ||
5667 | A size of 0 causes Squid to never fetch more than the | |
ab275c7b | 5668 | client requested. (default) |
11e3fa1c AJ |
5669 | |
5670 | A size of 'none' causes Squid to always fetch the object from the | |
41bd17a4 | 5671 | beginning so it may cache the result. (2.0 style) |
11e3fa1c AJ |
5672 | |
5673 | 'aclname' is the name of a defined ACL. | |
5674 | ||
5675 | NP: Using 'none' as the byte value here will override any quick_abort settings | |
5676 | that may otherwise apply to the range request. The range request will | |
ab275c7b AJ |
5677 | be fully fetched from start to finish regardless of the client |
5678 | actions. This affects bandwidth usage. | |
41bd17a4 | 5679 | DOC_END |
d95b862f | 5680 | |
41bd17a4 | 5681 | NAME: minimum_expiry_time |
5682 | COMMENT: (seconds) | |
5683 | TYPE: time_t | |
5684 | LOC: Config.minimum_expiry_time | |
5685 | DEFAULT: 60 seconds | |
5686 | DOC_START | |
5687 | The minimum caching time according to (Expires - Date) | |
638402dd AJ |
5688 | headers Squid honors if the object can't be revalidated. |
5689 | The default is 60 seconds. | |
5690 | ||
5691 | In reverse proxy environments it might be desirable to honor | |
5692 | shorter object lifetimes. It is most likely better to make | |
5693 | your server return a meaningful Last-Modified header however. | |
5694 | ||
5695 | In ESI environments where page fragments often have short | |
5696 | lifetimes, this will often be best set to 0. | |
41bd17a4 | 5697 | DOC_END |
c68e9c6b | 5698 | |
41bd17a4 | 5699 | NAME: store_avg_object_size |
58d5c5dd DK |
5700 | COMMENT: (bytes) |
5701 | TYPE: b_int64_t | |
41bd17a4 | 5702 | DEFAULT: 13 KB |
5703 | LOC: Config.Store.avgObjectSize | |
5704 | DOC_START | |
5705 | Average object size, used to estimate number of objects your | |
5706 | cache can hold. The default is 13 KB. | |
638402dd AJ |
5707 | |
5708 | This is used to pre-seed the cache index memory allocation to | |
5709 | reduce expensive reallocate operations while handling clients | |
5710 | traffic. Too-large values may result in memory allocation during | |
5711 | peak traffic, too-small values will result in wasted memory. | |
5712 | ||
5713 | Check the cache manager 'info' report metrics for the real | |
5714 | object sizes seen by your Squid before tuning this. | |
cccac0a2 | 5715 | DOC_END |
5716 | ||
41bd17a4 | 5717 | NAME: store_objects_per_bucket |
5718 | TYPE: int | |
5719 | DEFAULT: 20 | |
5720 | LOC: Config.Store.objectsPerBucket | |
5721 | DOC_START | |
5722 | Target number of objects per bucket in the store hash table. | |
5723 | Lowering this value increases the total number of buckets and | |
5724 | also the storage maintenance rate. The default is 20. | |
5725 | DOC_END | |
5726 | ||
5727 | COMMENT_START | |
5728 | HTTP OPTIONS | |
5729 | ----------------------------------------------------------------------------- | |
5730 | COMMENT_END | |
5731 | ||
f04b37d8 | 5732 | NAME: request_header_max_size |
5733 | COMMENT: (KB) | |
5734 | TYPE: b_size_t | |
df2eec10 | 5735 | DEFAULT: 64 KB |
f04b37d8 | 5736 | LOC: Config.maxRequestHeaderSize |
5737 | DOC_START | |
5738 | This specifies the maximum size for HTTP headers in a request. | |
5739 | Request headers are usually relatively small (about 512 bytes). | |
5740 | Placing a limit on the request header size will catch certain | |
5741 | bugs (for example with persistent connections) and possibly | |
5742 | buffer-overflow or denial-of-service attacks. | |
5743 | DOC_END | |
5744 | ||
5745 | NAME: reply_header_max_size | |
5746 | COMMENT: (KB) | |
5747 | TYPE: b_size_t | |
df2eec10 | 5748 | DEFAULT: 64 KB |
f04b37d8 | 5749 | LOC: Config.maxReplyHeaderSize |
5750 | DOC_START | |
5751 | This specifies the maximum size for HTTP headers in a reply. | |
5752 | Reply headers are usually relatively small (about 512 bytes). | |
5753 | Placing a limit on the reply header size will catch certain | |
5754 | bugs (for example with persistent connections) and possibly | |
5755 | buffer-overflow or denial-of-service attacks. | |
5756 | DOC_END | |
5757 | ||
5758 | NAME: request_body_max_size | |
5759 | COMMENT: (bytes) | |
5760 | TYPE: b_int64_t | |
5761 | DEFAULT: 0 KB | |
638402dd | 5762 | DEFAULT_DOC: No limit. |
f04b37d8 | 5763 | LOC: Config.maxRequestBodySize |
5764 | DOC_START | |
5765 | This specifies the maximum size for an HTTP request body. | |
5766 | In other words, the maximum size of a PUT/POST request. | |
5767 | A user who attempts to send a request with a body larger | |
5768 | than this limit receives an "Invalid Request" error message. | |
5769 | If you set this parameter to a zero (the default), there will | |
5770 | be no limit imposed. | |
638402dd AJ |
5771 | |
5772 | See also client_request_buffer_max_size for an alternative | |
5773 | limitation on client uploads which can be configured. | |
f04b37d8 | 5774 | DOC_END |
5775 | ||
1368d115 CT |
5776 | NAME: client_request_buffer_max_size |
5777 | COMMENT: (bytes) | |
5778 | TYPE: b_size_t | |
5779 | DEFAULT: 512 KB | |
5780 | LOC: Config.maxRequestBufferSize | |
5781 | DOC_START | |
5782 | This specifies the maximum buffer size of a client request. | |
5783 | It prevents squid eating too much memory when somebody uploads | |
5784 | a large file. | |
5785 | DOC_END | |
5786 | ||
41bd17a4 | 5787 | NAME: broken_posts |
626096be | 5788 | IFDEF: USE_HTTP_VIOLATIONS |
cccac0a2 | 5789 | TYPE: acl_access |
cccac0a2 | 5790 | DEFAULT: none |
638402dd | 5791 | DEFAULT_DOC: Obey RFC 2616. |
41bd17a4 | 5792 | LOC: Config.accessList.brokenPosts |
cccac0a2 | 5793 | DOC_START |
41bd17a4 | 5794 | A list of ACL elements which, if matched, causes Squid to send |
5795 | an extra CRLF pair after the body of a PUT/POST request. | |
cccac0a2 | 5796 | |
41bd17a4 | 5797 | Some HTTP servers has broken implementations of PUT/POST, |
5798 | and rely on an extra CRLF pair sent by some WWW clients. | |
cccac0a2 | 5799 | |
41bd17a4 | 5800 | Quote from RFC2616 section 4.1 on this matter: |
cccac0a2 | 5801 | |
41bd17a4 | 5802 | Note: certain buggy HTTP/1.0 client implementations generate an |
5803 | extra CRLF's after a POST request. To restate what is explicitly | |
5804 | forbidden by the BNF, an HTTP/1.1 client must not preface or follow | |
5805 | a request with an extra CRLF. | |
cccac0a2 | 5806 | |
b3567eb5 FC |
5807 | This clause only supports fast acl types. |
5808 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
5809 | ||
41bd17a4 | 5810 | Example: |
5811 | acl buggy_server url_regex ^http://.... | |
5812 | broken_posts allow buggy_server | |
5813 | DOC_END | |
cccac0a2 | 5814 | |
22fff3bf | 5815 | NAME: adaptation_uses_indirect_client icap_uses_indirect_client |
57d76dd4 AJ |
5816 | COMMENT: on|off |
5817 | TYPE: onoff | |
22fff3bf | 5818 | IFDEF: FOLLOW_X_FORWARDED_FOR&&USE_ADAPTATION |
57d76dd4 | 5819 | DEFAULT: on |
22fff3bf | 5820 | LOC: Adaptation::Config::use_indirect_client |
57d76dd4 | 5821 | DOC_START |
ea3ae478 AR |
5822 | Controls whether the indirect client IP address (instead of the direct |
5823 | client IP address) is passed to adaptation services. | |
5824 | ||
5825 | See also: follow_x_forwarded_for adaptation_send_client_ip | |
57d76dd4 AJ |
5826 | DOC_END |
5827 | ||
41bd17a4 | 5828 | NAME: via |
626096be | 5829 | IFDEF: USE_HTTP_VIOLATIONS |
41bd17a4 | 5830 | COMMENT: on|off |
5831 | TYPE: onoff | |
5832 | DEFAULT: on | |
5833 | LOC: Config.onoff.via | |
5834 | DOC_START | |
5835 | If set (default), Squid will include a Via header in requests and | |
5836 | replies as required by RFC2616. | |
5837 | DOC_END | |
4cc6eb12 | 5838 | |
41bd17a4 | 5839 | NAME: ie_refresh |
5840 | COMMENT: on|off | |
5841 | TYPE: onoff | |
5842 | LOC: Config.onoff.ie_refresh | |
5843 | DEFAULT: off | |
5844 | DOC_START | |
5845 | Microsoft Internet Explorer up until version 5.5 Service | |
5846 | Pack 1 has an issue with transparent proxies, wherein it | |
5847 | is impossible to force a refresh. Turning this on provides | |
5848 | a partial fix to the problem, by causing all IMS-REFRESH | |
5849 | requests from older IE versions to check the origin server | |
5850 | for fresh content. This reduces hit ratio by some amount | |
5851 | (~10% in my experience), but allows users to actually get | |
5852 | fresh content when they want it. Note because Squid | |
5853 | cannot tell if the user is using 5.5 or 5.5SP1, the behavior | |
5854 | of 5.5 is unchanged from old versions of Squid (i.e. a | |
5855 | forced refresh is impossible). Newer versions of IE will, | |
5856 | hopefully, continue to have the new behavior and will be | |
5857 | handled based on that assumption. This option defaults to | |
5858 | the old Squid behavior, which is better for hit ratios but | |
5859 | worse for clients using IE, if they need to be able to | |
5860 | force fresh content. | |
5861 | DOC_END | |
b9d7fe3e | 5862 | |
41bd17a4 | 5863 | NAME: vary_ignore_expire |
5864 | COMMENT: on|off | |
5865 | TYPE: onoff | |
5866 | LOC: Config.onoff.vary_ignore_expire | |
5867 | DEFAULT: off | |
5868 | DOC_START | |
5869 | Many HTTP servers supporting Vary gives such objects | |
5870 | immediate expiry time with no cache-control header | |
5871 | when requested by a HTTP/1.0 client. This option | |
5872 | enables Squid to ignore such expiry times until | |
5873 | HTTP/1.1 is fully implemented. | |
7e73cd78 AJ |
5874 | |
5875 | WARNING: If turned on this may eventually cause some | |
5876 | varying objects not intended for caching to get cached. | |
cccac0a2 | 5877 | DOC_END |
c4ab8329 | 5878 | |
41bd17a4 | 5879 | NAME: request_entities |
5880 | TYPE: onoff | |
5881 | LOC: Config.onoff.request_entities | |
5882 | DEFAULT: off | |
5883 | DOC_START | |
5884 | Squid defaults to deny GET and HEAD requests with request entities, | |
5885 | as the meaning of such requests are undefined in the HTTP standard | |
5886 | even if not explicitly forbidden. | |
0976f8db | 5887 | |
41bd17a4 | 5888 | Set this directive to on if you have clients which insists |
5889 | on sending request entities in GET or HEAD requests. But be warned | |
5890 | that there is server software (both proxies and web servers) which | |
5891 | can fail to properly process this kind of request which may make you | |
5892 | vulnerable to cache pollution attacks if enabled. | |
cccac0a2 | 5893 | DOC_END |
6b53c392 | 5894 | |
41bd17a4 | 5895 | NAME: request_header_access |
626096be | 5896 | IFDEF: USE_HTTP_VIOLATIONS |
3b07476b | 5897 | TYPE: http_header_access |
41bd17a4 | 5898 | LOC: Config.request_header_access |
cccac0a2 | 5899 | DEFAULT: none |
638402dd | 5900 | DEFAULT_DOC: No limits. |
cccac0a2 | 5901 | DOC_START |
41bd17a4 | 5902 | Usage: request_header_access header_name allow|deny [!]aclname ... |
0976f8db | 5903 | |
41bd17a4 | 5904 | WARNING: Doing this VIOLATES the HTTP standard. Enabling |
5905 | this feature could make you liable for problems which it | |
5906 | causes. | |
0976f8db | 5907 | |
41bd17a4 | 5908 | This option replaces the old 'anonymize_headers' and the |
5909 | older 'http_anonymizer' option with something that is much | |
3b07476b CT |
5910 | more configurable. A list of ACLs for each header name allows |
5911 | removal of specific header fields under specific conditions. | |
5912 | ||
5913 | This option only applies to outgoing HTTP request headers (i.e., | |
5914 | headers sent by Squid to the next HTTP hop such as a cache peer | |
5915 | or an origin server). The option has no effect during cache hit | |
5916 | detection. The equivalent adaptation vectoring point in ICAP | |
5917 | terminology is post-cache REQMOD. | |
5918 | ||
5919 | The option is applied to individual outgoing request header | |
5920 | fields. For each request header field F, Squid uses the first | |
5921 | qualifying sets of request_header_access rules: | |
5922 | ||
5923 | 1. Rules with header_name equal to F's name. | |
5924 | 2. Rules with header_name 'Other', provided F's name is not | |
5925 | on the hard-coded list of commonly used HTTP header names. | |
5926 | 3. Rules with header_name 'All'. | |
5927 | ||
5928 | Within that qualifying rule set, rule ACLs are checked as usual. | |
5929 | If ACLs of an "allow" rule match, the header field is allowed to | |
5930 | go through as is. If ACLs of a "deny" rule match, the header is | |
5931 | removed and request_header_replace is then checked to identify | |
5932 | if the removed header has a replacement. If no rules within the | |
5933 | set have matching ACLs, the header field is left as is. | |
5401aa8d | 5934 | |
41bd17a4 | 5935 | For example, to achieve the same behavior as the old |
5936 | 'http_anonymizer standard' option, you should use: | |
5401aa8d | 5937 | |
41bd17a4 | 5938 | request_header_access From deny all |
5939 | request_header_access Referer deny all | |
41bd17a4 | 5940 | request_header_access User-Agent deny all |
5401aa8d | 5941 | |
41bd17a4 | 5942 | Or, to reproduce the old 'http_anonymizer paranoid' feature |
5943 | you should use: | |
5401aa8d | 5944 | |
41bd17a4 | 5945 | request_header_access Authorization allow all |
41bd17a4 | 5946 | request_header_access Proxy-Authorization allow all |
41bd17a4 | 5947 | request_header_access Cache-Control allow all |
41bd17a4 | 5948 | request_header_access Content-Length allow all |
5949 | request_header_access Content-Type allow all | |
5950 | request_header_access Date allow all | |
41bd17a4 | 5951 | request_header_access Host allow all |
5952 | request_header_access If-Modified-Since allow all | |
41bd17a4 | 5953 | request_header_access Pragma allow all |
5954 | request_header_access Accept allow all | |
5955 | request_header_access Accept-Charset allow all | |
5956 | request_header_access Accept-Encoding allow all | |
5957 | request_header_access Accept-Language allow all | |
41bd17a4 | 5958 | request_header_access Connection allow all |
41bd17a4 | 5959 | request_header_access All deny all |
5401aa8d | 5960 | |
638402dd | 5961 | HTTP reply headers are controlled with the reply_header_access directive. |
5401aa8d | 5962 | |
638402dd | 5963 | By default, all headers are allowed (no anonymizing is performed). |
5401aa8d | 5964 | DOC_END |
5965 | ||
41bd17a4 | 5966 | NAME: reply_header_access |
626096be | 5967 | IFDEF: USE_HTTP_VIOLATIONS |
3b07476b | 5968 | TYPE: http_header_access |
41bd17a4 | 5969 | LOC: Config.reply_header_access |
cccac0a2 | 5970 | DEFAULT: none |
638402dd | 5971 | DEFAULT_DOC: No limits. |
cccac0a2 | 5972 | DOC_START |
41bd17a4 | 5973 | Usage: reply_header_access header_name allow|deny [!]aclname ... |
934b03fc | 5974 | |
41bd17a4 | 5975 | WARNING: Doing this VIOLATES the HTTP standard. Enabling |
5976 | this feature could make you liable for problems which it | |
5977 | causes. | |
934b03fc | 5978 | |
41bd17a4 | 5979 | This option only applies to reply headers, i.e., from the |
5980 | server to the client. | |
934b03fc | 5981 | |
41bd17a4 | 5982 | This is the same as request_header_access, but in the other |
3b07476b CT |
5983 | direction. Please see request_header_access for detailed |
5984 | documentation. | |
cccac0a2 | 5985 | |
41bd17a4 | 5986 | For example, to achieve the same behavior as the old |
5987 | 'http_anonymizer standard' option, you should use: | |
cccac0a2 | 5988 | |
41bd17a4 | 5989 | reply_header_access Server deny all |
41bd17a4 | 5990 | reply_header_access WWW-Authenticate deny all |
5991 | reply_header_access Link deny all | |
cccac0a2 | 5992 | |
41bd17a4 | 5993 | Or, to reproduce the old 'http_anonymizer paranoid' feature |
5994 | you should use: | |
cccac0a2 | 5995 | |
41bd17a4 | 5996 | reply_header_access Allow allow all |
41bd17a4 | 5997 | reply_header_access WWW-Authenticate allow all |
41bd17a4 | 5998 | reply_header_access Proxy-Authenticate allow all |
5999 | reply_header_access Cache-Control allow all | |
6000 | reply_header_access Content-Encoding allow all | |
6001 | reply_header_access Content-Length allow all | |
6002 | reply_header_access Content-Type allow all | |
6003 | reply_header_access Date allow all | |
6004 | reply_header_access Expires allow all | |
41bd17a4 | 6005 | reply_header_access Last-Modified allow all |
6006 | reply_header_access Location allow all | |
6007 | reply_header_access Pragma allow all | |
41bd17a4 | 6008 | reply_header_access Content-Language allow all |
41bd17a4 | 6009 | reply_header_access Retry-After allow all |
6010 | reply_header_access Title allow all | |
638402dd | 6011 | reply_header_access Content-Disposition allow all |
41bd17a4 | 6012 | reply_header_access Connection allow all |
41bd17a4 | 6013 | reply_header_access All deny all |
cccac0a2 | 6014 | |
638402dd | 6015 | HTTP request headers are controlled with the request_header_access directive. |
cccac0a2 | 6016 | |
41bd17a4 | 6017 | By default, all headers are allowed (no anonymizing is |
6018 | performed). | |
cccac0a2 | 6019 | DOC_END |
6020 | ||
75e4f2ea | 6021 | NAME: request_header_replace header_replace |
626096be | 6022 | IFDEF: USE_HTTP_VIOLATIONS |
3b07476b | 6023 | TYPE: http_header_replace |
41bd17a4 | 6024 | LOC: Config.request_header_access |
cccac0a2 | 6025 | DEFAULT: none |
41bd17a4 | 6026 | DOC_START |
75e4f2ea MB |
6027 | Usage: request_header_replace header_name message |
6028 | Example: request_header_replace User-Agent Nutscrape/1.0 (CP/M; 8-bit) | |
cccac0a2 | 6029 | |
41bd17a4 | 6030 | This option allows you to change the contents of headers |
75e4f2ea | 6031 | denied with request_header_access above, by replacing them |
638402dd | 6032 | with some fixed string. |
cccac0a2 | 6033 | |
41bd17a4 | 6034 | This only applies to request headers, not reply headers. |
cccac0a2 | 6035 | |
41bd17a4 | 6036 | By default, headers are removed if denied. |
6037 | DOC_END | |
cccac0a2 | 6038 | |
75e4f2ea MB |
6039 | NAME: reply_header_replace |
6040 | IFDEF: USE_HTTP_VIOLATIONS | |
3b07476b | 6041 | TYPE: http_header_replace |
75e4f2ea MB |
6042 | LOC: Config.reply_header_access |
6043 | DEFAULT: none | |
6044 | DOC_START | |
6045 | Usage: reply_header_replace header_name message | |
6046 | Example: reply_header_replace Server Foo/1.0 | |
6047 | ||
6048 | This option allows you to change the contents of headers | |
6049 | denied with reply_header_access above, by replacing them | |
6050 | with some fixed string. | |
6051 | ||
6052 | This only applies to reply headers, not request headers. | |
6053 | ||
6054 | By default, headers are removed if denied. | |
6055 | DOC_END | |
6056 | ||
f4698e0b CT |
6057 | NAME: request_header_add |
6058 | TYPE: HeaderWithAclList | |
6059 | LOC: Config.request_header_add | |
6060 | DEFAULT: none | |
6061 | DOC_START | |
6062 | Usage: request_header_add field-name field-value acl1 [acl2] ... | |
6063 | Example: request_header_add X-Client-CA "CA=%ssl::>cert_issuer" all | |
6064 | ||
6065 | This option adds header fields to outgoing HTTP requests (i.e., | |
6066 | request headers sent by Squid to the next HTTP hop such as a | |
6067 | cache peer or an origin server). The option has no effect during | |
6068 | cache hit detection. The equivalent adaptation vectoring point | |
6069 | in ICAP terminology is post-cache REQMOD. | |
6070 | ||
6071 | Field-name is a token specifying an HTTP header name. If a | |
6072 | standard HTTP header name is used, Squid does not check whether | |
6073 | the new header conflicts with any existing headers or violates | |
6074 | HTTP rules. If the request to be modified already contains a | |
6075 | field with the same name, the old field is preserved but the | |
6076 | header field values are not merged. | |
6077 | ||
6078 | Field-value is either a token or a quoted string. If quoted | |
6079 | string format is used, then the surrounding quotes are removed | |
6080 | while escape sequences and %macros are processed. | |
6081 | ||
6082 | In theory, all of the logformat codes can be used as %macros. | |
6083 | However, unlike logging (which happens at the very end of | |
6084 | transaction lifetime), the transaction may not yet have enough | |
6085 | information to expand a macro when the new header value is needed. | |
6086 | And some information may already be available to Squid but not yet | |
6087 | committed where the macro expansion code can access it (report | |
6088 | such instances!). The macro will be expanded into a single dash | |
6089 | ('-') in such cases. Not all macros have been tested. | |
6090 | ||
6091 | One or more Squid ACLs may be specified to restrict header | |
6092 | injection to matching requests. As always in squid.conf, all | |
6093 | ACLs in an option ACL list must be satisfied for the insertion | |
6094 | to happen. The request_header_add option supports fast ACLs | |
6095 | only. | |
6096 | DOC_END | |
6097 | ||
d7f4a0b7 CT |
6098 | NAME: note |
6099 | TYPE: note | |
6100 | LOC: Config.notes | |
6101 | DEFAULT: none | |
6102 | DOC_START | |
6103 | This option used to log custom information about the master | |
6104 | transaction. For example, an admin may configure Squid to log | |
6105 | which "user group" the transaction belongs to, where "user group" | |
6106 | will be determined based on a set of ACLs and not [just] | |
6107 | authentication information. | |
6108 | Values of key/value pairs can be logged using %{key}note macros: | |
6109 | ||
6110 | note key value acl ... | |
6111 | logformat myFormat ... %{key}note ... | |
6112 | DOC_END | |
6113 | ||
41bd17a4 | 6114 | NAME: relaxed_header_parser |
6115 | COMMENT: on|off|warn | |
6116 | TYPE: tristate | |
6117 | LOC: Config.onoff.relaxed_header_parser | |
6118 | DEFAULT: on | |
6119 | DOC_START | |
6120 | In the default "on" setting Squid accepts certain forms | |
6121 | of non-compliant HTTP messages where it is unambiguous | |
6122 | what the sending application intended even if the message | |
6123 | is not correctly formatted. The messages is then normalized | |
6124 | to the correct form when forwarded by Squid. | |
cccac0a2 | 6125 | |
41bd17a4 | 6126 | If set to "warn" then a warning will be emitted in cache.log |
6127 | each time such HTTP error is encountered. | |
cccac0a2 | 6128 | |
41bd17a4 | 6129 | If set to "off" then such HTTP errors will cause the request |
6130 | or response to be rejected. | |
6131 | DOC_END | |
7d90757b | 6132 | |
55eae904 AR |
6133 | NAME: collapsed_forwarding |
6134 | COMMENT: (on|off) | |
6135 | TYPE: onoff | |
6136 | LOC: Config.onoff.collapsed_forwarding | |
6137 | DEFAULT: off | |
6138 | DOC_START | |
6139 | This option controls whether Squid is allowed to merge multiple | |
6140 | potentially cachable requests for the same URI before Squid knows | |
6141 | whether the response is going to be cachable. | |
6142 | ||
6143 | This feature is disabled by default: Enabling collapsed forwarding | |
6144 | needlessly delays forwarding requests that look cachable (when they are | |
6145 | collapsed) but then need to be forwarded individually anyway because | |
6146 | they end up being for uncachable content. However, in some cases, such | |
6147 | as accelleration of highly cachable content with periodic or groupped | |
6148 | expiration times, the gains from collapsing [large volumes of | |
6149 | simultenous refresh requests] outweigh losses from such delays. | |
6150 | DOC_END | |
6151 | ||
41bd17a4 | 6152 | COMMENT_START |
6153 | TIMEOUTS | |
6154 | ----------------------------------------------------------------------------- | |
6155 | COMMENT_END | |
6156 | ||
6157 | NAME: forward_timeout | |
6158 | COMMENT: time-units | |
6159 | TYPE: time_t | |
6160 | LOC: Config.Timeout.forward | |
6161 | DEFAULT: 4 minutes | |
6162 | DOC_START | |
6163 | This parameter specifies how long Squid should at most attempt in | |
6164 | finding a forwarding path for the request before giving up. | |
cccac0a2 | 6165 | DOC_END |
6166 | ||
41bd17a4 | 6167 | NAME: connect_timeout |
6168 | COMMENT: time-units | |
6169 | TYPE: time_t | |
6170 | LOC: Config.Timeout.connect | |
6171 | DEFAULT: 1 minute | |
057f5854 | 6172 | DOC_START |
41bd17a4 | 6173 | This parameter specifies how long to wait for the TCP connect to |
6174 | the requested server or peer to complete before Squid should | |
6175 | attempt to find another path where to forward the request. | |
057f5854 | 6176 | DOC_END |
6177 | ||
41bd17a4 | 6178 | NAME: peer_connect_timeout |
6179 | COMMENT: time-units | |
6180 | TYPE: time_t | |
6181 | LOC: Config.Timeout.peer_connect | |
6182 | DEFAULT: 30 seconds | |
cccac0a2 | 6183 | DOC_START |
41bd17a4 | 6184 | This parameter specifies how long to wait for a pending TCP |
6185 | connection to a peer cache. The default is 30 seconds. You | |
6186 | may also set different timeout values for individual neighbors | |
6187 | with the 'connect-timeout' option on a 'cache_peer' line. | |
6188 | DOC_END | |
7f7db318 | 6189 | |
41bd17a4 | 6190 | NAME: read_timeout |
6191 | COMMENT: time-units | |
6192 | TYPE: time_t | |
6193 | LOC: Config.Timeout.read | |
6194 | DEFAULT: 15 minutes | |
6195 | DOC_START | |
d5430dc8 AJ |
6196 | Applied on peer server connections. |
6197 | ||
6198 | After each successful read(), the timeout will be extended by this | |
41bd17a4 | 6199 | amount. If no data is read again after this amount of time, |
d5430dc8 AJ |
6200 | the request is aborted and logged with ERR_READ_TIMEOUT. |
6201 | ||
6202 | The default is 15 minutes. | |
41bd17a4 | 6203 | DOC_END |
cccac0a2 | 6204 | |
5ef5e5cc AJ |
6205 | NAME: write_timeout |
6206 | COMMENT: time-units | |
6207 | TYPE: time_t | |
6208 | LOC: Config.Timeout.write | |
6209 | DEFAULT: 15 minutes | |
6210 | DOC_START | |
6211 | This timeout is tracked for all connections that have data | |
6212 | available for writing and are waiting for the socket to become | |
6213 | ready. After each successful write, the timeout is extended by | |
6214 | the configured amount. If Squid has data to write but the | |
6215 | connection is not ready for the configured duration, the | |
6216 | transaction associated with the connection is terminated. The | |
6217 | default is 15 minutes. | |
6218 | DOC_END | |
6219 | ||
41bd17a4 | 6220 | NAME: request_timeout |
6221 | TYPE: time_t | |
6222 | LOC: Config.Timeout.request | |
6223 | DEFAULT: 5 minutes | |
6224 | DOC_START | |
6b2a2108 | 6225 | How long to wait for complete HTTP request headers after initial |
41bd17a4 | 6226 | connection establishment. |
6227 | DOC_END | |
cccac0a2 | 6228 | |
3248e962 CT |
6229 | NAME: request_start_timeout |
6230 | TYPE: time_t | |
6231 | LOC: Config.Timeout.request_start_timeout | |
6232 | DEFAULT: 5 minutes | |
6233 | DOC_START | |
6234 | How long to wait for the first request byte after initial | |
6235 | connection establishment. | |
6236 | DOC_END | |
6237 | ||
97b32442 | 6238 | NAME: client_idle_pconn_timeout persistent_request_timeout |
41bd17a4 | 6239 | TYPE: time_t |
97b32442 | 6240 | LOC: Config.Timeout.clientIdlePconn |
41bd17a4 | 6241 | DEFAULT: 2 minutes |
6242 | DOC_START | |
6243 | How long to wait for the next HTTP request on a persistent | |
97b32442 | 6244 | client connection after the previous request completes. |
41bd17a4 | 6245 | DOC_END |
cccac0a2 | 6246 | |
f6e8754a AR |
6247 | NAME: ftp_client_idle_timeout |
6248 | TYPE: time_t | |
6249 | LOC: Config.Timeout.ftpClientIdle | |
6250 | DEFAULT: 30 minutes | |
6251 | DOC_START | |
6252 | How long to wait for an FTP request on a connection to Squid ftp_port. | |
6253 | Many FTP clients do not deal with idle connection closures well, | |
6254 | necessitating a longer default timeout than client_idle_pconn_timeout | |
6255 | used for incoming HTTP requests. | |
6256 | DOC_END | |
6257 | ||
41bd17a4 | 6258 | NAME: client_lifetime |
6259 | COMMENT: time-units | |
6260 | TYPE: time_t | |
6261 | LOC: Config.Timeout.lifetime | |
6262 | DEFAULT: 1 day | |
6263 | DOC_START | |
6264 | The maximum amount of time a client (browser) is allowed to | |
6265 | remain connected to the cache process. This protects the Cache | |
6266 | from having a lot of sockets (and hence file descriptors) tied up | |
6267 | in a CLOSE_WAIT state from remote clients that go away without | |
6268 | properly shutting down (either because of a network failure or | |
6269 | because of a poor client implementation). The default is one | |
6270 | day, 1440 minutes. | |
7d90757b | 6271 | |
41bd17a4 | 6272 | NOTE: The default value is intended to be much larger than any |
6273 | client would ever need to be connected to your cache. You | |
6274 | should probably change client_lifetime only as a last resort. | |
6275 | If you seem to have many client connections tying up | |
6276 | filedescriptors, we recommend first tuning the read_timeout, | |
6277 | request_timeout, persistent_request_timeout and quick_abort values. | |
cccac0a2 | 6278 | DOC_END |
6279 | ||
c5c06f02 CT |
6280 | NAME: pconn_lifetime |
6281 | COMMENT: time-units | |
6282 | TYPE: time_t | |
6283 | LOC: Config.Timeout.pconnLifetime | |
6284 | DEFAULT: 0 seconds | |
6285 | DOC_START | |
6286 | Desired maximum lifetime of a persistent connection. | |
6287 | When set, Squid will close a now-idle persistent connection that | |
6288 | exceeded configured lifetime instead of moving the connection into | |
6289 | the idle connection pool (or equivalent). No effect on ongoing/active | |
6290 | transactions. Connection lifetime is the time period from the | |
6291 | connection acceptance or opening time until "now". | |
6292 | ||
6293 | This limit is useful in environments with long-lived connections | |
6294 | where Squid configuration or environmental factors change during a | |
6295 | single connection lifetime. If unrestricted, some connections may | |
6296 | last for hours and even days, ignoring those changes that should | |
6297 | have affected their behavior or their existence. | |
6298 | ||
6299 | Currently, a new lifetime value supplied via Squid reconfiguration | |
6300 | has no effect on already idle connections unless they become busy. | |
6301 | ||
6302 | When set to '0' this limit is not used. | |
6303 | DOC_END | |
6304 | ||
41bd17a4 | 6305 | NAME: half_closed_clients |
6306 | TYPE: onoff | |
6307 | LOC: Config.onoff.half_closed_clients | |
0c2f5c4f | 6308 | DEFAULT: off |
4eb368f9 | 6309 | DOC_START |
41bd17a4 | 6310 | Some clients may shutdown the sending side of their TCP |
6311 | connections, while leaving their receiving sides open. Sometimes, | |
6312 | Squid can not tell the difference between a half-closed and a | |
0c2f5c4f AJ |
6313 | fully-closed TCP connection. |
6314 | ||
6315 | By default, Squid will immediately close client connections when | |
6316 | read(2) returns "no more data to read." | |
6317 | ||
abdf1651 | 6318 | Change this option to 'on' and Squid will keep open connections |
0c2f5c4f AJ |
6319 | until a read(2) or write(2) on the socket returns an error. |
6320 | This may show some benefits for reverse proxies. But if not | |
6321 | it is recommended to leave OFF. | |
4eb368f9 | 6322 | DOC_END |
6323 | ||
97b32442 | 6324 | NAME: server_idle_pconn_timeout pconn_timeout |
41bd17a4 | 6325 | TYPE: time_t |
97b32442 | 6326 | LOC: Config.Timeout.serverIdlePconn |
41bd17a4 | 6327 | DEFAULT: 1 minute |
cccac0a2 | 6328 | DOC_START |
41bd17a4 | 6329 | Timeout for idle persistent connections to servers and other |
6330 | proxies. | |
6331 | DOC_END | |
cccac0a2 | 6332 | |
41bd17a4 | 6333 | NAME: ident_timeout |
6334 | TYPE: time_t | |
6335 | IFDEF: USE_IDENT | |
4daaf3cb | 6336 | LOC: Ident::TheConfig.timeout |
41bd17a4 | 6337 | DEFAULT: 10 seconds |
6338 | DOC_START | |
6339 | Maximum time to wait for IDENT lookups to complete. | |
cccac0a2 | 6340 | |
41bd17a4 | 6341 | If this is too high, and you enabled IDENT lookups from untrusted |
6342 | users, you might be susceptible to denial-of-service by having | |
6343 | many ident requests going at once. | |
cccac0a2 | 6344 | DOC_END |
6345 | ||
41bd17a4 | 6346 | NAME: shutdown_lifetime |
6347 | COMMENT: time-units | |
6348 | TYPE: time_t | |
6349 | LOC: Config.shutdownLifetime | |
6350 | DEFAULT: 30 seconds | |
cccac0a2 | 6351 | DOC_START |
41bd17a4 | 6352 | When SIGTERM or SIGHUP is received, the cache is put into |
6353 | "shutdown pending" mode until all active sockets are closed. | |
6354 | This value is the lifetime to set for all open descriptors | |
6355 | during shutdown mode. Any active clients after this many | |
6356 | seconds will receive a 'timeout' message. | |
cccac0a2 | 6357 | DOC_END |
0976f8db | 6358 | |
cccac0a2 | 6359 | COMMENT_START |
6360 | ADMINISTRATIVE PARAMETERS | |
6361 | ----------------------------------------------------------------------------- | |
6362 | COMMENT_END | |
6363 | ||
6364 | NAME: cache_mgr | |
6365 | TYPE: string | |
6366 | DEFAULT: webmaster | |
6367 | LOC: Config.adminEmail | |
6368 | DOC_START | |
6369 | Email-address of local cache manager who will receive | |
638402dd | 6370 | mail if the cache dies. The default is "webmaster". |
cccac0a2 | 6371 | DOC_END |
6372 | ||
abacf776 | 6373 | NAME: mail_from |
6374 | TYPE: string | |
6375 | DEFAULT: none | |
6376 | LOC: Config.EmailFrom | |
6377 | DOC_START | |
6378 | From: email-address for mail sent when the cache dies. | |
638402dd AJ |
6379 | The default is to use 'squid@unique_hostname'. |
6380 | ||
6381 | See also: unique_hostname directive. | |
abacf776 | 6382 | DOC_END |
6383 | ||
d084bf20 | 6384 | NAME: mail_program |
6385 | TYPE: eol | |
6386 | DEFAULT: mail | |
6387 | LOC: Config.EmailProgram | |
6388 | DOC_START | |
6389 | Email program used to send mail if the cache dies. | |
846a5e31 | 6390 | The default is "mail". The specified program must comply |
d084bf20 | 6391 | with the standard Unix mail syntax: |
846a5e31 | 6392 | mail-program recipient < mailfile |
6393 | ||
d084bf20 | 6394 | Optional command line options can be specified. |
6395 | DOC_END | |
6396 | ||
cccac0a2 | 6397 | NAME: cache_effective_user |
6398 | TYPE: string | |
5483d916 | 6399 | DEFAULT: @DEFAULT_CACHE_EFFECTIVE_USER@ |
cccac0a2 | 6400 | LOC: Config.effectiveUser |
e3d74828 | 6401 | DOC_START |
6402 | If you start Squid as root, it will change its effective/real | |
6403 | UID/GID to the user specified below. The default is to change | |
5483d916 | 6404 | to UID of @DEFAULT_CACHE_EFFECTIVE_USER@. |
64e288bd | 6405 | see also; cache_effective_group |
e3d74828 | 6406 | DOC_END |
6407 | ||
cccac0a2 | 6408 | NAME: cache_effective_group |
6409 | TYPE: string | |
6410 | DEFAULT: none | |
638402dd | 6411 | DEFAULT_DOC: Use system group memberships of the cache_effective_user account |
cccac0a2 | 6412 | LOC: Config.effectiveGroup |
6413 | DOC_START | |
64e288bd | 6414 | Squid sets the GID to the effective user's default group ID |
6415 | (taken from the password file) and supplementary group list | |
6416 | from the groups membership. | |
6417 | ||
e3d74828 | 6418 | If you want Squid to run with a specific GID regardless of |
6419 | the group memberships of the effective user then set this | |
6420 | to the group (or GID) you want Squid to run as. When set | |
64e288bd | 6421 | all other group privileges of the effective user are ignored |
e3d74828 | 6422 | and only this GID is effective. If Squid is not started as |
64e288bd | 6423 | root the user starting Squid MUST be member of the specified |
e3d74828 | 6424 | group. |
64e288bd | 6425 | |
6426 | This option is not recommended by the Squid Team. | |
6427 | Our preference is for administrators to configure a secure | |
6428 | user account for squid with UID/GID matching system policies. | |
cccac0a2 | 6429 | DOC_END |
6430 | ||
d3caee79 | 6431 | NAME: httpd_suppress_version_string |
6432 | COMMENT: on|off | |
6433 | TYPE: onoff | |
6434 | DEFAULT: off | |
6435 | LOC: Config.onoff.httpd_suppress_version_string | |
6436 | DOC_START | |
6437 | Suppress Squid version string info in HTTP headers and HTML error pages. | |
6438 | DOC_END | |
6439 | ||
cccac0a2 | 6440 | NAME: visible_hostname |
6441 | TYPE: string | |
6442 | LOC: Config.visibleHostname | |
6443 | DEFAULT: none | |
638402dd | 6444 | DEFAULT_DOC: Automatically detect the system host name |
cccac0a2 | 6445 | DOC_START |
6446 | If you want to present a special hostname in error messages, etc, | |
7f7db318 | 6447 | define this. Otherwise, the return value of gethostname() |
cccac0a2 | 6448 | will be used. If you have multiple caches in a cluster and |
6449 | get errors about IP-forwarding you must set them to have individual | |
6450 | names with this setting. | |
6451 | DOC_END | |
6452 | ||
cccac0a2 | 6453 | NAME: unique_hostname |
6454 | TYPE: string | |
6455 | LOC: Config.uniqueHostname | |
6456 | DEFAULT: none | |
638402dd | 6457 | DEFAULT_DOC: Copy the value from visible_hostname |
cccac0a2 | 6458 | DOC_START |
6459 | If you want to have multiple machines with the same | |
7f7db318 | 6460 | 'visible_hostname' you must give each machine a different |
6461 | 'unique_hostname' so forwarding loops can be detected. | |
cccac0a2 | 6462 | DOC_END |
6463 | ||
cccac0a2 | 6464 | NAME: hostname_aliases |
6465 | TYPE: wordlist | |
6466 | LOC: Config.hostnameAliases | |
6467 | DEFAULT: none | |
6468 | DOC_START | |
7f7db318 | 6469 | A list of other DNS names your cache has. |
cccac0a2 | 6470 | DOC_END |
0976f8db | 6471 | |
c642c141 AJ |
6472 | NAME: umask |
6473 | TYPE: int | |
6474 | LOC: Config.umask | |
6475 | DEFAULT: 027 | |
6476 | DOC_START | |
6477 | Minimum umask which should be enforced while the proxy | |
6478 | is running, in addition to the umask set at startup. | |
6479 | ||
6480 | For a traditional octal representation of umasks, start | |
6481 | your value with 0. | |
6482 | DOC_END | |
6483 | ||
cccac0a2 | 6484 | COMMENT_START |
6485 | OPTIONS FOR THE CACHE REGISTRATION SERVICE | |
6486 | ----------------------------------------------------------------------------- | |
6487 | ||
6488 | This section contains parameters for the (optional) cache | |
6489 | announcement service. This service is provided to help | |
6490 | cache administrators locate one another in order to join or | |
6491 | create cache hierarchies. | |
6492 | ||
6493 | An 'announcement' message is sent (via UDP) to the registration | |
6494 | service by Squid. By default, the announcement message is NOT | |
6495 | SENT unless you enable it with 'announce_period' below. | |
6496 | ||
6497 | The announcement message includes your hostname, plus the | |
6498 | following information from this configuration file: | |
6499 | ||
6500 | http_port | |
6501 | icp_port | |
6502 | cache_mgr | |
6503 | ||
6504 | All current information is processed regularly and made | |
6505 | available on the Web at http://www.ircache.net/Cache/Tracker/. | |
6506 | COMMENT_END | |
6507 | ||
6508 | NAME: announce_period | |
6509 | TYPE: time_t | |
6510 | LOC: Config.Announce.period | |
6511 | DEFAULT: 0 | |
638402dd | 6512 | DEFAULT_DOC: Announcement messages disabled. |
cccac0a2 | 6513 | DOC_START |
638402dd | 6514 | This is how frequently to send cache announcements. |
cccac0a2 | 6515 | |
e0855596 | 6516 | To enable announcing your cache, just set an announce period. |
cccac0a2 | 6517 | |
e0855596 AJ |
6518 | Example: |
6519 | announce_period 1 day | |
cccac0a2 | 6520 | DOC_END |
6521 | ||
cccac0a2 | 6522 | NAME: announce_host |
6523 | TYPE: string | |
6524 | DEFAULT: tracker.ircache.net | |
6525 | LOC: Config.Announce.host | |
638402dd AJ |
6526 | DOC_START |
6527 | Set the hostname where announce registration messages will be sent. | |
6528 | ||
6529 | See also announce_port and announce_file | |
6530 | DOC_END | |
cccac0a2 | 6531 | |
6532 | NAME: announce_file | |
6533 | TYPE: string | |
6534 | DEFAULT: none | |
6535 | LOC: Config.Announce.file | |
638402dd AJ |
6536 | DOC_START |
6537 | The contents of this file will be included in the announce | |
6538 | registration messages. | |
6539 | DOC_END | |
cccac0a2 | 6540 | |
6541 | NAME: announce_port | |
ae870270 | 6542 | TYPE: u_short |
cccac0a2 | 6543 | DEFAULT: 3131 |
6544 | LOC: Config.Announce.port | |
6545 | DOC_START | |
638402dd | 6546 | Set the port where announce registration messages will be sent. |
cccac0a2 | 6547 | |
638402dd | 6548 | See also announce_host and announce_file |
cccac0a2 | 6549 | DOC_END |
6550 | ||
8d6275c0 | 6551 | COMMENT_START |
6552 | HTTPD-ACCELERATOR OPTIONS | |
6553 | ----------------------------------------------------------------------------- | |
6554 | COMMENT_END | |
6555 | ||
cccac0a2 | 6556 | NAME: httpd_accel_surrogate_id |
cccac0a2 | 6557 | TYPE: string |
b2b40d8c | 6558 | DEFAULT: none |
638402dd | 6559 | DEFAULT_DOC: visible_hostname is used if no specific ID is set. |
cccac0a2 | 6560 | LOC: Config.Accel.surrogate_id |
cccac0a2 | 6561 | DOC_START |
6562 | Surrogates (http://www.esi.org/architecture_spec_1.0.html) | |
6563 | need an identification token to allow control targeting. Because | |
6564 | a farm of surrogates may all perform the same tasks, they may share | |
6565 | an identification token. | |
6566 | DOC_END | |
6567 | ||
6568 | NAME: http_accel_surrogate_remote | |
cccac0a2 | 6569 | COMMENT: on|off |
6570 | TYPE: onoff | |
6571 | DEFAULT: off | |
6572 | LOC: Config.onoff.surrogate_is_remote | |
6573 | DOC_START | |
638402dd AJ |
6574 | Remote surrogates (such as those in a CDN) honour the header |
6575 | "Surrogate-Control: no-store-remote". | |
6576 | ||
cccac0a2 | 6577 | Set this to on to have squid behave as a remote surrogate. |
6578 | DOC_END | |
6579 | ||
6580 | NAME: esi_parser | |
f41735ea | 6581 | IFDEF: USE_SQUID_ESI |
964b44c3 | 6582 | COMMENT: libxml2|expat|custom |
cccac0a2 | 6583 | TYPE: string |
6584 | LOC: ESIParser::Type | |
6585 | DEFAULT: custom | |
6586 | DOC_START | |
6587 | ESI markup is not strictly XML compatible. The custom ESI parser | |
6588 | will give higher performance, but cannot handle non ASCII character | |
6589 | encodings. | |
6590 | DOC_END | |
0976f8db | 6591 | |
9edd9041 | 6592 | COMMENT_START |
8d6275c0 | 6593 | DELAY POOL PARAMETERS |
9edd9041 | 6594 | ----------------------------------------------------------------------------- |
6595 | COMMENT_END | |
6596 | ||
6597 | NAME: delay_pools | |
6598 | TYPE: delay_pool_count | |
6599 | DEFAULT: 0 | |
9a0a18de | 6600 | IFDEF: USE_DELAY_POOLS |
9edd9041 | 6601 | LOC: Config.Delay |
6602 | DOC_START | |
6603 | This represents the number of delay pools to be used. For example, | |
6604 | if you have one class 2 delay pool and one class 3 delays pool, you | |
6605 | have a total of 2 delay pools. | |
638402dd AJ |
6606 | |
6607 | See also delay_parameters, delay_class, delay_access for pool | |
6608 | configuration details. | |
9edd9041 | 6609 | DOC_END |
6610 | ||
6611 | NAME: delay_class | |
6612 | TYPE: delay_pool_class | |
6613 | DEFAULT: none | |
9a0a18de | 6614 | IFDEF: USE_DELAY_POOLS |
9edd9041 | 6615 | LOC: Config.Delay |
6616 | DOC_START | |
6617 | This defines the class of each delay pool. There must be exactly one | |
6618 | delay_class line for each delay pool. For example, to define two | |
6619 | delay pools, one of class 2 and one of class 3, the settings above | |
6620 | and here would be: | |
6621 | ||
b1fb3348 AJ |
6622 | Example: |
6623 | delay_pools 4 # 4 delay pools | |
6624 | delay_class 1 2 # pool 1 is a class 2 pool | |
6625 | delay_class 2 3 # pool 2 is a class 3 pool | |
6626 | delay_class 3 4 # pool 3 is a class 4 pool | |
6627 | delay_class 4 5 # pool 4 is a class 5 pool | |
9edd9041 | 6628 | |
6629 | The delay pool classes are: | |
6630 | ||
6631 | class 1 Everything is limited by a single aggregate | |
6632 | bucket. | |
6633 | ||
6634 | class 2 Everything is limited by a single aggregate | |
6635 | bucket as well as an "individual" bucket chosen | |
b1fb3348 | 6636 | from bits 25 through 32 of the IPv4 address. |
9edd9041 | 6637 | |
6638 | class 3 Everything is limited by a single aggregate | |
6639 | bucket as well as a "network" bucket chosen | |
6640 | from bits 17 through 24 of the IP address and a | |
6641 | "individual" bucket chosen from bits 17 through | |
b1fb3348 | 6642 | 32 of the IPv4 address. |
9edd9041 | 6643 | |
6644 | class 4 Everything in a class 3 delay pool, with an | |
6645 | additional limit on a per user basis. This | |
6646 | only takes effect if the username is established | |
6647 | in advance - by forcing authentication in your | |
6648 | http_access rules. | |
6649 | ||
6650 | class 5 Requests are grouped according their tag (see | |
6651 | external_acl's tag= reply). | |
6652 | ||
0b68481a AJ |
6653 | |
6654 | Each pool also requires a delay_parameters directive to configure the pool size | |
6655 | and speed limits used whenever the pool is applied to a request. Along with | |
6656 | a set of delay_access directives to determine when it is used. | |
6657 | ||
9edd9041 | 6658 | NOTE: If an IP address is a.b.c.d |
6659 | -> bits 25 through 32 are "d" | |
6660 | -> bits 17 through 24 are "c" | |
6661 | -> bits 17 through 32 are "c * 256 + d" | |
b1fb3348 AJ |
6662 | |
6663 | NOTE-2: Due to the use of bitmasks in class 2,3,4 pools they only apply to | |
6664 | IPv4 traffic. Class 1 and 5 pools may be used with IPv6 traffic. | |
638402dd AJ |
6665 | |
6666 | This clause only supports fast acl types. | |
6667 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
6668 | ||
6669 | See also delay_parameters and delay_access. | |
9edd9041 | 6670 | DOC_END |
6671 | ||
6672 | NAME: delay_access | |
6673 | TYPE: delay_pool_access | |
6674 | DEFAULT: none | |
638402dd | 6675 | DEFAULT_DOC: Deny using the pool, unless allow rules exist in squid.conf for the pool. |
9a0a18de | 6676 | IFDEF: USE_DELAY_POOLS |
9edd9041 | 6677 | LOC: Config.Delay |
6678 | DOC_START | |
6679 | This is used to determine which delay pool a request falls into. | |
6680 | ||
6681 | delay_access is sorted per pool and the matching starts with pool 1, | |
6682 | then pool 2, ..., and finally pool N. The first delay pool where the | |
6683 | request is allowed is selected for the request. If it does not allow | |
6684 | the request to any pool then the request is not delayed (default). | |
6685 | ||
6686 | For example, if you want some_big_clients in delay | |
6687 | pool 1 and lotsa_little_clients in delay pool 2: | |
6688 | ||
638402dd AJ |
6689 | delay_access 1 allow some_big_clients |
6690 | delay_access 1 deny all | |
6691 | delay_access 2 allow lotsa_little_clients | |
6692 | delay_access 2 deny all | |
6693 | delay_access 3 allow authenticated_clients | |
6694 | ||
6695 | See also delay_parameters and delay_class. | |
6696 | ||
9edd9041 | 6697 | DOC_END |
6698 | ||
6699 | NAME: delay_parameters | |
6700 | TYPE: delay_pool_rates | |
6701 | DEFAULT: none | |
9a0a18de | 6702 | IFDEF: USE_DELAY_POOLS |
9edd9041 | 6703 | LOC: Config.Delay |
6704 | DOC_START | |
6705 | This defines the parameters for a delay pool. Each delay pool has | |
6706 | a number of "buckets" associated with it, as explained in the | |
0b68481a | 6707 | description of delay_class. |
9edd9041 | 6708 | |
0b68481a | 6709 | For a class 1 delay pool, the syntax is: |
6e7502cc | 6710 | delay_class pool 1 |
0b68481a | 6711 | delay_parameters pool aggregate |
9edd9041 | 6712 | |
6713 | For a class 2 delay pool: | |
6e7502cc | 6714 | delay_class pool 2 |
0b68481a | 6715 | delay_parameters pool aggregate individual |
9edd9041 | 6716 | |
6717 | For a class 3 delay pool: | |
6e7502cc | 6718 | delay_class pool 3 |
0b68481a | 6719 | delay_parameters pool aggregate network individual |
9edd9041 | 6720 | |
6721 | For a class 4 delay pool: | |
6e7502cc | 6722 | delay_class pool 4 |
0b68481a | 6723 | delay_parameters pool aggregate network individual user |
9edd9041 | 6724 | |
6725 | For a class 5 delay pool: | |
6e7502cc | 6726 | delay_class pool 5 |
0b68481a | 6727 | delay_parameters pool tagrate |
9edd9041 | 6728 | |
0b68481a | 6729 | The option variables are: |
9edd9041 | 6730 | |
6731 | pool a pool number - ie, a number between 1 and the | |
6732 | number specified in delay_pools as used in | |
6733 | delay_class lines. | |
6734 | ||
fdb47ac6 | 6735 | aggregate the speed limit parameters for the aggregate bucket |
9edd9041 | 6736 | (class 1, 2, 3). |
6737 | ||
fdb47ac6 | 6738 | individual the speed limit parameters for the individual |
9edd9041 | 6739 | buckets (class 2, 3). |
6740 | ||
fdb47ac6 | 6741 | network the speed limit parameters for the network buckets |
9edd9041 | 6742 | (class 3). |
6743 | ||
fdb47ac6 | 6744 | user the speed limit parameters for the user buckets |
9edd9041 | 6745 | (class 4). |
6746 | ||
fdb47ac6 | 6747 | tagrate the speed limit parameters for the tag buckets |
9edd9041 | 6748 | (class 5). |
6749 | ||
6750 | A pair of delay parameters is written restore/maximum, where restore is | |
6751 | the number of bytes (not bits - modem and network speeds are usually | |
6752 | quoted in bits) per second placed into the bucket, and maximum is the | |
6753 | maximum number of bytes which can be in the bucket at any time. | |
6754 | ||
0b68481a AJ |
6755 | There must be one delay_parameters line for each delay pool. |
6756 | ||
6757 | ||
9edd9041 | 6758 | For example, if delay pool number 1 is a class 2 delay pool as in the |
0b68481a | 6759 | above example, and is being used to strictly limit each host to 64Kbit/sec |
9edd9041 | 6760 | (plus overheads), with no overall limit, the line is: |
6761 | ||
6e7502cc | 6762 | delay_parameters 1 none 8000/8000 |
0b68481a | 6763 | |
c3e31a3a | 6764 | Note that 8 x 8K Byte/sec -> 64K bit/sec. |
9edd9041 | 6765 | |
6e7502cc | 6766 | Note that the word 'none' is used to represent no limit. |
9edd9041 | 6767 | |
0b68481a | 6768 | |
9edd9041 | 6769 | And, if delay pool number 2 is a class 3 delay pool as in the above |
0b68481a AJ |
6770 | example, and you want to limit it to a total of 256Kbit/sec (strict limit) |
6771 | with each 8-bit network permitted 64Kbit/sec (strict limit) and each | |
6772 | individual host permitted 4800bit/sec with a bucket maximum size of 64Kbits | |
9edd9041 | 6773 | to permit a decent web page to be downloaded at a decent speed |
6774 | (if the network is not being limited due to overuse) but slow down | |
6775 | large downloads more significantly: | |
6776 | ||
0b68481a AJ |
6777 | delay_parameters 2 32000/32000 8000/8000 600/8000 |
6778 | ||
c3e31a3a AJ |
6779 | Note that 8 x 32K Byte/sec -> 256K bit/sec. |
6780 | 8 x 8K Byte/sec -> 64K bit/sec. | |
6781 | 8 x 600 Byte/sec -> 4800 bit/sec. | |
9edd9041 | 6782 | |
9edd9041 | 6783 | |
6784 | Finally, for a class 4 delay pool as in the example - each user will | |
0b68481a | 6785 | be limited to 128Kbits/sec no matter how many workstations they are logged into.: |
9edd9041 | 6786 | |
0b68481a | 6787 | delay_parameters 4 32000/32000 8000/8000 600/64000 16000/16000 |
638402dd AJ |
6788 | |
6789 | ||
6790 | See also delay_class and delay_access. | |
6791 | ||
9edd9041 | 6792 | DOC_END |
6793 | ||
6794 | NAME: delay_initial_bucket_level | |
6795 | COMMENT: (percent, 0-100) | |
ae870270 | 6796 | TYPE: u_short |
9edd9041 | 6797 | DEFAULT: 50 |
9a0a18de | 6798 | IFDEF: USE_DELAY_POOLS |
9edd9041 | 6799 | LOC: Config.Delay.initial |
6800 | DOC_START | |
6801 | The initial bucket percentage is used to determine how much is put | |
6802 | in each bucket when squid starts, is reconfigured, or first notices | |
6803 | a host accessing it (in class 2 and class 3, individual hosts and | |
6804 | networks only have buckets associated with them once they have been | |
6805 | "seen" by squid). | |
6806 | DOC_END | |
6807 | ||
b4cd430a CT |
6808 | COMMENT_START |
6809 | CLIENT DELAY POOL PARAMETERS | |
6810 | ----------------------------------------------------------------------------- | |
6811 | COMMENT_END | |
6812 | ||
6813 | NAME: client_delay_pools | |
6814 | TYPE: client_delay_pool_count | |
6815 | DEFAULT: 0 | |
9a0a18de | 6816 | IFDEF: USE_DELAY_POOLS |
b4cd430a CT |
6817 | LOC: Config.ClientDelay |
6818 | DOC_START | |
6819 | This option specifies the number of client delay pools used. It must | |
6820 | preceed other client_delay_* options. | |
6821 | ||
638402dd AJ |
6822 | Example: |
6823 | client_delay_pools 2 | |
6824 | ||
6825 | See also client_delay_parameters and client_delay_access. | |
b4cd430a CT |
6826 | DOC_END |
6827 | ||
6828 | NAME: client_delay_initial_bucket_level | |
6829 | COMMENT: (percent, 0-no_limit) | |
ae870270 | 6830 | TYPE: u_short |
b4cd430a | 6831 | DEFAULT: 50 |
9a0a18de | 6832 | IFDEF: USE_DELAY_POOLS |
b4cd430a CT |
6833 | LOC: Config.ClientDelay.initial |
6834 | DOC_START | |
6835 | This option determines the initial bucket size as a percentage of | |
6836 | max_bucket_size from client_delay_parameters. Buckets are created | |
6837 | at the time of the "first" connection from the matching IP. Idle | |
6838 | buckets are periodically deleted up. | |
6839 | ||
6840 | You can specify more than 100 percent but note that such "oversized" | |
6841 | buckets are not refilled until their size goes down to max_bucket_size | |
6842 | from client_delay_parameters. | |
6843 | ||
638402dd AJ |
6844 | Example: |
6845 | client_delay_initial_bucket_level 50 | |
b4cd430a CT |
6846 | DOC_END |
6847 | ||
6848 | NAME: client_delay_parameters | |
6849 | TYPE: client_delay_pool_rates | |
6850 | DEFAULT: none | |
9a0a18de | 6851 | IFDEF: USE_DELAY_POOLS |
b4cd430a CT |
6852 | LOC: Config.ClientDelay |
6853 | DOC_START | |
6854 | ||
6855 | This option configures client-side bandwidth limits using the | |
6856 | following format: | |
6857 | ||
6858 | client_delay_parameters pool speed_limit max_bucket_size | |
6859 | ||
6860 | pool is an integer ID used for client_delay_access matching. | |
6861 | ||
6862 | speed_limit is bytes added to the bucket per second. | |
6863 | ||
6864 | max_bucket_size is the maximum size of a bucket, enforced after any | |
6865 | speed_limit additions. | |
6866 | ||
6867 | Please see the delay_parameters option for more information and | |
6868 | examples. | |
6869 | ||
638402dd AJ |
6870 | Example: |
6871 | client_delay_parameters 1 1024 2048 | |
6872 | client_delay_parameters 2 51200 16384 | |
6873 | ||
6874 | See also client_delay_access. | |
6875 | ||
b4cd430a CT |
6876 | DOC_END |
6877 | ||
6878 | NAME: client_delay_access | |
6879 | TYPE: client_delay_pool_access | |
6880 | DEFAULT: none | |
638402dd | 6881 | DEFAULT_DOC: Deny use of the pool, unless allow rules exist in squid.conf for the pool. |
9a0a18de | 6882 | IFDEF: USE_DELAY_POOLS |
b4cd430a CT |
6883 | LOC: Config.ClientDelay |
6884 | DOC_START | |
b4cd430a CT |
6885 | This option determines the client-side delay pool for the |
6886 | request: | |
6887 | ||
6888 | client_delay_access pool_ID allow|deny acl_name | |
6889 | ||
6890 | All client_delay_access options are checked in their pool ID | |
6891 | order, starting with pool 1. The first checked pool with allowed | |
6892 | request is selected for the request. If no ACL matches or there | |
6893 | are no client_delay_access options, the request bandwidth is not | |
6894 | limited. | |
6895 | ||
6896 | The ACL-selected pool is then used to find the | |
6897 | client_delay_parameters for the request. Client-side pools are | |
6898 | not used to aggregate clients. Clients are always aggregated | |
6899 | based on their source IP addresses (one bucket per source IP). | |
6900 | ||
638402dd AJ |
6901 | This clause only supports fast acl types. |
6902 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
6903 | Additionally, only the client TCP connection details are available. | |
6904 | ACLs testing HTTP properties will not work. | |
6905 | ||
b4cd430a CT |
6906 | Please see delay_access for more examples. |
6907 | ||
638402dd AJ |
6908 | Example: |
6909 | client_delay_access 1 allow low_rate_network | |
6910 | client_delay_access 2 allow vips_network | |
6911 | ||
6912 | ||
6913 | See also client_delay_parameters and client_delay_pools. | |
b4cd430a CT |
6914 | DOC_END |
6915 | ||
cccac0a2 | 6916 | COMMENT_START |
8d6275c0 | 6917 | WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS |
cccac0a2 | 6918 | ----------------------------------------------------------------------------- |
6919 | COMMENT_END | |
6920 | ||
8d6275c0 | 6921 | NAME: wccp_router |
6922 | TYPE: address | |
6923 | LOC: Config.Wccp.router | |
0eb08770 | 6924 | DEFAULT: any_addr |
638402dd | 6925 | DEFAULT_DOC: WCCP disabled. |
8d6275c0 | 6926 | IFDEF: USE_WCCP |
e313ab0a AJ |
6927 | DOC_START |
6928 | Use this option to define your WCCP ``home'' router for | |
6929 | Squid. | |
6930 | ||
6931 | wccp_router supports a single WCCP(v1) router | |
6932 | ||
6933 | wccp2_router supports multiple WCCPv2 routers | |
6934 | ||
6935 | only one of the two may be used at the same time and defines | |
6936 | which version of WCCP to use. | |
6937 | DOC_END | |
df2eec10 | 6938 | |
8d6275c0 | 6939 | NAME: wccp2_router |
9fb4efad | 6940 | TYPE: IpAddress_list |
8d6275c0 | 6941 | LOC: Config.Wccp2.router |
cccac0a2 | 6942 | DEFAULT: none |
638402dd | 6943 | DEFAULT_DOC: WCCPv2 disabled. |
8d6275c0 | 6944 | IFDEF: USE_WCCPv2 |
cccac0a2 | 6945 | DOC_START |
8d6275c0 | 6946 | Use this option to define your WCCP ``home'' router for |
6947 | Squid. | |
cccac0a2 | 6948 | |
8d6275c0 | 6949 | wccp_router supports a single WCCP(v1) router |
cccac0a2 | 6950 | |
8d6275c0 | 6951 | wccp2_router supports multiple WCCPv2 routers |
cccac0a2 | 6952 | |
8d6275c0 | 6953 | only one of the two may be used at the same time and defines |
6954 | which version of WCCP to use. | |
6955 | DOC_END | |
6956 | ||
6957 | NAME: wccp_version | |
cccac0a2 | 6958 | TYPE: int |
8d6275c0 | 6959 | LOC: Config.Wccp.version |
6960 | DEFAULT: 4 | |
6961 | IFDEF: USE_WCCP | |
cccac0a2 | 6962 | DOC_START |
8d6275c0 | 6963 | This directive is only relevant if you need to set up WCCP(v1) |
6964 | to some very old and end-of-life Cisco routers. In all other | |
6965 | setups it must be left unset or at the default setting. | |
6966 | It defines an internal version in the WCCP(v1) protocol, | |
6967 | with version 4 being the officially documented protocol. | |
cccac0a2 | 6968 | |
8d6275c0 | 6969 | According to some users, Cisco IOS 11.2 and earlier only |
6970 | support WCCP version 3. If you're using that or an earlier | |
6971 | version of IOS, you may need to change this value to 3, otherwise | |
6972 | do not specify this parameter. | |
cccac0a2 | 6973 | DOC_END |
6974 | ||
8d6275c0 | 6975 | NAME: wccp2_rebuild_wait |
6976 | TYPE: onoff | |
6977 | LOC: Config.Wccp2.rebuildwait | |
6978 | DEFAULT: on | |
6979 | IFDEF: USE_WCCPv2 | |
6980 | DOC_START | |
6981 | If this is enabled Squid will wait for the cache dir rebuild to finish | |
6982 | before sending the first wccp2 HereIAm packet | |
6983 | DOC_END | |
cccac0a2 | 6984 | |
8d6275c0 | 6985 | NAME: wccp2_forwarding_method |
e313ab0a | 6986 | TYPE: wccp2_method |
8d6275c0 | 6987 | LOC: Config.Wccp2.forwarding_method |
451c4786 | 6988 | DEFAULT: gre |
8d6275c0 | 6989 | IFDEF: USE_WCCPv2 |
cccac0a2 | 6990 | DOC_START |
699acd19 | 6991 | WCCP2 allows the setting of forwarding methods between the |
8d6275c0 | 6992 | router/switch and the cache. Valid values are as follows: |
cccac0a2 | 6993 | |
451c4786 AJ |
6994 | gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) |
6995 | l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) | |
cccac0a2 | 6996 | |
8d6275c0 | 6997 | Currently (as of IOS 12.4) cisco routers only support GRE. |
6998 | Cisco switches only support the L2 redirect assignment method. | |
cccac0a2 | 6999 | DOC_END |
7000 | ||
8d6275c0 | 7001 | NAME: wccp2_return_method |
e313ab0a | 7002 | TYPE: wccp2_method |
8d6275c0 | 7003 | LOC: Config.Wccp2.return_method |
451c4786 | 7004 | DEFAULT: gre |
8d6275c0 | 7005 | IFDEF: USE_WCCPv2 |
cccac0a2 | 7006 | DOC_START |
699acd19 | 7007 | WCCP2 allows the setting of return methods between the |
8d6275c0 | 7008 | router/switch and the cache for packets that the cache |
7009 | decides not to handle. Valid values are as follows: | |
cccac0a2 | 7010 | |
451c4786 AJ |
7011 | gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) |
7012 | l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) | |
cccac0a2 | 7013 | |
8d6275c0 | 7014 | Currently (as of IOS 12.4) cisco routers only support GRE. |
7015 | Cisco switches only support the L2 redirect assignment. | |
cccac0a2 | 7016 | |
699acd19 | 7017 | If the "ip wccp redirect exclude in" command has been |
8d6275c0 | 7018 | enabled on the cache interface, then it is still safe for |
7019 | the proxy server to use a l2 redirect method even if this | |
7020 | option is set to GRE. | |
cccac0a2 | 7021 | DOC_END |
7022 | ||
8d6275c0 | 7023 | NAME: wccp2_assignment_method |
451c4786 | 7024 | TYPE: wccp2_amethod |
8d6275c0 | 7025 | LOC: Config.Wccp2.assignment_method |
451c4786 | 7026 | DEFAULT: hash |
8d6275c0 | 7027 | IFDEF: USE_WCCPv2 |
cccac0a2 | 7028 | DOC_START |
8d6275c0 | 7029 | WCCP2 allows the setting of methods to assign the WCCP hash |
7030 | Valid values are as follows: | |
cccac0a2 | 7031 | |
451c4786 | 7032 | hash - Hash assignment |
bb7a1781 | 7033 | mask - Mask assignment |
cccac0a2 | 7034 | |
8d6275c0 | 7035 | As a general rule, cisco routers support the hash assignment method |
7036 | and cisco switches support the mask assignment method. | |
7037 | DOC_END | |
cccac0a2 | 7038 | |
8d6275c0 | 7039 | NAME: wccp2_service |
7040 | TYPE: wccp2_service | |
7041 | LOC: Config.Wccp2.info | |
8d6275c0 | 7042 | DEFAULT_IF_NONE: standard 0 |
638402dd | 7043 | DEFAULT_DOC: Use the 'web-cache' standard service. |
8d6275c0 | 7044 | IFDEF: USE_WCCPv2 |
7045 | DOC_START | |
7046 | WCCP2 allows for multiple traffic services. There are two | |
7047 | types: "standard" and "dynamic". The standard type defines | |
7048 | one service id - http (id 0). The dynamic service ids can be from | |
7049 | 51 to 255 inclusive. In order to use a dynamic service id | |
7050 | one must define the type of traffic to be redirected; this is done | |
7051 | using the wccp2_service_info option. | |
7052 | ||
7053 | The "standard" type does not require a wccp2_service_info option, | |
7054 | just specifying the service id will suffice. | |
7055 | ||
7056 | MD5 service authentication can be enabled by adding | |
7057 | "password=<password>" to the end of this service declaration. | |
7058 | ||
7059 | Examples: | |
7060 | ||
7061 | wccp2_service standard 0 # for the 'web-cache' standard service | |
7062 | wccp2_service dynamic 80 # a dynamic service type which will be | |
7063 | # fleshed out with subsequent options. | |
7064 | wccp2_service standard 0 password=foo | |
8d6275c0 | 7065 | DOC_END |
7066 | ||
7067 | NAME: wccp2_service_info | |
7068 | TYPE: wccp2_service_info | |
7069 | LOC: Config.Wccp2.info | |
7070 | DEFAULT: none | |
7071 | IFDEF: USE_WCCPv2 | |
7072 | DOC_START | |
7073 | Dynamic WCCPv2 services require further information to define the | |
7074 | traffic you wish to have diverted. | |
7075 | ||
7076 | The format is: | |
7077 | ||
7078 | wccp2_service_info <id> protocol=<protocol> flags=<flag>,<flag>.. | |
7079 | priority=<priority> ports=<port>,<port>.. | |
7080 | ||
7081 | The relevant WCCPv2 flags: | |
7082 | + src_ip_hash, dst_ip_hash | |
005fe566 | 7083 | + source_port_hash, dst_port_hash |
8d6275c0 | 7084 | + src_ip_alt_hash, dst_ip_alt_hash |
7085 | + src_port_alt_hash, dst_port_alt_hash | |
7086 | + ports_source | |
7087 | ||
7088 | The port list can be one to eight entries. | |
7089 | ||
7090 | Example: | |
7091 | ||
7092 | wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source | |
7093 | priority=240 ports=80 | |
7094 | ||
7095 | Note: the service id must have been defined by a previous | |
7096 | 'wccp2_service dynamic <id>' entry. | |
7097 | DOC_END | |
7098 | ||
7099 | NAME: wccp2_weight | |
7100 | TYPE: int | |
7101 | LOC: Config.Wccp2.weight | |
7102 | DEFAULT: 10000 | |
7103 | IFDEF: USE_WCCPv2 | |
7104 | DOC_START | |
7105 | Each cache server gets assigned a set of the destination | |
7106 | hash proportional to their weight. | |
7107 | DOC_END | |
7108 | ||
7109 | NAME: wccp_address | |
7110 | TYPE: address | |
7111 | LOC: Config.Wccp.address | |
7112 | DEFAULT: 0.0.0.0 | |
638402dd | 7113 | DEFAULT_DOC: Address selected by the operating system. |
8d6275c0 | 7114 | IFDEF: USE_WCCP |
638402dd AJ |
7115 | DOC_START |
7116 | Use this option if you require WCCPv2 to use a specific | |
7117 | interface address. | |
7118 | ||
7119 | The default behavior is to not bind to any specific address. | |
7120 | DOC_END | |
df2eec10 | 7121 | |
8d6275c0 | 7122 | NAME: wccp2_address |
7123 | TYPE: address | |
7124 | LOC: Config.Wccp2.address | |
7125 | DEFAULT: 0.0.0.0 | |
638402dd | 7126 | DEFAULT_DOC: Address selected by the operating system. |
8d6275c0 | 7127 | IFDEF: USE_WCCPv2 |
7128 | DOC_START | |
7129 | Use this option if you require WCCP to use a specific | |
7130 | interface address. | |
7131 | ||
7132 | The default behavior is to not bind to any specific address. | |
7133 | DOC_END | |
7134 | ||
7135 | COMMENT_START | |
7136 | PERSISTENT CONNECTION HANDLING | |
7137 | ----------------------------------------------------------------------------- | |
7138 | ||
7139 | Also see "pconn_timeout" in the TIMEOUTS section | |
7140 | COMMENT_END | |
7141 | ||
7142 | NAME: client_persistent_connections | |
7143 | TYPE: onoff | |
7144 | LOC: Config.onoff.client_pconns | |
7145 | DEFAULT: on | |
638402dd AJ |
7146 | DOC_START |
7147 | Persistent connection support for clients. | |
7148 | Squid uses persistent connections (when allowed). You can use | |
7149 | this option to disable persistent connections with clients. | |
7150 | DOC_END | |
8d6275c0 | 7151 | |
7152 | NAME: server_persistent_connections | |
7153 | TYPE: onoff | |
7154 | LOC: Config.onoff.server_pconns | |
7155 | DEFAULT: on | |
7156 | DOC_START | |
638402dd AJ |
7157 | Persistent connection support for servers. |
7158 | Squid uses persistent connections (when allowed). You can use | |
7159 | this option to disable persistent connections with servers. | |
8d6275c0 | 7160 | DOC_END |
7161 | ||
7162 | NAME: persistent_connection_after_error | |
7163 | TYPE: onoff | |
7164 | LOC: Config.onoff.error_pconns | |
0fccfb7f | 7165 | DEFAULT: on |
8d6275c0 | 7166 | DOC_START |
7167 | With this directive the use of persistent connections after | |
7168 | HTTP errors can be disabled. Useful if you have clients | |
7169 | who fail to handle errors on persistent connections proper. | |
7170 | DOC_END | |
7171 | ||
7172 | NAME: detect_broken_pconn | |
7173 | TYPE: onoff | |
7174 | LOC: Config.onoff.detect_broken_server_pconns | |
7175 | DEFAULT: off | |
7176 | DOC_START | |
7177 | Some servers have been found to incorrectly signal the use | |
7178 | of HTTP/1.0 persistent connections even on replies not | |
7179 | compatible, causing significant delays. This server problem | |
7180 | has mostly been seen on redirects. | |
7181 | ||
7182 | By enabling this directive Squid attempts to detect such | |
7183 | broken replies and automatically assume the reply is finished | |
7184 | after 10 seconds timeout. | |
7185 | DOC_END | |
7186 | ||
7187 | COMMENT_START | |
7188 | CACHE DIGEST OPTIONS | |
7189 | ----------------------------------------------------------------------------- | |
7190 | COMMENT_END | |
7191 | ||
7192 | NAME: digest_generation | |
7193 | IFDEF: USE_CACHE_DIGESTS | |
7194 | TYPE: onoff | |
7195 | LOC: Config.onoff.digest_generation | |
7196 | DEFAULT: on | |
7197 | DOC_START | |
7198 | This controls whether the server will generate a Cache Digest | |
7199 | of its contents. By default, Cache Digest generation is | |
13e917b5 | 7200 | enabled if Squid is compiled with --enable-cache-digests defined. |
8d6275c0 | 7201 | DOC_END |
7202 | ||
7203 | NAME: digest_bits_per_entry | |
7204 | IFDEF: USE_CACHE_DIGESTS | |
7205 | TYPE: int | |
7206 | LOC: Config.digest.bits_per_entry | |
7207 | DEFAULT: 5 | |
7208 | DOC_START | |
7209 | This is the number of bits of the server's Cache Digest which | |
7210 | will be associated with the Digest entry for a given HTTP | |
7211 | Method and URL (public key) combination. The default is 5. | |
7212 | DOC_END | |
7213 | ||
7214 | NAME: digest_rebuild_period | |
7215 | IFDEF: USE_CACHE_DIGESTS | |
7216 | COMMENT: (seconds) | |
7217 | TYPE: time_t | |
7218 | LOC: Config.digest.rebuild_period | |
7219 | DEFAULT: 1 hour | |
7220 | DOC_START | |
749ceff8 | 7221 | This is the wait time between Cache Digest rebuilds. |
8d6275c0 | 7222 | DOC_END |
7223 | ||
7224 | NAME: digest_rewrite_period | |
7225 | COMMENT: (seconds) | |
7226 | IFDEF: USE_CACHE_DIGESTS | |
7227 | TYPE: time_t | |
7228 | LOC: Config.digest.rewrite_period | |
7229 | DEFAULT: 1 hour | |
7230 | DOC_START | |
749ceff8 | 7231 | This is the wait time between Cache Digest writes to |
8d6275c0 | 7232 | disk. |
7233 | DOC_END | |
7234 | ||
7235 | NAME: digest_swapout_chunk_size | |
7236 | COMMENT: (bytes) | |
7237 | TYPE: b_size_t | |
7238 | IFDEF: USE_CACHE_DIGESTS | |
7239 | LOC: Config.digest.swapout_chunk_size | |
7240 | DEFAULT: 4096 bytes | |
7241 | DOC_START | |
7242 | This is the number of bytes of the Cache Digest to write to | |
7243 | disk at a time. It defaults to 4096 bytes (4KB), the Squid | |
7244 | default swap page. | |
7245 | DOC_END | |
7246 | ||
7247 | NAME: digest_rebuild_chunk_percentage | |
7248 | COMMENT: (percent, 0-100) | |
7249 | IFDEF: USE_CACHE_DIGESTS | |
7250 | TYPE: int | |
7251 | LOC: Config.digest.rebuild_chunk_percentage | |
7252 | DEFAULT: 10 | |
7253 | DOC_START | |
7254 | This is the percentage of the Cache Digest to be scanned at a | |
7255 | time. By default it is set to 10% of the Cache Digest. | |
7256 | DOC_END | |
7257 | ||
1db9eacd | 7258 | COMMENT_START |
5473c134 | 7259 | SNMP OPTIONS |
1db9eacd | 7260 | ----------------------------------------------------------------------------- |
7261 | COMMENT_END | |
7262 | ||
5473c134 | 7263 | NAME: snmp_port |
ae870270 | 7264 | TYPE: u_short |
5473c134 | 7265 | LOC: Config.Port.snmp |
87630341 | 7266 | DEFAULT: 0 |
638402dd | 7267 | DEFAULT_DOC: SNMP disabled. |
5473c134 | 7268 | IFDEF: SQUID_SNMP |
8d6275c0 | 7269 | DOC_START |
87630341 | 7270 | The port number where Squid listens for SNMP requests. To enable |
7271 | SNMP support set this to a suitable port number. Port number | |
7272 | 3401 is often used for the Squid SNMP agent. By default it's | |
7273 | set to "0" (disabled) | |
e0855596 AJ |
7274 | |
7275 | Example: | |
7276 | snmp_port 3401 | |
8d6275c0 | 7277 | DOC_END |
7278 | ||
5473c134 | 7279 | NAME: snmp_access |
7280 | TYPE: acl_access | |
7281 | LOC: Config.accessList.snmp | |
638402dd AJ |
7282 | DEFAULT: none |
7283 | DEFAULT_DOC: Deny, unless rules exist in squid.conf. | |
5473c134 | 7284 | IFDEF: SQUID_SNMP |
8d6275c0 | 7285 | DOC_START |
5473c134 | 7286 | Allowing or denying access to the SNMP port. |
8d6275c0 | 7287 | |
5473c134 | 7288 | All access to the agent is denied by default. |
7289 | usage: | |
8d6275c0 | 7290 | |
5473c134 | 7291 | snmp_access allow|deny [!]aclname ... |
8d6275c0 | 7292 | |
b3567eb5 FC |
7293 | This clause only supports fast acl types. |
7294 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
638402dd | 7295 | |
5473c134 | 7296 | Example: |
7297 | snmp_access allow snmppublic localhost | |
7298 | snmp_access deny all | |
cccac0a2 | 7299 | DOC_END |
7300 | ||
5473c134 | 7301 | NAME: snmp_incoming_address |
7302 | TYPE: address | |
7303 | LOC: Config.Addrs.snmp_incoming | |
0eb08770 | 7304 | DEFAULT: any_addr |
638402dd | 7305 | DEFAULT_DOC: Accept SNMP packets from all machine interfaces. |
5473c134 | 7306 | IFDEF: SQUID_SNMP |
638402dd AJ |
7307 | DOC_START |
7308 | Just like 'udp_incoming_address', but for the SNMP port. | |
7309 | ||
7310 | snmp_incoming_address is used for the SNMP socket receiving | |
7311 | messages from SNMP agents. | |
7312 | ||
7313 | The default snmp_incoming_address is to listen on all | |
7314 | available network interfaces. | |
7315 | DOC_END | |
df2eec10 | 7316 | |
5473c134 | 7317 | NAME: snmp_outgoing_address |
7318 | TYPE: address | |
7319 | LOC: Config.Addrs.snmp_outgoing | |
0eb08770 | 7320 | DEFAULT: no_addr |
638402dd | 7321 | DEFAULT_DOC: Use snmp_incoming_address or an address selected by the operating system. |
5473c134 | 7322 | IFDEF: SQUID_SNMP |
cccac0a2 | 7323 | DOC_START |
638402dd | 7324 | Just like 'udp_outgoing_address', but for the SNMP port. |
cccac0a2 | 7325 | |
5473c134 | 7326 | snmp_outgoing_address is used for SNMP packets returned to SNMP |
7327 | agents. | |
cccac0a2 | 7328 | |
0eb08770 HN |
7329 | If snmp_outgoing_address is not set it will use the same socket |
7330 | as snmp_incoming_address. Only change this if you want to have | |
7331 | SNMP replies sent using another address than where this Squid | |
7332 | listens for SNMP queries. | |
cccac0a2 | 7333 | |
5473c134 | 7334 | NOTE, snmp_incoming_address and snmp_outgoing_address can not have |
638402dd | 7335 | the same value since they both use the same port. |
cccac0a2 | 7336 | DOC_END |
7337 | ||
5473c134 | 7338 | COMMENT_START |
7339 | ICP OPTIONS | |
7340 | ----------------------------------------------------------------------------- | |
7341 | COMMENT_END | |
7342 | ||
7343 | NAME: icp_port udp_port | |
ae870270 | 7344 | TYPE: u_short |
5473c134 | 7345 | DEFAULT: 0 |
638402dd | 7346 | DEFAULT_DOC: ICP disabled. |
5473c134 | 7347 | LOC: Config.Port.icp |
cccac0a2 | 7348 | DOC_START |
5473c134 | 7349 | The port number where Squid sends and receives ICP queries to |
7350 | and from neighbor caches. The standard UDP port for ICP is 3130. | |
e0855596 AJ |
7351 | |
7352 | Example: | |
7353 | icp_port @DEFAULT_ICP_PORT@ | |
cccac0a2 | 7354 | DOC_END |
7355 | ||
5473c134 | 7356 | NAME: htcp_port |
7357 | IFDEF: USE_HTCP | |
ae870270 | 7358 | TYPE: u_short |
87630341 | 7359 | DEFAULT: 0 |
638402dd | 7360 | DEFAULT_DOC: HTCP disabled. |
5473c134 | 7361 | LOC: Config.Port.htcp |
cccac0a2 | 7362 | DOC_START |
5473c134 | 7363 | The port number where Squid sends and receives HTCP queries to |
87630341 | 7364 | and from neighbor caches. To turn it on you want to set it to |
638402dd | 7365 | 4827. |
e0855596 AJ |
7366 | |
7367 | Example: | |
7368 | htcp_port 4827 | |
cccac0a2 | 7369 | DOC_END |
7370 | ||
7371 | NAME: log_icp_queries | |
7372 | COMMENT: on|off | |
7373 | TYPE: onoff | |
7374 | DEFAULT: on | |
7375 | LOC: Config.onoff.log_udp | |
7376 | DOC_START | |
7377 | If set, ICP queries are logged to access.log. You may wish | |
7378 | do disable this if your ICP load is VERY high to speed things | |
7379 | up or to simplify log analysis. | |
7380 | DOC_END | |
7381 | ||
5473c134 | 7382 | NAME: udp_incoming_address |
7383 | TYPE: address | |
7384 | LOC:Config.Addrs.udp_incoming | |
0eb08770 | 7385 | DEFAULT: any_addr |
638402dd | 7386 | DEFAULT_DOC: Accept packets from all machine interfaces. |
8524d4b2 | 7387 | DOC_START |
7388 | udp_incoming_address is used for UDP packets received from other | |
7389 | caches. | |
7390 | ||
7391 | The default behavior is to not bind to any specific address. | |
7392 | ||
7393 | Only change this if you want to have all UDP queries received on | |
7394 | a specific interface/address. | |
7395 | ||
7396 | NOTE: udp_incoming_address is used by the ICP, HTCP, and DNS | |
7397 | modules. Altering it will affect all of them in the same manner. | |
7398 | ||
7399 | see also; udp_outgoing_address | |
7400 | ||
7401 | NOTE, udp_incoming_address and udp_outgoing_address can not | |
7402 | have the same value since they both use the same port. | |
7403 | DOC_END | |
cccac0a2 | 7404 | |
5473c134 | 7405 | NAME: udp_outgoing_address |
7406 | TYPE: address | |
7407 | LOC: Config.Addrs.udp_outgoing | |
0eb08770 | 7408 | DEFAULT: no_addr |
638402dd | 7409 | DEFAULT_DOC: Use udp_incoming_address or an address selected by the operating system. |
cccac0a2 | 7410 | DOC_START |
8524d4b2 | 7411 | udp_outgoing_address is used for UDP packets sent out to other |
5473c134 | 7412 | caches. |
cccac0a2 | 7413 | |
5473c134 | 7414 | The default behavior is to not bind to any specific address. |
cccac0a2 | 7415 | |
8524d4b2 | 7416 | Instead it will use the same socket as udp_incoming_address. |
7417 | Only change this if you want to have UDP queries sent using another | |
7418 | address than where this Squid listens for UDP queries from other | |
5473c134 | 7419 | caches. |
7420 | ||
8524d4b2 | 7421 | NOTE: udp_outgoing_address is used by the ICP, HTCP, and DNS |
7422 | modules. Altering it will affect all of them in the same manner. | |
7423 | ||
7424 | see also; udp_incoming_address | |
7425 | ||
5473c134 | 7426 | NOTE, udp_incoming_address and udp_outgoing_address can not |
8524d4b2 | 7427 | have the same value since they both use the same port. |
cccac0a2 | 7428 | DOC_END |
7429 | ||
3d1e3e43 | 7430 | NAME: icp_hit_stale |
7431 | COMMENT: on|off | |
7432 | TYPE: onoff | |
7433 | DEFAULT: off | |
7434 | LOC: Config.onoff.icp_hit_stale | |
7435 | DOC_START | |
7436 | If you want to return ICP_HIT for stale cache objects, set this | |
7437 | option to 'on'. If you have sibling relationships with caches | |
7438 | in other administrative domains, this should be 'off'. If you only | |
7439 | have sibling relationships with caches under your control, | |
7440 | it is probably okay to set this to 'on'. | |
7441 | If set to 'on', your siblings should use the option "allow-miss" | |
7442 | on their cache_peer lines for connecting to you. | |
7443 | DOC_END | |
7444 | ||
5473c134 | 7445 | NAME: minimum_direct_hops |
cccac0a2 | 7446 | TYPE: int |
5473c134 | 7447 | DEFAULT: 4 |
7448 | LOC: Config.minDirectHops | |
cccac0a2 | 7449 | DOC_START |
5473c134 | 7450 | If using the ICMP pinging stuff, do direct fetches for sites |
7451 | which are no more than this many hops away. | |
cccac0a2 | 7452 | DOC_END |
7453 | ||
5473c134 | 7454 | NAME: minimum_direct_rtt |
638402dd | 7455 | COMMENT: (msec) |
5473c134 | 7456 | TYPE: int |
7457 | DEFAULT: 400 | |
7458 | LOC: Config.minDirectRtt | |
cccac0a2 | 7459 | DOC_START |
5473c134 | 7460 | If using the ICMP pinging stuff, do direct fetches for sites |
7461 | which are no more than this many rtt milliseconds away. | |
cccac0a2 | 7462 | DOC_END |
7463 | ||
cccac0a2 | 7464 | NAME: netdb_low |
7465 | TYPE: int | |
7466 | DEFAULT: 900 | |
7467 | LOC: Config.Netdb.low | |
638402dd AJ |
7468 | DOC_START |
7469 | The low water mark for the ICMP measurement database. | |
7470 | ||
7471 | Note: high watermark controlled by netdb_high directive. | |
7472 | ||
7473 | These watermarks are counts, not percents. The defaults are | |
7474 | (low) 900 and (high) 1000. When the high water mark is | |
7475 | reached, database entries will be deleted until the low | |
7476 | mark is reached. | |
7477 | DOC_END | |
cccac0a2 | 7478 | |
7479 | NAME: netdb_high | |
7480 | TYPE: int | |
7481 | DEFAULT: 1000 | |
7482 | LOC: Config.Netdb.high | |
7483 | DOC_START | |
638402dd AJ |
7484 | The high water mark for the ICMP measurement database. |
7485 | ||
7486 | Note: low watermark controlled by netdb_low directive. | |
7487 | ||
7488 | These watermarks are counts, not percents. The defaults are | |
7489 | (low) 900 and (high) 1000. When the high water mark is | |
7490 | reached, database entries will be deleted until the low | |
7491 | mark is reached. | |
cccac0a2 | 7492 | DOC_END |
7493 | ||
cccac0a2 | 7494 | NAME: netdb_ping_period |
7495 | TYPE: time_t | |
7496 | LOC: Config.Netdb.period | |
7497 | DEFAULT: 5 minutes | |
7498 | DOC_START | |
7499 | The minimum period for measuring a site. There will be at | |
7500 | least this much delay between successive pings to the same | |
7501 | network. The default is five minutes. | |
7502 | DOC_END | |
7503 | ||
cccac0a2 | 7504 | NAME: query_icmp |
7505 | COMMENT: on|off | |
7506 | TYPE: onoff | |
7507 | DEFAULT: off | |
7508 | LOC: Config.onoff.query_icmp | |
7509 | DOC_START | |
7510 | If you want to ask your peers to include ICMP data in their ICP | |
7511 | replies, enable this option. | |
7512 | ||
7513 | If your peer has configured Squid (during compilation) with | |
7f7db318 | 7514 | '--enable-icmp' that peer will send ICMP pings to origin server |
7515 | sites of the URLs it receives. If you enable this option the | |
cccac0a2 | 7516 | ICP replies from that peer will include the ICMP data (if available). |
7517 | Then, when choosing a parent cache, Squid will choose the parent with | |
7518 | the minimal RTT to the origin server. When this happens, the | |
7519 | hierarchy field of the access.log will be | |
7520 | "CLOSEST_PARENT_MISS". This option is off by default. | |
7521 | DOC_END | |
7522 | ||
7523 | NAME: test_reachability | |
7524 | COMMENT: on|off | |
7525 | TYPE: onoff | |
7526 | DEFAULT: off | |
7527 | LOC: Config.onoff.test_reachability | |
7528 | DOC_START | |
7529 | When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH | |
7530 | instead of ICP_MISS if the target host is NOT in the ICMP | |
7531 | database, or has a zero RTT. | |
7532 | DOC_END | |
7533 | ||
5473c134 | 7534 | NAME: icp_query_timeout |
7535 | COMMENT: (msec) | |
7536 | DEFAULT: 0 | |
638402dd | 7537 | DEFAULT_DOC: Dynamic detection. |
5473c134 | 7538 | TYPE: int |
7539 | LOC: Config.Timeout.icp_query | |
4c3ef9b2 | 7540 | DOC_START |
5473c134 | 7541 | Normally Squid will automatically determine an optimal ICP |
7542 | query timeout value based on the round-trip-time of recent ICP | |
7543 | queries. If you want to override the value determined by | |
7544 | Squid, set this 'icp_query_timeout' to a non-zero value. This | |
7545 | value is specified in MILLISECONDS, so, to use a 2-second | |
7546 | timeout (the old default), you would write: | |
4c3ef9b2 | 7547 | |
5473c134 | 7548 | icp_query_timeout 2000 |
4c3ef9b2 | 7549 | DOC_END |
7550 | ||
5473c134 | 7551 | NAME: maximum_icp_query_timeout |
7552 | COMMENT: (msec) | |
7553 | DEFAULT: 2000 | |
7554 | TYPE: int | |
7555 | LOC: Config.Timeout.icp_query_max | |
cccac0a2 | 7556 | DOC_START |
5473c134 | 7557 | Normally the ICP query timeout is determined dynamically. But |
7558 | sometimes it can lead to very large values (say 5 seconds). | |
7559 | Use this option to put an upper limit on the dynamic timeout | |
7560 | value. Do NOT use this option to always use a fixed (instead | |
7561 | of a dynamic) timeout value. To set a fixed timeout see the | |
7562 | 'icp_query_timeout' directive. | |
cccac0a2 | 7563 | DOC_END |
7564 | ||
5473c134 | 7565 | NAME: minimum_icp_query_timeout |
7566 | COMMENT: (msec) | |
7567 | DEFAULT: 5 | |
7568 | TYPE: int | |
7569 | LOC: Config.Timeout.icp_query_min | |
cccac0a2 | 7570 | DOC_START |
5473c134 | 7571 | Normally the ICP query timeout is determined dynamically. But |
7572 | sometimes it can lead to very small timeouts, even lower than | |
7573 | the normal latency variance on your link due to traffic. | |
7574 | Use this option to put an lower limit on the dynamic timeout | |
7575 | value. Do NOT use this option to always use a fixed (instead | |
7576 | of a dynamic) timeout value. To set a fixed timeout see the | |
7577 | 'icp_query_timeout' directive. | |
cccac0a2 | 7578 | DOC_END |
7579 | ||
5473c134 | 7580 | NAME: background_ping_rate |
7581 | COMMENT: time-units | |
7582 | TYPE: time_t | |
7583 | DEFAULT: 10 seconds | |
7584 | LOC: Config.backgroundPingRate | |
cccac0a2 | 7585 | DOC_START |
5473c134 | 7586 | Controls how often the ICP pings are sent to siblings that |
7587 | have background-ping set. | |
cccac0a2 | 7588 | DOC_END |
7589 | ||
5473c134 | 7590 | COMMENT_START |
7591 | MULTICAST ICP OPTIONS | |
7592 | ----------------------------------------------------------------------------- | |
7593 | COMMENT_END | |
7594 | ||
7595 | NAME: mcast_groups | |
7596 | TYPE: wordlist | |
7597 | LOC: Config.mcast_group_list | |
8c01ada0 | 7598 | DEFAULT: none |
7599 | DOC_START | |
5473c134 | 7600 | This tag specifies a list of multicast groups which your server |
7601 | should join to receive multicasted ICP queries. | |
8c01ada0 | 7602 | |
5473c134 | 7603 | NOTE! Be very careful what you put here! Be sure you |
7604 | understand the difference between an ICP _query_ and an ICP | |
7605 | _reply_. This option is to be set only if you want to RECEIVE | |
7606 | multicast queries. Do NOT set this option to SEND multicast | |
7607 | ICP (use cache_peer for that). ICP replies are always sent via | |
7608 | unicast, so this option does not affect whether or not you will | |
7609 | receive replies from multicast group members. | |
8c01ada0 | 7610 | |
5473c134 | 7611 | You must be very careful to NOT use a multicast address which |
7612 | is already in use by another group of caches. | |
8c01ada0 | 7613 | |
5473c134 | 7614 | If you are unsure about multicast, please read the Multicast |
7615 | chapter in the Squid FAQ (http://www.squid-cache.org/FAQ/). | |
8c01ada0 | 7616 | |
5473c134 | 7617 | Usage: mcast_groups 239.128.16.128 224.0.1.20 |
8c01ada0 | 7618 | |
5473c134 | 7619 | By default, Squid doesn't listen on any multicast groups. |
7620 | DOC_END | |
8c01ada0 | 7621 | |
5473c134 | 7622 | NAME: mcast_miss_addr |
7623 | IFDEF: MULTICAST_MISS_STREAM | |
7624 | TYPE: address | |
7625 | LOC: Config.mcast_miss.addr | |
0eb08770 | 7626 | DEFAULT: no_addr |
638402dd | 7627 | DEFAULT_DOC: disabled. |
5473c134 | 7628 | DOC_START |
7629 | If you enable this option, every "cache miss" URL will | |
7630 | be sent out on the specified multicast address. | |
cccac0a2 | 7631 | |
5473c134 | 7632 | Do not enable this option unless you are are absolutely |
7633 | certain you understand what you are doing. | |
cccac0a2 | 7634 | DOC_END |
7635 | ||
5473c134 | 7636 | NAME: mcast_miss_ttl |
7637 | IFDEF: MULTICAST_MISS_STREAM | |
ae870270 | 7638 | TYPE: u_short |
5473c134 | 7639 | LOC: Config.mcast_miss.ttl |
7640 | DEFAULT: 16 | |
cccac0a2 | 7641 | DOC_START |
5473c134 | 7642 | This is the time-to-live value for packets multicasted |
7643 | when multicasting off cache miss URLs is enabled. By | |
7644 | default this is set to 'site scope', i.e. 16. | |
7645 | DOC_END | |
cccac0a2 | 7646 | |
5473c134 | 7647 | NAME: mcast_miss_port |
7648 | IFDEF: MULTICAST_MISS_STREAM | |
ae870270 | 7649 | TYPE: u_short |
5473c134 | 7650 | LOC: Config.mcast_miss.port |
7651 | DEFAULT: 3135 | |
7652 | DOC_START | |
7653 | This is the port number to be used in conjunction with | |
7654 | 'mcast_miss_addr'. | |
7655 | DOC_END | |
cccac0a2 | 7656 | |
5473c134 | 7657 | NAME: mcast_miss_encode_key |
7658 | IFDEF: MULTICAST_MISS_STREAM | |
7659 | TYPE: string | |
7660 | LOC: Config.mcast_miss.encode_key | |
7661 | DEFAULT: XXXXXXXXXXXXXXXX | |
7662 | DOC_START | |
7663 | The URLs that are sent in the multicast miss stream are | |
7664 | encrypted. This is the encryption key. | |
7665 | DOC_END | |
8c01ada0 | 7666 | |
5473c134 | 7667 | NAME: mcast_icp_query_timeout |
7668 | COMMENT: (msec) | |
7669 | DEFAULT: 2000 | |
7670 | TYPE: int | |
7671 | LOC: Config.Timeout.mcast_icp_query | |
7672 | DOC_START | |
7673 | For multicast peers, Squid regularly sends out ICP "probes" to | |
7674 | count how many other peers are listening on the given multicast | |
7675 | address. This value specifies how long Squid should wait to | |
7676 | count all the replies. The default is 2000 msec, or 2 | |
7677 | seconds. | |
cccac0a2 | 7678 | DOC_END |
7679 | ||
5473c134 | 7680 | COMMENT_START |
7681 | INTERNAL ICON OPTIONS | |
7682 | ----------------------------------------------------------------------------- | |
7683 | COMMENT_END | |
7684 | ||
cccac0a2 | 7685 | NAME: icon_directory |
7686 | TYPE: string | |
7687 | LOC: Config.icons.directory | |
7688 | DEFAULT: @DEFAULT_ICON_DIR@ | |
7689 | DOC_START | |
7690 | Where the icons are stored. These are normally kept in | |
7691 | @DEFAULT_ICON_DIR@ | |
7692 | DOC_END | |
7693 | ||
f024c970 | 7694 | NAME: global_internal_static |
7695 | TYPE: onoff | |
7696 | LOC: Config.onoff.global_internal_static | |
7697 | DEFAULT: on | |
7698 | DOC_START | |
7699 | This directive controls is Squid should intercept all requests for | |
7700 | /squid-internal-static/ no matter which host the URL is requesting | |
7701 | (default on setting), or if nothing special should be done for | |
7702 | such URLs (off setting). The purpose of this directive is to make | |
7703 | icons etc work better in complex cache hierarchies where it may | |
7704 | not always be possible for all corners in the cache mesh to reach | |
7705 | the server generating a directory listing. | |
7706 | DOC_END | |
7707 | ||
5473c134 | 7708 | NAME: short_icon_urls |
7709 | TYPE: onoff | |
7710 | LOC: Config.icons.use_short_names | |
7711 | DEFAULT: on | |
7712 | DOC_START | |
7713 | If this is enabled Squid will use short URLs for icons. | |
7714 | If disabled it will revert to the old behavior of including | |
7715 | it's own name and port in the URL. | |
7716 | ||
7717 | If you run a complex cache hierarchy with a mix of Squid and | |
7718 | other proxies you may need to disable this directive. | |
7719 | DOC_END | |
7720 | ||
7721 | COMMENT_START | |
7722 | ERROR PAGE OPTIONS | |
7723 | ----------------------------------------------------------------------------- | |
7724 | COMMENT_END | |
7725 | ||
7726 | NAME: error_directory | |
7727 | TYPE: string | |
7728 | LOC: Config.errorDirectory | |
43000484 | 7729 | DEFAULT: none |
638402dd | 7730 | DEFAULT_DOC: Send error pages in the clients preferred language |
5473c134 | 7731 | DOC_START |
7732 | If you wish to create your own versions of the default | |
43000484 AJ |
7733 | error files to customize them to suit your company copy |
7734 | the error/template files to another directory and point | |
7735 | this tag at them. | |
7736 | ||
7737 | WARNING: This option will disable multi-language support | |
7738 | on error pages if used. | |
5473c134 | 7739 | |
7740 | The squid developers are interested in making squid available in | |
7741 | a wide variety of languages. If you are making translations for a | |
43000484 | 7742 | language that Squid does not currently provide please consider |
5473c134 | 7743 | contributing your translation back to the project. |
43000484 AJ |
7744 | http://wiki.squid-cache.org/Translations |
7745 | ||
7746 | The squid developers working on translations are happy to supply drop-in | |
7747 | translated error files in exchange for any new language contributions. | |
7748 | DOC_END | |
7749 | ||
7750 | NAME: error_default_language | |
7751 | IFDEF: USE_ERR_LOCALES | |
7752 | TYPE: string | |
7753 | LOC: Config.errorDefaultLanguage | |
7754 | DEFAULT: none | |
638402dd | 7755 | DEFAULT_DOC: Generate English language pages. |
43000484 AJ |
7756 | DOC_START |
7757 | Set the default language which squid will send error pages in | |
7758 | if no existing translation matches the clients language | |
7759 | preferences. | |
7760 | ||
7761 | If unset (default) generic English will be used. | |
7762 | ||
7763 | The squid developers are interested in making squid available in | |
7764 | a wide variety of languages. If you are interested in making | |
7765 | translations for any language see the squid wiki for details. | |
7766 | http://wiki.squid-cache.org/Translations | |
5473c134 | 7767 | DOC_END |
7768 | ||
c411820c AJ |
7769 | NAME: error_log_languages |
7770 | IFDEF: USE_ERR_LOCALES | |
7771 | TYPE: onoff | |
7772 | LOC: Config.errorLogMissingLanguages | |
7773 | DEFAULT: on | |
7774 | DOC_START | |
7775 | Log to cache.log what languages users are attempting to | |
7776 | auto-negotiate for translations. | |
7777 | ||
7778 | Successful negotiations are not logged. Only failures | |
7779 | have meaning to indicate that Squid may need an upgrade | |
0c49f10e | 7780 | of its error page translations. |
c411820c AJ |
7781 | DOC_END |
7782 | ||
5b52cb6c AJ |
7783 | NAME: err_page_stylesheet |
7784 | TYPE: string | |
7785 | LOC: Config.errorStylesheet | |
7786 | DEFAULT: @DEFAULT_CONFIG_DIR@/errorpage.css | |
7787 | DOC_START | |
7788 | CSS Stylesheet to pattern the display of Squid default error pages. | |
7789 | ||
7790 | For information on CSS see http://www.w3.org/Style/CSS/ | |
7791 | DOC_END | |
7792 | ||
5473c134 | 7793 | NAME: err_html_text |
7794 | TYPE: eol | |
7795 | LOC: Config.errHtmlText | |
7796 | DEFAULT: none | |
7797 | DOC_START | |
7798 | HTML text to include in error messages. Make this a "mailto" | |
7799 | URL to your admin address, or maybe just a link to your | |
7800 | organizations Web page. | |
7801 | ||
7802 | To include this in your error messages, you must rewrite | |
7803 | the error template files (found in the "errors" directory). | |
7804 | Wherever you want the 'err_html_text' line to appear, | |
7805 | insert a %L tag in the error template file. | |
7806 | DOC_END | |
7807 | ||
7808 | NAME: email_err_data | |
7809 | COMMENT: on|off | |
7810 | TYPE: onoff | |
7811 | LOC: Config.onoff.emailErrData | |
7812 | DEFAULT: on | |
7813 | DOC_START | |
7814 | If enabled, information about the occurred error will be | |
7815 | included in the mailto links of the ERR pages (if %W is set) | |
7816 | so that the email body contains the data. | |
7817 | Syntax is <A HREF="mailto:%w%W">%w</A> | |
7818 | DOC_END | |
7819 | ||
7820 | NAME: deny_info | |
7821 | TYPE: denyinfo | |
7822 | LOC: Config.denyInfoList | |
7823 | DEFAULT: none | |
7824 | DOC_START | |
7825 | Usage: deny_info err_page_name acl | |
7826 | or deny_info http://... acl | |
43000484 | 7827 | or deny_info TCP_RESET acl |
5473c134 | 7828 | |
7829 | This can be used to return a ERR_ page for requests which | |
7830 | do not pass the 'http_access' rules. Squid remembers the last | |
7831 | acl it evaluated in http_access, and if a 'deny_info' line exists | |
7832 | for that ACL Squid returns a corresponding error page. | |
7833 | ||
7834 | The acl is typically the last acl on the http_access deny line which | |
7835 | denied access. The exceptions to this rule are: | |
7836 | - When Squid needs to request authentication credentials. It's then | |
7837 | the first authentication related acl encountered | |
7838 | - When none of the http_access lines matches. It's then the last | |
7839 | acl processed on the last http_access line. | |
3af10ac0 AR |
7840 | - When the decision to deny access was made by an adaptation service, |
7841 | the acl name is the corresponding eCAP or ICAP service_name. | |
5473c134 | 7842 | |
43000484 AJ |
7843 | NP: If providing your own custom error pages with error_directory |
7844 | you may also specify them by your custom file name: | |
7845 | Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys | |
5473c134 | 7846 | |
aed9a15b AJ |
7847 | By defaut Squid will send "403 Forbidden". A different 4xx or 5xx |
7848 | may be specified by prefixing the file name with the code and a colon. | |
7849 | e.g. 404:ERR_CUSTOM_ACCESS_DENIED | |
7850 | ||
5473c134 | 7851 | Alternatively you can tell Squid to reset the TCP connection |
7852 | by specifying TCP_RESET. | |
15b02e9a AJ |
7853 | |
7854 | Or you can specify an error URL or URL pattern. The browsers will | |
aed9a15b AJ |
7855 | get redirected to the specified URL after formatting tags have |
7856 | been replaced. Redirect will be done with 302 or 307 according to | |
7857 | HTTP/1.1 specs. A different 3xx code may be specified by prefixing | |
7858 | the URL. e.g. 303:http://example.com/ | |
15b02e9a AJ |
7859 | |
7860 | URL FORMAT TAGS: | |
7861 | %a - username (if available. Password NOT included) | |
7862 | %B - FTP path URL | |
7863 | %e - Error number | |
7864 | %E - Error description | |
7865 | %h - Squid hostname | |
7866 | %H - Request domain name | |
7867 | %i - Client IP Address | |
7868 | %M - Request Method | |
7869 | %o - Message result from external ACL helper | |
7870 | %p - Request Port number | |
7871 | %P - Request Protocol name | |
7872 | %R - Request URL path | |
7873 | %T - Timestamp in RFC 1123 format | |
7874 | %U - Full canonical URL from client | |
7875 | (HTTPS URLs terminate with *) | |
7876 | %u - Full canonical URL from client | |
7877 | %w - Admin email from squid.conf | |
e4a8468d | 7878 | %x - Error name |
15b02e9a AJ |
7879 | %% - Literal percent (%) code |
7880 | ||
5473c134 | 7881 | DOC_END |
7882 | ||
7883 | COMMENT_START | |
7884 | OPTIONS INFLUENCING REQUEST FORWARDING | |
7885 | ----------------------------------------------------------------------------- | |
7886 | COMMENT_END | |
7887 | ||
7888 | NAME: nonhierarchical_direct | |
e72a0ec0 | 7889 | TYPE: onoff |
5473c134 | 7890 | LOC: Config.onoff.nonhierarchical_direct |
e72a0ec0 | 7891 | DEFAULT: on |
7892 | DOC_START | |
5473c134 | 7893 | By default, Squid will send any non-hierarchical requests |
9967aef6 | 7894 | (not cacheable request type) direct to origin servers. |
e72a0ec0 | 7895 | |
638402dd | 7896 | When this is set to "off", Squid will prefer to send these |
5473c134 | 7897 | requests to parents. |
0b0cfcf2 | 7898 | |
5473c134 | 7899 | Note that in most configurations, by turning this off you will only |
7900 | add latency to these request without any improvement in global hit | |
7901 | ratio. | |
0b0cfcf2 | 7902 | |
638402dd AJ |
7903 | This option only sets a preference. If the parent is unavailable a |
7904 | direct connection to the origin server may still be attempted. To | |
7905 | completely prevent direct connections use never_direct. | |
8d6275c0 | 7906 | DOC_END |
0b0cfcf2 | 7907 | |
5473c134 | 7908 | NAME: prefer_direct |
8d6275c0 | 7909 | TYPE: onoff |
5473c134 | 7910 | LOC: Config.onoff.prefer_direct |
8d6275c0 | 7911 | DEFAULT: off |
7912 | DOC_START | |
5473c134 | 7913 | Normally Squid tries to use parents for most requests. If you for some |
7914 | reason like it to first try going direct and only use a parent if | |
7915 | going direct fails set this to on. | |
0b0cfcf2 | 7916 | |
5473c134 | 7917 | By combining nonhierarchical_direct off and prefer_direct on you |
7918 | can set up Squid to use a parent as a backup path if going direct | |
7919 | fails. | |
7920 | ||
7921 | Note: If you want Squid to use parents for all requests see | |
7922 | the never_direct directive. prefer_direct only modifies how Squid | |
7923 | acts on cacheable requests. | |
cccac0a2 | 7924 | DOC_END |
7925 | ||
96598f93 AJ |
7926 | NAME: cache_miss_revalidate |
7927 | COMMENT: on|off | |
7928 | TYPE: onoff | |
7929 | DEFAULT: on | |
7930 | LOC: Config.onoff.cache_miss_revalidate | |
7931 | DOC_START | |
2d4eefd9 AJ |
7932 | RFC 7232 defines a conditional request mechanism to prevent |
7933 | response objects being unnecessarily transferred over the network. | |
7934 | If that mechanism is used by the client and a cache MISS occurs | |
7935 | it can prevent new cache entries being created. | |
7936 | ||
7937 | This option determines whether Squid on cache MISS will pass the | |
7938 | client revalidation request to the server or tries to fetch new | |
7939 | content for caching. It can be useful while the cache is mostly | |
7940 | empty to more quickly have the cache populated by generating | |
7941 | non-conditional GETs. | |
96598f93 AJ |
7942 | |
7943 | When set to 'on' (default), Squid will pass all client If-* headers | |
2d4eefd9 AJ |
7944 | to the server. This permits server responses without a cacheable |
7945 | payload to be delivered and on MISS no new cache entry is created. | |
96598f93 AJ |
7946 | |
7947 | When set to 'off' and if the request is cacheable, Squid will | |
7948 | remove the clients If-Modified-Since and If-None-Match headers from | |
2d4eefd9 AJ |
7949 | the request sent to the server. This requests a 200 status response |
7950 | from the server to create a new cache entry with. | |
96598f93 AJ |
7951 | DOC_END |
7952 | ||
5473c134 | 7953 | NAME: always_direct |
8d6275c0 | 7954 | TYPE: acl_access |
5473c134 | 7955 | LOC: Config.accessList.AlwaysDirect |
0b0cfcf2 | 7956 | DEFAULT: none |
638402dd | 7957 | DEFAULT_DOC: Prevent any cache_peer being used for this request. |
0b0cfcf2 | 7958 | DOC_START |
5473c134 | 7959 | Usage: always_direct allow|deny [!]aclname ... |
0b0cfcf2 | 7960 | |
5473c134 | 7961 | Here you can use ACL elements to specify requests which should |
7962 | ALWAYS be forwarded by Squid to the origin servers without using | |
7963 | any peers. For example, to always directly forward requests for | |
7964 | local servers ignoring any parents or siblings you may have use | |
7965 | something like: | |
0b0cfcf2 | 7966 | |
5473c134 | 7967 | acl local-servers dstdomain my.domain.net |
7968 | always_direct allow local-servers | |
0b0cfcf2 | 7969 | |
5473c134 | 7970 | To always forward FTP requests directly, use |
f16fbc82 | 7971 | |
5473c134 | 7972 | acl FTP proto FTP |
7973 | always_direct allow FTP | |
cccac0a2 | 7974 | |
5473c134 | 7975 | NOTE: There is a similar, but opposite option named |
7976 | 'never_direct'. You need to be aware that "always_direct deny | |
7977 | foo" is NOT the same thing as "never_direct allow foo". You | |
7978 | may need to use a deny rule to exclude a more-specific case of | |
7979 | some other rule. Example: | |
8d6275c0 | 7980 | |
5473c134 | 7981 | acl local-external dstdomain external.foo.net |
7982 | acl local-servers dstdomain .foo.net | |
7983 | always_direct deny local-external | |
7984 | always_direct allow local-servers | |
8d6275c0 | 7985 | |
5473c134 | 7986 | NOTE: If your goal is to make the client forward the request |
7987 | directly to the origin server bypassing Squid then this needs | |
7988 | to be done in the client configuration. Squid configuration | |
7989 | can only tell Squid how Squid should fetch the object. | |
8d6275c0 | 7990 | |
5473c134 | 7991 | NOTE: This directive is not related to caching. The replies |
7992 | is cached as usual even if you use always_direct. To not cache | |
b3567eb5 | 7993 | the replies see the 'cache' directive. |
5473c134 | 7994 | |
b3567eb5 FC |
7995 | This clause supports both fast and slow acl types. |
7996 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
cccac0a2 | 7997 | DOC_END |
0976f8db | 7998 | |
5473c134 | 7999 | NAME: never_direct |
8000 | TYPE: acl_access | |
8001 | LOC: Config.accessList.NeverDirect | |
8002 | DEFAULT: none | |
638402dd | 8003 | DEFAULT_DOC: Allow DNS results to be used for this request. |
8d6275c0 | 8004 | DOC_START |
5473c134 | 8005 | Usage: never_direct allow|deny [!]aclname ... |
8006 | ||
8007 | never_direct is the opposite of always_direct. Please read | |
8008 | the description for always_direct if you have not already. | |
8009 | ||
8010 | With 'never_direct' you can use ACL elements to specify | |
8011 | requests which should NEVER be forwarded directly to origin | |
8012 | servers. For example, to force the use of a proxy for all | |
8013 | requests, except those in your local domain use something like: | |
8014 | ||
8015 | acl local-servers dstdomain .foo.net | |
5473c134 | 8016 | never_direct deny local-servers |
8017 | never_direct allow all | |
8018 | ||
8019 | or if Squid is inside a firewall and there are local intranet | |
8020 | servers inside the firewall use something like: | |
8021 | ||
8022 | acl local-intranet dstdomain .foo.net | |
8023 | acl local-external dstdomain external.foo.net | |
8024 | always_direct deny local-external | |
8025 | always_direct allow local-intranet | |
8026 | never_direct allow all | |
8027 | ||
b3567eb5 FC |
8028 | This clause supports both fast and slow acl types. |
8029 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
8d6275c0 | 8030 | DOC_END |
0976f8db | 8031 | |
5473c134 | 8032 | COMMENT_START |
8033 | ADVANCED NETWORKING OPTIONS | |
8034 | ----------------------------------------------------------------------------- | |
8035 | COMMENT_END | |
8036 | ||
65d448bc | 8037 | NAME: incoming_udp_average incoming_icp_average |
cccac0a2 | 8038 | TYPE: int |
8039 | DEFAULT: 6 | |
65d448bc AJ |
8040 | LOC: Config.comm_incoming.udp.average |
8041 | DOC_START | |
8042 | Heavy voodoo here. I can't even believe you are reading this. | |
8043 | Are you crazy? Don't even think about adjusting these unless | |
8044 | you understand the algorithms in comm_select.c first! | |
8045 | DOC_END | |
cccac0a2 | 8046 | |
65d448bc | 8047 | NAME: incoming_tcp_average incoming_http_average |
cccac0a2 | 8048 | TYPE: int |
8049 | DEFAULT: 4 | |
65d448bc AJ |
8050 | LOC: Config.comm_incoming.tcp.average |
8051 | DOC_START | |
8052 | Heavy voodoo here. I can't even believe you are reading this. | |
8053 | Are you crazy? Don't even think about adjusting these unless | |
8054 | you understand the algorithms in comm_select.c first! | |
8055 | DOC_END | |
cccac0a2 | 8056 | |
8057 | NAME: incoming_dns_average | |
8058 | TYPE: int | |
8059 | DEFAULT: 4 | |
65d448bc AJ |
8060 | LOC: Config.comm_incoming.dns.average |
8061 | DOC_START | |
8062 | Heavy voodoo here. I can't even believe you are reading this. | |
8063 | Are you crazy? Don't even think about adjusting these unless | |
8064 | you understand the algorithms in comm_select.c first! | |
8065 | DOC_END | |
cccac0a2 | 8066 | |
65d448bc | 8067 | NAME: min_udp_poll_cnt min_icp_poll_cnt |
cccac0a2 | 8068 | TYPE: int |
8069 | DEFAULT: 8 | |
65d448bc AJ |
8070 | LOC: Config.comm_incoming.udp.min_poll |
8071 | DOC_START | |
8072 | Heavy voodoo here. I can't even believe you are reading this. | |
8073 | Are you crazy? Don't even think about adjusting these unless | |
8074 | you understand the algorithms in comm_select.c first! | |
8075 | DOC_END | |
cccac0a2 | 8076 | |
8077 | NAME: min_dns_poll_cnt | |
8078 | TYPE: int | |
8079 | DEFAULT: 8 | |
65d448bc AJ |
8080 | LOC: Config.comm_incoming.dns.min_poll |
8081 | DOC_START | |
8082 | Heavy voodoo here. I can't even believe you are reading this. | |
8083 | Are you crazy? Don't even think about adjusting these unless | |
8084 | you understand the algorithms in comm_select.c first! | |
8085 | DOC_END | |
cccac0a2 | 8086 | |
65d448bc | 8087 | NAME: min_tcp_poll_cnt min_http_poll_cnt |
cccac0a2 | 8088 | TYPE: int |
8089 | DEFAULT: 8 | |
65d448bc | 8090 | LOC: Config.comm_incoming.tcp.min_poll |
cccac0a2 | 8091 | DOC_START |
5473c134 | 8092 | Heavy voodoo here. I can't even believe you are reading this. |
8093 | Are you crazy? Don't even think about adjusting these unless | |
8094 | you understand the algorithms in comm_select.c first! | |
8095 | DOC_END | |
8096 | ||
8097 | NAME: accept_filter | |
5473c134 | 8098 | TYPE: string |
8099 | DEFAULT: none | |
8100 | LOC: Config.accept_filter | |
8101 | DOC_START | |
0b4d4be5 | 8102 | FreeBSD: |
8103 | ||
5473c134 | 8104 | The name of an accept(2) filter to install on Squid's |
8105 | listen socket(s). This feature is perhaps specific to | |
8106 | FreeBSD and requires support in the kernel. | |
8107 | ||
8108 | The 'httpready' filter delays delivering new connections | |
2324cda2 | 8109 | to Squid until a full HTTP request has been received. |
0b4d4be5 | 8110 | See the accf_http(9) man page for details. |
8111 | ||
8112 | The 'dataready' filter delays delivering new connections | |
8113 | to Squid until there is some data to process. | |
8114 | See the accf_dataready(9) man page for details. | |
8115 | ||
8116 | Linux: | |
8117 | ||
8118 | The 'data' filter delays delivering of new connections | |
8119 | to Squid until there is some data to process by TCP_ACCEPT_DEFER. | |
8120 | You may optionally specify a number of seconds to wait by | |
8121 | 'data=N' where N is the number of seconds. Defaults to 30 | |
8122 | if not specified. See the tcp(7) man page for details. | |
5473c134 | 8123 | EXAMPLE: |
0b4d4be5 | 8124 | # FreeBSD |
5473c134 | 8125 | accept_filter httpready |
0b4d4be5 | 8126 | # Linux |
8127 | accept_filter data | |
5473c134 | 8128 | DOC_END |
8129 | ||
ab2ecb0e AJ |
8130 | NAME: client_ip_max_connections |
8131 | TYPE: int | |
8132 | LOC: Config.client_ip_max_connections | |
8133 | DEFAULT: -1 | |
638402dd | 8134 | DEFAULT_DOC: No limit. |
ab2ecb0e AJ |
8135 | DOC_START |
8136 | Set an absolute limit on the number of connections a single | |
8137 | client IP can use. Any more than this and Squid will begin to drop | |
8138 | new connections from the client until it closes some links. | |
8139 | ||
8140 | Note that this is a global limit. It affects all HTTP, HTCP, Gopher and FTP | |
8141 | connections from the client. For finer control use the ACL access controls. | |
8142 | ||
8143 | Requires client_db to be enabled (the default). | |
8144 | ||
8145 | WARNING: This may noticably slow down traffic received via external proxies | |
8146 | or NAT devices and cause them to rebound error messages back to their clients. | |
8147 | DOC_END | |
8148 | ||
5473c134 | 8149 | NAME: tcp_recv_bufsize |
8150 | COMMENT: (bytes) | |
8151 | TYPE: b_size_t | |
8152 | DEFAULT: 0 bytes | |
638402dd | 8153 | DEFAULT_DOC: Use operating system TCP defaults. |
5473c134 | 8154 | LOC: Config.tcpRcvBufsz |
8155 | DOC_START | |
8156 | Size of receive buffer to set for TCP sockets. Probably just | |
638402dd AJ |
8157 | as easy to change your kernel's default. |
8158 | Omit from squid.conf to use the default buffer size. | |
5473c134 | 8159 | DOC_END |
8160 | ||
8161 | COMMENT_START | |
8162 | ICAP OPTIONS | |
8163 | ----------------------------------------------------------------------------- | |
8164 | COMMENT_END | |
8165 | ||
8166 | NAME: icap_enable | |
8167 | TYPE: onoff | |
8168 | IFDEF: ICAP_CLIENT | |
8169 | COMMENT: on|off | |
26cc52cb | 8170 | LOC: Adaptation::Icap::TheConfig.onoff |
5473c134 | 8171 | DEFAULT: off |
8172 | DOC_START | |
53e738c6 | 8173 | If you want to enable the ICAP module support, set this to on. |
5473c134 | 8174 | DOC_END |
8175 | ||
8176 | NAME: icap_connect_timeout | |
8177 | TYPE: time_t | |
8178 | DEFAULT: none | |
26cc52cb | 8179 | LOC: Adaptation::Icap::TheConfig.connect_timeout_raw |
5473c134 | 8180 | IFDEF: ICAP_CLIENT |
8181 | DOC_START | |
8182 | This parameter specifies how long to wait for the TCP connect to | |
8183 | the requested ICAP server to complete before giving up and either | |
8184 | terminating the HTTP transaction or bypassing the failure. | |
8185 | ||
8186 | The default for optional services is peer_connect_timeout. | |
8187 | The default for essential services is connect_timeout. | |
8188 | If this option is explicitly set, its value applies to all services. | |
8189 | DOC_END | |
8190 | ||
8191 | NAME: icap_io_timeout | |
8192 | COMMENT: time-units | |
8193 | TYPE: time_t | |
8194 | DEFAULT: none | |
638402dd | 8195 | DEFAULT_DOC: Use read_timeout. |
26cc52cb | 8196 | LOC: Adaptation::Icap::TheConfig.io_timeout_raw |
5473c134 | 8197 | IFDEF: ICAP_CLIENT |
8198 | DOC_START | |
8199 | This parameter specifies how long to wait for an I/O activity on | |
8200 | an established, active ICAP connection before giving up and | |
8201 | either terminating the HTTP transaction or bypassing the | |
8202 | failure. | |
5473c134 | 8203 | DOC_END |
8204 | ||
8205 | NAME: icap_service_failure_limit | |
8277060a CT |
8206 | COMMENT: limit [in memory-depth time-units] |
8207 | TYPE: icap_service_failure_limit | |
5473c134 | 8208 | IFDEF: ICAP_CLIENT |
8277060a | 8209 | LOC: Adaptation::Icap::TheConfig |
5473c134 | 8210 | DEFAULT: 10 |
8211 | DOC_START | |
8212 | The limit specifies the number of failures that Squid tolerates | |
8213 | when establishing a new TCP connection with an ICAP service. If | |
8214 | the number of failures exceeds the limit, the ICAP service is | |
8215 | not used for new ICAP requests until it is time to refresh its | |
8277060a | 8216 | OPTIONS. |
5473c134 | 8217 | |
8218 | A negative value disables the limit. Without the limit, an ICAP | |
8219 | service will not be considered down due to connectivity failures | |
8220 | between ICAP OPTIONS requests. | |
8277060a CT |
8221 | |
8222 | Squid forgets ICAP service failures older than the specified | |
8223 | value of memory-depth. The memory fading algorithm | |
8224 | is approximate because Squid does not remember individual | |
8225 | errors but groups them instead, splitting the option | |
8226 | value into ten time slots of equal length. | |
8227 | ||
8228 | When memory-depth is 0 and by default this option has no | |
8229 | effect on service failure expiration. | |
8230 | ||
8231 | Squid always forgets failures when updating service settings | |
8232 | using an ICAP OPTIONS transaction, regardless of this option | |
8233 | setting. | |
8234 | ||
8235 | For example, | |
8236 | # suspend service usage after 10 failures in 5 seconds: | |
8237 | icap_service_failure_limit 10 in 5 seconds | |
cccac0a2 | 8238 | DOC_END |
8239 | ||
5473c134 | 8240 | NAME: icap_service_revival_delay |
cccac0a2 | 8241 | TYPE: int |
5473c134 | 8242 | IFDEF: ICAP_CLIENT |
26cc52cb | 8243 | LOC: Adaptation::Icap::TheConfig.service_revival_delay |
5473c134 | 8244 | DEFAULT: 180 |
cccac0a2 | 8245 | DOC_START |
5473c134 | 8246 | The delay specifies the number of seconds to wait after an ICAP |
8247 | OPTIONS request failure before requesting the options again. The | |
8248 | failed ICAP service is considered "down" until fresh OPTIONS are | |
8249 | fetched. | |
cccac0a2 | 8250 | |
5473c134 | 8251 | The actual delay cannot be smaller than the hardcoded minimum |
8252 | delay of 30 seconds. | |
cccac0a2 | 8253 | DOC_END |
8254 | ||
5473c134 | 8255 | NAME: icap_preview_enable |
cccac0a2 | 8256 | TYPE: onoff |
5473c134 | 8257 | IFDEF: ICAP_CLIENT |
8258 | COMMENT: on|off | |
26cc52cb | 8259 | LOC: Adaptation::Icap::TheConfig.preview_enable |
ac7a62f9 | 8260 | DEFAULT: on |
cccac0a2 | 8261 | DOC_START |
ac7a62f9 | 8262 | The ICAP Preview feature allows the ICAP server to handle the |
8263 | HTTP message by looking only at the beginning of the message body | |
8264 | or even without receiving the body at all. In some environments, | |
8265 | previews greatly speedup ICAP processing. | |
8266 | ||
8267 | During an ICAP OPTIONS transaction, the server may tell Squid what | |
8268 | HTTP messages should be previewed and how big the preview should be. | |
8269 | Squid will not use Preview if the server did not request one. | |
8270 | ||
8271 | To disable ICAP Preview for all ICAP services, regardless of | |
8272 | individual ICAP server OPTIONS responses, set this option to "off". | |
8273 | Example: | |
8274 | icap_preview_enable off | |
cccac0a2 | 8275 | DOC_END |
8276 | ||
5473c134 | 8277 | NAME: icap_preview_size |
8278 | TYPE: int | |
8279 | IFDEF: ICAP_CLIENT | |
26cc52cb | 8280 | LOC: Adaptation::Icap::TheConfig.preview_size |
5473c134 | 8281 | DEFAULT: -1 |
638402dd | 8282 | DEFAULT_DOC: No preview sent. |
cccac0a2 | 8283 | DOC_START |
53e738c6 | 8284 | The default size of preview data to be sent to the ICAP server. |
638402dd | 8285 | This value might be overwritten on a per server basis by OPTIONS requests. |
cccac0a2 | 8286 | DOC_END |
8287 | ||
83c51da9 CT |
8288 | NAME: icap_206_enable |
8289 | TYPE: onoff | |
8290 | IFDEF: ICAP_CLIENT | |
8291 | COMMENT: on|off | |
8292 | LOC: Adaptation::Icap::TheConfig.allow206_enable | |
8293 | DEFAULT: on | |
8294 | DOC_START | |
8295 | 206 (Partial Content) responses is an ICAP extension that allows the | |
8296 | ICAP agents to optionally combine adapted and original HTTP message | |
8297 | content. The decision to combine is postponed until the end of the | |
8298 | ICAP response. Squid supports Partial Content extension by default. | |
8299 | ||
8300 | Activation of the Partial Content extension is negotiated with each | |
8301 | ICAP service during OPTIONS exchange. Most ICAP servers should handle | |
8302 | negotation correctly even if they do not support the extension, but | |
8303 | some might fail. To disable Partial Content support for all ICAP | |
8304 | services and to avoid any negotiation, set this option to "off". | |
8305 | ||
8306 | Example: | |
8307 | icap_206_enable off | |
8308 | DOC_END | |
8309 | ||
5473c134 | 8310 | NAME: icap_default_options_ttl |
8311 | TYPE: int | |
8312 | IFDEF: ICAP_CLIENT | |
26cc52cb | 8313 | LOC: Adaptation::Icap::TheConfig.default_options_ttl |
5473c134 | 8314 | DEFAULT: 60 |
cccac0a2 | 8315 | DOC_START |
53e738c6 | 8316 | The default TTL value for ICAP OPTIONS responses that don't have |
5473c134 | 8317 | an Options-TTL header. |
cccac0a2 | 8318 | DOC_END |
8319 | ||
5473c134 | 8320 | NAME: icap_persistent_connections |
8321 | TYPE: onoff | |
8322 | IFDEF: ICAP_CLIENT | |
8323 | COMMENT: on|off | |
26cc52cb | 8324 | LOC: Adaptation::Icap::TheConfig.reuse_connections |
5473c134 | 8325 | DEFAULT: on |
cccac0a2 | 8326 | DOC_START |
5473c134 | 8327 | Whether or not Squid should use persistent connections to |
8328 | an ICAP server. | |
cccac0a2 | 8329 | DOC_END |
8330 | ||
22fff3bf | 8331 | NAME: adaptation_send_client_ip icap_send_client_ip |
5473c134 | 8332 | TYPE: onoff |
22fff3bf | 8333 | IFDEF: USE_ADAPTATION |
5473c134 | 8334 | COMMENT: on|off |
22fff3bf | 8335 | LOC: Adaptation::Config::send_client_ip |
5473c134 | 8336 | DEFAULT: off |
cccac0a2 | 8337 | DOC_START |
ea3ae478 AR |
8338 | If enabled, Squid shares HTTP client IP information with adaptation |
8339 | services. For ICAP, Squid adds the X-Client-IP header to ICAP requests. | |
8340 | For eCAP, Squid sets the libecap::metaClientIp transaction option. | |
8341 | ||
8342 | See also: adaptation_uses_indirect_client | |
cccac0a2 | 8343 | DOC_END |
8344 | ||
22fff3bf | 8345 | NAME: adaptation_send_username icap_send_client_username |
5473c134 | 8346 | TYPE: onoff |
22fff3bf | 8347 | IFDEF: USE_ADAPTATION |
5473c134 | 8348 | COMMENT: on|off |
22fff3bf | 8349 | LOC: Adaptation::Config::send_username |
5473c134 | 8350 | DEFAULT: off |
cccac0a2 | 8351 | DOC_START |
5473c134 | 8352 | This sends authenticated HTTP client username (if available) to |
22fff3bf AR |
8353 | the adaptation service. |
8354 | ||
8355 | For ICAP, the username value is encoded based on the | |
5473c134 | 8356 | icap_client_username_encode option and is sent using the header |
8357 | specified by the icap_client_username_header option. | |
cccac0a2 | 8358 | DOC_END |
8359 | ||
5473c134 | 8360 | NAME: icap_client_username_header |
cccac0a2 | 8361 | TYPE: string |
5473c134 | 8362 | IFDEF: ICAP_CLIENT |
26cc52cb | 8363 | LOC: Adaptation::Icap::TheConfig.client_username_header |
5473c134 | 8364 | DEFAULT: X-Client-Username |
cccac0a2 | 8365 | DOC_START |
db49f682 | 8366 | ICAP request header name to use for adaptation_send_username. |
cccac0a2 | 8367 | DOC_END |
8368 | ||
5473c134 | 8369 | NAME: icap_client_username_encode |
cccac0a2 | 8370 | TYPE: onoff |
5473c134 | 8371 | IFDEF: ICAP_CLIENT |
8372 | COMMENT: on|off | |
26cc52cb | 8373 | LOC: Adaptation::Icap::TheConfig.client_username_encode |
5473c134 | 8374 | DEFAULT: off |
cccac0a2 | 8375 | DOC_START |
5473c134 | 8376 | Whether to base64 encode the authenticated client username. |
cccac0a2 | 8377 | DOC_END |
8378 | ||
5473c134 | 8379 | NAME: icap_service |
8380 | TYPE: icap_service_type | |
8381 | IFDEF: ICAP_CLIENT | |
26cc52cb | 8382 | LOC: Adaptation::Icap::TheConfig |
5473c134 | 8383 | DEFAULT: none |
cccac0a2 | 8384 | DOC_START |
a22e6cd3 | 8385 | Defines a single ICAP service using the following format: |
cccac0a2 | 8386 | |
c25c2836 | 8387 | icap_service id vectoring_point uri [option ...] |
7d90757b | 8388 | |
c25c2836 CT |
8389 | id: ID |
8390 | an opaque identifier or name which is used to direct traffic to | |
8391 | this specific service. Must be unique among all adaptation | |
8392 | services in squid.conf. | |
a22e6cd3 AR |
8393 | |
8394 | vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache | |
f3db09e2 | 8395 | This specifies at which point of transaction processing the |
8396 | ICAP service should be activated. *_postcache vectoring points | |
8397 | are not yet supported. | |
a22e6cd3 | 8398 | |
c25c2836 | 8399 | uri: icap://servername:port/servicepath |
a22e6cd3 | 8400 | ICAP server and service location. |
1b091aec CT |
8401 | icaps://servername:port/servicepath |
8402 | The "icap:" URI scheme is used for traditional ICAP server and | |
8403 | service location (default port is 1344, connections are not | |
8404 | encrypted). The "icaps:" URI scheme is for Secure ICAP | |
8405 | services that use SSL/TLS-encrypted ICAP connections (by | |
8406 | default, on port 11344). | |
a22e6cd3 AR |
8407 | |
8408 | ICAP does not allow a single service to handle both REQMOD and RESPMOD | |
8409 | transactions. Squid does not enforce that requirement. You can specify | |
8410 | services with the same service_url and different vectoring_points. You | |
8411 | can even specify multiple identical services as long as their | |
8412 | service_names differ. | |
8413 | ||
3caa16d2 AR |
8414 | To activate a service, use the adaptation_access directive. To group |
8415 | services, use adaptation_service_chain and adaptation_service_set. | |
a22e6cd3 AR |
8416 | |
8417 | Service options are separated by white space. ICAP services support | |
8418 | the following name=value options: | |
8419 | ||
8420 | bypass=on|off|1|0 | |
8421 | If set to 'on' or '1', the ICAP service is treated as | |
8422 | optional. If the service cannot be reached or malfunctions, | |
8423 | Squid will try to ignore any errors and process the message as | |
8424 | if the service was not enabled. No all ICAP errors can be | |
8425 | bypassed. If set to 0, the ICAP service is treated as | |
8426 | essential and all ICAP errors will result in an error page | |
8427 | returned to the HTTP client. | |
8428 | ||
8429 | Bypass is off by default: services are treated as essential. | |
8430 | ||
8431 | routing=on|off|1|0 | |
8432 | If set to 'on' or '1', the ICAP service is allowed to | |
8433 | dynamically change the current message adaptation plan by | |
8434 | returning a chain of services to be used next. The services | |
8435 | are specified using the X-Next-Services ICAP response header | |
8436 | value, formatted as a comma-separated list of service names. | |
e2851fe7 AR |
8437 | Each named service should be configured in squid.conf. Other |
8438 | services are ignored. An empty X-Next-Services value results | |
8439 | in an empty plan which ends the current adaptation. | |
8440 | ||
8441 | Dynamic adaptation plan may cross or cover multiple supported | |
8442 | vectoring points in their natural processing order. | |
a22e6cd3 AR |
8443 | |
8444 | Routing is not allowed by default: the ICAP X-Next-Services | |
8445 | response header is ignored. | |
8446 | ||
e6713f4e AJ |
8447 | ipv6=on|off |
8448 | Only has effect on split-stack systems. The default on those systems | |
8449 | is to use IPv4-only connections. When set to 'on' this option will | |
8450 | make Squid use IPv6-only connections to contact this ICAP service. | |
8451 | ||
2dba5b8e CT |
8452 | on-overload=block|bypass|wait|force |
8453 | If the service Max-Connections limit has been reached, do | |
8454 | one of the following for each new ICAP transaction: | |
8455 | * block: send an HTTP error response to the client | |
8456 | * bypass: ignore the "over-connected" ICAP service | |
8457 | * wait: wait (in a FIFO queue) for an ICAP connection slot | |
8458 | * force: proceed, ignoring the Max-Connections limit | |
8459 | ||
8460 | In SMP mode with N workers, each worker assumes the service | |
8461 | connection limit is Max-Connections/N, even though not all | |
8462 | workers may use a given service. | |
8463 | ||
8464 | The default value is "bypass" if service is bypassable, | |
8465 | otherwise it is set to "wait". | |
8466 | ||
8467 | ||
8468 | max-conn=number | |
8469 | Use the given number as the Max-Connections limit, regardless | |
8470 | of the Max-Connections value given by the service, if any. | |
8471 | ||
88df846b CT |
8472 | connection-encryption=on|off |
8473 | Determines the ICAP service effect on the connections_encrypted | |
8474 | ACL. | |
8475 | ||
8476 | The default is "on" for Secure ICAP services (i.e., those | |
8477 | with the icaps:// service URIs scheme) and "off" for plain ICAP | |
8478 | services. | |
8479 | ||
8480 | Does not affect ICAP connections (e.g., does not turn Secure | |
8481 | ICAP on or off). | |
8482 | ||
4dd2c9d6 | 8483 | ==== ICAPS / TLS OPTIONS ==== |
1b091aec CT |
8484 | |
8485 | These options are used for Secure ICAP (icaps://....) services only. | |
8486 | ||
4dd2c9d6 | 8487 | tls-cert=/path/to/ssl/certificate |
1b091aec CT |
8488 | A client SSL certificate to use when connecting to |
8489 | this icap server. | |
8490 | ||
4dd2c9d6 AJ |
8491 | tls-key=/path/to/ssl/key |
8492 | The private TLS/SSL key corresponding to sslcert above. | |
8493 | If 'tls-key' is not specified 'tls-cert' is assumed to | |
8494 | reference a combined PEM format file containing both the | |
1b091aec CT |
8495 | certificate and the key. |
8496 | ||
4dd2c9d6 | 8497 | tls-cipher=... The list of valid TLS/SSL ciphers to use when connecting |
1b091aec CT |
8498 | to this icap server. |
8499 | ||
1cc44095 AJ |
8500 | tls-min-version=1.N |
8501 | The minimum TLS protocol version to permit. To control | |
8502 | SSLv3 use the ssloptions= parameter. | |
8503 | Supported Values: 1.0 (default), 1.1, 1.2 | |
8504 | ||
4dd2c9d6 | 8505 | tls-options=... Specify various OpenSSL library options: |
1b091aec CT |
8506 | |
8507 | NO_SSLv3 Disallow the use of SSLv3 | |
4dd2c9d6 | 8508 | |
1b091aec CT |
8509 | NO_TLSv1 Disallow the use of TLSv1.0 |
8510 | NO_TLSv1_1 Disallow the use of TLSv1.1 | |
8511 | NO_TLSv1_2 Disallow the use of TLSv1.2 | |
4dd2c9d6 | 8512 | |
1b091aec CT |
8513 | SINGLE_DH_USE |
8514 | Always create a new key when using | |
8515 | temporary/ephemeral DH key exchanges | |
4dd2c9d6 | 8516 | |
1b091aec | 8517 | ALL Enable various bug workarounds |
4dd2c9d6 AJ |
8518 | suggested as "harmless" by OpenSSL |
8519 | Be warned that this reduces SSL/TLS | |
8520 | strength to some attacks. | |
1b091aec CT |
8521 | |
8522 | See the OpenSSL SSL_CTX_set_options documentation for a | |
4dd2c9d6 AJ |
8523 | more complete list. Options relevant only to SSLv2 are |
8524 | not supported. | |
1b091aec | 8525 | |
86a84cc0 AJ |
8526 | tls-cafile= PEM file containing CA certificates to use when verifying |
8527 | the icap server certificate. | |
8528 | Use to specify intermediate CA certificate(s) if not sent | |
8529 | by the server. Or the full CA chain for the server when | |
8b253b83 | 8530 | using the tls-no-default-ca flag. |
86a84cc0 | 8531 | May be repeated to load multiple files. |
1b091aec | 8532 | |
4dd2c9d6 | 8533 | tls-capath=... A directory containing additional CA certificates to |
1b091aec | 8534 | use when verifying the icap server certificate. |
86a84cc0 | 8535 | Requires OpenSSL or LibreSSL. |
1b091aec | 8536 | |
4dd2c9d6 | 8537 | tls-crlfile=... A certificate revocation list file to use when |
1b091aec CT |
8538 | verifying the icap server certificate. |
8539 | ||
4dd2c9d6 | 8540 | tls-flags=... Specify various flags modifying the Squid TLS implementation: |
1b091aec CT |
8541 | |
8542 | DONT_VERIFY_PEER | |
8543 | Accept certificates even if they fail to | |
8544 | verify. | |
1b091aec CT |
8545 | DONT_VERIFY_DOMAIN |
8546 | Don't verify the icap server certificate | |
8547 | matches the server name | |
8548 | ||
8b253b83 AJ |
8549 | tls-no-default-ca |
8550 | Do no use the system default Trusted CA. | |
8551 | ||
4dd2c9d6 | 8552 | tls-domain= The icap server name as advertised in it's certificate. |
1b091aec CT |
8553 | Used for verifying the correctness of the received icap |
8554 | server certificate. If not specified the icap server | |
8555 | hostname extracted from ICAP URI will be used. | |
8556 | ||
a22e6cd3 AR |
8557 | Older icap_service format without optional named parameters is |
8558 | deprecated but supported for backward compatibility. | |
5473c134 | 8559 | |
5473c134 | 8560 | Example: |
c25c2836 | 8561 | icap_service svcBlocker reqmod_precache icap://icap1.mydomain.net:1344/reqmod bypass=0 |
1b091aec | 8562 | icap_service svcLogger reqmod_precache icaps://icap2.mydomain.net:11344/reqmod routing=on |
cccac0a2 | 8563 | DOC_END |
8564 | ||
5473c134 | 8565 | NAME: icap_class |
8566 | TYPE: icap_class_type | |
8567 | IFDEF: ICAP_CLIENT | |
21a26d31 | 8568 | LOC: none |
5473c134 | 8569 | DEFAULT: none |
cccac0a2 | 8570 | DOC_START |
a22e6cd3 | 8571 | This deprecated option was documented to define an ICAP service |
62c7f90e AR |
8572 | chain, even though it actually defined a set of similar, redundant |
8573 | services, and the chains were not supported. | |
5473c134 | 8574 | |
62c7f90e | 8575 | To define a set of redundant services, please use the |
a22e6cd3 AR |
8576 | adaptation_service_set directive. For service chains, use |
8577 | adaptation_service_chain. | |
cccac0a2 | 8578 | DOC_END |
8579 | ||
5473c134 | 8580 | NAME: icap_access |
8581 | TYPE: icap_access_type | |
8582 | IFDEF: ICAP_CLIENT | |
21a26d31 | 8583 | LOC: none |
cccac0a2 | 8584 | DEFAULT: none |
cccac0a2 | 8585 | DOC_START |
a22e6cd3 | 8586 | This option is deprecated. Please use adaptation_access, which |
62c7f90e AR |
8587 | has the same ICAP functionality, but comes with better |
8588 | documentation, and eCAP support. | |
cccac0a2 | 8589 | DOC_END |
8590 | ||
57afc994 AR |
8591 | COMMENT_START |
8592 | eCAP OPTIONS | |
8593 | ----------------------------------------------------------------------------- | |
8594 | COMMENT_END | |
8595 | ||
21a26d31 AR |
8596 | NAME: ecap_enable |
8597 | TYPE: onoff | |
8598 | IFDEF: USE_ECAP | |
8599 | COMMENT: on|off | |
574b508c | 8600 | LOC: Adaptation::Ecap::TheConfig.onoff |
21a26d31 AR |
8601 | DEFAULT: off |
8602 | DOC_START | |
8603 | Controls whether eCAP support is enabled. | |
8604 | DOC_END | |
8605 | ||
8606 | NAME: ecap_service | |
8607 | TYPE: ecap_service_type | |
8608 | IFDEF: USE_ECAP | |
574b508c | 8609 | LOC: Adaptation::Ecap::TheConfig |
21a26d31 AR |
8610 | DEFAULT: none |
8611 | DOC_START | |
8612 | Defines a single eCAP service | |
8613 | ||
c25c2836 | 8614 | ecap_service id vectoring_point uri [option ...] |
21a26d31 | 8615 | |
c25c2836 CT |
8616 | id: ID |
8617 | an opaque identifier or name which is used to direct traffic to | |
8618 | this specific service. Must be unique among all adaptation | |
8619 | services in squid.conf. | |
8620 | ||
8621 | vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache | |
21a26d31 AR |
8622 | This specifies at which point of transaction processing the |
8623 | eCAP service should be activated. *_postcache vectoring points | |
8624 | are not yet supported. | |
c25c2836 CT |
8625 | |
8626 | uri: ecap://vendor/service_name?custom&cgi=style¶meters=optional | |
8627 | Squid uses the eCAP service URI to match this configuration | |
8628 | line with one of the dynamically loaded services. Each loaded | |
8629 | eCAP service must have a unique URI. Obtain the right URI from | |
8630 | the service provider. | |
8631 | ||
3caa16d2 AR |
8632 | To activate a service, use the adaptation_access directive. To group |
8633 | services, use adaptation_service_chain and adaptation_service_set. | |
c25c2836 CT |
8634 | |
8635 | Service options are separated by white space. eCAP services support | |
8636 | the following name=value options: | |
8637 | ||
8638 | bypass=on|off|1|0 | |
8639 | If set to 'on' or '1', the eCAP service is treated as optional. | |
8640 | If the service cannot be reached or malfunctions, Squid will try | |
8641 | to ignore any errors and process the message as if the service | |
21a26d31 | 8642 | was not enabled. No all eCAP errors can be bypassed. |
c25c2836 CT |
8643 | If set to 'off' or '0', the eCAP service is treated as essential |
8644 | and all eCAP errors will result in an error page returned to the | |
21a26d31 | 8645 | HTTP client. |
c25c2836 CT |
8646 | |
8647 | Bypass is off by default: services are treated as essential. | |
8648 | ||
8649 | routing=on|off|1|0 | |
8650 | If set to 'on' or '1', the eCAP service is allowed to | |
8651 | dynamically change the current message adaptation plan by | |
8652 | returning a chain of services to be used next. | |
8653 | ||
8654 | Dynamic adaptation plan may cross or cover multiple supported | |
8655 | vectoring points in their natural processing order. | |
8656 | ||
8657 | Routing is not allowed by default. | |
8658 | ||
88df846b CT |
8659 | connection-encryption=on|off |
8660 | Determines the eCAP service effect on the connections_encrypted | |
8661 | ACL. | |
8662 | ||
8663 | Defaults to "on", which does not taint the master transaction | |
8664 | w.r.t. that ACL. | |
8665 | ||
8666 | Does not affect eCAP API calls. | |
8667 | ||
c25c2836 CT |
8668 | Older ecap_service format without optional named parameters is |
8669 | deprecated but supported for backward compatibility. | |
8670 | ||
21a26d31 AR |
8671 | |
8672 | Example: | |
c25c2836 CT |
8673 | ecap_service s1 reqmod_precache ecap://filters.R.us/leakDetector?on_error=block bypass=off |
8674 | ecap_service s2 respmod_precache ecap://filters.R.us/virusFilter config=/etc/vf.cfg bypass=on | |
21a26d31 AR |
8675 | DOC_END |
8676 | ||
57afc994 AR |
8677 | NAME: loadable_modules |
8678 | TYPE: wordlist | |
8679 | IFDEF: USE_LOADABLE_MODULES | |
8680 | LOC: Config.loadable_module_names | |
8681 | DEFAULT: none | |
8682 | DOC_START | |
8683 | Instructs Squid to load the specified dynamic module(s) or activate | |
8684 | preloaded module(s). | |
8685 | Example: | |
8686 | loadable_modules @DEFAULT_PREFIX@/lib/MinimalAdapter.so | |
8687 | DOC_END | |
8688 | ||
62c7f90e AR |
8689 | COMMENT_START |
8690 | MESSAGE ADAPTATION OPTIONS | |
8691 | ----------------------------------------------------------------------------- | |
8692 | COMMENT_END | |
8693 | ||
8694 | NAME: adaptation_service_set | |
8695 | TYPE: adaptation_service_set_type | |
8696 | IFDEF: USE_ADAPTATION | |
8697 | LOC: none | |
8698 | DEFAULT: none | |
8699 | DOC_START | |
8700 | ||
a22e6cd3 AR |
8701 | Configures an ordered set of similar, redundant services. This is |
8702 | useful when hot standby or backup adaptation servers are available. | |
8703 | ||
8704 | adaptation_service_set set_name service_name1 service_name2 ... | |
8705 | ||
8706 | The named services are used in the set declaration order. The first | |
8707 | applicable adaptation service from the set is used first. The next | |
8708 | applicable service is tried if and only if the transaction with the | |
8709 | previous service fails and the message waiting to be adapted is still | |
8710 | intact. | |
62c7f90e | 8711 | |
a22e6cd3 AR |
8712 | When adaptation starts, broken services are ignored as if they were |
8713 | not a part of the set. A broken service is a down optional service. | |
62c7f90e | 8714 | |
a22e6cd3 AR |
8715 | The services in a set must be attached to the same vectoring point |
8716 | (e.g., pre-cache) and use the same adaptation method (e.g., REQMOD). | |
8717 | ||
8718 | If all services in a set are optional then adaptation failures are | |
8719 | bypassable. If all services in the set are essential, then a | |
8720 | transaction failure with one service may still be retried using | |
8721 | another service from the set, but when all services fail, the master | |
8722 | transaction fails as well. | |
8723 | ||
8724 | A set may contain a mix of optional and essential services, but that | |
8725 | is likely to lead to surprising results because broken services become | |
8726 | ignored (see above), making previously bypassable failures fatal. | |
8727 | Technically, it is the bypassability of the last failed service that | |
8728 | matters. | |
8729 | ||
8730 | See also: adaptation_access adaptation_service_chain | |
62c7f90e AR |
8731 | |
8732 | Example: | |
8733 | adaptation_service_set svcBlocker urlFilterPrimary urlFilterBackup | |
8734 | adaptation service_set svcLogger loggerLocal loggerRemote | |
8735 | DOC_END | |
8736 | ||
a22e6cd3 AR |
8737 | NAME: adaptation_service_chain |
8738 | TYPE: adaptation_service_chain_type | |
8739 | IFDEF: USE_ADAPTATION | |
8740 | LOC: none | |
8741 | DEFAULT: none | |
8742 | DOC_START | |
8743 | ||
8744 | Configures a list of complementary services that will be applied | |
8745 | one-by-one, forming an adaptation chain or pipeline. This is useful | |
8746 | when Squid must perform different adaptations on the same message. | |
8747 | ||
8748 | adaptation_service_chain chain_name service_name1 svc_name2 ... | |
8749 | ||
8750 | The named services are used in the chain declaration order. The first | |
8751 | applicable adaptation service from the chain is used first. The next | |
8752 | applicable service is applied to the successful adaptation results of | |
8753 | the previous service in the chain. | |
8754 | ||
8755 | When adaptation starts, broken services are ignored as if they were | |
8756 | not a part of the chain. A broken service is a down optional service. | |
8757 | ||
8758 | Request satisfaction terminates the adaptation chain because Squid | |
8759 | does not currently allow declaration of RESPMOD services at the | |
8760 | "reqmod_precache" vectoring point (see icap_service or ecap_service). | |
8761 | ||
8762 | The services in a chain must be attached to the same vectoring point | |
8763 | (e.g., pre-cache) and use the same adaptation method (e.g., REQMOD). | |
8764 | ||
8765 | A chain may contain a mix of optional and essential services. If an | |
8766 | essential adaptation fails (or the failure cannot be bypassed for | |
8767 | other reasons), the master transaction fails. Otherwise, the failure | |
8768 | is bypassed as if the failed adaptation service was not in the chain. | |
8769 | ||
8770 | See also: adaptation_access adaptation_service_set | |
8771 | ||
8772 | Example: | |
8773 | adaptation_service_chain svcRequest requestLogger urlFilter leakDetector | |
8774 | DOC_END | |
8775 | ||
62c7f90e AR |
8776 | NAME: adaptation_access |
8777 | TYPE: adaptation_access_type | |
8778 | IFDEF: USE_ADAPTATION | |
8779 | LOC: none | |
8780 | DEFAULT: none | |
638402dd | 8781 | DEFAULT_DOC: Allow, unless rules exist in squid.conf. |
62c7f90e AR |
8782 | DOC_START |
8783 | Sends an HTTP transaction to an ICAP or eCAP adaptation service. | |
8784 | ||
8785 | adaptation_access service_name allow|deny [!]aclname... | |
8786 | adaptation_access set_name allow|deny [!]aclname... | |
8787 | ||
8788 | At each supported vectoring point, the adaptation_access | |
8789 | statements are processed in the order they appear in this | |
8790 | configuration file. Statements pointing to the following services | |
8791 | are ignored (i.e., skipped without checking their ACL): | |
8792 | ||
8793 | - services serving different vectoring points | |
8794 | - "broken-but-bypassable" services | |
8795 | - "up" services configured to ignore such transactions | |
8796 | (e.g., based on the ICAP Transfer-Ignore header). | |
8797 | ||
8798 | When a set_name is used, all services in the set are checked | |
8799 | using the same rules, to find the first applicable one. See | |
8800 | adaptation_service_set for details. | |
8801 | ||
8802 | If an access list is checked and there is a match, the | |
8803 | processing stops: For an "allow" rule, the corresponding | |
8804 | adaptation service is used for the transaction. For a "deny" | |
8805 | rule, no adaptation service is activated. | |
8806 | ||
8807 | It is currently not possible to apply more than one adaptation | |
8808 | service at the same vectoring point to the same HTTP transaction. | |
8809 | ||
8810 | See also: icap_service and ecap_service | |
8811 | ||
8812 | Example: | |
8813 | adaptation_access service_1 allow all | |
8814 | DOC_END | |
8815 | ||
a22e6cd3 AR |
8816 | NAME: adaptation_service_iteration_limit |
8817 | TYPE: int | |
8818 | IFDEF: USE_ADAPTATION | |
8819 | LOC: Adaptation::Config::service_iteration_limit | |
8820 | DEFAULT: 16 | |
8821 | DOC_START | |
8822 | Limits the number of iterations allowed when applying adaptation | |
8823 | services to a message. If your longest adaptation set or chain | |
8824 | may have more than 16 services, increase the limit beyond its | |
8825 | default value of 16. If detecting infinite iteration loops sooner | |
8826 | is critical, make the iteration limit match the actual number | |
8827 | of services in your longest adaptation set or chain. | |
8828 | ||
8829 | Infinite adaptation loops are most likely with routing services. | |
8830 | ||
8831 | See also: icap_service routing=1 | |
8832 | DOC_END | |
8833 | ||
3ff65596 AR |
8834 | NAME: adaptation_masterx_shared_names |
8835 | TYPE: string | |
8836 | IFDEF: USE_ADAPTATION | |
8837 | LOC: Adaptation::Config::masterx_shared_name | |
8838 | DEFAULT: none | |
8839 | DOC_START | |
8840 | For each master transaction (i.e., the HTTP request and response | |
8841 | sequence, including all related ICAP and eCAP exchanges), Squid | |
8842 | maintains a table of metadata. The table entries are (name, value) | |
8843 | pairs shared among eCAP and ICAP exchanges. The table is destroyed | |
8844 | with the master transaction. | |
8845 | ||
8846 | This option specifies the table entry names that Squid must accept | |
8847 | from and forward to the adaptation transactions. | |
8848 | ||
8849 | An ICAP REQMOD or RESPMOD transaction may set an entry in the | |
8850 | shared table by returning an ICAP header field with a name | |
6666da11 AR |
8851 | specified in adaptation_masterx_shared_names. |
8852 | ||
8853 | An eCAP REQMOD or RESPMOD transaction may set an entry in the | |
8854 | shared table by implementing the libecap::visitEachOption() API | |
8855 | to provide an option with a name specified in | |
8856 | adaptation_masterx_shared_names. | |
5038f9d8 AR |
8857 | |
8858 | Squid will store and forward the set entry to subsequent adaptation | |
3ff65596 AR |
8859 | transactions within the same master transaction scope. |
8860 | ||
8861 | Only one shared entry name is supported at this time. | |
8862 | ||
8863 | Example: | |
8864 | # share authentication information among ICAP services | |
8865 | adaptation_masterx_shared_names X-Subscriber-ID | |
8866 | DOC_END | |
8867 | ||
71be37e0 | 8868 | NAME: adaptation_meta |
d7f4a0b7 | 8869 | TYPE: note |
71be37e0 CT |
8870 | IFDEF: USE_ADAPTATION |
8871 | LOC: Adaptation::Config::metaHeaders | |
8872 | DEFAULT: none | |
8873 | DOC_START | |
8874 | This option allows Squid administrator to add custom ICAP request | |
8875 | headers or eCAP options to Squid ICAP requests or eCAP transactions. | |
8876 | Use it to pass custom authentication tokens and other | |
8877 | transaction-state related meta information to an ICAP/eCAP service. | |
8878 | ||
8879 | The addition of a meta header is ACL-driven: | |
8880 | adaptation_meta name value [!]aclname ... | |
8881 | ||
8882 | Processing for a given header name stops after the first ACL list match. | |
8883 | Thus, it is impossible to add two headers with the same name. If no ACL | |
8884 | lists match for a given header name, no such header is added. For | |
8885 | example: | |
8886 | ||
8887 | # do not debug transactions except for those that need debugging | |
8888 | adaptation_meta X-Debug 1 needs_debugging | |
8889 | ||
8890 | # log all transactions except for those that must remain secret | |
8891 | adaptation_meta X-Log 1 !keep_secret | |
8892 | ||
8893 | # mark transactions from users in the "G 1" group | |
8894 | adaptation_meta X-Authenticated-Groups "G 1" authed_as_G1 | |
8895 | ||
8896 | The "value" parameter may be a regular squid.conf token or a "double | |
8897 | quoted string". Within the quoted string, use backslash (\) to escape | |
8898 | any character, which is currently only useful for escaping backslashes | |
8899 | and double quotes. For example, | |
8900 | "this string has one backslash (\\) and two \"quotes\"" | |
d7f4a0b7 CT |
8901 | |
8902 | Used adaptation_meta header values may be logged via %note | |
8903 | logformat code. If multiple adaptation_meta headers with the same name | |
8904 | are used during master transaction lifetime, the header values are | |
8905 | logged in the order they were used and duplicate values are ignored | |
8906 | (only the first repeated value will be logged). | |
71be37e0 CT |
8907 | DOC_END |
8908 | ||
3ff65596 AR |
8909 | NAME: icap_retry |
8910 | TYPE: acl_access | |
8911 | IFDEF: ICAP_CLIENT | |
8912 | LOC: Adaptation::Icap::TheConfig.repeat | |
3ff65596 AR |
8913 | DEFAULT_IF_NONE: deny all |
8914 | DOC_START | |
8915 | This ACL determines which retriable ICAP transactions are | |
8916 | retried. Transactions that received a complete ICAP response | |
8917 | and did not have to consume or produce HTTP bodies to receive | |
8918 | that response are usually retriable. | |
8919 | ||
8920 | icap_retry allow|deny [!]aclname ... | |
8921 | ||
8922 | Squid automatically retries some ICAP I/O timeouts and errors | |
8923 | due to persistent connection race conditions. | |
8924 | ||
8925 | See also: icap_retry_limit | |
8926 | DOC_END | |
8927 | ||
8928 | NAME: icap_retry_limit | |
8929 | TYPE: int | |
8930 | IFDEF: ICAP_CLIENT | |
8931 | LOC: Adaptation::Icap::TheConfig.repeat_limit | |
8932 | DEFAULT: 0 | |
638402dd | 8933 | DEFAULT_DOC: No retries are allowed. |
3ff65596 | 8934 | DOC_START |
638402dd | 8935 | Limits the number of retries allowed. |
3ff65596 AR |
8936 | |
8937 | Communication errors due to persistent connection race | |
8938 | conditions are unavoidable, automatically retried, and do not | |
8939 | count against this limit. | |
8940 | ||
8941 | See also: icap_retry | |
8942 | DOC_END | |
8943 | ||
8944 | ||
5473c134 | 8945 | COMMENT_START |
8946 | DNS OPTIONS | |
8947 | ----------------------------------------------------------------------------- | |
8948 | COMMENT_END | |
8949 | ||
8950 | NAME: check_hostnames | |
cccac0a2 | 8951 | TYPE: onoff |
cccac0a2 | 8952 | DEFAULT: off |
5473c134 | 8953 | LOC: Config.onoff.check_hostnames |
cccac0a2 | 8954 | DOC_START |
5473c134 | 8955 | For security and stability reasons Squid can check |
8956 | hostnames for Internet standard RFC compliance. If you want | |
8957 | Squid to perform these checks turn this directive on. | |
cccac0a2 | 8958 | DOC_END |
8959 | ||
5473c134 | 8960 | NAME: allow_underscore |
cccac0a2 | 8961 | TYPE: onoff |
cccac0a2 | 8962 | DEFAULT: on |
5473c134 | 8963 | LOC: Config.onoff.allow_underscore |
cccac0a2 | 8964 | DOC_START |
5473c134 | 8965 | Underscore characters is not strictly allowed in Internet hostnames |
8966 | but nevertheless used by many sites. Set this to off if you want | |
8967 | Squid to be strict about the standard. | |
8968 | This check is performed only when check_hostnames is set to on. | |
cccac0a2 | 8969 | DOC_END |
8970 | ||
5473c134 | 8971 | NAME: dns_retransmit_interval |
fd0f51c4 | 8972 | TYPE: time_msec |
5473c134 | 8973 | DEFAULT: 5 seconds |
8974 | LOC: Config.Timeout.idns_retransmit | |
cccac0a2 | 8975 | DOC_START |
5473c134 | 8976 | Initial retransmit interval for DNS queries. The interval is |
8977 | doubled each time all configured DNS servers have been tried. | |
cccac0a2 | 8978 | DOC_END |
8979 | ||
5473c134 | 8980 | NAME: dns_timeout |
fd0f51c4 | 8981 | TYPE: time_msec |
a541c34e | 8982 | DEFAULT: 30 seconds |
5473c134 | 8983 | LOC: Config.Timeout.idns_query |
cccac0a2 | 8984 | DOC_START |
5473c134 | 8985 | DNS Query timeout. If no response is received to a DNS query |
8986 | within this time all DNS servers for the queried domain | |
8987 | are assumed to be unavailable. | |
cccac0a2 | 8988 | DOC_END |
8989 | ||
e210930b AJ |
8990 | NAME: dns_packet_max |
8991 | TYPE: b_ssize_t | |
638402dd | 8992 | DEFAULT_DOC: EDNS disabled |
e210930b AJ |
8993 | DEFAULT: none |
8994 | LOC: Config.dns.packet_max | |
e210930b AJ |
8995 | DOC_START |
8996 | Maximum number of bytes packet size to advertise via EDNS. | |
8997 | Set to "none" to disable EDNS large packet support. | |
8998 | ||
8999 | For legacy reasons DNS UDP replies will default to 512 bytes which | |
9000 | is too small for many responses. EDNS provides a means for Squid to | |
9001 | negotiate receiving larger responses back immediately without having | |
9002 | to failover with repeat requests. Responses larger than this limit | |
9003 | will retain the old behaviour of failover to TCP DNS. | |
9004 | ||
9005 | Squid has no real fixed limit internally, but allowing packet sizes | |
9006 | over 1500 bytes requires network jumbogram support and is usually not | |
9007 | necessary. | |
9008 | ||
9009 | WARNING: The RFC also indicates that some older resolvers will reply | |
9010 | with failure of the whole request if the extension is added. Some | |
9011 | resolvers have already been identified which will reply with mangled | |
9012 | EDNS response on occasion. Usually in response to many-KB jumbogram | |
9013 | sizes being advertised by Squid. | |
9014 | Squid will currently treat these both as an unable-to-resolve domain | |
9015 | even if it would be resolvable without EDNS. | |
9016 | DOC_END | |
9017 | ||
5473c134 | 9018 | NAME: dns_defnames |
9019 | COMMENT: on|off | |
cccac0a2 | 9020 | TYPE: onoff |
cccac0a2 | 9021 | DEFAULT: off |
638402dd | 9022 | DEFAULT_DOC: Search for single-label domain names is disabled. |
5473c134 | 9023 | LOC: Config.onoff.res_defnames |
cccac0a2 | 9024 | DOC_START |
5473c134 | 9025 | Normally the RES_DEFNAMES resolver option is disabled |
9026 | (see res_init(3)). This prevents caches in a hierarchy | |
9027 | from interpreting single-component hostnames locally. To allow | |
9028 | Squid to handle single-component names, enable this option. | |
cccac0a2 | 9029 | DOC_END |
9030 | ||
bce61b00 AJ |
9031 | NAME: dns_multicast_local |
9032 | COMMENT: on|off | |
9033 | TYPE: onoff | |
9034 | DEFAULT: off | |
9035 | DEFAULT_DOC: Search for .local and .arpa names is disabled. | |
9036 | LOC: Config.onoff.dns_mdns | |
9037 | DOC_START | |
9038 | When set to on, Squid sends multicast DNS lookups on the local | |
9039 | network for domains ending in .local and .arpa. | |
9040 | This enables local servers and devices to be contacted in an | |
9041 | ad-hoc or zero-configuration network environment. | |
9042 | DOC_END | |
9043 | ||
5473c134 | 9044 | NAME: dns_nameservers |
9045 | TYPE: wordlist | |
9046 | DEFAULT: none | |
638402dd | 9047 | DEFAULT_DOC: Use operating system definitions |
5473c134 | 9048 | LOC: Config.dns_nameservers |
cccac0a2 | 9049 | DOC_START |
5473c134 | 9050 | Use this if you want to specify a list of DNS name servers |
9051 | (IP addresses) to use instead of those given in your | |
9052 | /etc/resolv.conf file. | |
638402dd | 9053 | |
5473c134 | 9054 | On Windows platforms, if no value is specified here or in |
9055 | the /etc/resolv.conf file, the list of DNS name servers are | |
9056 | taken from the Windows registry, both static and dynamic DHCP | |
9057 | configurations are supported. | |
cccac0a2 | 9058 | |
5473c134 | 9059 | Example: dns_nameservers 10.0.0.1 192.172.0.4 |
cccac0a2 | 9060 | DOC_END |
9061 | ||
5473c134 | 9062 | NAME: hosts_file |
cccac0a2 | 9063 | TYPE: string |
5473c134 | 9064 | DEFAULT: @DEFAULT_HOSTS@ |
9065 | LOC: Config.etcHostsPath | |
cccac0a2 | 9066 | DOC_START |
5473c134 | 9067 | Location of the host-local IP name-address associations |
9068 | database. Most Operating Systems have such a file on different | |
9069 | default locations: | |
9070 | - Un*X & Linux: /etc/hosts | |
9071 | - Windows NT/2000: %SystemRoot%\system32\drivers\etc\hosts | |
9072 | (%SystemRoot% value install default is c:\winnt) | |
9073 | - Windows XP/2003: %SystemRoot%\system32\drivers\etc\hosts | |
9074 | (%SystemRoot% value install default is c:\windows) | |
9075 | - Windows 9x/Me: %windir%\hosts | |
9076 | (%windir% value is usually c:\windows) | |
9077 | - Cygwin: /etc/hosts | |
cccac0a2 | 9078 | |
5473c134 | 9079 | The file contains newline-separated definitions, in the |
9080 | form ip_address_in_dotted_form name [name ...] names are | |
9081 | whitespace-separated. Lines beginning with an hash (#) | |
9082 | character are comments. | |
cccac0a2 | 9083 | |
5473c134 | 9084 | The file is checked at startup and upon configuration. |
9085 | If set to 'none', it won't be checked. | |
9086 | If append_domain is used, that domain will be added to | |
9087 | domain-local (i.e. not containing any dot character) host | |
9088 | definitions. | |
cccac0a2 | 9089 | DOC_END |
9090 | ||
5473c134 | 9091 | NAME: append_domain |
9092 | TYPE: string | |
9093 | LOC: Config.appendDomain | |
9094 | DEFAULT: none | |
638402dd | 9095 | DEFAULT_DOC: Use operating system definitions |
6a2f3fcf | 9096 | DOC_START |
5473c134 | 9097 | Appends local domain name to hostnames without any dots in |
9098 | them. append_domain must begin with a period. | |
9099 | ||
9100 | Be warned there are now Internet names with no dots in | |
9101 | them using only top-domain names, so setting this may | |
9102 | cause some Internet sites to become unavailable. | |
9103 | ||
9104 | Example: | |
9105 | append_domain .yourdomain.com | |
6a2f3fcf | 9106 | DOC_END |
9107 | ||
5473c134 | 9108 | NAME: ignore_unknown_nameservers |
9109 | TYPE: onoff | |
9110 | LOC: Config.onoff.ignore_unknown_nameservers | |
df6fd596 | 9111 | DEFAULT: on |
9112 | DOC_START | |
5473c134 | 9113 | By default Squid checks that DNS responses are received |
9114 | from the same IP addresses they are sent to. If they | |
9115 | don't match, Squid ignores the response and writes a warning | |
9116 | message to cache.log. You can allow responses from unknown | |
9117 | nameservers by setting this option to 'off'. | |
df6fd596 | 9118 | DOC_END |
9119 | ||
5a0da9ec AJ |
9120 | NAME: dns_v4_first |
9121 | TYPE: onoff | |
9122 | DEFAULT: off | |
9123 | LOC: Config.dns.v4_first | |
5a0da9ec AJ |
9124 | DOC_START |
9125 | With the IPv6 Internet being as fast or faster than IPv4 Internet | |
9126 | for most networks Squid prefers to contact websites over IPv6. | |
9127 | ||
9128 | This option reverses the order of preference to make Squid contact | |
9129 | dual-stack websites over IPv4 first. Squid will still perform both | |
9130 | IPv6 and IPv4 DNS lookups before connecting. | |
9131 | ||
9132 | WARNING: | |
9133 | This option will restrict the situations under which IPv6 | |
9134 | connectivity is used (and tested). Hiding network problems | |
9135 | which would otherwise be detected and warned about. | |
9136 | DOC_END | |
9137 | ||
6bc15a4f | 9138 | NAME: ipcache_size |
9139 | COMMENT: (number of entries) | |
9140 | TYPE: int | |
9141 | DEFAULT: 1024 | |
9142 | LOC: Config.ipcache.size | |
638402dd AJ |
9143 | DOC_START |
9144 | Maximum number of DNS IP cache entries. | |
9145 | DOC_END | |
6bc15a4f | 9146 | |
9147 | NAME: ipcache_low | |
9148 | COMMENT: (percent) | |
9149 | TYPE: int | |
9150 | DEFAULT: 90 | |
9151 | LOC: Config.ipcache.low | |
9152 | DOC_NONE | |
9153 | ||
9154 | NAME: ipcache_high | |
9155 | COMMENT: (percent) | |
9156 | TYPE: int | |
9157 | DEFAULT: 95 | |
9158 | LOC: Config.ipcache.high | |
9159 | DOC_START | |
9160 | The size, low-, and high-water marks for the IP cache. | |
9161 | DOC_END | |
9162 | ||
9163 | NAME: fqdncache_size | |
9164 | COMMENT: (number of entries) | |
9165 | TYPE: int | |
9166 | DEFAULT: 1024 | |
9167 | LOC: Config.fqdncache.size | |
9168 | DOC_START | |
9169 | Maximum number of FQDN cache entries. | |
9170 | DOC_END | |
9171 | ||
a58ff010 | 9172 | COMMENT_START |
5473c134 | 9173 | MISCELLANEOUS |
a58ff010 | 9174 | ----------------------------------------------------------------------------- |
9175 | COMMENT_END | |
9176 | ||
2eceb328 CT |
9177 | NAME: configuration_includes_quoted_values |
9178 | COMMENT: on|off | |
bde7a8ce CT |
9179 | TYPE: configuration_includes_quoted_values |
9180 | DEFAULT: off | |
2eceb328 CT |
9181 | LOC: ConfigParser::RecognizeQuotedValues |
9182 | DOC_START | |
9183 | If set, Squid will recognize each "quoted string" after a configuration | |
9184 | directive as a single parameter. The quotes are stripped before the | |
9185 | parameter value is interpreted or used. | |
9186 | See "Values with spaces, quotes, and other special characters" | |
9187 | section for more details. | |
9188 | DOC_END | |
9189 | ||
5473c134 | 9190 | NAME: memory_pools |
a58ff010 | 9191 | COMMENT: on|off |
5473c134 | 9192 | TYPE: onoff |
9193 | DEFAULT: on | |
9194 | LOC: Config.onoff.mem_pools | |
a58ff010 | 9195 | DOC_START |
5473c134 | 9196 | If set, Squid will keep pools of allocated (but unused) memory |
9197 | available for future use. If memory is a premium on your | |
9198 | system and you believe your malloc library outperforms Squid | |
9199 | routines, disable this. | |
a58ff010 | 9200 | DOC_END |
9201 | ||
5473c134 | 9202 | NAME: memory_pools_limit |
9203 | COMMENT: (bytes) | |
70be1349 | 9204 | TYPE: b_int64_t |
5473c134 | 9205 | DEFAULT: 5 MB |
9206 | LOC: Config.MemPools.limit | |
ec1245f8 | 9207 | DOC_START |
5473c134 | 9208 | Used only with memory_pools on: |
9209 | memory_pools_limit 50 MB | |
ec1245f8 | 9210 | |
5473c134 | 9211 | If set to a non-zero value, Squid will keep at most the specified |
9212 | limit of allocated (but unused) memory in memory pools. All free() | |
9213 | requests that exceed this limit will be handled by your malloc | |
9214 | library. Squid does not pre-allocate any memory, just safe-keeps | |
9215 | objects that otherwise would be free()d. Thus, it is safe to set | |
9216 | memory_pools_limit to a reasonably high value even if your | |
9217 | configuration will use less memory. | |
ec1245f8 | 9218 | |
89646bd7 | 9219 | If set to none, Squid will keep all memory it can. That is, there |
5473c134 | 9220 | will be no limit on the total amount of memory used for safe-keeping. |
ec1245f8 | 9221 | |
5473c134 | 9222 | To disable memory allocation optimization, do not set |
70be1349 | 9223 | memory_pools_limit to 0 or none. Set memory_pools to "off" instead. |
5473c134 | 9224 | |
9225 | An overhead for maintaining memory pools is not taken into account | |
9226 | when the limit is checked. This overhead is close to four bytes per | |
9227 | object kept. However, pools may actually _save_ memory because of | |
9228 | reduced memory thrashing in your malloc library. | |
ec1245f8 | 9229 | DOC_END |
9230 | ||
5473c134 | 9231 | NAME: forwarded_for |
67c06f0d AJ |
9232 | COMMENT: on|off|transparent|truncate|delete |
9233 | TYPE: string | |
5473c134 | 9234 | DEFAULT: on |
9235 | LOC: opt_forwarded_for | |
5f8252d2 | 9236 | DOC_START |
67c06f0d AJ |
9237 | If set to "on", Squid will append your client's IP address |
9238 | in the HTTP requests it forwards. By default it looks like: | |
5f8252d2 | 9239 | |
5473c134 | 9240 | X-Forwarded-For: 192.1.2.3 |
9241 | ||
67c06f0d | 9242 | If set to "off", it will appear as |
5473c134 | 9243 | |
9244 | X-Forwarded-For: unknown | |
67c06f0d AJ |
9245 | |
9246 | If set to "transparent", Squid will not alter the | |
9247 | X-Forwarded-For header in any way. | |
9248 | ||
9249 | If set to "delete", Squid will delete the entire | |
9250 | X-Forwarded-For header. | |
9251 | ||
9252 | If set to "truncate", Squid will remove all existing | |
dd68402f | 9253 | X-Forwarded-For entries, and place the client IP as the sole entry. |
5f8252d2 | 9254 | DOC_END |
9255 | ||
5473c134 | 9256 | NAME: cachemgr_passwd |
9257 | TYPE: cachemgrpasswd | |
9258 | DEFAULT: none | |
638402dd | 9259 | DEFAULT_DOC: No password. Actions which require password are denied. |
5473c134 | 9260 | LOC: Config.passwd_list |
5f8252d2 | 9261 | DOC_START |
5473c134 | 9262 | Specify passwords for cachemgr operations. |
5f8252d2 | 9263 | |
5473c134 | 9264 | Usage: cachemgr_passwd password action action ... |
9265 | ||
9266 | Some valid actions are (see cache manager menu for a full list): | |
9267 | 5min | |
9268 | 60min | |
9269 | asndb | |
9270 | authenticator | |
9271 | cbdata | |
9272 | client_list | |
9273 | comm_incoming | |
9274 | config * | |
9275 | counters | |
9276 | delay | |
9277 | digest_stats | |
9278 | dns | |
9279 | events | |
9280 | filedescriptors | |
9281 | fqdncache | |
9282 | histograms | |
9283 | http_headers | |
9284 | info | |
9285 | io | |
9286 | ipcache | |
9287 | mem | |
9288 | menu | |
9289 | netdb | |
9290 | non_peers | |
9291 | objects | |
9292 | offline_toggle * | |
9293 | pconn | |
9294 | peer_select | |
b360c477 | 9295 | reconfigure * |
5473c134 | 9296 | redirector |
9297 | refresh | |
9298 | server_list | |
9299 | shutdown * | |
9300 | store_digest | |
9301 | storedir | |
9302 | utilization | |
9303 | via_headers | |
9304 | vm_objects | |
9305 | ||
9306 | * Indicates actions which will not be performed without a | |
9307 | valid password, others can be performed if not listed here. | |
9308 | ||
9309 | To disable an action, set the password to "disable". | |
9310 | To allow performing an action without a password, set the | |
9311 | password to "none". | |
9312 | ||
9313 | Use the keyword "all" to set the same password for all actions. | |
9314 | ||
9315 | Example: | |
9316 | cachemgr_passwd secret shutdown | |
9317 | cachemgr_passwd lesssssssecret info stats/objects | |
9318 | cachemgr_passwd disable all | |
5f8252d2 | 9319 | DOC_END |
9320 | ||
5473c134 | 9321 | NAME: client_db |
a58ff010 | 9322 | COMMENT: on|off |
5473c134 | 9323 | TYPE: onoff |
9324 | DEFAULT: on | |
9325 | LOC: Config.onoff.client_db | |
a58ff010 | 9326 | DOC_START |
5473c134 | 9327 | If you want to disable collecting per-client statistics, |
9328 | turn off client_db here. | |
a58ff010 | 9329 | DOC_END |
9330 | ||
5473c134 | 9331 | NAME: refresh_all_ims |
9332 | COMMENT: on|off | |
9333 | TYPE: onoff | |
9334 | DEFAULT: off | |
9335 | LOC: Config.onoff.refresh_all_ims | |
a58ff010 | 9336 | DOC_START |
5473c134 | 9337 | When you enable this option, squid will always check |
9338 | the origin server for an update when a client sends an | |
9339 | If-Modified-Since request. Many browsers use IMS | |
9340 | requests when the user requests a reload, and this | |
9341 | ensures those clients receive the latest version. | |
a58ff010 | 9342 | |
5473c134 | 9343 | By default (off), squid may return a Not Modified response |
9344 | based on the age of the cached version. | |
78e8cfc4 | 9345 | DOC_END |
9346 | ||
5473c134 | 9347 | NAME: reload_into_ims |
626096be | 9348 | IFDEF: USE_HTTP_VIOLATIONS |
12b91c99 | 9349 | COMMENT: on|off |
5473c134 | 9350 | TYPE: onoff |
9351 | DEFAULT: off | |
9352 | LOC: Config.onoff.reload_into_ims | |
12b91c99 | 9353 | DOC_START |
5473c134 | 9354 | When you enable this option, client no-cache or ``reload'' |
9355 | requests will be changed to If-Modified-Since requests. | |
9356 | Doing this VIOLATES the HTTP standard. Enabling this | |
9357 | feature could make you liable for problems which it | |
9358 | causes. | |
9359 | ||
9360 | see also refresh_pattern for a more selective approach. | |
12b91c99 | 9361 | DOC_END |
9362 | ||
31ef19cd | 9363 | NAME: connect_retries |
5473c134 | 9364 | TYPE: int |
31ef19cd AJ |
9365 | LOC: Config.connect_retries |
9366 | DEFAULT: 0 | |
638402dd | 9367 | DEFAULT_DOC: Do not retry failed connections. |
a58ff010 | 9368 | DOC_START |
aed188fd AJ |
9369 | This sets the maximum number of connection attempts made for each |
9370 | TCP connection. The connect_retries attempts must all still | |
9371 | complete within the connection timeout period. | |
31ef19cd AJ |
9372 | |
9373 | The default is not to re-try if the first connection attempt fails. | |
9374 | The (not recommended) maximum is 10 tries. | |
5473c134 | 9375 | |
31ef19cd AJ |
9376 | A warning message will be generated if it is set to a too-high |
9377 | value and the configured value will be over-ridden. | |
5473c134 | 9378 | |
31ef19cd AJ |
9379 | Note: These re-tries are in addition to forward_max_tries |
9380 | which limit how many different addresses may be tried to find | |
9381 | a useful server. | |
a58ff010 | 9382 | DOC_END |
9383 | ||
5473c134 | 9384 | NAME: retry_on_error |
a58ff010 | 9385 | TYPE: onoff |
5473c134 | 9386 | LOC: Config.retry.onerror |
a58ff010 | 9387 | DEFAULT: off |
9388 | DOC_START | |
aea8548b AJ |
9389 | If set to ON Squid will automatically retry requests when |
9390 | receiving an error response with status 403 (Forbidden), | |
9391 | 500 (Internal Error), 501 or 503 (Service not available). | |
9392 | Status 502 and 504 (Gateway errors) are always retried. | |
9393 | ||
9394 | This is mainly useful if you are in a complex cache hierarchy to | |
9395 | work around access control errors. | |
9396 | ||
9397 | NOTE: This retry will attempt to find another working destination. | |
9398 | Which is different from the server which just failed. | |
5f8252d2 | 9399 | DOC_END |
9400 | ||
5473c134 | 9401 | NAME: as_whois_server |
5f8252d2 | 9402 | TYPE: string |
5473c134 | 9403 | LOC: Config.as_whois_server |
9404 | DEFAULT: whois.ra.net | |
5f8252d2 | 9405 | DOC_START |
5473c134 | 9406 | WHOIS server to query for AS numbers. NOTE: AS numbers are |
9407 | queried only when Squid starts up, not for every request. | |
5f8252d2 | 9408 | DOC_END |
9409 | ||
5473c134 | 9410 | NAME: offline_mode |
5f8252d2 | 9411 | TYPE: onoff |
5473c134 | 9412 | LOC: Config.onoff.offline |
5f8252d2 | 9413 | DEFAULT: off |
9414 | DOC_START | |
5473c134 | 9415 | Enable this option and Squid will never try to validate cached |
9416 | objects. | |
a58ff010 | 9417 | DOC_END |
9418 | ||
5473c134 | 9419 | NAME: uri_whitespace |
9420 | TYPE: uri_whitespace | |
9421 | LOC: Config.uri_whitespace | |
9422 | DEFAULT: strip | |
a58ff010 | 9423 | DOC_START |
5473c134 | 9424 | What to do with requests that have whitespace characters in the |
9425 | URI. Options: | |
a58ff010 | 9426 | |
5473c134 | 9427 | strip: The whitespace characters are stripped out of the URL. |
82806837 AJ |
9428 | This is the behavior recommended by RFC2396 and RFC3986 |
9429 | for tolerant handling of generic URI. | |
9430 | NOTE: This is one difference between generic URI and HTTP URLs. | |
9431 | ||
5473c134 | 9432 | deny: The request is denied. The user receives an "Invalid |
9433 | Request" message. | |
82806837 AJ |
9434 | This is the behaviour recommended by RFC2616 for safe |
9435 | handling of HTTP request URL. | |
9436 | ||
5473c134 | 9437 | allow: The request is allowed and the URI is not changed. The |
9438 | whitespace characters remain in the URI. Note the | |
9439 | whitespace is passed to redirector processes if they | |
9440 | are in use. | |
82806837 AJ |
9441 | Note this may be considered a violation of RFC2616 |
9442 | request parsing where whitespace is prohibited in the | |
9443 | URL field. | |
9444 | ||
5473c134 | 9445 | encode: The request is allowed and the whitespace characters are |
82806837 AJ |
9446 | encoded according to RFC1738. |
9447 | ||
5473c134 | 9448 | chop: The request is allowed and the URI is chopped at the |
82806837 AJ |
9449 | first whitespace. |
9450 | ||
9451 | ||
9452 | NOTE the current Squid implementation of encode and chop violates | |
9453 | RFC2616 by not using a 301 redirect after altering the URL. | |
5473c134 | 9454 | DOC_END |
a58ff010 | 9455 | |
5473c134 | 9456 | NAME: chroot |
9457 | TYPE: string | |
9458 | LOC: Config.chroot_dir | |
a58ff010 | 9459 | DEFAULT: none |
9460 | DOC_START | |
9f37c18a | 9461 | Specifies a directory where Squid should do a chroot() while |
2d89f399 HN |
9462 | initializing. This also causes Squid to fully drop root |
9463 | privileges after initializing. This means, for example, if you | |
9464 | use a HTTP port less than 1024 and try to reconfigure, you may | |
9465 | get an error saying that Squid can not open the port. | |
5473c134 | 9466 | DOC_END |
a58ff010 | 9467 | |
5473c134 | 9468 | NAME: balance_on_multiple_ip |
9469 | TYPE: onoff | |
9470 | LOC: Config.onoff.balance_on_multiple_ip | |
cc192b50 | 9471 | DEFAULT: off |
5473c134 | 9472 | DOC_START |
cc192b50 | 9473 | Modern IP resolvers in squid sort lookup results by preferred access. |
9474 | By default squid will use these IP in order and only rotates to | |
9475 | the next listed when the most preffered fails. | |
9476 | ||
5473c134 | 9477 | Some load balancing servers based on round robin DNS have been |
9478 | found not to preserve user session state across requests | |
9479 | to different IP addresses. | |
a58ff010 | 9480 | |
cc192b50 | 9481 | Enabling this directive Squid rotates IP's per request. |
a58ff010 | 9482 | DOC_END |
9483 | ||
5473c134 | 9484 | NAME: pipeline_prefetch |
079a8480 AJ |
9485 | TYPE: pipelinePrefetch |
9486 | LOC: Config.pipeline_max_prefetch | |
9487 | DEFAULT: 0 | |
9488 | DEFAULT_DOC: Do not pre-parse pipelined requests. | |
a58ff010 | 9489 | DOC_START |
079a8480 AJ |
9490 | HTTP clients may send a pipeline of 1+N requests to Squid using a |
9491 | single connection, without waiting for Squid to respond to the first | |
9492 | of those requests. This option limits the number of concurrent | |
9493 | requests Squid will try to handle in parallel. If set to N, Squid | |
9494 | will try to receive and process up to 1+N requests on the same | |
9495 | connection concurrently. | |
a58ff010 | 9496 | |
079a8480 | 9497 | Defaults to 0 (off) for bandwidth management and access logging |
5473c134 | 9498 | reasons. |
a0e23afd | 9499 | |
079a8480 AJ |
9500 | NOTE: pipelining requires persistent connections to clients. |
9501 | ||
a0e23afd | 9502 | WARNING: pipelining breaks NTLM and Negotiate/Kerberos authentication. |
5473c134 | 9503 | DOC_END |
a58ff010 | 9504 | |
5473c134 | 9505 | NAME: high_response_time_warning |
9506 | TYPE: int | |
9507 | COMMENT: (msec) | |
9508 | LOC: Config.warnings.high_rptm | |
9509 | DEFAULT: 0 | |
638402dd | 9510 | DEFAULT_DOC: disabled. |
5473c134 | 9511 | DOC_START |
9512 | If the one-minute median response time exceeds this value, | |
9513 | Squid prints a WARNING with debug level 0 to get the | |
9514 | administrators attention. The value is in milliseconds. | |
a58ff010 | 9515 | DOC_END |
9516 | ||
5473c134 | 9517 | NAME: high_page_fault_warning |
9518 | TYPE: int | |
9519 | LOC: Config.warnings.high_pf | |
9520 | DEFAULT: 0 | |
638402dd | 9521 | DEFAULT_DOC: disabled. |
cc9f92d4 | 9522 | DOC_START |
5473c134 | 9523 | If the one-minute average page fault rate exceeds this |
9524 | value, Squid prints a WARNING with debug level 0 to get | |
9525 | the administrators attention. The value is in page faults | |
9526 | per second. | |
9527 | DOC_END | |
cc9f92d4 | 9528 | |
5473c134 | 9529 | NAME: high_memory_warning |
9530 | TYPE: b_size_t | |
9531 | LOC: Config.warnings.high_memory | |
f2228f3b | 9532 | IFDEF: HAVE_MSTATS&&HAVE_GNUMALLOC_H |
904971da | 9533 | DEFAULT: 0 KB |
638402dd | 9534 | DEFAULT_DOC: disabled. |
5473c134 | 9535 | DOC_START |
4bf2a476 FC |
9536 | If the memory usage (as determined by gnumalloc, if available and used) |
9537 | exceeds this amount, Squid prints a WARNING with debug level 0 to get | |
5473c134 | 9538 | the administrators attention. |
9539 | DOC_END | |
4bf2a476 | 9540 | # TODO: link high_memory_warning to mempools? |
cc9f92d4 | 9541 | |
5473c134 | 9542 | NAME: sleep_after_fork |
9543 | COMMENT: (microseconds) | |
9544 | TYPE: int | |
9545 | LOC: Config.sleep_after_fork | |
9546 | DEFAULT: 0 | |
9547 | DOC_START | |
9548 | When this is set to a non-zero value, the main Squid process | |
9549 | sleeps the specified number of microseconds after a fork() | |
9550 | system call. This sleep may help the situation where your | |
9551 | system reports fork() failures due to lack of (virtual) | |
9552 | memory. Note, however, if you have a lot of child | |
9553 | processes, these sleep delays will add up and your | |
9554 | Squid will not service requests for some amount of time | |
9555 | until all the child processes have been started. | |
9556 | On Windows value less then 1000 (1 milliseconds) are | |
9557 | rounded to 1000. | |
cc9f92d4 | 9558 | DOC_END |
9559 | ||
b6696974 | 9560 | NAME: windows_ipaddrchangemonitor |
7aa9bb3e | 9561 | IFDEF: _SQUID_WINDOWS_ |
b6696974 GS |
9562 | COMMENT: on|off |
9563 | TYPE: onoff | |
9564 | DEFAULT: on | |
9565 | LOC: Config.onoff.WIN32_IpAddrChangeMonitor | |
9566 | DOC_START | |
9567 | On Windows Squid by default will monitor IP address changes and will | |
9568 | reconfigure itself after any detected event. This is very useful for | |
9569 | proxies connected to internet with dial-up interfaces. | |
9570 | In some cases (a Proxy server acting as VPN gateway is one) it could be | |
9571 | desiderable to disable this behaviour setting this to 'off'. | |
9572 | Note: after changing this, Squid service must be restarted. | |
9573 | DOC_END | |
9574 | ||
a98c2da5 AJ |
9575 | NAME: eui_lookup |
9576 | TYPE: onoff | |
9577 | IFDEF: USE_SQUID_EUI | |
9578 | DEFAULT: on | |
9579 | LOC: Eui::TheConfig.euiLookup | |
9580 | DOC_START | |
9581 | Whether to lookup the EUI or MAC address of a connected client. | |
9582 | DOC_END | |
9583 | ||
f3f0f563 AJ |
9584 | NAME: max_filedescriptors max_filedesc |
9585 | TYPE: int | |
9586 | DEFAULT: 0 | |
638402dd | 9587 | DEFAULT_DOC: Use operating system limits set by ulimit. |
f3f0f563 AJ |
9588 | LOC: Config.max_filedescriptors |
9589 | DOC_START | |
638402dd AJ |
9590 | Reduce the maximum number of filedescriptors supported below |
9591 | the usual operating system defaults. | |
f3f0f563 | 9592 | |
638402dd | 9593 | Remove from squid.conf to inherit the current ulimit setting. |
f3f0f563 AJ |
9594 | |
9595 | Note: Changing this requires a restart of Squid. Also | |
638402dd | 9596 | not all I/O types supports large values (eg on Windows). |
f3f0f563 AJ |
9597 | DOC_END |
9598 | ||
ec69bdb2 CT |
9599 | NAME: force_request_body_continuation |
9600 | TYPE: acl_access | |
9601 | LOC: Config.accessList.forceRequestBodyContinuation | |
9602 | DEFAULT: none | |
9603 | DEFAULT_DOC: Deny, unless rules exist in squid.conf. | |
9604 | DOC_START | |
9605 | This option controls how Squid handles data upload requests from HTTP | |
9606 | and FTP agents that require a "Please Continue" control message response | |
9607 | to actually send the request body to Squid. It is mostly useful in | |
9608 | adaptation environments. | |
9609 | ||
9610 | When Squid receives an HTTP request with an "Expect: 100-continue" | |
9611 | header or an FTP upload command (e.g., STOR), Squid normally sends the | |
9612 | request headers or FTP command information to an adaptation service (or | |
9613 | peer) and waits for a response. Most adaptation services (and some | |
9614 | broken peers) may not respond to Squid at that stage because they may | |
9615 | decide to wait for the HTTP request body or FTP data transfer. However, | |
9616 | that request body or data transfer may never come because Squid has not | |
9617 | responded with the HTTP 100 or FTP 150 (Please Continue) control message | |
9618 | to the request sender yet! | |
9619 | ||
9620 | An allow match tells Squid to respond with the HTTP 100 or FTP 150 | |
9621 | (Please Continue) control message on its own, before forwarding the | |
9622 | request to an adaptation service or peer. Such a response usually forces | |
9623 | the request sender to proceed with sending the body. A deny match tells | |
9624 | Squid to delay that control response until the origin server confirms | |
9625 | that the request body is needed. Delaying is the default behavior. | |
9626 | DOC_END | |
9627 | ||
cccac0a2 | 9628 | EOF |