cf.data.pre
上传用户:liugui
上传日期:2007-01-04
资源大小:822k
文件大小:75k
源码类别:

代理服务器

开发平台:

Unix_Linux

  1. #
  2. # $Id: cf.data.pre,v 1.144.2.1 1999/02/09 23:10:31 wessels Exp $
  3. #
  4. #
  5. # SQUID Internet Object Cache  http://squid.nlanr.net/Squid/
  6. # ----------------------------------------------------------
  7. #
  8. #  Squid is the result of efforts by numerous individuals from the
  9. #  Internet community.  Development is led by Duane Wessels of the
  10. #  National Laboratory for Applied Network Research and funded by the
  11. #  National Science Foundation.  Squid is Copyrighted (C) 1998 by
  12. #  Duane Wessels and the University of California San Diego.  Please
  13. #  see the COPYRIGHT file for full details.  Squid incorporates
  14. #  software developed and/or copyrighted by other sources.  Please see
  15. #  the CREDITS file for full details.
  16. #
  17. #  This program is free software; you can redistribute it and/or modify
  18. #  it under the terms of the GNU General Public License as published by
  19. #  the Free Software Foundation; either version 2 of the License, or
  20. #  (at your option) any later version.
  21. #  
  22. #  This program is distributed in the hope that it will be useful,
  23. #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24. #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25. #  GNU General Public License for more details.
  26. #  
  27. #  You should have received a copy of the GNU General Public License
  28. #  along with this program; if not, write to the Free Software
  29. #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  30. #
  31. COMMENT_START
  32. WELCOME TO SQUID 2
  33. ------------------
  34. This is the default Squid configuration file. You may wish
  35. to look at http://cache.is.co.za/squid/ for documentation,
  36. or the Squid home page (http://squid.nlanr.net/) for the FAQ.
  37. The default Squid config file shows what the defaults for
  38. various options happen to be.  If you don't need to change the
  39. default, you shouldn't uncomment the line.  Doing so may cause
  40. run-time problems.  In some cases "none" refers to no default
  41. setting at all, whilst in other cases it refers to a valid
  42. option - the comments for that keyword indicate if this is the
  43. case.
  44. COMMENT_END
  45. COMMENT_START
  46.  NETWORK OPTIONS
  47.  -----------------------------------------------------------------------------
  48. COMMENT_END
  49. NAME: http_port ascii_port
  50. TYPE: ushortlist
  51. DEFAULT: none
  52. DEFAULT_IF_NONE: 3128
  53. LOC: Config.Port.http
  54. DOC_START
  55. The port number where Squid will listen for HTTP client
  56. requests.  Default is 3128, for httpd-accel mode use port 80.
  57. May be overridden with -a on the command line.
  58. You may specify multiple ports here, but they MUST all be on
  59. a single line.
  60. http_port 3128
  61. DOC_END
  62. NAME: icp_port udp_port
  63. TYPE: ushort
  64. DEFAULT: 3130
  65. LOC: Config.Port.icp
  66. DOC_START
  67. The port number where Squid sends and receives ICP requests to
  68. and from neighbor caches.  Default is 3130.  To disable use
  69. "0".  May be overridden with -u on the command line.
  70. icp_port 3130
  71. DOC_END
  72. NAME: htcp_port
  73. IFDEF: USE_HTCP
  74. TYPE: ushort
  75. DEFAULT: 4827
  76. LOC: Config.Port.htcp
  77. DOC_START
  78. The port number where Squid sends and receives ICP requests to
  79. and from neighbor caches.  Default is 4827.  To disable use
  80. "0".
  81. htcp_port 4827
  82. DOC_END
  83. NAME: mcast_groups
  84. TYPE: wordlist
  85. LOC: Config.mcast_group_list
  86. DEFAULT: none
  87. DOC_START
  88. This tag specifies a list of multicast groups which your server
  89. should join to receive multicasted ICP requests.
  90. NOTE!  Be very careful what you put here!  Be sure you
  91. understand the difference between an ICP _query_ and an ICP
  92. _reply_.  This option is to be set only if you want to RECEIVE
  93. multicast queries.  Do NOT set this option to SEND multicast
  94. ICP (use cache_peer for that).  ICP replies are always sent via
  95. unicast, so this option does not affect whether or not you will
  96. receive replies from multicast group members.
  97. You must be very careful to NOT use a multicast address which
  98. is already in use by another group of caches.  NLANR has been
  99. assigned a block of multicast address space for use in Web
  100. Caching.  Plese write to us at nlanr-cache@nlanr.net to receive
  101. an address for your own use.
  102. If you are unsure about multicast, please read the Multicast
  103. chapter in the Squid FAQ (http://squid.nlanr.net/Squid/FAQ/).
  104. Usage: mcast_groups 239.128.16.128 224.0.1.20
  105. By default, Squid doesn't listen on any multicast groups.
  106. mcast_groups 239.128.16.128
  107. DOC_END
  108. NAME: tcp_incoming_address bind_address
  109. TYPE: address
  110. LOC: Config.Addrs.tcp_incoming
  111. DEFAULT: 0.0.0.0
  112. DOC_NONE
  113. NAME: tcp_outgoing_address outbound_address
  114. TYPE: address
  115. LOC: Config.Addrs.tcp_outgoing
  116. DEFAULT: 255.255.255.255
  117. DOC_NONE
  118. NAME: udp_incoming_address
  119. TYPE: address
  120. LOC:Config.Addrs.udp_incoming
  121. DEFAULT: 0.0.0.0
  122. DOC_NONE
  123. NAME: udp_outgoing_address
  124. TYPE: address
  125. LOC: Config.Addrs.udp_outgoing
  126. DEFAULT: 255.255.255.255
  127. DOC_START
  128. Usage: tcp_incoming_address 10.20.30.40
  129.        udp_outgoing_address fully.qualified.domain.name
  130. tcp_incoming_address is used for the HTTP socket which accepts
  131. connections from clients and other caches.
  132. tcp_outgoing_address is used for connections made to remote
  133. servers and other caches.
  134. udp_incoming_address is used for the ICP socket receiving packets
  135. from other caches.
  136. udp_outgoing_address is used for ICP packets sent out to other
  137. caches.
  138. The default behaviour is to not bind to any specific address.
  139. NOTE, udp_incoming_address and udp_outgoing_address can not
  140. have the same value (unless it is 0.0.0.0) since they both use
  141. port 3130.
  142. tcp_incoming_address 0.0.0.0
  143. tcp_outgoing_address 0.0.0.0
  144. udp_incoming_address 0.0.0.0
  145. udp_outgoing_address 0.0.0.0
  146. DOC_END
  147. COMMENT_START
  148.  OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM
  149.  -----------------------------------------------------------------------------
  150. COMMENT_END
  151. NAME: cache_peer
  152. TYPE: peer
  153. DEFAULT: none
  154. LOC: Config.peers
  155. DOC_START
  156. To specify other caches in a hierarchy, use the format:
  157. hostname type http_port icp_port
  158. For example,
  159. #                                        proxy  icp
  160. #          hostname             type     port   port  options
  161. #          -------------------- -------- ----- -----  -----------
  162. cache_peer parent.foo.net       parent    3128  3130  [proxy-only]
  163. cache_peer sib1.foo.net         sibling   3128  3130  [proxy-only]
  164. cache_peer sib2.foo.net         sibling   3128  3130  [proxy-only]
  165.       type:  either 'parent', 'sibling', or 'multicast'.
  166. proxy_port:  The port number where the cache listens for proxy
  167.      requests.
  168.   icp_port:  Used for querying neighbor caches about
  169.      objects.  To have a non-ICP neighbor
  170.      specify '7' for the ICP port and make sure the
  171.      neighbor machine has the UDP echo port
  172.      enabled in its /etc/inetd.conf file.
  173.     options: proxy-only
  174.      weight=n
  175.      ttl=n
  176.      no-query
  177.      default
  178.      round-robin
  179.      multicast-responder
  180.      closest-only
  181.      no-digest
  182.      no-netdb-exchange
  183.      no-delay
  184.      login=user:password
  185.      use 'proxy-only' to specify that objects fetched
  186.      from this cache should not be saved locally.
  187.      use 'weight=n' to specify a weighted parent.
  188.      The weight must be an integer.  The default weight
  189.      is 1, larger weights are favored more.
  190.      use 'ttl=n' to specify a IP multicast TTL to use
  191.      when sending an ICP request to this address.
  192.      Only useful when sending to a multicast group.
  193.      Because we don't accept ICP replies from random
  194.      hosts, you must configure other group members as
  195.      peers with the 'multicast-responder' option below.
  196.      use 'no-query' to NOT send ICP queries to this
  197.      neighbor.
  198.      use 'default' if this is a parent cache which can
  199.      be used as a "last-resort." You should probably
  200.      only use 'default' in situations where you cannot
  201.      use ICP with your parent cache(s).
  202.      use 'round-robin' to define a set of parents which
  203.      should be used in a round-robin fashion in the
  204.      absence of any ICP queries.
  205.      'multicast-responder' indicates that the named peer
  206.      is a member of a multicast group.  ICP queries will
  207.      not be sent directly to the peer, but ICP replies
  208.      will be accepted from it.
  209.      'closest-only' indicates that, for ICP_OP_MISS
  210.      replies, we'll only forward CLOSEST_PARENT_MISSes
  211.      and never FIRST_PARENT_MISSes.
  212.      use 'no-digest' to NOT request cache digests from
  213.      this neighbor.
  214.      'no-netdb-exchange' disables requesting ICMP
  215.      RTT database (NetDB) from the neighbor.
  216.      use 'no-delay' to prevent access to this neighbor
  217.      from influencing the delay pools.
  218.      use 'login=user:password' if this is a personal/workgroup
  219.      proxy and your parent requires proxy authentication.
  220. NOTE: non-ICP neighbors must be specified as 'parent'.
  221. cache_peer hostname type 3128 3130
  222. DOC_END
  223. NAME: cache_peer_domain cache_host_domain
  224. TYPE: hostdomain
  225. DEFAULT: none
  226. LOC: none
  227. DOC_START
  228. Use to limit the domains for which a neighbor cache will be
  229. queried.  Usage:
  230. cache_peer_domain cache-host domain [domain ...]
  231. cache_peer_domain cache-host !domain
  232. For example, specifying
  233. cache_peer_domain parent.foo.net .edu
  234. has the effect such that UDP query packets are sent to
  235. 'bigserver' only when the requested object exists on a
  236. server in the .edu domain.  Prefixing the domainname
  237. with '!' means that the cache will be queried for objects
  238. NOT in that domain.
  239. NOTE: * Any number of domains may be given for a cache-host,
  240.   either on the same or separate lines.
  241. * When multiple domains are given for a particular
  242.   cache-host, the first matched domain is applied.
  243. * Cache hosts with no domain restrictions are queried
  244.   for all requests.
  245. * There are no defaults.
  246. * There is also a 'cache_peer_access' tag in the ACL
  247.   section.
  248. DOC_END
  249. NAME: neighbor_type_domain
  250. TYPE: hostdomaintype
  251. DEFAULT: none
  252. LOC: none
  253. DOC_START
  254. usage: neighbor_type_domain parent|sibling domain domain ...
  255. Modifying the neighbor type for specific domains is now
  256. possible.  You can treat some domains differently than the the
  257. default neighbor type specified on the 'cache_peer' line.
  258. Normally it should only be necessary to list domains which
  259. should be treated differently because the default neighbor type
  260. applies for hostnames which do not match domains listed here.
  261. EXAMPLE:
  262. cache_peer  parent cache.foo.org 3128 3130
  263. neighbor_type_domain cache.foo.org sibling .com .net
  264. neighbor_type_domain cache.foo.org sibling .au .de
  265. DOC_END
  266. NAME: icp_query_timeout
  267. COMMENT: (msec)
  268. DEFAULT: 0
  269. TYPE: int
  270. LOC: Config.Timeout.icp_query
  271. DOC_START
  272. Normally Squid will automatically determine an optimal ICP
  273. query timeout value based on the round-trip-time of recent ICP
  274. queries.  If you want to override the value determined by
  275. Squid, set this 'icp_query_timeout' to a non-zero value.  This
  276. value is specified in MILLISECONDS, so, to use a 2-second
  277. timeout (the old default), you would write:
  278. icp_query_timeout 2000
  279. icp_query_timeout 0
  280. DOC_END
  281. NAME: mcast_icp_query_timeout
  282. COMMENT: (msec)
  283. DEFAULT: 2000
  284. TYPE: int
  285. LOC: Config.Timeout.mcast_icp_query
  286. DOC_START
  287. For Multicast peers, Squid regularly sends out ICP "probes" to
  288. count how many other peers are listening on the given multicast
  289. address.  This value specifies how long Squid should wait to
  290. count all the replies.  The default is 2000 msec, or 2
  291. seconds.
  292. mcast_icp_query_timeout 2000
  293. DOC_END
  294. NAME: dead_peer_timeout
  295. COMMENT: (seconds)
  296. DEFAULT: 10 seconds
  297. TYPE: time_t
  298. LOC: Config.Timeout.deadPeer
  299. DOC_START
  300. This controls how long Squid waits to declare a peer cache
  301. as "dead."  If there are no ICP replies received in this
  302. amount of time, Squid will declare the peer dead and not
  303. expect to receive any further ICP replies.  However, it
  304. continues to send ICP queries, and will mark the peer as
  305. alive upon receipt of the first subsequent ICP reply.
  306. This timeout also affects when Squid expects to receive ICP
  307. replies from peers.  If more than 'dead_peer' seconds have
  308. passed since the last ICP reply was received, Squid will not
  309. expect to receive an ICP reply on the next query.  Thus, if
  310. your time between requests is greater than this timeout, you
  311. will see a lot of requests sent DIRECT to origin servers
  312. instead of to your parents.
  313. dead_peer_timeout 10 seconds
  314. DOC_END
  315. NAME: hierarchy_stoplist
  316. TYPE: wordlist
  317. DEFAULT: none
  318. DEFAULT_IF_NONE: cgi-bin ?
  319. LOC: Config.hierarchy_stoplist
  320. DOC_START
  321. A list of words which, if found in a URL, cause the object to
  322. be handled directly by this cache.  In other words, use this
  323. to not query neighbor caches for certain objects.  You may
  324. list this option multiple times.
  325. The default is to directly fetch URLs containing 'cgi-bin' or '?'.
  326. hierarchy_stoplist cgi-bin ?
  327. DOC_END
  328. NAME: no_cache
  329. TYPE: acl_access
  330. DEFAULT: none
  331. LOC: Config.accessList.noCache
  332. DOC_START
  333. A list of ACL elements which, if matched, cause the reply to
  334. immediately removed from the cache.  In other words, use this
  335. to force certain objects to never be cached.
  336. You must use the word 'DENY' to indicate the ACL names which should
  337. NOT be cached.
  338. There is no default.  We recommend you uncomment the following
  339. two lines.
  340. acl QUERY urlpath_regex cgi-bin ?
  341. no_cache deny QUERY
  342. DOC_END
  343. COMMENT_START
  344.  OPTIONS WHICH AFFECT THE CACHE SIZE
  345.  -----------------------------------------------------------------------------
  346. COMMENT_END
  347. NAME: cache_mem
  348. COMMENT: (bytes)
  349. TYPE: b_size_t
  350. DEFAULT: 8 MB
  351. LOC: Config.memMaxSize
  352. DOC_START
  353. NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS
  354. SIZE.  IT PLACES A LIMIT ON ONE ASPECT OF SQUID'S MEMORY
  355. USAGE.  SQUID USES MEMORY FOR OTHER THINGS AS WELL.
  356. YOUR PROCESS WILL PROBABLY BECOME TWICE OR THREE TIMES
  357. BIGGER THAN THE VALUE YOU PUT HERE 
  358. 'cache_mem' specifies the ideal amount of memory to be used
  359. for:
  360. * In-Transit objects
  361. * Hot Objects
  362. * Negative-Cached objects
  363. Data for these objects are stored in 4 KB blocks.  This
  364. parameter specifies the ideal upper limit on the total size of
  365. 4 KB blocks allocated.  In-Transit objects take the highest
  366. priority.
  367. In-transit objects have priority over the others.  When
  368. additional space is needed for incoming data, negative-cached
  369. and hot objects will be released.  In other words, the
  370. negative-cached and hot objects will fill up any unused space
  371. not needed for in-transit objects.
  372. If circumstances require, this limit will be exceeded.
  373. Specifically, if your incoming request rate requires more than
  374. 'cache_mem' of memory to hold in-transit objects, Squid will
  375. exceed this limit to satisfy the new requests.  When the load
  376. decreases, blocks will be freed until the high-water mark is
  377. reached.  Thereafter, blocks will be used to store hot
  378. objects.
  379. The values of cache_mem_low and cache_mem_high (below) can be
  380. used to tune the use of the memory pool.  When the high mark is
  381. reached, in-transit and hot objects will be released to clear
  382. space.  When an object transfer is completed, it will remain in
  383. memory only if the current memory usage is below the low water
  384. mark.
  385. The default is 8 Megabytes.
  386. cache_mem  8 MB
  387. DOC_END
  388. NAME: cache_swap_low
  389. COMMENT: (percent, 0-100)
  390. TYPE: int
  391. DEFAULT: 90
  392. LOC: Config.Swap.lowWaterMark
  393. DOC_NONE
  394. NAME: cache_swap_high
  395. COMMENT: (percent, 0-100)
  396. TYPE: int
  397. DEFAULT: 95
  398. LOC: Config.Swap.highWaterMark
  399. DOC_START
  400. The low- and high-water marks for cache LRU replacement.  LRU
  401. replacement begins when the high-water mark is reached and ends
  402. when enough objects have been removed and the low-water mark is
  403. reached. Defaults are 90% and 95%. If you have a large cache, 5%
  404. could be hundreds of MB. If this is the case you may wish to
  405. set these numbers closer together.
  406. cache_swap_low  90
  407. cache_swap_high 95
  408. DOC_END
  409. NAME: maximum_object_size
  410. COMMENT: (bytes)
  411. TYPE: b_size_t
  412. DEFAULT: 4096 KB
  413. LOC: Config.Store.maxObjectSize
  414. DOC_START
  415. Objects larger than this size will NOT be saved on disk.  The
  416. value is specified in kilobytes, and the default is 4MB.  If
  417. you wish to get a high BYTES hit ratio, you should probably
  418. increase this (one 32 MB object hit counts for 3200 10KB
  419. hits).  If you wish to increase speed more than your want to
  420. save bandwidth you should leave this low.
  421. maximum_object_size 4096 KB
  422. DOC_END
  423. NAME: ipcache_size
  424. COMMENT: (number of entries)
  425. TYPE: int
  426. DEFAULT: 1024
  427. LOC: Config.ipcache.size
  428. DOC_NONE
  429. NAME: ipcache_low
  430. COMMENT: (percent)
  431. TYPE: int
  432. DEFAULT: 90
  433. LOC: Config.ipcache.low
  434. DOC_NONE
  435. NAME: ipcache_high
  436. COMMENT: (percent)
  437. TYPE: int
  438. DEFAULT: 95
  439. LOC: Config.ipcache.high
  440. DOC_START
  441. The size, low-, and high-water marks for the IP cache.
  442. ipcache_size 1024
  443. ipcache_low  90
  444. ipcache_high 95
  445. DOC_END
  446. NAME: fqdncache_size
  447. COMMENT: (number of entries)
  448. TYPE: int
  449. DEFAULT: 1024
  450. LOC: Config.fqdncache.size
  451. DOC_START
  452. Maximum number of FQDN cache entries.
  453. fqdncache_size 1024
  454. DOC_END
  455. COMMENT_START
  456.  LOGFILE PATHNAMES AND CACHE DIRECTORIES
  457.  -----------------------------------------------------------------------------
  458. COMMENT_END
  459. NAME: cache_dir
  460. TYPE: cachedir
  461. DEFAULT: none
  462. DEFAULT_IF_NONE: @DEFAULT_SWAP_DIR@ 100 16 256
  463. LOC: Config.cacheSwap
  464. DOC_START
  465. Usage:
  466. cache_dir Directory-Name Mbytes Level-1 Level2
  467. You can specify multiple cache_dir lines to spread the
  468. cache among different disk partitions.
  469. 'Directory' is a top-level directory where cache swap
  470. files will be stored.  If you want to use an entire disk
  471. for caching, then this can be the mount-point directory.
  472. The directory must exist and be writable by the Squid
  473. process.  Squid will NOT create this directory for you.
  474. If no 'cache_dir' lines are specified, the following
  475. default will be used: @DEFAULT_SWAP_DIR@.
  476. 'Mbytes' is the amount of disk space (MB) to use under this
  477. directory.  The default is 100 MB.  Change this to suit your
  478. configuration.
  479. 'Level-1' is the number of first-level subdirectories which
  480. will be created under the 'Directory'.  The default is 16.
  481. 'Level-2' is the number of second-level subdirectories which
  482. will be created under each first-level directory.  The default
  483. is 256.
  484. cache_dir @DEFAULT_SWAP_DIR@ 100 16 256
  485. DOC_END
  486. NAME: cache_access_log
  487. TYPE: string
  488. DEFAULT: @DEFAULT_ACCESS_LOG@
  489. LOC: Config.Log.access
  490. DOC_START
  491. Logs the client request activity.  Contains an entry for
  492. every HTTP and ICP request received.
  493. cache_access_log @DEFAULT_ACCESS_LOG@
  494. DOC_END
  495. NAME: cache_log
  496. TYPE: string
  497. DEFAULT: @DEFAULT_CACHE_LOG@
  498. LOC: Config.Log.log
  499. DOC_START
  500. Cache logging file. This is where general information about
  501. your cache's behaviour goes. You can increase the amount of data
  502. logged to this file with the "debug_options" tag below.
  503. cache_log @DEFAULT_CACHE_LOG@
  504. DOC_END
  505. NAME: cache_store_log
  506. TYPE: string
  507. DEFAULT: @DEFAULT_STORE_LOG@
  508. LOC: Config.Log.store
  509. DOC_START
  510. Logs the activities of the storage manager.  Shows which
  511. objects are ejected from the cache, and which objects are
  512. saved and for how long.  To disable, enter "none". There are
  513. not really utilities to analyse this data, so you can safely
  514. disable it.
  515. cache_store_log @DEFAULT_STORE_LOG@
  516. DOC_END
  517. NAME: cache_swap_log
  518. TYPE: string
  519. LOC: Config.Log.swap
  520. DEFAULT: none
  521. DOC_START
  522. Location for the cache "swap.log."  This log file holds the
  523. metadata of objects saved on disk.  It is used to rebuild the
  524. cache during startup.  Normally this file resides in the first
  525. 'cache_dir' directory, but you may specify an alternate
  526. pathname here.  Note you must give a full filename, not just
  527. a directory. Since this is the index for the whole object
  528. list you CANNOT periodically rotate it!
  529. If you have more than one 'cache_dir', these swap logs will
  530. have names such as:
  531. cache_swap_log.00
  532. cache_swap_log.01
  533. cache_swap_log.02
  534. The numbered extension (which is added automatically)
  535. corresponds to the order of the 'cache_dir' lines in this
  536. configuration file.  If you change the order of the 'cache_dir'
  537. lines in this file, then these log files will NOT correspond to
  538. the correct 'cache_dir' entry (unless you manually rename
  539. them).  We recommend that you do NOT use this option.  It is
  540. better to keep these log files in each 'cache_dir' directory.
  541. cache_swap_log
  542. DOC_END
  543. NAME: emulate_httpd_log
  544. COMMENT: on|off
  545. TYPE: onoff
  546. DEFAULT: off
  547. LOC: Config.onoff.common_log
  548. DOC_START
  549. The Cache can emulate the log file format which many 'httpd'
  550. programs use.  To disable/enable this emulation, set
  551. emulate_httpd_log to 'off' or 'on'.  The default
  552. is to use the native log format since it includes useful
  553. information that Squid-specific log analysers use.
  554. emulate_httpd_log off
  555. DOC_END
  556. NAME: mime_table
  557. TYPE: string
  558. DEFAULT: @DEFAULT_MIME_TABLE@
  559. LOC: Config.mimeTablePathname
  560. DOC_START
  561. Pathname to Squid's MIME table. You shouldn't need to change
  562. this, but the default file contains examples and formatting
  563. information if you do.
  564. mime_table @DEFAULT_MIME_TABLE@
  565. DOC_END
  566. NAME: log_mime_hdrs
  567. COMMENT: on|off
  568. TYPE: onoff
  569. LOC: Config.onoff.log_mime_hdrs
  570. DEFAULT: off
  571. DOC_START
  572. The Cache can record both the request and the response MIME
  573. headers for each HTTP transaction.  The headers are encoded
  574. safely and will appear as two bracketed fields at the end of
  575. the access log (for either the native or httpd-emulated log
  576. formats).  To enable this logging set log_mime_hdrs to 'on'.
  577. log_mime_hdrs off
  578. DOC_END
  579. NAME: useragent_log
  580. TYPE: string
  581. LOC: Config.Log.useragent
  582. DEFAULT: none
  583. DOC_START
  584. If configured with the "--enable-useragent_log" configure
  585. option, Squid will write the User-Agent field from HTTP
  586. requests to the filename specified here.  By default
  587. useragent_log is disabled.
  588. useragent_log none
  589. DOC_END
  590. NAME: pid_filename
  591. TYPE: string
  592. DEFAULT: @DEFAULT_PID_FILE@
  593. LOC: Config.pidFilename
  594. DOC_START
  595. A filename to write the process-id to.  To disable, enter "none".
  596. pid_filename @DEFAULT_PID_FILE@
  597. DOC_END
  598. NAME: debug_options
  599. TYPE: eol
  600. DEFAULT: ALL,1
  601. LOC: Config.debugOptions
  602. DOC_START
  603. Logging options are set as section,level where each source file
  604. is assigned a unique section.  Lower levels result in less
  605. output,  Full debugging (level 9) can result in a very large
  606. log file, so be careful.  The magic word "ALL" sets debugging
  607. levels for all sections.  We recommend normally running with
  608. "ALL,1".
  609. debug_options ALL,1
  610. DOC_END
  611. NAME: ident_lookup_access
  612. TYPE: acl_access
  613. IFDEF: USE_IDENT
  614. DEFAULT: none
  615. DEFAULT_IF_NONE: deny all
  616. LOC: Config.accessList.identLookup
  617. DOC_START
  618. A list of ACL elements which, if matched, cause an ident
  619. (RFC 931) lookup to be performed for this request.  For
  620. example, you might choose to always perform ident lookups
  621. for your main multi-user Unix boxes, but not for your Macs
  622. and PCs.  By default, ident lookups are not performed for
  623. any requests.
  624. To enable ident lookups for specific client addresses, you
  625. can follow this example:
  626.  
  627. acl ident_aware_hosts src 198.168.1.0/255.255.255.0
  628. ident_lookup_access allow ident_aware_hosts
  629. ident_lookup_access deny all
  630. ident_lookup_access deny all
  631. DOC_END
  632. NAME: log_fqdn
  633. COMMENT: on|off
  634. TYPE: onoff
  635. DEFAULT: off
  636. LOC: Config.onoff.log_fqdn
  637. DOC_START
  638. Turn this on if you wish to log fully qualified domain names
  639. in the access.log. To do this Squid does a DNS lookup of all
  640. IP's connecting to it. This can (in some situations) increase
  641. latency, which makes your cache seem slower for interactive
  642. browsing. 
  643. log_fqdn off
  644. DOC_END
  645. NAME: client_netmask
  646. TYPE: address
  647. LOC: Config.Addrs.client_netmask
  648. DEFAULT: 255.255.255.255
  649. DOC_START
  650. A netmask for client addresses in logfiles and cachemgr output.
  651. Change this to protect the privacy of your cache clients.
  652. A netmask of 255.255.255.0 will log all IP's in that range with
  653. the last digit set to '0'.
  654. client_netmask 255.255.255.255
  655. DOC_END
  656. COMMENT_START
  657.  OPTIONS FOR EXTERNAL SUPPORT PROGRAMS
  658.  -----------------------------------------------------------------------------
  659. COMMENT_END
  660. NAME: ftp_user
  661. TYPE: string
  662. DEFAULT: Squid@
  663. LOC: Config.Ftp.anon_user
  664. DOC_START
  665. If you want the anonymous login password to be more informative
  666. (and enable the use of picky ftp servers), set this to something
  667. resonable for your domain, like wwwuser@somewhere.net
  668. The reason why this is domainless by default is that the
  669. request can be made on the behalf of a user in any domain,
  670. depending on how the cache is used.
  671. Some ftp server also validate that the email address is valid
  672. (for example perl.com).
  673. ftp_user Squid@
  674. DOC_END
  675. NAME: ftp_list_width
  676. TYPE: size_t
  677. DEFAULT: 32
  678. LOC: Config.Ftp.list_width
  679. DOC_START
  680. Sets the width of ftp listings. This should be set to fit in
  681. the width of a standard browser. Setting this too small
  682. can cut off long filenames when browsing ftp sites.
  683. ftp_list_width 32
  684. DOC_END
  685. NAME: cache_dns_program
  686. TYPE: string
  687. DEFAULT: @DEFAULT_DNSSERVER@
  688. LOC: Config.Program.dnsserver
  689. DOC_START
  690. Specify the location of the executable for dnslookup process.
  691. cache_dns_program @DEFAULT_DNSSERVER@
  692. DOC_END
  693. NAME: dns_children
  694. TYPE: int
  695. DEFAULT: 5
  696. LOC: Config.dnsChildren
  697. DOC_START
  698. The number of processes spawn to service DNS name lookups.
  699. For heavily loaded caches on large servers, you should
  700. probably increase this value to at least 10.  The maximum
  701. is 32.  The default is 5.
  702. To disable dnsservers, set this to 0.  NOTE, this is very
  703. strongly discouraged.  If you disable dnsservers your Squid
  704. process will BLOCK on DNS lookups!
  705. dns_children 5
  706. DOC_END
  707. NAME: dns_defnames
  708. COMMENT: on|off
  709. TYPE: onoff
  710. DEFAULT: off
  711. LOC: Config.onoff.res_defnames
  712. DOC_START
  713. Normally the 'dnsserver' disables the RES_DEFNAMES resolver
  714. option (see res_init(3)).  This prevents caches in a hierarchy
  715. from interpreting single-component hostnames locally.  To allow
  716. dnsserver to handle single-component names, enable this
  717. option.
  718. dns_defnames off
  719. DOC_END
  720. NAME: dns_nameservers
  721. TYPE: wordlist
  722. DEFAULT: none
  723. LOC: Config.dns_nameservers
  724. DOC_START
  725. Use this if you want to specify a list of DNS name servers
  726. (IP addresses) to use instead of those given in your
  727. /etc/resolv.conf file.
  728. Example: dns_nameservers 10.0.0.1 192.172.0.4
  729. dns_nameservers none
  730. DOC_END
  731. NAME: unlinkd_program
  732. TYPE: string
  733. DEFAULT: @DEFAULT_UNLINKD@
  734. LOC: Config.Program.unlinkd
  735. DOC_START
  736. Specify the location of the executable for file deletion process.
  737. This isn't needed if you are using async-io since it's handled by
  738. a thread.
  739. unlinkd_program @DEFAULT_UNLINKD@
  740. DOC_END
  741. NAME: pinger_program
  742. TYPE: string
  743. DEFAULT: @DEFAULT_PINGER@
  744. LOC: Config.Program.pinger
  745. DOC_START
  746. Specify the location of the executable for the pinger process.
  747. This is only useful if you configured Squid (during compliation)
  748. with the '--enable-icmp' option.
  749. pinger_program @DEFAULT_PINGER@
  750. DOC_END
  751. NAME: redirect_program
  752. TYPE: string
  753. LOC: Config.Program.redirect
  754. DEFAULT: none
  755. DOC_START
  756. Specify the location of the executable for the URL redirector.
  757. Since they can perform almost any function there isn't one included.
  758. See the Release-Notes for information on how to write one.
  759. By default, a redirector is not used.
  760. redirect_program none
  761. DOC_END
  762. NAME: redirect_children
  763. TYPE: int
  764. DEFAULT: 5
  765. LOC: Config.redirectChildren
  766. DOC_START
  767. The number of redirector processes to spawn. If you start
  768. too few Squid will have to wait for them to process a backlog of
  769. URLs, slowing it down. If you start too many they will use RAM
  770. and other system resources.
  771. redirect_children 5
  772. DOC_END
  773. NAME: redirect_rewrites_host_header
  774. TYPE: onoff
  775. DEFAULT: on
  776. LOC: Config.onoff.redir_rewrites_host
  777. DOC_START
  778. By default Squid rewrites any Host: header in redirected requests.
  779. If you are running a accelerator then this may not be a wanted effect
  780. of a redirector.
  781. redirect_rewrites_host_header on
  782. DOC_END
  783. NAME: authenticate_program
  784. TYPE: wordlist
  785. LOC: Config.Program.authenticate
  786. DEFAULT: none
  787. DOC_START
  788. Specify the command for the external authenticator.  Such a
  789. program reads a line containing "username password" and replies
  790. "OK" or "ERR" in an endless loop.  If you use an authenticator,
  791. make sure you have 1 acl of type proxy_auth.  By default, the
  792. authenticator_program is not used.
  793. If you want to use the traditional proxy authentication,
  794. jump over to the ../auth_modules/NCSA directory and
  795. type:
  796. % make
  797. % make install
  798. Then, set this line to something like
  799. authenticate_program @DEFAULT_PREFIX@/bin/ncsa_auth @DEFAULT_PREFIX@/etc/passwd
  800. authenticate_program none
  801. DOC_END
  802. NAME: authenticate_children
  803. TYPE: int
  804. DEFAULT: 5
  805. LOC: Config.authenticateChildren
  806. DOC_START
  807. The number of authenticator processes to spawn (default 5). If you
  808. start too few Squid will have to wait for them to process a backlog
  809. of usercode/password verifications, slowing it down. When password
  810. verifications are done via a (slow) network you are likely to need
  811. lots of authenticator processes.
  812. authenticate_children 5
  813. DOC_END
  814. NAME: authenticate_ttl
  815. TYPE: int
  816. DEFAULT: 3600
  817. LOC: Config.authenticateTTL
  818. DOC_START
  819. The time a checked username/password combination remains cached
  820. (default 3600). If a wrong password is given for a cached user,
  821. the user gets removed from the username/password cache forcing
  822. a revalidation.
  823. authenticate_ttl 3600
  824. DOC_END
  825. COMMENT_START
  826.  OPTIONS FOR TUNING THE CACHE
  827.  -----------------------------------------------------------------------------
  828. COMMENT_END
  829. NAME: wais_relay_host
  830. TYPE: string
  831. DEFAULT: none
  832. LOC: Config.Wais.relayHost
  833. DOC_NONE
  834. NAME: wais_relay_port
  835. TYPE: ushort
  836. DEFAULT: 0
  837. LOC: Config.Wais.relayPort
  838. DOC_START
  839. Relay WAIS request to host (1st arg) at port (2 arg).
  840. wais_relay_host localhost
  841. wais_relay_port 8000
  842. DOC_END
  843. NAME: request_size
  844. COMMENT: (KB)
  845. TYPE: b_size_t
  846. DEFAULT: 100 KB
  847. LOC: Config.maxRequestSize
  848. DOC_START
  849. Maximum allowed request size in kilobytes.  If people are using
  850. POST to upload files, then set this to the largest acceptable
  851. filesize plus a few extra kbytes.
  852. request_size 100 KB
  853. DOC_END
  854. NAME: refresh_pattern
  855. TYPE: refreshpattern
  856. LOC: Config.Refresh
  857. DEFAULT: none
  858. DOC_START
  859. usage: refresh_pattern [-i] regex min percent max [options]
  860. By default, regular expressions are CASE-SENSITIVE.  To make
  861. them case-insensitive, use the -i option.
  862. min and max are specified in MINUTES.
  863. percent is an integer number.
  864. options: override-expire
  865.  override-lastmod
  866.  reload-into-ims
  867.  ignore-reload
  868. override-expire enforces min age even if the server
  869. sent a Expires: header. Doing this VIOLATES the HTTP
  870. standard.  Enabling this feature could make you liable
  871. for problems which it causes.
  872. override-lastmod enforces min age even on objects
  873. that was modified recently.
  874. reload-into-ims changes client no-cache or ``reload''
  875. to If-Modified-Since requests. Doing this VIOLATES the
  876. HTTP standard. Enabling this feature could make you
  877. liable for problems which it causes.
  878. ignore-reload ignores a client no-cache or ``reload''
  879. header. Doing this VIOLATES the HTTP standard. Enabling
  880. this feature could make you liable for problems which
  881. it causes.
  882. Please see the file doc/Release-Notes-1.1.txt for a full
  883. description of Squid's refresh algorithm.  Basically a
  884. cached object is: (the order is changed from 1.1.X)
  885. STALE if age > max
  886. FRESH if expires < now, else STALE
  887. FRESH if lm-factor < percent, else STALE
  888. FRESH if age < min
  889. else STALE
  890. The refresh_pattern lines are checked in the order listed here.
  891. The first entry which matches is used.  If none of the entries
  892. match, then the default will be used.
  893. Default:
  894. refresh_pattern  . 0 20% 4320
  895. DOC_END
  896. NAME: reference_age
  897. TYPE: time_t
  898. LOC: Config.referenceAge
  899. DEFAULT: 1 year
  900. DOC_START
  901. As a part of normal operation, Squid performs Least Recently
  902. Used removal of cached objects.  The LRU age for removal is
  903. computed dynamically, based on the amount of disk space in
  904. use.  The dynamic value can be seen in the Cache Manager 'info'
  905. output.
  906. The 'reference_age' parameter defines the maximum LRU age.  For
  907. example, setting reference_age to '1 week' will cause objects
  908. to be removed if they have not been accessed for a week or
  909. more.  The default value is one month.
  910. Specify a number here, followed by units of time.  For example:
  911. 1 week
  912. 3.5 days
  913. 4 months
  914. 2.2 hours
  915. reference_age 1 month
  916. DOC_END
  917. NAME: quick_abort_min
  918. COMMENT: (KB)
  919. TYPE: kb_size_t
  920. DEFAULT: 16 KB
  921. LOC: Config.quickAbort.min
  922. DOC_NONE
  923. NAME: quick_abort_max
  924. COMMENT: (KB)
  925. TYPE: kb_size_t
  926. DEFAULT: 16 kb
  927. LOC: Config.quickAbort.max
  928. DOC_NONE
  929. NAME: quick_abort_pct
  930. COMMENT: (percent)
  931. TYPE: int
  932. DEFAULT: 95
  933. LOC: Config.quickAbort.pct
  934. DOC_START
  935. The cache can be configured to continue downloading aborted
  936. requests.  This may be undesirable on slow (e.g. SLIP) links
  937. and/or very busy caches.  Impatient users may tie up file
  938. descriptors and bandwidth by repeatedly requesting and
  939. immediately aborting downloads.
  940. When the user aborts a request, Squid will check the
  941. quick_abort values to the amount of data transfered until
  942. then.
  943. If the transfer has less than 'quick_abort_min' KB remaining,
  944. it will finish the retrieval.  Setting 'quick_abort_min' to -1
  945. will disable the quick_abort feature.
  946. If the transfer has more than 'quick_abort_max' KB remaining,
  947. it will abort the retrieval.
  948. If more than 'quick_abort_pct' of the transfer has completed,
  949. it will finish the retrieval.
  950. quick_abort_min 16 KB
  951. quick_abort_max 16 KB
  952. quick_abort_pct 95
  953. DOC_END
  954. NAME: negative_ttl
  955. COMMENT: time-units
  956. TYPE: time_t
  957. LOC: Config.negativeTtl
  958. DEFAULT: 5 minutes
  959. DOC_START
  960. Time-to-Live (TTL) for failed requests.  Certain types of
  961. failures (such as "connection refused" and "404 Not Found") are
  962. negatively-cached for a configurable amount of time.  The
  963. default is 5 minutes.  Note that this is different from
  964. negative caching of DNS lookups.
  965. negative_ttl 5 minutes
  966. DOC_END
  967. NAME: positive_dns_ttl
  968. COMMENT: time-units
  969. TYPE: time_t
  970. LOC: Config.positiveDnsTtl
  971. DEFAULT: 6 hours
  972. DOC_START
  973. Time-to-Live (TTL) for positive caching of successful DNS lookups.
  974. Default is 6 hours (360 minutes).  If you want to minimize the
  975. use of Squid's ipcache, set this to 1, not 0.
  976. positive_dns_ttl 6 hours
  977. DOC_END
  978. NAME: negative_dns_ttl
  979. COMMENT: time-units
  980. TYPE: time_t
  981. LOC: Config.negativeDnsTtl
  982. DEFAULT: 5 minutes
  983. DOC_START
  984. Time-to-Live (TTL) for negative caching of failed DNS lookups.
  985. negative_dns_ttl 5 minutes
  986. DOC_END
  987. NAME: range_offset_limit
  988. COMMENT: (bytes)
  989. TYPE: b_size_t
  990. LOC: Config.rangeOffsetLimit
  991. DEFAULT: 0 KB
  992. DOC_START
  993. Sets a upper limit on how far into the the file a Range request
  994. may be to cause Squid to prefetch the whole file. If beyond this
  995. limit then Squid forwards the Range request as it is and the result
  996. is NOT cached.
  997. This is to stop a far ahead range request (lets say start at 17MB)
  998. from making Squid fetch the whole object up to that point before
  999. sending anything to the client.
  1000. A value of -1 causes Squid to always fetch the object from the
  1001. beginning so that it may cache the result. (2.0 style)
  1002. A value of 0 causes Squid to never fetch more than the client
  1003. client requested. (default)
  1004. range_offset_limit 0 KB
  1005. DOC_END
  1006. COMMENT_START
  1007.  TIMEOUTS
  1008.  -----------------------------------------------------------------------------
  1009. COMMENT_END
  1010. NAME: connect_timeout
  1011. COMMENT: time-units
  1012. TYPE: time_t
  1013. LOC: Config.Timeout.connect
  1014. DEFAULT: 2 minutes
  1015. DOC_START
  1016. Some systems (notably Linux) can not be relied upon to properly
  1017. time out connect(2) requests.  Therefore the Squid process
  1018. enforces its own timeout on server connections.  This parameter
  1019. specifies how long to wait for the connect to complete.  The
  1020. default is two minutes (120 seconds).
  1021. connect_timeout 120 seconds
  1022. DOC_END
  1023. NAME: siteselect_timeout
  1024. COMMENT: time-units
  1025. TYPE: time_t
  1026. LOC: Config.Timeout.siteSelect
  1027. DEFAULT: 4 seconds
  1028. DOC_START
  1029. For URN to multiple URL's URL selection
  1030. siteselect_timeout 4 seconds
  1031. DOC_END
  1032. NAME: read_timeout
  1033. COMMENT: time-units
  1034. TYPE: time_t
  1035. LOC: Config.Timeout.read
  1036. DEFAULT: 15 minutes
  1037. DOC_START
  1038. The read_timeout is applied on server-side connections.  After
  1039. each successful read(), the timeout will be extended by this
  1040. amount.  If no data is read again after this amount of time,
  1041. the request is aborted and logged with ERR_READ_TIMEOUT.  The
  1042. default is 15 minutes.
  1043. read_timeout 15 minutes
  1044. DOC_END
  1045. NAME: request_timeout
  1046. TYPE: time_t
  1047. LOC: Config.Timeout.request
  1048. DEFAULT: 30 seconds
  1049. DOC_START
  1050. How long to wait for an HTTP request after connection
  1051. establishment.  For persistent connections, wait this long
  1052. after the previous request completes.
  1053. request_timeout 30 seconds
  1054. DOC_END
  1055. NAME: client_lifetime
  1056. COMMENT: time-units
  1057. TYPE: time_t
  1058. LOC: Config.Timeout.lifetime
  1059. DEFAULT: 1 day
  1060. DOC_START
  1061. The maximum amount of time that a client (browser) is allowed to
  1062. remain connected to the cache process.  This protects the Cache
  1063. from having alot of sockets (and hence file descriptors) tied up
  1064. in a CLOSE_WAIT state from remote clients that go away without
  1065. properly shutting down (either because of a network failure or
  1066. because of a poor client implementation).  The default is one
  1067. day, 1440 minutes.
  1068. NOTE:  The default value is intended to be much larger than any
  1069. client would ever need to be connected to your cache.  You
  1070. should probably change client_lifetime only as a last resort.
  1071. If you seem to have many client connections tying up
  1072. filedescriptors, we recommend first tuning the read_timeout,
  1073. request_timeout, pconn_timeout and quick_abort values.
  1074. client_lifetime 1 day
  1075. DOC_END
  1076. NAME: half_closed_clients
  1077. TYPE: onoff
  1078. LOC: Config.onoff.half_closed_clients
  1079. DEFAULT: on
  1080. DOC_START
  1081. Some clients may shutdown the sending side of their TCP
  1082. connections, while leaving their receiving sides open. Sometimes,
  1083. Squid can not tell the difference between a half-closed and a
  1084. fully-closed TCP connection.  By default, half-closed client
  1085. connections are kept open until a read(2) or write(2) on the
  1086. socket returns an error.  Change this option to 'off' and Squid
  1087. will immediately close client connections when read(2) returns
  1088. "no more data to read."
  1089. half_closed_clients on
  1090. DOC_END
  1091. NAME: pconn_timeout
  1092. TYPE: time_t
  1093. LOC: Config.Timeout.pconn
  1094. DEFAULT: 120 seconds
  1095. DOC_START
  1096. Timeout for idle persistent connections to servers and other
  1097. proxies.
  1098. pconn_timeout 120 seconds
  1099. DOC_END
  1100. NAME: ident_timeout
  1101. TYPE: time_t
  1102. IFDEF: USE_IDENT
  1103. LOC: Config.Timeout.ident
  1104. DEFAULT: 10 seconds
  1105. DOC_START
  1106. Maximum time to wait for IDENT requests.  If this is too high,
  1107. and you enabled 'ident_lookup', then you might be susceptible
  1108. to denial-of-service by having many ident requests going at
  1109. once.
  1110. ident_timeout 10 seconds
  1111. DOC_END
  1112. NAME: shutdown_lifetime
  1113. COMMENT: time-units
  1114. TYPE: time_t
  1115. LOC: Config.shutdownLifetime
  1116. DEFAULT: 30 seconds
  1117. DOC_START
  1118. When SIGTERM or SIGHUP is received, the cache is put into
  1119. "shutdown pending" mode until all active sockets are closed.
  1120. This value is the lifetime to set for all open descriptors
  1121. during shutdown mode.  Any active clients after this many
  1122. seconds will receive a 'timeout' message.
  1123. shutdown_lifetime 30 seconds
  1124. DOC_END
  1125. COMMENT_START
  1126.  ACCESS CONTROLS
  1127.  -----------------------------------------------------------------------------
  1128. COMMENT_END
  1129. NAME: acl
  1130. TYPE: acl
  1131. LOC: Config.aclList
  1132. DEFAULT: none
  1133. DOC_START
  1134. Defining an Access List
  1135. acl aclname acltype string1 ...
  1136. acl aclname acltype "file" ...
  1137. when using "file", the file should contain one item per line
  1138. acltype is one of src dst srcdomain dstdomain url_pattern
  1139. urlpath_pattern time port proto method browser user
  1140. By default, regular expressions are CASE-SENSITIVE.  To make
  1141. them case-insensitive, use the -i option.
  1142. acl aclname src      ip-address/netmask ... (clients IP address)
  1143. acl aclname src      addr1-addr2/netmask ... (range of addresses)
  1144. acl aclname dst      ip-address/netmask ... (URL host's IP address)
  1145. acl aclname myip     ip-address/netmask ... (local socket IP address)
  1146. acl aclname srcdomain   foo.com ...     # reverse lookup, client IP
  1147. acl aclname dstdomain   foo.com ...     # Destination server from URL
  1148. acl aclname srcdom_regex [-i] xxx ...   # regex matching client name
  1149. acl aclname dstdom_regex [-i] xxx ...   # regex matching server
  1150.   # For dstdomain and dstdom_regex  a reverse lookup is tried if a IP
  1151.   # based URL is used. The name "none" is used if the reverse lookup
  1152.   # fails.
  1153. acl aclname time     [day-abbrevs]  [h1:m1-h2:m2]
  1154.     day-abbrevs:
  1155. S - Sunday
  1156. M - Monday
  1157. T - Tuesday
  1158. W - Wednesday
  1159. H - Thursday
  1160. F - Friday
  1161. A - Saturday
  1162.     h1:m1 must be less than h2:m2
  1163. acl aclname url_regex [-i] ^http:// ... # regex matching on whole URL
  1164. acl aclname urlpath_regex [-i] .gif$ ... # regex matching on URL path
  1165. acl aclname port     80 70 21 ...
  1166. acl aclname port     0-1024 ... # ranges allowed
  1167. acl aclname proto    HTTP FTP ...
  1168. acl aclname method   GET POST ...
  1169. acl aclname browser  [-i] regexp
  1170.   # pattern match on User-Agent header
  1171. acl aclname ident    username ...
  1172.   # string match on ident output.
  1173.   # use REQUIRED to accept any non-null ident.
  1174. acl aclname src_as   number ... 
  1175. acl aclname dst_as   number ...
  1176.   # Except for access control, AS numbers can be used for
  1177.   # routing of requests to specific caches. Here's an 
  1178.   # example for routing all requests for AS#1241 and only 
  1179.   # those to mycache.mydomain.net:
  1180.   # acl asexample dst_as 1241
  1181.   # cache_peer_access mycache.mydomain.net allow asexample
  1182.   # cache_peer_access mycache_mydomain.net deny all
  1183. acl aclname proxy_auth username ...
  1184.   # list of valid usernames
  1185.   # use REQUIRED to accept any valid username.
  1186.   #
  1187.   # NOTE: when a Proxy-Authentication header is sent but it is not
  1188.   # needed during ACL checking the username is NOT logged
  1189.   # in access.log.
  1190.   #
  1191.   # NOTE: proxy_auth requires a EXTERNAL authentication program
  1192.   # to check username/password combinations (see
  1193.   # authenticate_program).
  1194.   #
  1195.   # WARNING: proxy_auth can't be used in a transparent proxy. It
  1196.   # collides with any authentication done by origin servers. It may
  1197.   # seem like it works at first, but it doesn't.
  1198. acl aclname snmp_community string ...
  1199.   # A community string to limit access to your SNMP Agent
  1200.   # Example:
  1201.   # 
  1202.   # acl snmppublic snmp_community public
  1203. Examples:
  1204. acl myexample dst_as 1241
  1205. acl password proxy_auth 300
  1206. Defaults:
  1207. NOCOMMENT_START
  1208. acl all src 0.0.0.0/0.0.0.0
  1209. acl manager proto cache_object
  1210. acl localhost src 127.0.0.1/255.255.255.255
  1211. acl SSL_ports port 443 563
  1212. acl Safe_ports port 80 21 443 563 70 210 1025-65535
  1213. acl CONNECT method CONNECT
  1214. NOCOMMENT_END
  1215. DOC_END
  1216. NAME: http_access
  1217. TYPE: acl_access
  1218. LOC: Config.accessList.http
  1219. DEFAULT: none
  1220. DEFAULT_IF_NONE: deny all
  1221. DOC_START
  1222. Allowing or Denying access based on defined access lists
  1223. Access to the HTTP port:
  1224. http_access allow|deny [!]aclname ...
  1225. Access to the ICP port:
  1226. icp_access  allow|deny [!]aclname ...
  1227. NOTE on default values:
  1228. If there are no "access" lines present, the default is to allow
  1229. the request.
  1230. If none of the "access" lines cause a match, the default is the
  1231. opposite of the last line in the list.  If the last line was
  1232. deny, then the default is allow.  Conversely, if the last line
  1233. is allow, the default will be deny.  For these reasons, it is a
  1234. good idea to have an "deny all" or "allow all" entry at the end
  1235. of your access lists to avoid potential confusion.
  1236. Default configuration:
  1237. NOCOMMENT_START
  1238. http_access allow manager localhost
  1239. http_access deny manager
  1240. http_access deny !Safe_ports
  1241. http_access deny CONNECT !SSL_ports
  1242. #
  1243. # INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS
  1244. #
  1245. http_access deny all
  1246. NOCOMMENT_END
  1247. DOC_END
  1248. NAME: icp_access
  1249. TYPE: acl_access
  1250. LOC: Config.accessList.icp
  1251. DEFAULT: none
  1252. DEFAULT_IF_NONE: deny all
  1253. DOC_START
  1254. Reply to all ICP queries we receive
  1255. NOCOMMENT_START
  1256. icp_access allow all
  1257. NOCOMMENT_END
  1258. DOC_END
  1259. NAME: miss_access
  1260. TYPE: acl_access
  1261. LOC: Config.accessList.miss
  1262. DEFAULT: none
  1263. DOC_START
  1264. Use to force your neighbors to use you as a sibling instead of
  1265. a parent.  For example:
  1266. acl localclients src 172.16.0.0/16
  1267. miss_access allow localclients
  1268. miss_access deny  !localclients
  1269. This means that only your local clients are allowed to fetch
  1270. MISSES and all other clients can only fetch HITS.
  1271. By default, allow all clients who passed the http_access rules
  1272. to fetch MISSES from us.
  1273. NOCOMMENT_START
  1274. miss_access allow all
  1275. NOCOMMENT_END
  1276. DOC_END
  1277. NAME: cache_peer_access
  1278. TYPE: peer_access
  1279. DEFAULT: none
  1280. LOC: none
  1281. DOC_START
  1282. Similar to 'cache_peer_domain' but provides more flexibility by
  1283. using ACL elements.
  1284. cache_peer_access cache-host allow|deny [!]aclname ...
  1285. The syntax is identical to 'http_access' and the other lists of
  1286. ACL elements.  See the comments for 'http_access' below, or
  1287. the Squid FAQ (http://squid.nlanr.net/Squid/FAQ/FAQ-10.html).
  1288. DOC_END
  1289. NAME: proxy_auth_realm
  1290. TYPE: eol
  1291. DEFAULT: Squid proxy-caching web server
  1292. LOC: Config.proxyAuthRealm
  1293. DOC_START
  1294. Specifies the realm name which is to be reported to the client for
  1295. proxy authentication (part of the text the user will see when
  1296. prompted their username and password).
  1297. proxy_auth_realm Squid proxy-caching web server
  1298. DOC_END
  1299. COMMENT_START
  1300.  ADMINISTRATIVE PARAMETERS
  1301.  -----------------------------------------------------------------------------
  1302. COMMENT_END
  1303. NAME: cache_mgr
  1304. TYPE: string
  1305. DEFAULT: webmaster
  1306. LOC: Config.adminEmail
  1307. DOC_START
  1308. Email-address of local cache manager who will receive
  1309. mail if the cache dies.  The default is "webmaster."
  1310. cache_mgr webmaster
  1311. DOC_END
  1312. NAME: cache_effective_user
  1313. TYPE: string
  1314. DEFAULT: nobody
  1315. LOC: Config.effectiveUser
  1316. DOC_NONE
  1317. NAME: cache_effective_group
  1318. TYPE: string
  1319. DEFAULT: nogroup
  1320. LOC: Config.effectiveGroup
  1321. DOC_START
  1322. If the cache is run as root, it will change its effective/real
  1323. UID/GID to the UID/GID specified below.  The default is to
  1324. change to UID to nobody and GID to nogroup.
  1325. If Squid is not started as root, the default is to keep the
  1326. current UID/GID.  Note that if Squid is not started as root then
  1327. you cannot set http_port to a value lower than 1024.
  1328. cache_effective_user nobody
  1329. cache_effective_group nogroup
  1330. DOC_END
  1331. NAME: visible_hostname
  1332. TYPE: string
  1333. LOC: Config.visibleHostname
  1334. DEFAULT: none
  1335. DOC_START
  1336. If you want to present a special hostname in error messages, etc,
  1337. then define this.  Otherwise, the return value of gethostname()
  1338. will be used. If you have multiple caches in a cluster and
  1339. get errors about IP-forwarding you must set them to have individual
  1340. names with this setting.
  1341. visible_hostname www-cache.foo.org
  1342. DOC_END
  1343. NAME: unique_hostname
  1344. TYPE: string
  1345. LOC: Config.uniqueHostname
  1346. DEFAULT: none
  1347. DOC_START
  1348. If you want to have multiple machines with the same
  1349. 'visible_hostname' then you must give each machine a different
  1350. 'unique_hostname' so that forwarding loops can be detected.
  1351. unique_hostname www-cache1.foo.org
  1352. DOC_END
  1353. COMMENT_START
  1354.  OPTIONS FOR THE CACHE REGISTRATION SERVICE
  1355.  -----------------------------------------------------------------------------
  1356. This section contains parameters for the (optional) cache
  1357. announcement service.  This service is provided to help
  1358. cache administrators locate one another in order to join or
  1359. create cache hierarchies.
  1360. An 'announcement' message is sent (via UDP) to the registration
  1361. service by Squid.  By default, the annoucement message is NOT
  1362. SENT unless you enable it with 'announce_period' below.
  1363. The announcement message includes your hostname, plus the
  1364. following information from this configuration file:
  1365. http_port
  1366. icp_port
  1367. cache_mgr
  1368. All current information is processed regularly and made
  1369. available on the Web at http://ircache.nlanr.net/Cache/Tracker/.
  1370. COMMENT_END
  1371. NAME: announce_period
  1372. TYPE: time_t
  1373. LOC: Config.Announce.period
  1374. DEFAULT: 0
  1375. DOC_START
  1376. This is how frequently to send cache announcements.  The
  1377. default is `0' which disables sending the announcement
  1378. messages.
  1379. To enable announcing your cache, just uncomment the line
  1380. below.
  1381. announce_period 1 day
  1382. DOC_END
  1383. NAME: announce_host
  1384. TYPE: string
  1385. DEFAULT: tracker.ircache.net
  1386. LOC: Config.Announce.host
  1387. DOC_NONE
  1388. NAME: announce_file
  1389. TYPE: string
  1390. DEFAULT: none
  1391. LOC: Config.Announce.file
  1392. DOC_NONE
  1393. NAME: announce_port
  1394. TYPE: ushort
  1395. DEFAULT: 3131
  1396. LOC: Config.Announce.port
  1397. DOC_START
  1398. announce_host and announce_port set the hostname and port
  1399. number where the registration message will be sent.
  1400. Hostname will default to 'tracker.ircache.net' and port will
  1401. default default to 3131.  If the 'filename' argument is given,
  1402. the contents of that file will be included in the announce
  1403. message.
  1404. announce_host tracker.ircache.net
  1405. announce_port 3131
  1406. DOC_END
  1407. COMMENT_START
  1408.  HTTPD-ACCELERATOR OPTIONS
  1409.  -----------------------------------------------------------------------------
  1410. COMMENT_END
  1411. NAME: httpd_accel_host
  1412. TYPE: string
  1413. LOC: Config.Accel.host
  1414. DEFAULT: none
  1415. DOC_NONE
  1416. NAME: httpd_accel_port
  1417. TYPE: ushort
  1418. LOC: Config.Accel.port
  1419. DEFAULT: 80
  1420. DOC_START
  1421. If you want to run Squid as an httpd accelerator, define the
  1422. host name and port number where the real HTTP server is.
  1423. If you want virtual host support then specify the hostname
  1424. as "virtual".
  1425. NOTE: enabling httpd_accel_host disables proxy-caching and
  1426. ICP.  If you want these features enabled also, then set
  1427. the 'httpd_accel_with_proxy' option.
  1428. httpd_accel_host hostname
  1429. httpd_accel_port port
  1430. DOC_END
  1431. NAME: httpd_accel_with_proxy
  1432. COMMENT: on|off
  1433. TYPE: onoff
  1434. DEFAULT: off
  1435. LOC: Config.onoff.accel_with_proxy
  1436. DOC_START
  1437. If you want to use Squid as both a local httpd accelerator
  1438. and as a proxy, change this to 'on'.
  1439. httpd_accel_with_proxy off
  1440. DOC_END
  1441. NAME: httpd_accel_uses_host_header
  1442. COMMENT: on|off
  1443. TYPE: onoff
  1444. DEFAULT: off
  1445. LOC: opt_accel_uses_host
  1446. DOC_START
  1447. HTTP/1.1 requests include a Host: header which is basically the
  1448. hostname from the URL.  Squid can be an accelerator for
  1449. different HTTP servers by looking at this header.  However,
  1450. Squid does NOT check the value of the Host header, so it opens
  1451. a big security hole.  We recommend that this option remain
  1452. disabled unless you are sure of what you are doing.
  1453. However, you will need to enable this option if you run Squid
  1454. as a transparent proxy.  Otherwise, virtual servers which
  1455. require the Host: header will not be properly cached.
  1456. httpd_accel_uses_host_header off
  1457. DOC_END
  1458. COMMENT_START
  1459.  MISCELLANEOUS
  1460.  -----------------------------------------------------------------------------
  1461. COMMENT_END
  1462. NAME: dns_testnames
  1463. TYPE: wordlist
  1464. LOC: Config.dns_testname_list
  1465. DEFAULT: none
  1466. DOC_START
  1467. The DNS tests exit as soon as the first site is successfully looked up
  1468. If you want to disable DNS tests, do not comment out or delete this
  1469. list.  Instead use the -D command line option
  1470. dns_testnames netscape.com internic.net nlanr.net microsoft.com
  1471. DOC_END
  1472. NAME: logfile_rotate
  1473. TYPE: int
  1474. DEFAULT: 10
  1475. LOC: Config.Log.rotateNumber
  1476. DOC_START
  1477. Specifies the number of logfile rotations to make when you
  1478. type 'squid -k rotate'.  The default is 10, which will rotate
  1479. with extensions 0 through 9.  Setting logfile_rotate to 0 will
  1480. disable the rotation, but the logfiles are still closed and
  1481. re-opened.  This will enable you to rename the logfiles
  1482. yourself just before sending the rotate signal.
  1483. Note, the 'squid -k rotate' command normally sends a USR1
  1484. signal to the running squid process.  In certain situations
  1485. (e.g. on Linux with Async I/O), USR1 is used for other
  1486. purposes, so -k rotate uses another signal.  It is best to get
  1487. in the habit of using 'squid -k rotate' instead of 'kill -USR1
  1488. <pid>'.
  1489. logfile_rotate 10
  1490. DOC_END
  1491. NAME: append_domain
  1492. TYPE: string
  1493. LOC:  Config.appendDomain
  1494. DEFAULT: none
  1495. DOC_START
  1496. Appends local domain name to hostnames without any dots in
  1497. them.  append_domain must begin with a period.
  1498. append_domain .yourdomain.com
  1499. DOC_END
  1500. NAME: tcp_recv_bufsize
  1501. COMMENT: (bytes)
  1502. TYPE: b_size_t
  1503. DEFAULT: 0 bytes
  1504. LOC: Config.tcpRcvBufsz
  1505. DOC_START
  1506. Size of receive buffer to set for TCP sockets.  Probably just
  1507. as easy to change your kernel's default.  Set to zero to use
  1508. the default buffer size.
  1509. tcp_recv_bufsize 0 bytes
  1510. DOC_END
  1511. NAME: err_html_text
  1512. TYPE: eol
  1513. LOC: Config.errHtmlText
  1514. DEFAULT: none
  1515. DOC_START
  1516. HTML text to include in error messages.  Make this a "mailto"
  1517. URL to your admin address, or maybe just a link to your
  1518. organizations Web page.
  1519. To include this in your error messages, you must rewrite
  1520. the error template files (found in the "errors" directory).
  1521. Wherever you want the 'err_html_text' line to appear,
  1522. insert a %L tag in the error template file.
  1523. err_html_text
  1524. DOC_END
  1525. NAME: deny_info
  1526. TYPE: denyinfo
  1527. LOC: Config.denyInfoList
  1528. DEFAULT: none
  1529. DOC_START
  1530. Usage:   deny_info err_page_name acl
  1531. Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys
  1532. This can be used to return a ERR_ page for requests which
  1533. do not pass the 'http_access' rules.  A single ACL will cause
  1534. the http_access check to fail.  If a 'deny_info' line exists
  1535. for that ACL then Squid returns a corresponding error page.
  1536. You may use ERR_ pages that come with Squid or create your own pages
  1537. and put them into the configured errors/ directory.
  1538. DOC_END
  1539. NAME: memory_pools
  1540. COMMENT: on|off
  1541. TYPE: onoff
  1542. DEFAULT: on
  1543. LOC: Config.onoff.mem_pools
  1544. DOC_START
  1545. If set, Squid will keep pools of allocated (but unused) memory
  1546. available for future use.  If memory is a premium on your
  1547. system and you believe your malloc library outperforms Squid 
  1548. routines, disable this.
  1549. memory_pools on
  1550. DOC_END
  1551. NAME: memory_pools_limit
  1552. COMMENT: (bytes)
  1553. TYPE: b_size_t
  1554. DEFAULT: none
  1555. LOC: Config.MemPools.limit
  1556. DOC_START
  1557. Used only with memory_pools on:
  1558. memory_pools_limit 50 MB
  1559. If set to a non-zero value, Squid will keep at most the specified
  1560. limit of allocated (but unused) memory in memory pools. All free()
  1561. requests that exceed this limit will be handled by your malloc
  1562. library. Squid does not pre-allocate any memory, just safe-keeps
  1563. objects that otherwise would be free()d. Thus, it is safe to set
  1564. memory_pools_limit to a reasonably high value even if your
  1565. configuration will use less memory.
  1566. If not set (default) or set to zero, Squid will keep all memory it
  1567. can. That is, there will be no limit on the total amount of memory
  1568. used for safe-keeping.
  1569. To disable memory allocation optimization, do not set
  1570. memory_pools_limit to 0. Set memory_pools to "off" instead.
  1571. An overhead for maintaining memory pools is not taken into account
  1572. when the limit is checked. This overhead is close to four bytes per
  1573. object kept. However, pools may actually _save_ memory because of
  1574. reduced memory thrashing in your malloc library.
  1575. DOC_END
  1576. NAME: forwarded_for
  1577. COMMENT: on|off
  1578. TYPE: onoff
  1579. DEFAULT: on
  1580. LOC: opt_forwarded_for
  1581. DOC_START
  1582. If set, Squid will include your system's IP address or name
  1583. in the HTTP requests it forwards.  By default it looks like
  1584. this:
  1585. X-Forwarded-For: 192.1.2.3
  1586. If you disable this, it will appear as
  1587. X-Forwarded-For: unknown
  1588. forwarded_for on
  1589. DOC_END
  1590. NAME: log_icp_queries
  1591. COMMENT: on|off
  1592. TYPE: onoff
  1593. DEFAULT: on
  1594. LOC: Config.onoff.log_udp
  1595. DOC_START
  1596. If set, ICP queries are logged to access.log. You may wish
  1597. do disable this if your ICP load is VERY high to speed things
  1598. up or to simplify log analysis.
  1599. log_icp_queries on
  1600. DOC_END
  1601. NAME: icp_hit_stale
  1602. COMMENT: on|off
  1603. TYPE: onoff
  1604. DEFAULT: off
  1605. LOC: Config.onoff.icp_hit_stale
  1606. DOC_START
  1607. If you want to return ICP_HIT for stale cache objects, set this
  1608. option to 'on'.  If you have sibling relationships with caches
  1609. in other administrative domains, this should be 'off'.  If you only
  1610. have sibling relationships with caches under your control, then
  1611. it is probably okay to set this to 'on'.
  1612. icp_hit_stale off
  1613. DOC_END
  1614. NAME: minimum_direct_hops
  1615. TYPE: int
  1616. DEFAULT: 4
  1617. LOC: Config.minDirectHops
  1618. DOC_START
  1619. If using the ICMP pinging stuff, do direct fetches for sites
  1620. which are no more than this many hops away.
  1621. minimum_direct_hops 4
  1622. DOC_END
  1623. NAME: cachemgr_passwd
  1624. TYPE: cachemgrpasswd
  1625. DEFAULT: none
  1626. LOC: Config.passwd_list
  1627. DOC_START
  1628. Specify passwords for cachemgr operations.
  1629. Usage: cachemgr_passwd password action action ...
  1630. Some valid actions are (see cache manager menu for a full list):
  1631. 5min
  1632. 60min
  1633. asndb
  1634. authenticator
  1635. cbdata
  1636. client_list
  1637. comm_incoming
  1638. config *
  1639. counters
  1640. delay
  1641. digest_stats
  1642. dns
  1643. events
  1644. filedescriptors
  1645. fqdncache
  1646. histograms
  1647. http_headers
  1648. info
  1649. io
  1650. ipcache
  1651. mem
  1652. menu
  1653. netdb
  1654. non_peers
  1655. objects
  1656. pconn
  1657. peer_select
  1658. redirector
  1659. refresh
  1660. server_list
  1661. shutdown *
  1662. store_digest
  1663. storedir
  1664. utilization
  1665. via_headers
  1666. vm_objects
  1667. * Indicates actions which will not be performed without a
  1668.   valid password, others can be performed if not listed here.
  1669. To disable an action, set the password to "disable".
  1670. To allow performing an action without a password, set the
  1671. password to "none".
  1672. Use the keyword "all" to set the same password for all actions.
  1673. cachemgr_passwd secret shutdown
  1674. cachemgr_passwd lesssssssecret info stats/objects
  1675. cachemgr_passwd disable all
  1676. DOC_END
  1677. NAME: store_avg_object_size
  1678. COMMENT: (kbytes)
  1679. TYPE: kb_size_t
  1680. DEFAULT: 13 KB
  1681. LOC: Config.Store.avgObjectSize
  1682. DOC_START
  1683. Average object size, used to estimate number of objects your
  1684. cache can hold.  See doc/Release-Notes-1.1.txt.  The default is
  1685. 13 KB.
  1686. store_avg_object_size 13 KB
  1687. DOC_END
  1688. NAME: store_objects_per_bucket
  1689. TYPE: int
  1690. DEFAULT: 50
  1691. LOC: Config.Store.objectsPerBucket
  1692. DOC_START
  1693. Target number of objects per bucket in the store hash table.
  1694. Lowering this value increases the total number of buckets and
  1695. also the storage maintenance rate.  The default is 20.
  1696. store_objects_per_bucket 20
  1697. DOC_END
  1698. NAME: client_db
  1699. COMMENT: on|off
  1700. TYPE: onoff
  1701. DEFAULT: on
  1702. LOC: Config.onoff.client_db
  1703. DOC_START
  1704. If you want to disable collecting per-client statistics, then
  1705. turn off client_db here.
  1706. client_db on
  1707. DOC_END
  1708. NAME: netdb_low
  1709. TYPE: int
  1710. DEFAULT: 900
  1711. LOC: Config.Netdb.low
  1712. DOC_NONE
  1713. NAME: netdb_high
  1714. TYPE: int
  1715. DEFAULT: 1000
  1716. LOC: Config.Netdb.high
  1717. DOC_START
  1718. The low and high water marks for the ICMP measurement
  1719. database.  These are counts, not percents.  The defaults are
  1720. 900 and 1000.  When the high water mark is reached, database
  1721. entries will be deleted until the low mark is reached.
  1722. netdb_low 900
  1723. netdb_high 1000
  1724. DOC_END
  1725. NAME: netdb_ping_period
  1726. TYPE: time_t
  1727. LOC: Config.Netdb.period
  1728. DEFAULT: 5 minutes
  1729. DOC_START
  1730. The minimum period for measuring a site.  There will be at
  1731. least this much delay between successive pings to the same
  1732. network.  The default is five minutes.
  1733. netdb_ping_period 5 minutes
  1734. DOC_END
  1735. NAME: query_icmp
  1736. COMMENT: on|off
  1737. TYPE: onoff
  1738. DEFAULT: off
  1739. LOC: Config.onoff.query_icmp
  1740. DOC_START
  1741. If you want to ask your peers to include ICMP data in their ICP
  1742. replies, enable this option.
  1743. If your peer has configured Squid (during compilation) with
  1744. '--enable-icmp' then that peer will send ICMP pings to origin server
  1745. sites of the URLs it receives.  If you enable this option then the
  1746. ICP replies from that peer will include the ICMP data (if available).
  1747. Then, when choosing a parent cache, Squid will choose the parent with
  1748. the minimal RTT to the origin server.  When this happens, the
  1749. hierarchy field of the access.log will be
  1750. "CLOSEST_PARENT_MISS".  This option is off by default.
  1751. query_icmp off
  1752. DOC_END
  1753. NAME: test_reachability
  1754. COMMENT: on|off
  1755. TYPE: onoff
  1756. DEFAULT: off
  1757. LOC: Config.onoff.test_reachability
  1758. DOC_START
  1759. When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH
  1760. instead of ICP_MISS if the target host is NOT in the ICMP
  1761. database, or has a zero RTT.
  1762. test_reachability off
  1763. DOC_END
  1764. NAME: buffered_logs
  1765. COMMENT: on|off
  1766. TYPE: onoff
  1767. DEFAULT: off
  1768. LOC: Config.onoff.buffered_logs
  1769. DOC_START
  1770. Some log files (cache.log, useragent.log) are written with
  1771. stdio functions, and as such they can be buffered or
  1772. unbuffered.  By default they will be unbuffered. Buffering them
  1773. can speed up the writing slightly (though you are unlikely to
  1774. need to worry).
  1775. buffered_logs off
  1776. DOC_END
  1777. NAME: reload_into_ims
  1778. IFDEF: HTTP_VIOLATIONS
  1779. COMMENT: on|off
  1780. TYPE: onoff
  1781. DEFAULT: off
  1782. LOC: Config.onoff.reload_into_ims
  1783. DOC_START
  1784. When you enable this option, client no-cache or ``reload''
  1785. requests will be changed to If-Modified-Since requests.
  1786. Doing this VIOLATES the HTTP standard.  Enabling this
  1787. feature could make you liable for problems which it
  1788. causes.
  1789. see also refresh_pattern for a more selective approach.
  1790. reload_into_ims off
  1791. DOC_END
  1792. NAME: always_direct
  1793. TYPE: acl_access
  1794. LOC: Config.accessList.AlwaysDirect
  1795. DEFAULT: none
  1796. DOC_START
  1797. Usage: always_direct allow|deny [!]aclname ...
  1798. Here you can use ACL elements to specify requests which should
  1799. ALWAYS be forwarded directly to origin servers.  For example,
  1800. to always directly forward requests for local servers use
  1801. something like:
  1802. acl local-servers dstdomain my.domain.net
  1803. always_direct allow local-servers
  1804. To always forward FTP requests directly, use
  1805. acl FTP proto FTP
  1806. always_direct allow FTP
  1807. NOTE: There is a similar, but opposite option named
  1808. 'never_direct'.  You need to be aware that "always_direct deny
  1809. foo" is NOT the same thing as "never_direct allow foo".  You
  1810. may need to use a deny rule to exclude a more-specific case of
  1811. some other rule.  Example:
  1812. acl local-external dstdomain external.foo.net
  1813. acl local-servers dstdomain  foo.net
  1814. always_direct deny local-external
  1815. always_direct allow local-servers
  1816. This option replaces some v1.1 options such as local_domain
  1817. and local_ip.
  1818. DOC_END
  1819. NAME: never_direct
  1820. TYPE: acl_access
  1821. LOC: Config.accessList.NeverDirect
  1822. DEFAULT: none
  1823. DOC_START
  1824. Usage: never_direct allow|deny [!]aclname ...
  1825. never_direct is the opposite of always_direct.  Please read
  1826. the description for always_direct if you have not already.
  1827. With 'never_direct' you can use ACL elements to specify
  1828. requests which should NEVER be forwarded directly to origin
  1829. servers.  For example, to force the use of a proxy for all
  1830. requests, except those in your local domain use something like:
  1831. acl local-servers dstdomain foo.net
  1832. acl all src 0.0.0.0/0.0.0.0
  1833. never_direct deny local-servers
  1834. never_direct allow all
  1835. or if squid is inside a firewall and there is local intranet
  1836. servers inside the firewall then use something like:
  1837. acl local-intranet dstdomain foo.net
  1838. acl local-external dstdomain external.foo.net
  1839. always_direct deny local-external
  1840. always_direct allow local-intranet
  1841. never_direct allow all
  1842. This option replaces some v1.1 options such as inside_firewall
  1843. and firewall_ip.
  1844. DOC_END
  1845. NAME: anonymize_headers
  1846. TYPE: http_header
  1847. LOC: Config.anonymize_headers
  1848. DEFAULT: none
  1849. DOC_START
  1850.         Usage: anonymize_headers allow|deny header_name ...
  1851. This option replaces the old 'http_anonymizer' option with
  1852. something that is much more configurable.  You may now
  1853. specify exactly which headers are to be allowed, or which
  1854. are to be removed from outgoing requests.
  1855. There are two methods of using this option.  You may either
  1856. allow specific headers (thus denying all others), or you
  1857. may deny specific headers (thus allowing all others).
  1858. For example, to achieve the same behaviour as the old
  1859. 'http_anonymizer standard' option, you should use:
  1860. anonymize_headers deny From Referer Server
  1861. anonymize_headers deny User-Agent WWW-Authenticate Link
  1862. Or, to reproduce the old 'http_anonymizer paranoid' feature
  1863. you should use:
  1864. anonymize_headers allow Allow Authorization Cache-Control
  1865. anonymize_headers allow Content-Encoding Content-Length
  1866. anonymize_headers allow Content-Type Date Expires Host
  1867. anonymize_headers allow If-Modified-Since Last-Modified
  1868. anonymize_headers allow Location Pragma Accept Charset
  1869. anonymize_headers allow Accept-Encoding Accept-Language
  1870. anonymize_headers allow Content-Language Mime-Version
  1871. anonymize_headers allow Retry-After Title Connection
  1872. anonymize_headers allow Proxy-Connection
  1873. NOTE: You can not mix "allow" and "deny".  All 'anonymize_headers'
  1874. lines must have the same second argument.
  1875. By default, all headers are allowed (no anonymizing is
  1876. performed).
  1877. anonymize_headers
  1878. DOC_END
  1879. NAME: fake_user_agent
  1880. TYPE: eol
  1881. LOC: Config.fake_ua
  1882. DEFAULT: none
  1883. DOC_START
  1884. If you filter the User-Agent header with 'anonymize_headers' it
  1885. may cause some Web servers to refuse your request.  Use this to
  1886. fake one up.  For example:
  1887. fake_user_agent Nutscrape/1.0 (CP/M; 8-bit)
  1888. (credit to Paul Southworth pauls@etext.org for this one!)
  1889. fake_user_agent none
  1890. DOC_END
  1891. NAME: icon_directory
  1892. TYPE: string
  1893. LOC: Config.icons.directory
  1894. DEFAULT: @DEFAULT_ICON_DIR@
  1895. DOC_START
  1896. Where the icons are stored. These are normally kept in
  1897. @DEFAULT_ICON_DIR@
  1898. DOC_END
  1899. NAME: error_directory
  1900. TYPE: string
  1901. LOC: Config.errorDirectory
  1902. DEFAULT: @DEFAULT_ERROR_DIR@
  1903. DOC_START
  1904. If you wish to create your own versions of the default
  1905. (English) error files, either to customise them to suit your
  1906. language or company copy the template english files to another
  1907. directory and point this tag at them.
  1908. DOC_END
  1909. NAME: minimum_retry_timeout
  1910. COMMENT: (seconds)
  1911. TYPE: time_t
  1912. LOC: Config.retry.timeout
  1913. DEFAULT: 5 seconds
  1914. DOC_START
  1915. This specifies the minimum connect timeout, for when the
  1916. connect timeout is reduced to compensate for the availability
  1917. of multiple IP addresses.
  1918. When a connection to a host is initiated, and that host has
  1919. several IP addresses, the default connection timeout is reduced
  1920. by dividing it by the number of addresses.  So, a site with 15
  1921. addresses would then have a timeout of 8 seconds for each
  1922. address attempted.  To avoid having the timeout reduced to the
  1923. point where even a working host would not have a chance to
  1924. respond, this setting is provided.  The default, and the
  1925. minimum value, is five seconds, and the maximum value is sixty
  1926. seconds, or half of connect_timeout, whichever is greater and
  1927. less than connect_timeout.
  1928. minimum_retry_timeout 5 seconds
  1929. DOC_END
  1930. NAME: maximum_single_addr_tries
  1931. TYPE: int
  1932. LOC: Config.retry.maxtries
  1933. DEFAULT: 3
  1934. DOC_START
  1935. This sets the maximum number of connection attempts for a
  1936. host that only has one address (for multiple-address hosts,
  1937. each address is tried once).
  1938. The default value is three tries, the (not recommended)
  1939. maximum is 255 tries.  A warning message will be generated
  1940. if it is set to a value greater than ten.
  1941. maximum_single_addr_tries 3
  1942. DOC_END
  1943. NAME: snmp_port
  1944. TYPE: ushort
  1945. LOC: Config.Port.snmp
  1946. DEFAULT: 3401
  1947. IFDEF: SQUID_SNMP
  1948. DOC_START
  1949. Squid can now serve statistics and status information via SNMP.
  1950. By default it listens to port 3401 on the machine. If you don't
  1951. wish to use SNMP, set this to '-1'.
  1952. NOTE: SNMP support requires use the --enable-snmp configure
  1953. command line option.
  1954. snmp_port 3401
  1955. DOC_END
  1956. NAME: forward_snmpd_port
  1957. TYPE: ushort
  1958. LOC: Config.Snmp.localPort
  1959. DEFAULT: 0
  1960. IFDEF: SQUID_SNMP
  1961. DOC_START
  1962. This configures whether we should be forwarding SNMP requests
  1963. to another snmpd. The reason for putting this piece of
  1964. functionality into Squid was to enable access to the system's
  1965. installed snmpd with minimal changes.  This option is turned
  1966. off by default, check with your /etc/services for your system's
  1967. snmp port (usually 161).  We do not use getservbyname() to
  1968. allow you to set Squid into port 161 and your system's snmpd to
  1969. another port by changing /etc/services.
  1970. WARNING: Because of Squid acting as a proxy snmpd for system
  1971. you have to do security checks on THIS snmpd for all objects.
  1972. Check your snmp_config_file.
  1973. forward_snmpd_port 0
  1974. DOC_END
  1975. NAME: snmp_access
  1976. TYPE: acl_access
  1977. LOC: Config.accessList.snmp
  1978. DEFAULT: none
  1979. DEFAULT_IF_NONE: deny all
  1980. IFDEF: SQUID_SNMP
  1981. DOC_START
  1982. Allowing or denying access to the SNMP port.
  1983. All access to the agent is denied by default.
  1984. usage:
  1985. snmp_access allow|deny [!]aclname ...
  1986. Example:
  1987. snmp_access allow public localhost
  1988. snmp_access deny all
  1989. DOC_END
  1990. NAME: snmp_incoming_address
  1991. TYPE: address
  1992. LOC: Config.Addrs.snmp_outgoing
  1993. DEFAULT: 0.0.0.0
  1994. IFDEF: SQUID_SNMP
  1995. DOC_NONE
  1996. NAME: snmp_outgoing_address
  1997. TYPE: address
  1998. LOC: Config.Addrs.snmp_outgoing
  1999. DEFAULT: 255.255.255.255
  2000. IFDEF: SQUID_SNMP
  2001. DOC_START
  2002. Just like 'udp_incoming_address' above, but for the SNMP port.
  2003. snmp_incoming_address is used for the SNMP socket receiving
  2004. messages from SNMP agents.
  2005. snmp_outgoing_address is used for SNMP packets returned to SNMP
  2006. agents.
  2007. The default behaviour is to not bind to any specific address.
  2008. NOTE, snmp_incoming_address and snmp_outgoing_address can not have
  2009. the same value since they both use port 3130.
  2010. snmp_incoming_address 0.0.0.0
  2011. snmp_outgoing_address 0.0.0.0
  2012. DOC_END
  2013. NAME: as_whois_server
  2014. TYPE: string
  2015. LOC: Config.as_whois_server
  2016. DEFAULT: whois.ra.net
  2017. DEFAULT_IF_NONE: whois.ra.net
  2018. DOC_START
  2019. WHOIS server to query for AS numbers.  NOTE: AS numbers are
  2020. queried only when Squid starts up, not for every request.
  2021. DOC_END
  2022. COMMENT_START
  2023.  DELAY POOL PARAMETERS (all require DELAY_POOLS compilation option)
  2024.  -----------------------------------------------------------------------------
  2025. COMMENT_END
  2026. NAME: delay_pools
  2027. TYPE: delay_pool_count
  2028. DEFAULT: 0
  2029. IFDEF: DELAY_POOLS
  2030. LOC: Config.Delay
  2031. DOC_START
  2032. This represents the number of delay pools to be used.  For example,
  2033. if you have one class 2 delay pool and one class 3 delays pool, you
  2034. have a total of 2 delay pools.
  2035. delay_pools 0
  2036. DOC_END
  2037. NAME: delay_class
  2038. TYPE: delay_pool_class
  2039. DEFAULT: none
  2040. IFDEF: DELAY_POOLS
  2041. LOC: Config.Delay
  2042. DOC_START
  2043. This defines the class of each delay pool.  There must be exactly one
  2044. delay_class line for each delay pool.  For example, to define two
  2045. delay pools, one of class 2 and one of class 3, the settings above
  2046. and here would be:
  2047. delay_pools 2      # 2 delay pools
  2048. delay_class 1 2    # pool 1 is a class 2 pool
  2049. delay_class 2 3    # pool 2 is a class 3 pool
  2050. The delay pool classes are:
  2051. class 1 Everything is limited by a single aggregate
  2052. bucket.
  2053. class 2  Everything is limited by a single aggregate
  2054. bucket as well as an "individual" bucket chosen
  2055. from bits 25 through 32 of the IP address.
  2056. class 3 Everything is limited by a single aggregate
  2057. bucket as well as a "network" bucket chosen
  2058. from bits 17 through 24 of the IP address and a
  2059. "individual" bucket chosen from bits 17 through
  2060. 32 of the IP address.
  2061. NOTE: If an IP address is a.b.c.d
  2062. -> bits 25 through 32 are "d"
  2063. -> bits 17 through 24 are "c"
  2064. -> bits 17 through 32 are "c * 256 + d"
  2065. DOC_END
  2066. NAME: delay_access
  2067. TYPE: delay_pool_access
  2068. DEFAULT: none
  2069. IFDEF: DELAY_POOLS
  2070. LOC: Config.Delay
  2071. DOC_START
  2072. This is used to determine which delay pool a request falls into.
  2073. The first matched delay pool is always used, ie, if a request falls
  2074. into delay pool number one, no more delay are checked, otherwise the
  2075. rest are checked in order of their delay pool number until they have
  2076. all been checked.  For example, if you want some_big_clients in delay
  2077. pool 1 and lotsa_little_clients in delay pool 2:
  2078. delay_access 1 allow some_big_clients
  2079. delay_access 1 deny all
  2080. delay_access 2 allow lotsa_little_clients
  2081. delay_access 2 deny all
  2082. DOC_END
  2083. NAME: delay_parameters
  2084. TYPE: delay_pool_rates
  2085. DEFAULT: none
  2086. IFDEF: DELAY_POOLS
  2087. LOC: Config.Delay
  2088. DOC_START
  2089. This defines the parameters for a delay pool.  Each delay pool has
  2090. a number of "buckets" associated with it, as explained in the
  2091. description of delay_class.  For a class 1 delay pool, the syntax is:
  2092. delay_parameters pool aggregate
  2093. For a class 2 delay pool:
  2094. delay_parameters pool aggregate individual
  2095. For a class 3 delay pool:
  2096. delay_parameters pool aggregate network individual
  2097. The variables here are:
  2098. pool a pool number - ie, a number between 1 and the
  2099. number specified in delay_pools as used in
  2100. delay_class lines.
  2101. aggregate the "delay parameters" for the aggregate bucket
  2102. (class 1, 2, 3).
  2103. individual the "delay parameters" for the individual
  2104. buckets (class 2, 3).
  2105. network the "delay parameters" for the network buckets
  2106. (class 3).
  2107. A pair of delay parameters is written restore/maximum, where restore is
  2108. the number of bytes (not bits - modem and network speeds are usually
  2109. quoted in bits) per second placed into the bucket, and maximum is the
  2110. maximum number of bytes which can be in the bucket at any time.
  2111. For example, if delay pool number 1 is a class 2 delay pool as in the
  2112. above example, and is being used to strictly limit each host to 64kbps
  2113. (plus overheads), with no overall limit, the line is:
  2114. delay_parameters 1 -1/-1 8000/8000
  2115. Note that the figure -1 is used to represent "unlimited".
  2116. And, if delay pool number 2 is a class 3 delay pool as in the above
  2117. example, and you want to limit it to a total of 256kbps (strict limit)
  2118. with each 8-bit network permitted 64kbps (strict limit) and each
  2119. individual host permitted 4800bps with a bucket maximum size of 64kb
  2120. to permit a decent web page to be downloaded at a decent speed
  2121. (if the network is not being limited due to overuse) but slow down
  2122. large downloads more significantly:
  2123. delay_parameters 2 32000/32000 8000/8000 600/64000
  2124. There must be one delay_parameters line for each delay pool.
  2125. DOC_END
  2126. NAME: delay_initial_bucket_level
  2127. COMMENT: (percent, 0-100)
  2128. TYPE: ushort
  2129. DEFAULT: 50
  2130. IFDEF: DELAY_POOLS
  2131. LOC: Config.Delay.initial
  2132. DOC_START
  2133. The initial bucket percentage is used to determine how much is put
  2134. in each bucket when squid starts, is reconfigured, or first notices
  2135. a host accessing it (in class 2 and class 3, individual hosts and
  2136. networks only have buckets associated with them once they have been
  2137. "seen" by squid).
  2138. delay_initial_bucket_level 50
  2139. DOC_END
  2140. NAME: incoming_icp_average
  2141. TYPE: int
  2142. DEFAULT: 6
  2143. LOC: Config.comm_incoming.icp_average
  2144. DOC_NONE
  2145. NAME: incoming_http_average
  2146. TYPE: int
  2147. DEFAULT: 4
  2148. LOC: Config.comm_incoming.http_average
  2149. DOC_NONE
  2150. NAME: min_icp_poll_cnt
  2151. TYPE: int
  2152. DEFAULT: 8
  2153. LOC: Config.comm_incoming.icp_min_poll
  2154. DOC_NONE
  2155. NAME: min_http_poll_cnt
  2156. TYPE: int
  2157. DEFAULT: 8
  2158. LOC: Config.comm_incoming.http_min_poll
  2159. DOC_START
  2160. Heavy voodoo here.  I can't even believe you are reading this.
  2161. Are you crazy?  Don't even think about adjusting these unless
  2162. you understand the algorithms in comm_select.c first!
  2163. incoming_icp_average 6
  2164. incoming_http_average 4
  2165. min_icp_poll_cnt 8
  2166. min_http_poll_cnt 8
  2167. DOC_END
  2168. NAME: max_open_disk_fds
  2169. TYPE: int
  2170. LOC: Config.max_open_disk_fds
  2171. DEFAULT: 0
  2172. DOC_NONE
  2173. NAME: offline_mode
  2174. TYPE: onoff
  2175. LOC: Config.onoff.offline
  2176. DEFAULT: off
  2177. DOC_START
  2178. Enable this option and Squid will never try to validate cached
  2179. objects.
  2180. DOC_END
  2181. NAME: uri_whitespace
  2182. TYPE: uri_whitespace
  2183. LOC: Config.uri_whitespace
  2184. DEFAULT: deny
  2185. DOC_START
  2186. What to do with requests that have whitespace characters in the
  2187. URI.  Options:
  2188. deny:   The request is denied.  The user receives an "Invalid
  2189. Request" message.
  2190. allow:  The request is allowed and the URI is not changed.  The
  2191. whitespace characters remain in the URI.  Note the
  2192. whitespace is passed to redirector processes if they
  2193. are in use.
  2194. encode: The request is allowed and the whitespace characters are
  2195. encoded according to RFC1738.  This could be considered
  2196. a violation of the HTTP/1.1
  2197. RFC because proxies are not allowed to rewrite URI's.
  2198. chop: The request is allowed and the URI is chopped at the
  2199. first whitespace.  This might also be considered a
  2200. violation.
  2201. uri_whitespace deny
  2202. DOC_END
  2203. NAME: broken_posts
  2204. TYPE: acl_access
  2205. DEFAULT: none
  2206. LOC: Config.accessList.brokenPosts
  2207. DOC_START
  2208. A list of ACL elements which, if matched, causes Squid to send
  2209. a extra CRLF pair after the body of a PUT/POST request.
  2210. Some HTTP servers has broken implementations of PUT/POST,
  2211. and rely on a extra CRLF pair sent by some WWW clients.
  2212. Quote from RFC 2068 section 4.1 on this matter:
  2213.   Note: certain buggy HTTP/1.0 client implementations generate an
  2214.   extra CRLF's after a POST request. To restate what is explicitly
  2215.   forbidden by the BNF, an HTTP/1.1 client must not preface or follow
  2216.   a request with an extra CRLF.
  2217. acl buggy_server url_regex ^http://....
  2218. broken_posts allow buggy_server
  2219. DOC_END
  2220. NAME: mcast_miss_addr
  2221. IFDEF: MULTICAST_MISS_STREAM
  2222. TYPE: address
  2223. LOC: Config.mcast_miss.addr
  2224. DEFAULT: 255.255.255.255
  2225. DOC_START
  2226. If you enable this option, every "cache miss" URL will
  2227. be sent out on the specified multicast address.
  2228. Do not enable this option unless you are are absolutely
  2229. certain you understand what you are doing.
  2230. DOC_END
  2231. NAME: mcast_miss_port
  2232. IFDEF: MULTICAST_MISS_STREAM
  2233. TYPE: ushort
  2234. LOC: Config.mcast_miss.port
  2235. DEFAULT: 3135
  2236. DOC_START
  2237. This is the port number to be used in conjuction with
  2238. 'mcast_miss_addr'.
  2239. DOC_END
  2240. NAME: mcast_miss_encode_key
  2241. IFDEF: MULTICAST_MISS_STREAM
  2242. TYPE: string
  2243. LOC: Config.mcast_miss.encode_key
  2244. DEFAULT: XXXXXXXXXXXXXXXX
  2245. DOC_START
  2246. The URLs that are sent in the multicast miss stream are
  2247. encrypted.  This is the encryption key.
  2248. DOC_END
  2249. NAME: prefer_direct
  2250. TYPE: onoff
  2251. LOC: Config.onoff.prefer_direct
  2252. DEFAULT: on
  2253. DOC_START
  2254. By default, if the ICP, HTCP, Cache Digest, etc. techniques
  2255. do not yield a parent cache, Squid gives higher preference
  2256. to forwarding the request direct to origin servers, rather
  2257. than selecting a parent cache anyway.
  2258. If you want Squid to give higher precedence to a parent
  2259. cache, instead of going direct, then turn this option off.
  2260. prefer_direct on
  2261. DOC_END
  2262. NAME: strip_query_terms
  2263. TYPE: onoff
  2264. LOC: Config.onoff.strip_query_terms
  2265. DEFAULT: on
  2266. DOC_START
  2267. By default, Squid strips query terms from requested URLs before
  2268. logging.  This protects your user's privacy.
  2269. strip_query_terms on
  2270. DOC_END
  2271. EOF