Squid 2.4 Stable1 Configuration Manual |
||
Previous |
Tag Name |
delay_pools |
|
Usage |
delay_pools numbers |
|
Description |
||
This represents the number of delay pools to be used. For example, if you have one class 2 delay pool and one class 3 delay pool, you have a total of 2 delay pools. Delay pools allow you to limit traffic for clients or client groups, with various features. Objects retrieved from the cache will not be delayed. Only the object from the server will be delayed. This option is only available if Squid is rebuiltwith the --enable-delaypools option |
||
Default |
delay_pools 0 |
|
Example |
delay_pools 2 |
|
Caution To enable this option, you must use --enable-delay-pools with the # configure script. |
Tag Name |
delay_class |
|
Usage |
delay_class number (delay-pool number), number (delay class) |
|
Description |
||
This defines the class of each delay pool. There must be exactly one delay_class line for each delay pool. For example, to define two delay pools; one of class 2 and one of class 3, the settings will be like as given in the example. For details on the delay pool classes see Glossary. This option is only available if Squid is rebuilt with the --enable-delaypools option |
||
Default |
none |
|
Example delay_pools 2 # 2 delay pools delay_class 1 2 # pool 1 is a class 2 pool delay_class 2 3 # pool 2 is a class 3 pool |
||
Caution |
- |
Tag Name |
delay_access |
|
Usage |
delay_access allow acl name|deny acl name |
|
Description |
||
This is used to determine which delay pool a request falls into. The first matched delay pool is always used, i.e., if a request falls into delay pool number one, no more delay are checked, otherwise the rest are checked in order of their delay pool number until they have all been checked. For example, if you want some_big_clients in delay pool 1 and lotsa_little_clients in delay pool 2 then look atthe example below. This option is only available if Squid is rebuiltwith the --enable-delaypools option |
||
Default |
none |
|
Example delay_access 1 allow some_big_clients delay_access 1 deny all delay_access 2 allow lotsa_little_clients delay_access 2 deny all |
||
Caution |
- |
Tag Name |
delay_parameters |
|
Usage |
delay_parameters pool aggregate (for delay_class 1 networks) delay_parameters pool aggregate individual (for delay_class 2 networks) delay_parameters pool aggregate network individual (for delay_class 3 networks) |
|
Description |
||
This defines the parameters for a delay pool. Each delay pool has number of "buckets" associated with it, as explained in the description of delay_class. For a class 1,2 and 3 delay pool, the syntax is given in the usage. For Glossary of term related to delay_pool see Glossary . This option is only availableif Squid is rebuilt with the --enable-delaypools option |
||
Default |
none |
|
Example1 |
||
acl tech src 192.168.0.1/32-192.168.0.20/32 acl no_hotmail url_regex -i hotmail acl all 0.0.0.0/0 delay_pools 1 #Number of delay_pool 1 delay_class 1 1 #pool 1 is a delay_class 1 delay_parameters 1 100/100 delay_access 1 allow no_hotmail !tech In the above example hotmail users are limited to the speed of specified in the delay_class. IP’s in the ACL tech are allowed in the normal bandwidth. You can see the usage of bandwidth through cachemgr.cgi. |
||
Example2 |
||
The above example tells that the squid is limited to the bandwidth of 512k.For ACL you can go Here . |
||
Caution |
- |
Tag Name |
delay_initial_bucket_level |
|
Usage |
delay_initial_bucket_level bytes |
|
Description |
||
The initial bucket percentage is used to determine how much is put in each bucket when squid starts, is reconfigured, or firstnotices a host accessing it (in class 2 and class 3, individual hostsand networks only have buckets associated with them once they havebeen "seen" by squid). This option is only available if Squid is rebuiltwith the --enable-delaypools option. |
||
Default |
delay_initial_bucket_level 50(bytes) |
|
Example |
- |
|
Caution |
- |
Tag Name |
|
|
Usage |
TagName Number |
|
Description |
||
This describes the algorithms used for the above tags. INCOMING sockets are the ICP and HTTP ports. We need to check these fairly regularly, but how often? When the load increases, we want to check the incoming sockets more often. If we have a lot of incoming ICP, then we need to check these sockets more than if we just haveHTTP. The variables 'incoming_icp_interval' and 'incoming_http_interval'determine how many normal I/O events to process before checking incomingsockets again. Note we store the incoming_interval multiplied by afactor of (2^INCOMING_FACTOR) to have some pseudo-floating point precision. The variable 'icp_io_events' and 'http_io_events' counts how many normal I/O events have been processed since the last check on the incoming sockets. When io_events > incoming_interval, its time to check incoming sockets. Every time we check incoming sockets, we count how many new messages or connections were processed. This is used to adjust the incoming_interval for the next iteration. The new incoming_interval is calculated asthe current incoming_interval plus what we would like to see as anaverage number of events minus the number of events just processed. incoming_interval = incoming_interval + target_average - number_of_events_processed There are separate incoming_interval counters for both HTTP and ICP events. You can see the current values of the incoming_interval, as well as a histogram of 'incoming_events' by asking the cache manager for 'comm_incoming', e.g.: % ./client mgr:comm_incoming |
||
|
||
Example |
- |
|
Caution -We have MAX_INCOMING_INTEGER as a magic upper limit on incoming_interval for both types of sockets. At the largest value the cache will effectively be idling. -The higher the INCOMING_FACTOR, the slower the algorithm will respond to load spikes/increases/decreases in demand. A value between 3 and 8 is recommended |
Tag Name |
max_open_disk_fds |
|
Usage |
max_open_disk_fds number |
|
Description |
||
This specifies the maximum file descriptor squid can use to open files. To avoid having disk as the I/O bottleneck Squid can optionally bypass the on-disk cache if more than this amount of disk file descriptors are open. A value of 0 indicates no limit |
||
Default |
max_open_disk_fds 0 |
|
Example |
- |
|
Caution |
- |
Tag Name |
offline_mode |
|
Usage |
offline_mode on|off |
|
Description |
||
Enable this option and Squid will never try to validatecached objects. |
||
Default |
offline_mode off |
|
Example |
- |
|
Caution |
- |
Tag Name |
uri_whitespace |
|
Usage |
uri_whitespace options |
|
Description |
||
The action to be done on the requests that have whitespace characters in the URI is decided with this tag. Available options: strip: The whitespace characters are stripped out of the URL. This is thebehavior recommended by RFC2616. deny: The request is denied. The user receives an "Invalid Request" message. allow: The request is allowed and the URI is not changed. The whitespace characters remain in the URI. Note the whitespace is passed to redirector processes if they are in use. Encode: The request is allowed and the whitespace characters are encoded according to RFC1738. This could be considered a violation of the HTTP/1.1 RFC because proxies are not allowed to rewrite URI's. chop: The request is allowed and the URI is chopped at the first whitespace. This might also be considered a violation |
||
Default |
uri_whitespace strip |
|
Example |
uri_whitespace chop |
|
Caution |
- |
Tag Name |
broken_posts |
|
Usage |
broken_posts allow|deny acl name |
|
Description |
||
A list of ACL elements which, if matched, causes Squid to send a extra CRLF pair after the body of a PUT/POST request. Some HTTP servers have broken implementations of PUT/POST, and rely on an extra CRLF pair sent by some WWW clients |
||
Default |
none |
|
Example acl buggy_server url_regex ^http://.... broken_posts allow buggy_server |
||
Caution |
- |
Tag Name |
mcast_miss_addr |
|
Usage |
mcast_miss_addr enable|disable |
|
Description |
||
If you enable this option, every "cache miss" URL will be sent out on the specified multicast address. This option is only available if Squid is rebuilt with the -DMULTICAST_MISS_STREAM option |
||
Default |
mcast_miss_addr 255.255.255.255 |
|
Caution This option should be enabled only after a careful understanding. See multicast |
Tag Name |
mcast_miss_ttl |
|
Usage |
mcast_miss_ttl time-units |
|
Description |
||
This is the time-to-live value for packets multicasted when multicasting off cache miss URLs is enabled. This option is only available if Squid is rebuilt with the -DMULTICAST_MISS_TTL option |
||
Default |
mcast_miss_ttl 16 |
|
Example |
- |
|
Caution |
- |
Tag Name |
mcast_miss_port |
|
Usage |
mcast_miss_port port no |
|
Description |
||
This is the port number to be used in conjunction with 'mcast_miss_addr'. This option is only available if Squid is rebuilt with the -DMULTICAST_MISS_TTL option |
||
Default |
mcast_miss_port 3135 |
|
Example |
- |
|
Caution This tag is used only when u enable mcast_miss_addr |
Tag Name |
mcast_miss_encode_key |
|
Usage |
mcast_miss_encode_key enable|disable |
|
Description |
||
The URLs that are sent in the multicast miss stream areencrypted. This is the encryption key. This option is only availableif Squid is rebuilt with the -DMULTICAST_MISS_STREAM option |
||
Default |
mcast_miss_encode_key XXXXXXXXXXXXXXX |
|
Example |
- |
|
Caution |
- |
Tag Name |
nonhierarchical_direct |
|
Usage |
nonhierarchical_direct on|off |
|
Description |
||
By default, Squid will send any non-hierarchical requests (matching hierarchy_stoplist or not cacheable request type) directto origin servers. If you set this to off, then Squid will prefer tosend these requests to parents. Note that in most configurations, byturning this off you will only add latency to this request withoutany improvement in global hit ratio. If you are inside a firewall thensee never_direct insteadof this directive |
||
Default |
nonhierarchical_direct on |
|
Example |
- |
|
Caution |
- |
Tag Name |
prefer_direct |
|
Usage |
prefer_direct on|off |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
strip_query_terms |
|
Usage |
strip_query_terms on|off |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
coredump_dir |
|
Usage |
coredump_dir directory |
|
Description |
||
|
||
Default |
|
|
Example |
coredump_dir /usr/local |
|
Caution |
- |
Tag Name |
redirector_bypass |
|
Usage |
redirector_bypass on|off |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
ignore_unknown_nameservers |
|
Usage |
ignore_unknown_nameservers on|off |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
digest_generation |
|
Usage |
digest_generation on|off |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
digest_bits_per_entry |
|
Usage |
digest_bits_per_entry number |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
digest_rebuild_period |
|
Usage |
digest_rebuild_period time-units |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
digest_rewrite_period |
|
Usage |
digest_rewrite_period time-units |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
digest_swapout_chunk_size |
|
Usage |
digest_swapout_chunk_size bytes |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
digest_rebuild_chunk_percentage |
|
Usage |
digest_rebuild_chunk_percentage %(0 to 100) |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
chroot |
|
Usage |
chroot enable|disable |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
client_persistent_connections |
|
Usage |
client_persistent_connections on|off |
|
Description |
||
Persistent connection support for clients and servers. By default,
Squid uses persistent connections (when allowed) with its clients and servers.
You can use these options to disable persistent connections with clientsand/or
server. |
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
server_persistent_connections |
|
Usage |
server_persistent_connections on|off |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
pipeline_prefetch |
|
Usage |
pipeline_prefetch on|off |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
extension_methods |
|
Usage |
extension_methods requestmethod |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
high_response_time_warning |
|
Usage |
high_response_time_warning msec |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
high_page_fault_warning |
|
Usage |
high_page_fault_warning time-units |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
high_memory_warning |
|
Usage |
high_memory_warning number |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
store_dir_select_algorithm |
|
Usage |
store_dir_select_algorithm algorithm type |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |
Tag Name |
ie_refresh |
|
Usage |
ie_refresh on|off |
|
Description |
||
|
||
Default |
|
|
Example |
- |
|
Caution |
- |