Squid configuration directives 3.0

	WELCOME TO SQUID 3.0.STABLE25-20100412
	----------------------------

	This is the default Squid configuration file. You may wish
	to look at the Squid home page (http://www.squid-cache.org/)
	for the FAQ and other documentation.

	The default Squid config file shows what the defaults for
	various options happen to be.  If you don't need to change the
	default, you shouldn't uncomment the line.  Doing so may cause
	run-time problems.  In some cases "none" refers to no default
	setting at all, while in other cases it refers to a valid
	option - the comments for that keyword indicate if this is the
	case.

  Configuration options can be included using the "include" directive.
  Include takes a list of files to include. Quoting and wildcards is
  supported.

  For example,

  include /path/to/included/file/squid.acl.config

  Includes can be nested up to a hard-coded depth of 16 levels.
  This arbitrary restriction is to prevent recursive include references
  from causing Squid entering an infinite loop whilst trying to load
  configuration files.

 OPTIONS FOR AUTHENTICATION
 -----------------------------------------------------------------------------

• auth_param

• authenticate_cache_garbage_interval
• authenticate_ttl
• authenticate_ip_ttl

 ACCESS CONTROLS
 -----------------------------------------------------------------------------

• external_acl_type

• acl
• http_access
• http_reply_access
• icp_access
• htcp_access
• htcp_clr_access
• miss_access
• ident_lookup_access
• reply_body_max_size

 NETWORK OPTIONS
 -----------------------------------------------------------------------------

• http_port

• https_port
• tcp_outgoing_tos
• clientside_tos
• tcp_outgoing_address

 SSL OPTIONS
 -----------------------------------------------------------------------------

• ssl_unclean_shutdown

• ssl_engine
• sslproxy_client_certificate
• sslproxy_client_key
• sslproxy_version
• sslproxy_options
• sslproxy_cipher
• sslproxy_cafile
• sslproxy_capath
• sslproxy_flags
• sslpassword_program

 OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM
 -----------------------------------------------------------------------------

• cache_peer

• cache_peer_domain
• cache_peer_access
• neighbor_type_domain
• dead_peer_timeout
• hierarchy_stoplist

 MEMORY CACHE OPTIONS
 -----------------------------------------------------------------------------

• cache_mem

• maximum_object_size_in_memory
• memory_replacement_policy

 DISK CACHE OPTIONS
 -----------------------------------------------------------------------------

• cache_replacement_policy

• cache_dir
• store_dir_select_algorithm
• max_open_disk_fds
• minimum_object_size
• maximum_object_size
• cache_swap_low
• cache_swap_high

 LOGFILE OPTIONS
 -----------------------------------------------------------------------------

• logformat

• access_log
• log_access
• cache_log
• cache_store_log
• cache_swap_state
• logfile_rotate
• emulate_httpd_log
• log_ip_on_direct
• mime_table
• log_mime_hdrs
• useragent_log
• referer_log
• pid_filename
• debug_options
• log_fqdn
• client_netmask
• forward_log
• strip_query_terms
• buffered_logs

 OPTIONS FOR FTP GATEWAYING
 -----------------------------------------------------------------------------

• ftp_user

• ftp_list_width
• ftp_passive
• ftp_sanitycheck
• ftp_telnet_protocol

 OPTIONS FOR EXTERNAL SUPPORT PROGRAMS
 -----------------------------------------------------------------------------

• diskd_program

• unlinkd_program
• pinger_program

 OPTIONS FOR URL REWRITING
 -----------------------------------------------------------------------------

• url_rewrite_program

• url_rewrite_children
• url_rewrite_concurrency
• url_rewrite_host_header
• url_rewrite_access
• url_rewrite_bypass

 OPTIONS FOR TUNING THE CACHE
 -----------------------------------------------------------------------------

• cache

• refresh_pattern
• quick_abort_min
• quick_abort_max
• quick_abort_pct
• read_ahead_gap
• negative_ttl
• positive_dns_ttl
• negative_dns_ttl
• range_offset_limit
• minimum_expiry_time
• store_avg_object_size
• store_objects_per_bucket

 HTTP OPTIONS
 -----------------------------------------------------------------------------

• request_header_max_size

• reply_header_max_size
• request_body_max_size
• chunked_request_body_max_size
• broken_posts
• via
• ie_refresh
• vary_ignore_expire
• extension_methods
• request_entities
• request_header_access
• reply_header_access
• header_replace
• relaxed_header_parser

 TIMEOUTS
 -----------------------------------------------------------------------------

• forward_timeout

• connect_timeout
• peer_connect_timeout
• read_timeout
• request_timeout
• persistent_request_timeout
• client_lifetime
• half_closed_clients
• pconn_timeout
• ident_timeout
• shutdown_lifetime

 ADMINISTRATIVE PARAMETERS
 -----------------------------------------------------------------------------

• cache_mgr

• mail_from
• mail_program
• cache_effective_user
• cache_effective_group
• httpd_suppress_version_string
• visible_hostname
• unique_hostname
• hostname_aliases
• umask

 OPTIONS FOR THE CACHE REGISTRATION SERVICE
 -----------------------------------------------------------------------------

	This section contains parameters for the (optional) cache
	announcement service.  This service is provided to help
	cache administrators locate one another in order to join or
	create cache hierarchies.

	An 'announcement' message is sent (via UDP) to the registration
	service by Squid.  By default, the announcement message is NOT
	SENT unless you enable it with 'announce_period' below.

	The announcement message includes your hostname, plus the
	following information from this configuration file:

		http_port
		icp_port
		cache_mgr

	All current information is processed regularly and made
	available on the Web at http://www.ircache.net/Cache/Tracker/.

• announce_period

• announce_host
• announce_file
• announce_port

 HTTPD-ACCELERATOR OPTIONS
 -----------------------------------------------------------------------------

• httpd_accel_surrogate_id

• http_accel_surrogate_remote
• esi_parser

 DELAY POOL PARAMETERS
 -----------------------------------------------------------------------------

• delay_pools

• delay_class
• delay_access
• delay_parameters
• delay_initial_bucket_level

 WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS
 -----------------------------------------------------------------------------

• wccp_router

• wccp2_router
• wccp_version
• wccp2_rebuild_wait
• wccp2_forwarding_method
• wccp2_return_method
• wccp2_assignment_method
• wccp2_service
• wccp2_service_info
• wccp2_weight
• wccp_address
• wccp2_address

 PERSISTENT CONNECTION HANDLING
 -----------------------------------------------------------------------------

 Also see "pconn_timeout" in the TIMEOUTS section

• client_persistent_connections

• server_persistent_connections
• persistent_connection_after_error
• detect_broken_pconn

 CACHE DIGEST OPTIONS
 -----------------------------------------------------------------------------

• digest_generation

• digest_bits_per_entry
• digest_rebuild_period
• digest_rewrite_period
• digest_swapout_chunk_size
• digest_rebuild_chunk_percentage

 SNMP OPTIONS
 -----------------------------------------------------------------------------

• snmp_port

• snmp_access
• snmp_incoming_address
• snmp_outgoing_address

 ICP OPTIONS
 -----------------------------------------------------------------------------

• icp_port

• htcp_port
• log_icp_queries
• udp_incoming_address
• udp_outgoing_address
• icp_hit_stale
• minimum_direct_hops
• minimum_direct_rtt
• netdb_low
• netdb_high
• netdb_ping_period
• query_icmp
• test_reachability
• icp_query_timeout
• maximum_icp_query_timeout
• minimum_icp_query_timeout
• background_ping_rate

 MULTICAST ICP OPTIONS
 -----------------------------------------------------------------------------

• mcast_groups

• mcast_miss_addr
• mcast_miss_ttl
• mcast_miss_port
• mcast_miss_encode_key
• mcast_icp_query_timeout

 INTERNAL ICON OPTIONS
 -----------------------------------------------------------------------------

• icon_directory

• global_internal_static
• short_icon_urls

 ERROR PAGE OPTIONS
 -----------------------------------------------------------------------------

• error_directory

• err_html_text
• email_err_data
• deny_info

 OPTIONS INFLUENCING REQUEST FORWARDING
 -----------------------------------------------------------------------------

• nonhierarchical_direct

• prefer_direct
• always_direct
• never_direct

 ADVANCED NETWORKING OPTIONS
 -----------------------------------------------------------------------------

• incoming_icp_average

• incoming_http_average
• incoming_dns_average
• min_icp_poll_cnt
• min_dns_poll_cnt
• min_http_poll_cnt
• accept_filter
• client_ip_max_connections
• tcp_recv_bufsize

 ICAP OPTIONS
 -----------------------------------------------------------------------------

• icap_enable

• icap_connect_timeout
• icap_io_timeout
• icap_service_failure_limit
• icap_service_revival_delay
• icap_preview_enable
• icap_preview_size
• icap_default_options_ttl
• icap_persistent_connections
• icap_send_client_ip
• icap_send_client_username
• icap_client_username_header
• icap_client_username_encode
• icap_service
• icap_class
• icap_access

 DNS OPTIONS
 -----------------------------------------------------------------------------

• check_hostnames

• allow_underscore
• cache_dns_program
• dns_children
• dns_retransmit_interval
• dns_timeout
• dns_defnames
• dns_nameservers
• hosts_file
• dns_testnames
• append_domain
• ignore_unknown_nameservers
• ipcache_size
• ipcache_low
• ipcache_high
• fqdncache_size

 MISCELLANEOUS
 -----------------------------------------------------------------------------

• memory_pools

• memory_pools_limit
• forwarded_for
• cachemgr_passwd
• client_db
• refresh_all_ims
• reload_into_ims
• maximum_single_addr_tries
• retry_on_error
• as_whois_server
• offline_mode
• uri_whitespace
• coredump_dir
• chroot
• balance_on_multiple_ip
• pipeline_prefetch
• high_response_time_warning
• high_page_fault_warning
• high_memory_warning
• sleep_after_fork
• windows_ipaddrchangemonitor

Alphabetic index