Guest User

Squid 3.3.8

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