---
.../configuration-files/records.config.en.mdtext | 146 ++++++++++++++++++++
1 files changed, 146 insertions(+), 0 deletions(-)
diff --git
a/content/docs/trunk/admin/configuration-files/records.config.en.mdtext
b/content/docs/trunk/admin/configuration-files/records.config.en.mdtext
index cbf708a..b36d3de 100644
--- a/content/docs/trunk/admin/configuration-files/records.config.en.mdtext
+++ b/content/docs/trunk/admin/configuration-files/records.config.en.mdtext
@@ -83,6 +83,7 @@ the `records.config` file.
: `STRING`
: Default: *`build_machine`*
: The name of the Traffic Server node.
+: Reloadable.
*`proxy.config.bin_path`* {#proxy.config.bin_path}
: `STRING`
@@ -134,6 +135,7 @@ the `records.config` file.
: `STRING`
: Default: (none)
: The email address to which Traffic Server sends alarm messages. During a
custom Traffic Server installation, you can specify the email address;
otherwise, Traffic Server uses the Traffic Server user account name as the
default value for this variable.
+: Reloadable.
*`proxy.config.syslog_facility`* {#proxy.config.syslog_facility}
: `STRING`
@@ -370,6 +372,7 @@ the `records.config` file.
: `INT`
: Default: `1`
: You can specify one of the following:
+: Reloadable.
* `0` = no extra information is added to the string.
* `1` = all extra information is added.
@@ -382,6 +385,7 @@ the `records.config` file.
: `INT`
: Default: `1`
: You can specify one of the following:
+: Reloadable.
* `0` no extra information is added to the string.
* `1` all extra information is added.
@@ -391,6 +395,7 @@ the `records.config` file.
: `INT`
: Default: `1`
: You can specify one of the following:
+: Reloadable.
* `0` no Server: header is added to the response.
* `1` the Server: header is added (see string below).
@@ -400,6 +405,7 @@ the `records.config` file.
: `INT`
: Default: `1`
: This option specifies whether Traffic Server should insert an `Age` header
in the response. The Age field value is the cache's estimate of the amount of
time since the response was generated or revalidated by the origin server.
+: Reloadable.
* `0` no `Age` header is added
* `1` the `Age` header is added
@@ -408,16 +414,19 @@ the `records.config` file.
: `STRING`
: Default: `ATS/`
: The Server: string that ATS will insert in a response header (if
requested, see above). Note that the current version number is always appended
to this string.
+: Reloadable.
*`proxy.config.http.enable_url_expandomatic`*
{#proxy.config.http.enable_url_expandomatic}
: `INT`
: Default: `1`
: Enables (`1`) or disables (`0`) `.com` domain expansion. This configures
the Traffic Server to resolve unqualified hostnames by prepending with `www.`
and appending with `.com` before redirecting to the expanded address. For
example: if a client makes a request to `host`, then Traffic Server redirects
the request to `www.host.com`.
+: Reloadable.
*`proxy.config.http.chunking_enabled`* {#proxy.config.http.chunking_enabled}
: `INT`
: Default: `1`
: Specifies whether Traffic Sever can generate a chunked response:
+: Reloadable.
* `0` Never
* `1` Always
@@ -436,11 +445,13 @@ the `records.config` file.
: `INT`
: Default: `0`
: Enables (`1`) or disables (`0`) `traffic_cop` heartbeat logging.
+: Reloadable.
*`proxy.config.http.use_client_target_addr`*
{#proxy.config.http.use_client_target_addr}
: `INT`
: Default: `0`
: Avoid DNS lookup for forward transparent requests:
+: Reloadable.
* `0` Never.
* `1` Avoid DNS lookup if possible.
@@ -472,39 +483,46 @@ the `records.config` file.
: `INT`
: Default: `0`
: Enables (`1`) or disables (`0`) the parent caching option. Refer to
[Hierarchical Caching](../hierachical-caching).
+: Reloadable.
*`proxy.config.http.parent_proxy.retry_time`*
{#proxy.config.http.parent_proxy.retry_time}
: `INT`
: Default: `300`
: The amount of time allowed between connection retries to a parent cache
that is unavailable.
+: Reloadable.
*`proxy.config.http.parent_proxy.fail_threshold`*
{#proxy.config.http.parent_proxy.fail_threshold}
: `INT`
: Default: `10`
: The number of times the connection to the parent cache can fail before
Traffic Server considers the parent unavailable.
+: Reloadable.
*`proxy.config.http.parent_proxy.total_connect_attempts`*
{#proxy.config.http.parent_proxy.total_connect_attempts}
: `INT`
: Default: `4`
: The total number of connection attempts allowed to a parent cache before
Traffic Server bypasses the parent or fails the request (depending on the
*`go_direct`* option in the `bypass.config` file).
+: Reloadable.
*`proxy.config.http.parent_proxy.per_parent_connect_attempts`*
{#proxy.config.http.parent_proxy.per_parent_connect_attempts}
: `INT`
: Default: `2`
: The total number of connection attempts allowed per parent, if multiple
parents are used.
+: Reloadable.
*`proxy.config.http.parent_proxy.connect_attempts_timeout`*
{#proxy.config.http.parent_proxy.connect_attempts_timeout}
: `INT`
: Default: `30`
: The timeout value (in seconds) for parent cache connection attempts.
+: Reloadable.
*`proxy.config.http.forward.proxy_auth_to_parent`*
{#proxy.config.http.forward.proxy_auth_to_parent}
: `INT`
: Default: `0`
: Configures Traffic Server to send proxy authentication headers on to the
parent cache.
+: Reloadable.
@@ -514,49 +532,58 @@ the `records.config` file.
: `INT`
: Default: `10`
: Specifies how long Traffic Server keeps connections to clients open for a
subsequent request after a transaction ends.
+: Reloadable.
*`proxy.config.http.keep_alive_no_activity_timeout_out`*
{#proxy.config.http.keep_alive_no_activity_timeout_out}
: `INT`
: Default: `10`
: Specifies how long Traffic Server keeps connections to origin servers open
for a subsequent transfer of data after a transaction ends.
+: Reloadable.
*`proxy.config.http.transaction_no_activity_timeout_in`*
{#proxy.config.http.transaction_no_activity_timeout_in}
: `INT`
: Default: `120`
: Specifies how long Traffic Server keeps connections to clients open if a
transaction stalls.
+: Reloadable.
*`proxy.config.http.transaction_no_activity_timeout_out`*
{#proxy.config.http.transaction_no_activity_timeout_out}
: `INT`
: Default: `120`
: Specifies how long Traffic Server keeps connections to origin servers open
if the transaction stalls.
+: Reloadable.
*`proxy.config.http.transaction_active_timeout_in`*
{#proxy.config.http.transaction_active_timeout_in}
: `INT`
: Default: `0`
: The maximum amount of time Traffic Server can remain connected to a
client. If the transfer to the client is not complete before this timeout
expires, then Traffic Server closes the connection.
The default value of `0` specifies that there is no timeout.
+: Reloadable.
*`proxy.config.http.transaction_active_timeout_out`*
{#proxy.config.http.transaction_active_timeout_out}
: `INT`
: Default: `0`
: The maximum amount of time Traffic Server waits for fulfillment of a
connection request to an origin server. If Traffic Server does not complete the
transfer to the origin server before this timeout expires, then Traffic Server
terminates the connection request.
The default value of `0` specifies that there is no timeout.
+: Reloadable.
*`proxy.config.http.accept_no_activity_timeout`*
{#proxy.config.http.accept_no_activity_timeout}
: `INT`
: Default: `120`
: The timeout interval in seconds before Traffic Server closes a connection
that has no activity.
+: Reloadable.
*`proxy.config.http.background_fill_active_timeout`*
{#proxy.config.http.background_fill_active_timeout}
: `INT`
: Default: `60`
: Specifies how long Traffic Server continues a background fill before
giving up and dropping the origin server connection.
+: Reloadable.
*`proxy.config.http.background_fill_completed_threshold`*
{#proxy.config.http.background_fill_completed_threshold}
: `FLOAT`
: Default: `0.50000`
: The proportion of total document size already transferred when a client
aborts at which the proxy continues fetching the document from the origin
server to get it into the cache (a **background fill**).
+: Reloadable.
# Origin Server Connect Attempts # {#OriginServerConnectAttempts}
@@ -565,51 +592,62 @@ the `records.config` file.
: `INT`
: Default: `6`
: The maximum number of connection retries Traffic Server can make when the
origin server is not responding.
+: Reloadable.
*`proxy.config.http.connect_attempts_max_retries_dead_server`*
{#proxy.config.http.connect_attempts_max_retries_dead_server}
: `INT`
: Default: `2`
: The maximum number of connection retries Traffic Server can make when the
origin server is unavailable.
+: Reloadable.
+: Reloadable.
*`proxy.config.http.server_max_connections`*
{#proxy.config.http.server_max_connections}
: `INT`
: Default: `0`
: Limits the number of socket connections across all origin servers to the
value specified. To disable, set to zero (`0`).
+: Reloadable.
*`proxy.config.http.origin_max_connections`*
{#proxy.config.http.origin_max_connections}
: `INT`
: Default: `0`
: Limits the number of socket connections per origin server to the value
specified. To enable, set to one (`1`).
+: Reloadable.
*`proxy.config.http.origin_min_keep_alive_connections`*
{#proxy.config.http.origin_min_keep_alive_connections}
: `INT`
: Default: `0`
: As connection to an origin server are opened, keep at least 'n' number of
connections open to that origin, even if the connection isn't used for a long
time period. Useful when the origin supports keep-alive, removing the time
needed to set up a new connection from the next request at the expense of added
(inactive) connections. To enable, set to one (`1`).
+: Reloadable.
*`proxy.config.http.connect_attempts_rr_retries`*
{#proxy.config.http.connect_attempts_rr_retries}
: `INT`
: Default: `2`
: The maximum number of failed connection attempts allowed before a
round-robin entry is marked as 'down' if a server has round-robin DNS entries.
+: Reloadable.
*`proxy.config.http.connect_attempts_timeout`*
{#proxy.config.http.connect_attempts_timeout}
: `INT`
: Default: `30`
: The timeout value (in seconds) for an origin server connection.
+: Reloadable.
*`proxy.config.http.post_connect_attempts_timeout`*
{#proxy.config.http.post_connect_attempts_timeout}
: `INT`
: Default: `1800`
: The timeout value (in seconds) for an origin server connection when the
client request is a `POST` or `PUT` request.
+: Reloadable.
*`proxy.config.http.down_server.cache_time`*
{#proxy.config.http.down_server.cache_time}
: `INT`
: Default: `900`
: Specifies how long (in seconds) Traffic Server remembers that an origin
server was unreachable.
+: Reloadable.
*`proxy.config.http.down_server.abort_threshold`*
{#proxy.config.http.down_server.abort_threshold}
: `INT`
: Default: `10`
: The number of seconds before Traffic Server marks an origin server as
unavailable after a client abandons a request because the origin server was too
slow in sending the response header.
+: Reloadable.
# Congestion Control # {#CongestionControl}
@@ -626,6 +664,7 @@ the `records.config` file.
: `INT`
: Default: `0`
: When enabled (`1`), Traffic Server caches negative responses (such as `404
Not Found`) when a requested page does not exist. The next time a client
requests the same page, Traffic Server serves the negative response directly
from cache.
+: Reloadable.
**Note**: `Cache-Control` directives from the server forbidding cache are
ignored for the following HTTP response codes, regardless of the value
specified for the *`proxy.config.http.negative_caching_enabled`* variable. The
following negative responses are cached by Traffic Server:
@@ -648,32 +687,38 @@ the `records.config` file.
: `INT`
: Default: `0`
: When enabled (`1`), Traffic Server removes the `From` header to protect
the privacy of your users.
+: Reloadable.
*`proxy.config.http.anonymize_remove_referer`*
{#proxy.config.http.anonymize_remove_referer}
: `INT`
: Default: `0`
: When enabled (`1`), Traffic Server removes the `Referrer` header to
protect the privacy of your site and users.
+: Reloadable.
*`proxy.config.http.anonymize_remove_user_agent`*
{#proxy.config.http.anonymize_remove_user_agent}
: `INT`
: Default: `0`
: When enabled (`1`), Traffic Server removes the `User-agent` header to
protect the privacy of your site and users.
+: Reloadable.
*`proxy.config.http.anonymize_remove_cookie`*
{#proxy.config.http.anonymize_remove_cookie}
: `INT`
: Default: `0`
: When enabled (`1`), Traffic Server removes the `Cookie` header to protect
the privacy of your site and users.
+: Reloadable.
*`proxy.config.http.anonymize_remove_client_ip`*
{#proxy.config.http.anonymize_remove_client_ip}
: `INT`
: Default: `0`
: When enabled (`1`), Traffic Server removes `Client-IP` headers for more
privacy.
+: Reloadable.
*`proxy.config.http.anonymize_insert_client_ip`*
{#proxy.config.http.anonymize_insert_client_ip}
: `INT`
: Default: `1`
: When enabled (`1`), Traffic Server inserts `Client-IP` headers to retain
the client IP address.
+: Reloadable.
*`proxy.config.http.append_xforwards_header`*
{#proxy.config.http.append_xforwards_header}
: `INT`
@@ -684,16 +729,19 @@ the `records.config` file.
: `STRING`
: Default: `NULL`
: The headers Traffic Server should remove from outgoing requests.
+: Reloadable.
*`proxy.config.http.insert_squid_x_forwarded_for`*
{#proxy.config.http.insert_squid_x_forwarded_for}
: `INT`
: Default: `0`
: When enabled (`1`), Traffic Server adds the client IP address to the
`X-Forwarded-For` header.
+: Reloadable.
*`proxy.config.http.normalize_ae_gzip`* {#proxy.config.http.normalize_ae_gzip}
: `INT`
: Default: `0`
: Enable (`1`) to normalize all `Accept-Encoding:` headers to one of the
following:
+: Reloadable.
- `Accept-Encoding: gzip` (if the header has `gzip` or `x-gzip` with any
`q`) **OR**
- *blank* (for any header that does not include `gzip`)
@@ -707,6 +755,7 @@ the `records.config` file.
: `INT`
: Default: `0`
: Enables (`1`) or disables (`0`) the HTTP `PUSH` option, which allows you
to deliver content directly to the cache without a user request.
+: Reloadable.
**Important:** If you enable this option, then you must also specify a
filtering rule in the [`ip_allow.config`](ip_allow.config) file to allow only
certain machines to push content into the cache.
@@ -717,36 +766,43 @@ the `records.config` file.
: `INT`
: Default: `0`
: Enables (`1`) or disables (`0`) ability to a read cached object while the
another connection is completing the write to cache for the same object. This
must be enabled for connection collapsing to work
+: Reloadable.
*`proxy.config.cache.force_sector_size`*
{#proxy.config.cache.force_sector_size}
: `INT`
: Default: `512`
: Forces the use of a specific hardware sector size (512 - 8192 bytes).
+: Reloadable.
*`proxy.config.http.cache.http`* {#proxy.config.http.cache.http}
: `INT`
: Default: `1`
: Enables (`1`) or disables (`0`) caching of HTTP requests.
+: Reloadable.
*`proxy.config.http.cache.ignore_client_no_cache`*
{#proxy.config.http.cache.ignore_client_no_cache}
: `INT`
: Default: `0`
: When enabled (`1`), Traffic Server ignores client requests to bypass the
cache.
+: Reloadable.
*`proxy.config.http.cache.ims_on_client_no_cache`*
{#proxy.config.http.cache.ims_on_client_no_cache}
: `INT`
: Default: `0`
: When enabled (`1`), Traffic Server issues a conditional request to the
origin server if an incoming request has a `No-Cache` header.
+: Reloadable.
*`proxy.config.http.cache.ignore_server_no_cache`*
{#proxy.config.http.cache.ignore_server_no_cache}
: `INT`
: Default: `0`
: When enabled (`1`), Traffic Server ignores origin server requests to
bypass the cache.
+: Reloadable.
*`proxy.config.http.cache.cache_responses_to_cookies`*
{#proxy.config.http.cache.cache_responses_to_cookies}
: `INT`
: Default: `3`
: Specifies how cookies are cached:
+: Reloadable.
* `0` = do not cache any responses to cookies
* `1` = cache for any content-type
@@ -762,17 +818,20 @@ the `records.config` file.
: `INT`
: Default: `1`
: Enables (`1`) or disables (`0`) caching of URLs that look dynamic, i.e.:
URLs that end in **`.asp`** or contain a question mark (**`?`**), a semicolon
(**`;`**), or **`cgi`**. For a full list, please refer to
[HttpTransact::url_looks_dynamic](/link/to/doxygen)
+: Reloadable.
*`proxy.config.http.cache.enable_default_vary_headers`*
{#proxy.config.http.cache.enable_default_vary_headers}
: `INT`
: Default: `0`
: Enables (`1`) or disables (`0`) caching of alternate versions of HTTP
objects that do not contain the `Vary` header.
+: Reloadable.
*`proxy.config.http.cache.when_to_revalidate`*
{#proxy.config.http.cache.when_to_revalidate}
: `INT`
: Default: `0`
: Specifies when to revalidate content:
+: Reloadable.
* `0` = use cache directives or heuristic (the default value)
* `1` = stale if heuristic
@@ -787,6 +846,7 @@ the `records.config` file.
: `INT`
: Default: 0
: Specifies when to add `no-cache` directives to Microsoft Internet Explorer
requests. You can specify the following:
+: Reloadable.
* `0` = `no-cache` is *not* added to MSIE requests
* `1` = `no-cache` is added to IMS MSIE requests
@@ -796,6 +856,7 @@ the `records.config` file.
: `INT`
: Default: `0`
: The type of headers required in a request for the request to be cacheable.
+: Reloadable.
* `0` = no headers required to make document cacheable
* `1` = either the `Last-Modified` header, or an explicit lifetime
header, `Expires` or `Cache-Control: max-age`, is required
@@ -805,6 +866,7 @@ the `records.config` file.
: `INT`
: Default: `604800`
: The maximum age allowed for a stale response before it cannot be cached.
+: Reloadable.
*`proxy.config.http.cache.range.lookup`*
{#proxy.config.http.cache.range.lookup}
: `INT`
@@ -836,11 +898,13 @@ the `records.config` file.
: `INT`
: Default: `0`
: Sets a minimum fuzz time; the default value is `0`. **Effective fuzz
time** is a calculation in the range (`fuzz.min_time` - `fuzz.min_time`).
+: Reloadable.
*`proxy.config.http.cache.ignore_accept_mismatch`*
{#proxy.config.http.cache.ignore_accept_mismatch}
: `INT`
: Default: `0`
: When enabled (`1`), Traffic Server serves documents from cache with a
`Content-Type:` header that does not match the `Accept:` header of the request.
+: Reloadable.
**Note:** This option should only be enabled if you're having problems
with caching *and* one of the following is true:
@@ -852,6 +916,7 @@ the `records.config` file.
: `INT`
: Default: `0`
: When enabled (`1`), Traffic Server serves documents from cache with a
`Content-Language:` header that does not match the `Accept-Language:` header of
the request.
+: Reloadable.
**Note:** This option should only be enabled if you're having problems
with caching and your origin server is guaranteed to set `Vary:
Accept-Language` when doing content negotiation with `Accept-Language`.
@@ -860,6 +925,7 @@ the `records.config` file.
: `INT`
: Default: `0`
: When enabled (`1`), Traffic Server serves documents from cache with a
`Content-Type:` header that does not match the `Accept-Charset:` header of the
request.
+: Reloadable.
**Note:** This option should only be enabled if you're having problems
with caching and your origin server is guaranteed to set `Vary: Accept-Charset`
when doing content negotiation with `Accept-Charset`.
@@ -867,11 +933,13 @@ the `records.config` file.
: `INT`
: Default: `1`
: When enabled (`1`), Traffic Server ignores any `Cache-Control: max-age`
headers from the client.
+: Reloadable.
*`proxy.config.cache.permit.pinning`* {#proxy.config.cache.permit.pinning}
: `INT`
: Default: `0`
: When enabled (`1`), Traffic Server will keep certain HTTP objects in the
cache for a certain time as specified in [`cache.config`](cache.config).
+: Reloadable.
# Heuristic Expiration # {#HeuristicExpiration}
@@ -879,27 +947,32 @@ the `records.config` file.
: `INT`
: Default: `3600` (1 hour)
: The minimum amount of time an HTTP object without an expiration date can
remain fresh in the cache before is considered to be stale.
+: Reloadable.
*`proxy.config.http.cache.heuristic_max_lifetime`*
{#proxy.config.http.cache.heuristic_max_lifetime}
: `INT`
: Default: `86400` (1 day)
: The maximum amount of time an HTTP object without an expiration date can
remain fresh in the cache before is considered to be stale.
+: Reloadable.
*`proxy.config.http.cache.heuristic_lm_factor`*
{#proxy.config.http.cache.heuristic_lm_factor}
: `FLOAT`
: Default: `0.10000`
: The aging factor for freshness computations. Traffic Server stores an
object for this percentage of the time that elapsed since it last changed.
+: Reloadable.
*`proxy.config.http.cache.fuzz.time`* {#proxy.config.http.cache.fuzz.time}
: `INT`
: Default: `240`
: How often Traffic Server checks for an early refresh, during the period
before the document stale time. The interval specified must be in seconds.
+: Reloadable.
*`proxy.config.http.cache.fuzz.probability`*
{#proxy.config.http.cache.fuzz.probability}
: `FLOAT`
: Default: `0.00500`
: The probability that a refresh is made on a document during the specified
fuzz time.
+: Reloadable.
# Dynamic Content & Content Negotiation #
{#DynamicContentAndContentNegotiation}
@@ -908,16 +981,19 @@ the `records.config` file.
: Default: `NULL`
: The header on which Traffic Server varies for text documents.
For example: if you specify `User-agent`, then Traffic Server caches all the
different user-agent versions of documents it encounters.
+: Reloadable.
*`proxy.config.http.cache.vary_default_images`*
{#proxy.config.http.cache.vary_default_images}
: `STRING`
: Default: `NULL`
: The header on which Traffic Server varies for images.
+: Reloadable.
*`proxy.config.http.cache.vary_default_other`*
{#proxy.config.http.cache.vary_default_other}
: `STRING`
: Default: `NULL`
: The header on which Traffic Server varies for anything other than text and
images.
+: Reloadable.
# Customizable User Response Pages # {#CustomizableUserResponsePages}
@@ -957,11 +1033,13 @@ the `records.config` file.
: `INT`
: Default: `1`
: Enables (`1`) or disables (`0`) local domain expansion so that Traffic
Server can attempt to resolve unqualified hostnames by expanding to the local
domain. For example: if a client makes a request to an unqualified host
(`host_x`) and the Traffic Server local domain is `y.com` , then Traffic Server
will expand the hostname to `host_x.y.com`.
+: Reloadable.
*`proxy.config.dns.splitDNS.enabled`* {#proxy.config.dns.splitDNS.enabled}
: `INT`
: Default: `0`
: Enables (`1`) or disables (`0`) DNS server selection. When enabled,
Traffic Server refers to the `splitdns.config` file for the selection
specification. Refer to [Configuring DNS Server Selection (Split
DNS)](../security-options#ConfiguringDNSServerSelectionSplit).
+: Reloadable.
*`proxy.config.dns.url_expansions`* {#proxy.config.dns.url_expansions}
@@ -980,16 +1058,19 @@ the `records.config` file.
: `INT`
: Default: `0`
: Enables (`1`) or disables (`0`) DNS server round-robin.
+: Reloadable.
*`proxy.config.dns.nameservers`* {#proxy.config.dns.nameservers}
: `STRING`
: Default: `NULL`
: The DNS servers.
+: Reloadable.
*`proxy.config.srv_enabled`* {#proxy.config.srv_enabled}
: `INT`
: Default: `0`
: Indicates whether to use SRV records for orgin server lookup.
+: Reloadable.
# HostDB # {#HostDB}
@@ -998,16 +1079,22 @@ the `records.config` file.
: `INT`
: Default: `0`
: The number of seconds for which to use a stale NS record while initiating a
background fetch for the new data.
+: Reloadable.
+: Reloadable.
*`proxy.config.hostdb.storage_size`* {#proxy.config.hostdb.storage_size}
: `INT`
: Default: `33554432`
: The amount of space (in bytes) used to store *`hostdb`*. Thevalue of this
variable must be increased if you increase the sizeof the
*`proxy.config.hostdb.size`* variable.
+: Reloadable.
+: Reloadable.
*`proxy.config.hostdb.size`* {#proxy.config.hostdb.size}
: `INT`
: Default: `200000`
: The maximum number of entries allowed in the host database.
+: Reloadable.
+: Reloadable.
**Note:** For values above `200000`, you must increase the value ofthe
*`proxy.config.hostdb.storage_size`* variable by at least44 bytes per entry.
@@ -1015,6 +1102,8 @@ the `records.config` file.
: `INT`
: Default: `0`
: The host database time to live mode. You can specify one of the following:
+: Reloadable.
+: Reloadable.
* `0` = obey
* `1`= ignore
@@ -1025,11 +1114,15 @@ the `records.config` file.
: `INT`
: Default: `1440`
: The foreground timeout (in minutes).
+: Reloadable.
+: Reloadable.
*`proxy.config.hostdb.strict_round_robin`*
{#proxy.config.hostdb.strict_round_robin}
: `INT`
: Default: `0`
: When disabled (`0`), Traffic Server always uses the same origin server for
the same client, for as long as the origin server is available.
+: Reloadable.
+: Reloadable.
# Logging Configuration # {#LoggingConfig}
@@ -1038,6 +1131,7 @@ the `records.config` file.
: `INT`
: Default: `3`
: Enables and disables event logging:
+: Reloadable.
* `0` = logging disabled
* `1` = log errors only
@@ -1050,37 +1144,44 @@ the `records.config` file.
: `INT`
: Default: `5`
: The maximum amount of time before data in the buffer is flushed to disk.
+: Reloadable.
*`proxy.config.log.max_space_mb_for_logs`*
{#proxy.config.log.max_space_mb_for_logs}
: `INT`
: Default: `2000`
: The amount of space allocated to the logging directory (in MB). **Note:**
All files in the logging directory contribute to the space used, even if they
are not log files. In collation client mode, if there is no local disk logging,
or max_space_mb_for_orphan_logs is set to a higher value than
max_space_mb_for_logs, TS will take
proxy.config.log.max_space_mb_for_orphan_logs for maximum allowed log space.
+: Reloadable.
*`proxy.config.log.max_space_mb_for_orphan_logs`*
{#proxy.config.log.max_space_mb_for_orphan_logs}
: `INT`
: Default: `25`
: The amount of space allocated to the logging directory (in MB) if this
node is acting as a collation client. **Note:** When
max_space_mb_for_orphan_logs is take as the maximum allowedlog space in the
logging system, the same rule apply to proxy.config.log.max_space_mb_for_logs
also apply to proxy.config.log.max_space_mb_for_orphan_logs, ie: All files in
the logging directory contribute to the space used, even if they are not log
files. you may need to consider this when you enable full remote logging, and
bump to the same size as proxy.config.log.max_space_mb_for_logs.
+: Reloadable.
*`proxy.config.log.max_space_mb_headroom`*
{#proxy.config.log.max_space_mb_headroom}
: `INT`
: Default: `10`
: The tolerance for the log space limit (in bytes). If the variable
*`proxy.config.log.auto_delete_rolled_file`* is set to `1` (enabled), then
autodeletion of log files is triggered when the amount of free space available
in the logging directory is less than the value specified here.
+: Reloadable.
*`proxy.config.log.hostname`* {#proxy.config.log.hostname}
: `STRING`
: Default: `localhost`
: The hostname of the machine running Traffic Server.
+: Reloadable.
*`proxy.config.log.logfile_dir`* {#proxy.config.log.logfile_dir}
: `STRING`
: Default: *`install_dir`*`/logs`
: The full path to the logging directory. This can be an absolute path or a
path relative to the directory in which Traffic Server is installed. **Note:**
The directory you specify must already exist.
+: Reloadable.
*`proxy.config.log.logfile_perm`* {#proxy.config.log.logfile_perm}
: `STRING`
: Default: `rw-r--r--`
: The log file permissions. The standard UNIX file permissions are used
(owner, group, other). Permissible values are:
+: Reloadable.
`-`no permission
`r`read permission
@@ -1093,17 +1194,20 @@ the `records.config` file.
: `INT`
: Default: `0`
: Enables (`1`) or disables (`0`) custom logging.
+: Reloadable.
*`proxy.config.log.squid_log_enabled`* {#proxy.config.log.squid_log_enabled}
: `INT`
: Default: `1`
: Enables (`1`) or disables (`0`) the [squid log file
format](../working-log-files/log-formats#SquidFormat).
+: Reloadable.
*`proxy.config.log.squid_log_is_ascii`* {#proxy.config.log.squid_log_is_ascii}
: `INT`
: Default: `1`
: The squid log file type:
+: Reloadable.
* `1` = ASCII
* `0` = binary
@@ -1112,21 +1216,25 @@ the `records.config` file.
: `STRING`
: Default: `squid`
: The [squid log](../working-log-files/log-formats#SquidFormat) filename.
+: Reloadable.
*`proxy.config.log.squid_log_header`* {#proxy.config.log.squid_log_header}
: `STRING`
: Default: `NULL`
: The [squid log](../working-log-files/log-formats#SquidFormat) file header
text.
+: Reloadable.
*`proxy.config.log.common_log_enabled`* {#proxy.config.log.common_log_enabled}
: `INT`
: Default: `0`
: Enables (`1`) or disables (`0`) the [Netscape common log file
format](../working-log-files/log-formats#NetscapeFormats).
+: Reloadable.
*`proxy.config.log.common_log_is_ascii`*
{#proxy.config.log.common_log_is_ascii}
: `INT`
: Default: `1`
: The [Netscape common
log](../working-log-files/log-formats#NetscapeFormats) file type:
+: Reloadable.
* `1` = ASCII
* `0` = binary
@@ -1135,16 +1243,19 @@ the `records.config` file.
: `STRING`
: Default: `common`
: The [Netscape common
log](../working-log-files/log-formats#NetscapeFormats) filename.
+: Reloadable.
*`proxy.config.log.common_log_header`* {#proxy.config.log.common_log_header}
: `STRING`
: Default: `NULL`
: The [Netscape common
log](../working-log-files/log-formats#NetscapeFormats) file header text.
+: Reloadable.
*`proxy.config.log.extended_log_enabled`*
{#proxy.config.log.extended_log_enabled}
: `INT`
: Default: `0`
: Enables (`1`) or disables (`0`) the [Netscape extended log file
format](../working-log-files/log-formats#NetscapeFormats).
+: Reloadable.
*`proxy.confg.log.extended_log_is_ascii`*
{#proxy.confg.log.extended_log_is_ascii}
: `INT`
@@ -1158,21 +1269,25 @@ the `records.config` file.
: `STRING`
: Default: `extended`
: The [Netscape extended
log](../working-log-files/log-formats#NetscapeFormats) filename.
+: Reloadable.
*`proxy.config.log.extended_log_header`*
{#proxy.config.log.extended_log_header}
: `STRING`
: Default: `NULL`
: The [Netscape extended
log](../working-log-files/log-formats#NetscapeFormats) file header text.
+: Reloadable.
*`proxy.config.log.extended2_log_enabled`*
{#proxy.config.log.extended2_log_enabled}
: `INT`
: Default: `0`
: Enables (`1`) or disables (`0`) the [Netscape Extended-2 log file
format](../working-log-files/log-formats#NetscapeFormats).
+: Reloadable.
*`proxy.config.log.extended2_log_is_ascii`*
{#proxy.config.log.extended2_log_is_ascii}
: `INT`
: Default: `1`
: The [Netscape Extended-2
log](../working-log-files/log-formats#NetscapeFormats) file type:
+: Reloadable.
* `1` = ASCII
* `0` = binary
@@ -1181,16 +1296,19 @@ the `records.config` file.
: `STRING`
: Default: `extended2`
: The [Netscape Extended-2
log](../working-log-files/log-formats#NetscapeFormats) filename.
+: Reloadable.
*`proxy.config.log.extended2_log_header`*
{#proxy.config.log.extended2_log_header}
: `STRING`
: Default: `NULL`
: The [Netscape Extended-2
log](../working-log-files/log-formats#NetscapeFormats) file header text.
+: Reloadable.
*`proxy.config.log.separate_icp_logs`* {#proxy.config.log.separate_icp_logs}
: `INT`
: Default: `0`
: When enabled (`1`), configures Traffic Server to store ICP transactions in
a separate log file.
+: Reloadable.
* `0` = separation is disabled, all ICP transactions are recorded in the
same file as HTTP transactions
* `1` = all ICP transactions are recorded in a separate log file.
@@ -1201,11 +1319,13 @@ the `records.config` file.
: `INT`
: Default: `0`
: When enabled (`1`), configures Traffic Server to create a separate log
file for HTTP transactions for each origin server listed in the
`log_hosts.config` file. Refer to [HTTP Host Log
Splitting](../working-log-files#HTTPHostLogSplitting).
+: Reloadable.
*`proxy.local.log.collation_mode`* {#proxy.local.log.collation_mode}
: `INT`
: Default: `0`
: The log collation mode:
+: Reloadable.
* `0` = collation is disabled
* `1` = this host is a log collation server
@@ -1226,26 +1346,32 @@ the `records.config` file.
: `INT`
: Default: `8085`
: The port used for communication between the collation server and client.
+: Reloadable.
*`proxy.config.log.collation_secret`* {#proxy.config.log.collation_secret}
: `STRING`
: Default: `foobar`
: The password used to validate logging data and prevent the exchange of
unauthorized information when a collation server is being used.
+: Reloadable.
*`proxy.config.log.collation_host_tagged`*
{#proxy.config.log.collation_host_tagged}
: `INT`
: Default: `0`
: When enabled (`1`), configures Traffic Server to include the hostname of
the collation client that generated the log entry in each entry.
+: Reloadable.
+: Reloadable.
*`proxy.config.log.collation_retry_sec`*
{#proxy.config.log.collation_retry_sec}
: `INT`
: Default: `5`
: The number of seconds between collation server connection retries.
+: Reloadable.
*`proxy.config.log.rolling_enabled`* {#proxy.config.log.rolling_enabled}
: `INT`
: Default: `1`
: Specifies how log files are rolled. You can specify the following values:
+: Reloadable.
* `0` = disables log file rolling
* `1` = enables log file rolling at specific intervals during the day
(specified with the *`proxy.config.log.rolling_interval_sec`* and
*`proxy.config.log.rolling_offset_hr`* variables)
@@ -1257,6 +1383,7 @@ the `records.config` file.
: `INT`
: Default: `86400`
: The log file rolling interval, in seconds. The minimum value is `300` (5
minutes). The maximum value is 86400 seconds (one day).
+: Reloadable.
**Note:** If you start Traffic Server within a few minutes of the next
rolling time, then rolling might not occur until the next rolling time.
@@ -1264,21 +1391,25 @@ the `records.config` file.
: `INT`
: Default: `0`
: The file rolling offset hour. The hour of the day that starts the log
rolling period.
+: Reloadable.
*`proxy.config.log.rolling_size_mb`* {#proxy.config.log.rolling_size_mb}
: `INT`
: Default: `10`
: The size that log files must reach before rolling takes place.
+: Reloadable.
*`proxy.config.log.auto_delete_rolled_files`*
{#proxy.config.log.auto_delete_rolled_files}
: `INT`
: Default: `1`
: Enables (`1`) or disables (`0`) automatic deletion of rolled files.
+: Reloadable.
*`proxy.config.log.sampling_frequency`* {#proxy.config.log.sampling_frequency}
: `INT`
: Default: `1`
: Configures Traffic Server to log only a sample of transactions rather than
every transaction. You can specify the following values:
+: Reloadable.
* `1` = log every transaction
* `2` = log every second transaction
@@ -1289,6 +1420,7 @@ the `records.config` file.
: `INT`
: Default: `0`
: The number of milliseconds before a slow connection's debugging stats are
dumped. Specify `1` to enable or `0` to disable.
+: Reloadable.
# Diagnostic Logging Configuration # {#DiagnosticLogging}
@@ -1320,6 +1452,7 @@ the `records.config` file.
: `INT`
: Default: `1`
: Enables (`1`) or disables (`0`) HTTP reverse proxy.
+: Reloadable.
@@ -1327,6 +1460,7 @@ the `records.config` file.
: `STRING`
: Default: `NULL`
: The URL to which to redirect requests with no host headers (reverse proxy).
+: Reloadable.
# URL Remap Rules # {#URLRemapRules}
@@ -1335,21 +1469,26 @@ the `records.config` file.
: `INT`
: Default: `0`
: Enables (`1`) or disables (`0`) requests for a PAC file on the proxy
service port (8080 by default) to be redirected to the PAC port. For this type
of redirection to work, the variable *`proxy.config.reverse_proxy.enabled`*
must be set to `1`.
+: Reloadable.
*`proxy.config.url_remap.default_to_server_pac_port`*
{#proxy.config.url_remap.default_to_server_pac_port}
: `INT`
: Default: `-1`
: Sets the PAC port so that PAC requests made to the Traffic Server proxy
service port are redirected this port. `-1` is the default setting that sets
the PAC port to the autoconfiguration port (the default autoconfiguration port
is 8083). This variable can be used together with the
*`proxy.config.url_remap.default_to_server_pac`* variable to get a PAC file
from a different port. You must create and run a process that serves a PAC file
on this port. For example: if you create a Perl script that listens on port
9000 and writes a PAC file in response to any request, then you can set this
variable to `9000`. Browsers that request the PAC file from a proxy server on
port 8080 will get the PAC file served by the Perl script.
+: Reloadable.
+: Reloadable.
*`proxy.config.url_remap.remap_required`*
{#proxy.config.url_remap.remap_required}
: `INT`
: Default: `1`
: Set this variable to `1` if you want Traffic Server to serve requests only
from origin servers listed in the mapping rules of the `remap.config` file. If
a request does not match, then the browser will receive an error.
+: Reloadable.
*`proxy.config.url_remap.pristine_host_hdr`*
{#proxy.config.url_remap.pristine_host_hdr}
: `INT`
: Default: `1`
: Set this variable to `1` if you want to retain the client host header in a
request during remapping.
+: Reloadable.
# SSL Termination # {#SSLTermination}
@@ -1509,11 +1648,13 @@ the `records.config` file.
: `INT`
: Default: `3130`
: Specifies the UDP port that you want to use for ICP messages.
+: Reloadable.
*`proxy.config.icp.query_timeout`* {#proxy.config.icp.query_timeout}
: `INT`
: Default: `2`
: Specifies the timeout used for ICP queries.
+: Reloadable.
# Scheduled Update Configuration # {#ScheduledUpdatesConfiguration}
@@ -1522,26 +1663,31 @@ the `records.config` file.
: `INT`
: `0`
: Enables (`1`) or disables (`0`) the Scheduled Update option.
+: Reloadable.
*`proxy.config.update.force`* {#proxy.config.update.force}
: `INT`
: Default: `0`
: Enables (`1`) or disables (`0`) a force immediate update. When enabled,
Traffic Server overrides the scheduling expiration time for all scheduled
update entries and initiates updates until this option is disabled.
+: Reloadable.
*`proxy.config.update.retry_count`* {#proxy.config.update.retry_count}
: `INT`
: Default: `10`
: Specifies the number of times Traffic Server can retry the scheduled
update of a URL in the event of failure.
+: Reloadable.
*`proxy.config.update.retry_interval`* {#proxy.config.update.retry_interval}
: `INT`
: Default: `2`
: Specifies the delay (in seconds) between each scheduled update retry for a
URL in the event of failure.
+: Reloadable.
*`proxy.config.update.concurrent_updates`*
{#proxy.config.update.concurrent_updates}
: `INT`
: Default: `100`
: Specifies the maximum simultaneous update requests allowed at any time.
This option prevents the scheduled update process from overburdening the host.
+: Reloadable.
# Remap Plugin Processor # {#RemapPluginProcessor}
--
1.7.1
