Guest User

Untitled

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