WELCOME TO SQUID 3.4.12-20150218-r13218
----------------------------
This is the documentation for the Squid configuration file.
This documentation can also be found online at:
http://www.squid-cache.org/Doc/config/
You may wish to look at the Squid home page and wiki for the
FAQ and other documentation:
http://www.squid-cache.org/
http://wiki.squid-cache.org/SquidFaq
http://wiki.squid-cache.org/ConfigExamples
This documentation shows what the defaults for various directives
happen to be. If you don't need to change the default, you should
leave the line out of your squid.conf in most cases.
In some cases "none" refers to no default setting at all,
while in other cases it refers to the value of the 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 are
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.
Values with byte units
Squid accepts size units on some size related directives. All
such directives are documented with a default value displaying
a unit.
Units accepted by Squid are:
bytes - byte
KB - Kilobyte (1024 bytes)
MB - Megabyte
GB - Gigabyte
Values with spaces, quotes, and other special characters
Squid supports directive parameters with spaces, quotes, and other
special characters. Surround such parameters with "double quotes". Use
the configuration_includes_quoted_values directive to enable or
disable that support.
For example;
configuration_includes_quoted_values on
acl group external groupCheck Administrators "Internet Users" Guest
configuration_includes_quoted_values off
Conditional configuration
If-statements can be used to make configuration directives
depend on conditions:
if
... regular configuration directives ...
[else
... regular configuration directives ...]
endif
The else part is optional. The keywords "if", "else", and "endif"
must be typed on their own lines, as if they were regular
configuration directives.
NOTE: An else-if condition is not supported.
These individual conditions types are supported:
true
Always evaluates to true.
false
Always evaluates to false.
=
Equality comparison of two integer numbers.
SMP-Related Macros
The following SMP-related preprocessor macros can be used.
${process_name} expands to the current Squid process "name"
(e.g., squid1, squid2, or cache1).
${process_number} expands to the current Squid process
identifier, which is an integer number (e.g., 1, 2, 3) unique
across all Squid processes.
OPTIONS FOR AUTHENTICATION
-----------------------------------------------------------------------------
ACCESS CONTROLS
-----------------------------------------------------------------------------
NETWORK OPTIONS
-----------------------------------------------------------------------------
SSL OPTIONS
-----------------------------------------------------------------------------
OPTIONS RELATING TO EXTERNAL SSL_CRTD
-----------------------------------------------------------------------------
OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM
-----------------------------------------------------------------------------
MEMORY CACHE OPTIONS
-----------------------------------------------------------------------------
DISK CACHE OPTIONS
-----------------------------------------------------------------------------
LOGFILE OPTIONS
-----------------------------------------------------------------------------
OPTIONS FOR TROUBLESHOOTING
-----------------------------------------------------------------------------
OPTIONS FOR FTP GATEWAYING
-----------------------------------------------------------------------------
OPTIONS FOR EXTERNAL SUPPORT PROGRAMS
-----------------------------------------------------------------------------
OPTIONS FOR URL REWRITING
-----------------------------------------------------------------------------
OPTIONS FOR STORE ID
-----------------------------------------------------------------------------
OPTIONS FOR TUNING THE CACHE
-----------------------------------------------------------------------------
HTTP OPTIONS
-----------------------------------------------------------------------------
TIMEOUTS
-----------------------------------------------------------------------------
ADMINISTRATIVE PARAMETERS
-----------------------------------------------------------------------------
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/.
HTTPD-ACCELERATOR OPTIONS
-----------------------------------------------------------------------------
DELAY POOL PARAMETERS
-----------------------------------------------------------------------------
CLIENT DELAY POOL PARAMETERS
-----------------------------------------------------------------------------
WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS
-----------------------------------------------------------------------------
PERSISTENT CONNECTION HANDLING
-----------------------------------------------------------------------------
Also see "pconn_timeout" in the TIMEOUTS section
CACHE DIGEST OPTIONS
-----------------------------------------------------------------------------
SNMP OPTIONS
-----------------------------------------------------------------------------
ICP OPTIONS
-----------------------------------------------------------------------------
MULTICAST ICP OPTIONS
-----------------------------------------------------------------------------
INTERNAL ICON OPTIONS
-----------------------------------------------------------------------------
ERROR PAGE OPTIONS
-----------------------------------------------------------------------------
OPTIONS INFLUENCING REQUEST FORWARDING
-----------------------------------------------------------------------------
ADVANCED NETWORKING OPTIONS
-----------------------------------------------------------------------------
ICAP OPTIONS
-----------------------------------------------------------------------------
eCAP OPTIONS
-----------------------------------------------------------------------------
MESSAGE ADAPTATION OPTIONS
-----------------------------------------------------------------------------
DNS OPTIONS
-----------------------------------------------------------------------------
MISCELLANEOUS
-----------------------------------------------------------------------------
Alphabetic index