You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by ml...@apache.org on 2011/06/08 02:38:11 UTC
svn commit: r1133218 [2/2] -
/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/records.config.en.mdtext
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/records.config.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/records.config.en.mdtext?rev=1133218&r1=1133217&r2=1133218&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/records.config.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/records.config.en.mdtext Wed Jun 8 00:38:11 2011
@@ -102,14 +102,12 @@ the `records.config` file.
*`proxy.config.manager_binary`* {#proxy.config.manager_binary}
: `STRING`
: Default: `traffic_manager`
-: The name of the executable that runs the `traffic_manager`
- process.
+: The name of the executable that runs the `traffic_manager` process.
*`proxy.config.cli_binary`* {#proxy.config.cli_binary}
: `STRING`
: Default: `traffic_line`
-: The name of the executable that runs the command-line interface
- (Traffic Line).
+: The name of the executable that runs the command-line interface (Traffic Line).
*`proxy.config.watch_script`* {#proxy.config.watch_script}
@@ -120,8 +118,7 @@ the `records.config` file.
*`proxy.config.env_prep`* {#proxy.config.env_prep}
: `STRING`
: Default: (none)
-: The script executed before the `traffic_manager` process spawns the
- `traffic_server` process.
+: The script executed before the `traffic_manager` process spawns the `traffic_server` process.
*`proxy.config.config_dir`* {#proxy.config.config_dir}
: `STRING`
@@ -136,65 +133,42 @@ the `records.config` file.
*`proxy.config.alarm_email`* {#proxy.config.alarm_email}
: `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.
+: 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.
*`proxy.config.syslog_facility`* {#proxy.config.syslog_facility}
: `STRING`
: Default: `LOG_DAEMON`
-: The facility used to record system log files.
- Refer to
- [Understanding Traffic Server Log Files](../working-log-files#UnderstandingTrafficServerLogFiles).
+: The facility used to record system log files. Refer to [Understanding Traffic Server Log Files](../working-log-files#UnderstandingTrafficServerLogFiles).
*`proxy.config.cop.core_signal`* {#proxy.config.cop.core_signal}
: `INT`
: Default: `0`
-: The signal sent to `traffic_cop`'s managed processes to stop them.
-
- * 0 = no signal is sent.
+: The signal sent to `traffic_cop`'s managed processes to stop them. * 0 = no signal is sent.
*`proxy.config.cop.linux_min_swapfree_kb`* {#proxy.config.cop.linux_min_swapfree_kb}
: `INT`
: Default: `10240`
-: The minimum amount of free swap space allowed before Traffic Server
- stops the `traffic_server`and `traffic_manager` processes to
- prevent the system from hanging.
-
- This configuration variable applies if swap is enabled in Linux 2.2
- only.
+: The minimum amount of free swap space allowed before Traffic Server stops the `traffic_server`and `traffic_manager` processes to prevent the system from hanging. This configuration variable applies if swap is enabled in Linux 2.2 only.
*`proxy.config.output.logfile`* {#proxy.config.output.logfile}
: `STRING`
: Default: `traffic.out`
-: The name and location of the file that contains warnings, status
- messages, and error messages produced by the Traffic Server
- processes.
-
- If no path is specified, then Traffic Server creates the file in
- its logging directory.
+: The name and location of the file that contains warnings, status messages, and error messages produced by the Traffic Server processes. If no path is specified, then Traffic Server creates the file in its logging directory.
*`proxy.config.snapshot_dir`* {#proxy.config.snapshot_dir}
: `STRING`
: Default: `snapshots`
-: The directory in which Traffic Server stores configuration
- snapshots on the local system. Unless you specify an absolute path,
- this directory is located in the Traffic Server `config`
- directory.
+: The directory in which Traffic Server stores configuration snapshots on the local system. Unless you specify an absolute path, this directory is located in the Traffic Server `config` directory.
*`proxy.config.accept_threads`* {#proxy.config.accept_threads}
: `INT`
: Default: `0`
-: When enabled (`1`), runs a separate thread for accept processing.
- If disabled (`0`), then only 1 thread can be created.
+: When enabled (`1`), runs a separate thread for accept processing. If disabled (`0`), then only 1 thread can be created.
*`proxy.config.thread.default.stacksize`* {#proxy.config.thread.default.stacksize}
: `INT`
: Default: `1096908`
-: The new default thread stack size, for all threads. The original
- default is set at 1 MB.
+: The new default thread stack size, for all threads. The original default is set at 1 MB.
### Local Manager ### {#LocalManager}
@@ -216,9 +190,7 @@ the `records.config` file.
*`proxy.config.cluster.rsport`* {#proxy.config.cluster.rsport}
: `INT`
: Default: `8088`
-: The reliable service port. The reliable service port is used to
- send configuration information between the nodes in a cluster. All
- nodes in a cluster must use the same reliable service port.
+: The reliable service port. The reliable service port is used to send configuration information between the nodes in a cluster. All nodes in a cluster must use the same reliable service port.
*`proxy.config.admin.autoconf_port`* {#proxy.config.admin.autoconf_port}
: `INT`
@@ -229,29 +201,19 @@ the `records.config` file.
*`proxy.config.admin.number_config_bak`* {#proxy.config.admin.number_config_bak}
: `INT`
: Default: `3`
-: The maximum number of copies of rolled configuration files to
- keep.
+: The maximum number of copies of rolled configuration files to keep.
*`proxy.config.admin.user_id`* {#proxy.config.admin.user_id}
: `STRING`
: Default: `nobody`
-: Option used to specify who to run the `traffic_server`process as;
- also used to specify ownership of config and log files.
+: Option used to specify who to run the `traffic_server`process as; also used to specify ownership of config and log files.
The nonprivileged user account designated to Traffic Server.
- As of version 2.1.1 if the user\_id is prefixed with pound
- character (\#) the remaining of the string is considered to be
- [numeric user identifier](http://en.wikipedia.org/wiki/User_identifier).
- If the value is set to '\#-1' Traffic Server will not change the
- user during startup.
-
- Setting `user_id` to `root` or `#0` is now forbidden to increase
- security. Trying to do so, will cause the `traffic_server` fatal
- failure. However there are two ways to bypass that restriction:
- Specify `-DBIG_SECURITY_HOLE` in `CXXFLAGS` during compilation
- Set the `user_id=#-1` and start trafficserver as root.
+ As of version 2.1.1 if the user\_id is prefixed with pound character (\#) the remaining of the string is considered to be [numeric user identifier](http://en.wikipedia.org/wiki/User_identifier). If the value is set to '\#-1' Traffic Server will not change the user during startup.
+
+ Setting `user_id` to `root` or `#0` is now forbidden to increase security. Trying to do so, will cause the `traffic_server` fatal failure. However there are two ways to bypass that restriction: Specify `-DBIG_SECURITY_HOLE` in `CXXFLAGS` during compilation Set the `user_id=#-1` and start trafficserver as root.
### Process Manager ### {#ProcessManager}
@@ -259,8 +221,7 @@ the `records.config` file.
*`proxy.config.process_manager.mgmt_port`* {#proxy.config.process_manager.mgmt_port}
: `INT`
: Default: `8084`
-: The port used for internal communication between the
- `traffic_manager` and `traffic_server` processes.
+: The port used for internal communication between the `traffic_manager` and `traffic_server` processes.
### Alarm Configuration ### {#ProcessManager}
@@ -268,16 +229,12 @@ the `records.config` file.
*`proxy.config.alarm.bin`* {#proxy.config.alarm.bin}
: `STRING`
: Default: `example_alarm_bin.sh`
-: Name of the script file that can execute certain actions when an
- alarm is signaled. The default file is a sample script named
- `example_alarm_bin.sh` located in the `bin` directory. You must
- edit the script to suit your needs.
+: Name of the script file that can execute certain actions when an alarm is signaled. The default file is a sample script named `example_alarm_bin.sh` located in the `bin` directory. You must edit the script to suit your needs.
*`proxy.config.alarm.abs_path`* {#proxy.config.alarm.abs_path}
: `STRING`
: Default: `NULL`
-: The full path to the script file that sends email to alert someone
- about Traffic Server problems.
+: The full path to the script file that sends email to alert someone about Traffic Server problems.
@@ -286,8 +243,7 @@ the `records.config` file.
*`proxy.config.http.server_port`* {#proxy.config.http.server_port}
: `INT`
: Default: `8080`
-: The port that Traffic Server uses when acting as a web proxy server
- for web traffic.
+: The port that Traffic Server uses when acting as a web proxy server for web traffic.
*`proxy.config.http.server_port_attr`* {#proxy.config.http.server_port_attr}
: `STRING`
@@ -301,25 +257,14 @@ the `records.config` file.
*`proxy.config.http.server_other_ports`* {#proxy.config.http.server_other_ports}
: `STRING`
: Default: `NULL`
-: The ports other than the port specified by the variable
-
- *`proxy.config.http.server_port`* to bind for incoming HTTP
- requests. Example:
-
+: The ports other than the port specified by the variable *`proxy.config.http.server_port`* to bind for incoming HTTP requests. Example:
CONFIG proxy.config.http.server_other_ports STRING 6060:X 9090:X
-
- would listed to ports `6060`, `9090`, and the port specified by
- *`proxy.config.http.server_port`*.
+ would listed to ports `6060`, `9090`, and the port specified by *`proxy.config.http.server_port`*.
*`proxy.config.http.ssl_ports`* {#proxy.config.http.ssl_ports}
: `STRING`
: Default: `443 563`
-: The range of ports used for tunneling. Traffic Server allows
- tunnels only to the specified ports.
-
- For example: to retrieve an object using HTTPS via Traffic Server,
- a tunnel must be established to an origin server via Traffic
- Server.
+: The range of ports used for tunneling. Traffic Server allows tunnels only to the specified ports. For example: to retrieve an object using HTTPS via Traffic Server, a tunnel must be established to an origin server via Traffic Server.
*`proxy.config.http.insert_request_via_str`* {#proxy.config.http.insert_request_via_str}
: `INT`
@@ -330,8 +275,7 @@ the `records.config` file.
* `1` = all extra information is added.
* `2` = some extra information is added.
- Note: the Via: header string interpretation is
- [documented here.](../faqs#interpret_via_header)
+ Note: the Via: header string interpretation is [documented here.](../faqs#interpret_via_header)
*`proxy.config.http.insert_response_via_str`* {#proxy.config.http.insert_response_via_str}
@@ -350,26 +294,17 @@ the `records.config` file.
* `0` no Server: header is added to the response.
* `1` the Server: header is added (see string below).
- * `2` the Server: header is added only if the response from Origin
- does not have one already.
+ * `2` the Server: header is added only if the response from Origin does not have one already.
*`proxy.config.http.response_server_str`* {#proxy.config.http.response_server_str}
: `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.
+: 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.
*`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`.
+: 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`.
*`proxy.config.http.chunking_enabled`* {#proxy.config.http.chunking_enabled}
: `INT`
@@ -379,15 +314,9 @@ the `records.config` file.
* `0` Never
* `1` Always
* `2` Generate a chunked response if the server has returned HTTP/1.1 before
- * `3` = Generate a chunked response if the client request is HTTP/1.1 and
- the origin server has returned HTTP/1.1 before
+ * `3` = Generate a chunked response if the client request is HTTP/1.1 and the origin server has returned HTTP/1.1 before
- **Note:** If HTTP/1.1 is used, then Traffic Server can use
- keep-alive connections with pipelining to origin servers. If HTTP/0.9
- is used, then Traffic Server does not use `keep-alive`
- connections to origin servers. If HTTP/1.0 is used, then Traffic
- Server can use `keep-alive` connections without pipelining to origin
- servers.
+ **Note:** If HTTP/1.1 is used, then Traffic Server can use keep-alive connections with pipelining to origin servers. If HTTP/0.9 is used, then Traffic Server does not use `keep-alive` connections to origin servers. If HTTP/1.0 is used, then Traffic Server can use `keep-alive` connections without pipelining to origin servers.
*`proxy.config.http.share_server_sessions`* {#proxy.config.http.share_server_sessions}
@@ -408,9 +337,7 @@ the `records.config` file.
* `0` Never.
* `1` Avoid DNS lookup if possible.
- This option causes Traffic Server to avoid where possible doing DNS lookups
- in forward transparent proxy mode. The option is only effective if the following
- three conditions are true -
+ This option causes Traffic Server to avoid where possible doing DNS lookups in forward transparent proxy mode. The option is only effective if the following three conditions are true -
* Traffic Server is in forward proxy mode.
* Traffic Server is using client side transparency.
@@ -418,33 +345,17 @@ the `records.config` file.
If any of these conditions are not true, then normal DNS processing is done for the connection.
- If all of these conditions are met, then the origin server IP address is retrieved from the
- original client connection, rather than through HostDB or DNS lookup. In effect, client DNS
- resolution is used instead of Traffic Server DNS.
-
- This can be used to be a little more efficient (looking up the target once by the client rather
- than by both the client and Traffic Server) but the primary use is when client DNS resolution
- can differ from that of Traffic Server.
- Two known uses cases are:
-
- 1. Embedded IP addresses in a protocol with DNS load sharing. In this case, even though Traffic Server
- and the client both make the same request to the same DNS resolver chain, they may get different origin
- server addresses. If the address is embedded in the protocol then the overall exchange will fail.
- One current example is Microsoft Windows update, which presumably embeds the address as a security measure.
-
- 2. The client has access to local DNS zone information which is not available to Traffic Server. There are
- corporate nets with local DNS information for internal servers which, by design, is not propagated outside
- the core corporate network. Depending a network topology it can be the case that Traffic Server can access
- the servers by IP address but cannot resolve such addresses by name.
- In such as case the client supplied target address must be used.
+ If all of these conditions are met, then the origin server IP address is retrieved from the original client connection, rather than through HostDB or DNS lookup. In effect, client DNS resolution is used instead of Traffic Server DNS.
+
+ This can be used to be a little more efficient (looking up the target once by the client rather than by both the client and Traffic Server) but the primary use is when client DNS resolution can differ from that of Traffic Server. Two known uses cases are:
+
+ 1. Embedded IP addresses in a protocol with DNS load sharing. In this case, even though Traffic Server and the client both make the same request to the same DNS resolver chain, they may get different origin server addresses. If the address is embedded in the protocol then the overall exchange will fail. One current example is Microsoft Windows update, which presumably embeds the address as a security measure.
+
+ 2. The client has access to local DNS zone information which is not available to Traffic Server. There are corporate nets with local DNS information for internal servers which, by design, is not propagated outside the core corporate network. Depending a network topology it can be the case that Traffic Server can access the servers by IP address but cannot resolve such addresses by name. In such as case the client supplied target address must be used.
Additional Notes:
- This solution must be considered interim. In the longer term, it should be possible to arrange for much finer
- grained control of DNS lookup so that wildcard domain can be set to use Traffic Server or client resolution.
- In both known use cases, marking specific domains as client determined (rather than a single global switch)
- would suffice. It is possible to do this crudely with this flag by enabling it and then use identity URL
- mappings to re-disable it for specific domains.
+ This solution must be considered interim. In the longer term, it should be possible to arrange for much finer grained control of DNS lookup so that wildcard domain can be set to use Traffic Server or client resolution. In both known use cases, marking specific domains as client determined (rather than a single global switch) would suffice. It is possible to do this crudely with this flag by enabling it and then use identity URL mappings to re-disable it for specific domains.
### Parent Proxy Configuration ### {#ParentProxyConfiguration}
@@ -452,50 +363,40 @@ the `records.config` file.
*`proxy.config.http.parent_proxy_routing_enable`* {#proxy.config.http.parent_proxy_routing_enable}
: `INT`
: Default: `0`
-: Enables (`1`) or disables (`0`) the parent caching option.
-
- Refer to [Hierarchical Caching](../hierachical-caching).
+: Enables (`1`) or disables (`0`) the parent caching option. Refer to [Hierarchical Caching](../hierachical-caching).
*`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.
+: The amount of time allowed between connection retries to a parent cache that is unavailable.
*`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.
+: The number of times the connection to the parent cache can fail before Traffic Server considers the parent unavailable.
*`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).
+: 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).
*`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.
+: The total number of connection attempts allowed per parent, if multiple parents are used.
*`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.
+: The timeout value (in seconds) for parent cache connection attempts.
*`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.
+: Configures Traffic Server to send proxy authentication headers on to the parent cache.
@@ -504,67 +405,50 @@ the `records.config` file.
*`proxy.config.http.keep_alive_no_activity_timeout_in`* {#proxy.config.http.keep_alive_no_activity_timeout_in}
: `INT`
: Default: `10`
-: Specifies how long Traffic Server keeps connections to clients open
- for a subsequent request after a transaction ends.
+: Specifies how long Traffic Server keeps connections to clients open for a subsequent request after a transaction ends.
*`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.
+: Specifies how long Traffic Server keeps connections to origin servers open for a subsequent transfer of data after a transaction ends.
*`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.
+: Specifies how long Traffic Server keeps connections to clients open if a transaction stalls.
*`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.
+: Specifies how long Traffic Server keeps connections to origin servers open if the transaction stalls.
*`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.
+: 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.
*`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.
+: 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.
*`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.
+: The timeout interval in seconds before Traffic Server closes a connection that has no activity.
*`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.
+: Specifies how long Traffic Server continues a background fill before giving up and dropping the origin server connection.
*`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**).
+: 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**).
### Origin Server Connect Attempts ### {#OriginServerConnectAttempts}
@@ -572,49 +456,32 @@ the `records.config` file.
*`proxy.config.http.connect_attempts_max_retries`* {#proxy.config.http.connect_attempts_max_retries}
: `INT`
: Default: `6`
-: The maximum number of connection retries Traffic Server can make
- when the origin server is not responding.
+: The maximum number of connection retries Traffic Server can make when the origin server is not responding.
*`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.
+: The maximum number of connection retries Traffic Server can make when the origin server is unavailable.
*`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`).
+: Limits the number of socket connections across all origin servers to the value specified. To disable, set to zero (`0`).
*`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`).
+: Limits the number of socket connections per origin server to the value specified. To enable, set to one (`1`).
*`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`).
+: 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`).
*`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.
+: 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.
*`proxy.config.http.connect_attempts_timeout`* {#proxy.config.http.connect_attempts_timeout}
: `INT`
@@ -624,21 +491,17 @@ the `records.config` file.
*`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.
+: The timeout value (in seconds) for an origin server connection when the client request is a `POST` or `PUT` request.
*`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.
+: Specifies how long (in seconds) Traffic Server remembers that an origin server was unreachable.
*`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.
+: 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.
### Congestion Control ### {#CongestionControl}
@@ -646,13 +509,7 @@ the `records.config` file.
*`proxy.config.http.congestion_control.enabled`* {#proxy.config.http.congestion_control.enabled}
: `INT`
: Default: `0`
-: Enables (`1`) or disables (`0`) the Congestion Control option,
- which configures Traffic Server to stop forwarding HTTP requests to
- origin servers when they become congested. Traffic Server sends the
- client a message to retry the congested origin server later.
-
- Refer to
- [Using Congestion Control](../http-proxy-caching#UsingCongestionControl).
+: Enables (`1`) or disables (`0`) the Congestion Control option, which configures Traffic Server to stop forwarding HTTP requests to origin servers when they become congested. Traffic Server sends the client a message to retry the congested origin server later. Refer to [Using Congestion Control](../http-proxy-caching#UsingCongestionControl).
### Negative Response Caching ### {#NegativeResponseCaching}
@@ -660,16 +517,9 @@ the `records.config` file.
*`proxy.config.http.negative_caching_enabled`* {#proxy.config.http.negative_caching_enabled}
: `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.
-
- **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:
+: 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.
+
+ **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:
204 No Content
305 Use Proxy
@@ -689,45 +539,38 @@ the `records.config` file.
*`proxy.config.http.anonymize_remove_from`* {#proxy.config.http.anonymize_remove_from}
: `INT`
: Default: `0`
-: When enabled (`1`), Traffic Server removes the `From` header to
- protect the privacy of your users.
+: When enabled (`1`), Traffic Server removes the `From` header to protect the privacy of your users.
*`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.
+: When enabled (`1`), Traffic Server removes the `Referrer` header to protect the privacy of your site and users.
*`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.
+: When enabled (`1`), Traffic Server removes the `User-agent` header to protect the privacy of your site and users.
*`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.
+: When enabled (`1`), Traffic Server removes the `Cookie` header to protect the privacy of your site and users.
*`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.
+: When enabled (`1`), Traffic Server removes `Client-IP` headers for more privacy.
*`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.
+: When enabled (`1`), Traffic Server inserts `Client-IP` headers to retain the client IP address.
*`proxy.config.http.append_xforwards_header`* {#proxy.config.http.append_xforwards_header}
: `INT`
: Default: `0`
-: When enabled (`1`), Traffic Server appends `X-Forwards` headers to
- outgoing requests.
+: When enabled (`1`), Traffic Server appends `X-Forwards` headers to outgoing requests.
*`proxy.config.http.anonymize_other_header_list`* {#proxy.config.http.anonymize_other_header_list}
: `STRING`
@@ -737,21 +580,17 @@ the `records.config` file.
*`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.
+: When enabled (`1`), Traffic Server adds the client IP address to the `X-Forwarded-For` header.
*`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:
+: Enable (`1`) to normalize all `Accept-Encoding:` headers to one of the following:
- `Accept-Encoding: gzip` (if the header has `gzip` or `x-gzip` with any `q`) **OR**
- *blank* (for any header that does not include `gzip`)
- This is useful for minimizing cached alternates of documents (e.g.
- `gzip, deflate` vs. `deflate, gzip`). Enabling this option is
- recommended if your origin servers use no encodings other than `gzip`.
+ This is useful for minimizing cached alternates of documents (e.g. `gzip, deflate` vs. `deflate, gzip`). Enabling this option is recommended if your origin servers use no encodings other than `gzip`.
### Security ### {#Security}
@@ -759,14 +598,9 @@ the `records.config` file.
*`proxy.config.http.push_method_enabled`* {#proxy.config.http.push_method_enabled}
: `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.
-
- **Important:** If you enable this option, then you must also
- specify a filtering rule in the
- [`filter.config`](filter.config) file to allow only
- certain machines to push content into the cache.
+: Enables (`1`) or disables (`0`) the HTTP `PUSH` option, which allows you to deliver content directly to the cache without a user request.
+
+ **Important:** If you enable this option, then you must also specify a filtering rule in the [`filter.config`](filter.config) file to allow only certain machines to push content into the cache.
### Cache Control ### {#CacheControl}
@@ -774,18 +608,12 @@ the `records.config` file.
*`proxy.config.cache.enable_read_while_writer`* {#proxy.config.cache.enable_read_while_writer}
: `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
+: 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
*`proxy.config.cache.force_sector_size`* {#proxy.config.cache.force_sector_size}
: `INT`
: Default: `512`
-: 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
+: 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
*`proxy.config.http.cache.http`* {#proxy.config.http.cache.http}
: `INT`
@@ -795,20 +623,17 @@ the `records.config` file.
*`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.
+: When enabled (`1`), Traffic Server ignores client requests to bypass the cache.
*`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.
+: When enabled (`1`), Traffic Server issues a conditional request to the origin server if an incoming request has a `No-Cache` header.
*`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.
+: When enabled (`1`), Traffic Server ignores origin server requests to bypass the cache.
*`proxy.config.http.cache.cache_responses_to_cookies`* {#proxy.config.http.cache.cache_responses_to_cookies}
: `INT`
@@ -823,24 +648,17 @@ the `records.config` file.
*`proxy.config.http.cache.ignore_authentication`* {#proxy.config.http.cache.ignore_authentication}
: `INT`
: Default: `0`
-: When enabled (`1`), Traffic Server ignores `WWW-Authentication`
- headers in responses
-
- `WWW-Authentication` headers are removed and not cached.
+: When enabled (`1`), Traffic Server ignores `WWW-Authentication` headers in responses `WWW-Authentication` headers are removed and not cached.
*`proxy.config.http.cache.cache_urls_that_look_dynamic`* {#proxy.config.http.cache.cache_urls_that_look_dynamic}
: `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)
+: 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)
*`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.
+: Enables (`1`) or disables (`0`) caching of alternate versions of HTTP objects that do not contain the `Vary` header.
*`proxy.config.http.cache.when_to_revalidate`* {#proxy.config.http.cache.when_to_revalidate}
@@ -855,15 +673,12 @@ the `records.config` file.
* `4` = use cache directives or heuristic (0) unless the request has
an `If-Modified-Since` header
- If the request contains the `If-Modified-Since` header, then
- Traffic Server always revalidates the cached content and uses the
- client's `If-Modified-Since` header for the proxy request.
+ If the request contains the `If-Modified-Since` header, then Traffic Server always revalidates the cached content and uses the client's `If-Modified-Since` header for the proxy request.
*`proxy.config.http.cache.when_to_add_no_cache_to_msie_requests`* {#proxy.config.http.cache.when_to_add_no_cache_to_msie_requests}
: `INT`
: Default: 0
-: Specifies when to add `no-cache` directives to Microsoft Internet
- Explorer requests. You can specify the following:
+: Specifies when to add `no-cache` directives to Microsoft Internet Explorer requests. You can specify the following:
* `0` = `no-cache` is *not* added to MSIE requests
* `1` = `no-cache` is added to IMS MSIE requests
@@ -872,151 +687,111 @@ the `records.config` file.
*`proxy.config.http.cache.required_headers`* {#proxy.config.http.cache.required_headers}
: `INT`
: Default: `0`
-: The type of headers required in a request for the request to be
- cacheable.
+: The type of headers required in a request for the request to be cacheable.
* `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
- * `2` = explicit lifetime is required, `Expires` or
- `Cache-Control: max-age`
+ * `1` = either the `Last-Modified` header, or an explicit lifetime header, `Expires` or `Cache-Control: max-age`, is required
+ * `2` = explicit lifetime is required, `Expires` or `Cache-Control: max-age`
*`proxy.config.http.cache.max_stale_age`* {#proxy.config.http.cache.max_stale_age}
: `INT`
: Default: `604800`
-: The maximum age allowed for a stale response before it cannot be
- cached.
+: The maximum age allowed for a stale response before it cannot be cached.
*`proxy.config.http.cache.range.lookup`* {#proxy.config.http.cache.range.lookup}
: `INT`
: Default: `1`
-: When enabled (`1`), Traffic Server looks up range requests in the
- cache.
+: When enabled (`1`), Traffic Server looks up range requests in the cache.
*`proxy.config.http.cache.enable_read_while_writer`* {#proxy.config.http.cache.enable_read_while_writer}
: `INT`
: Default: `0`
-: Enables (`1`) or disables (`0`) the ability to read a cached object
- while another connection is completing a write to cache for the
- same object. If you want connection collapsing to work, then this
- option must be enabled.
+: Enables (`1`) or disables (`0`) the ability to read a cached object while another connection is completing a write to cache for the same object. If you want connection collapsing to work, then this option must be enabled.
*`proxy.config.connection_collapsing.hashtable_enabled`* {#proxy.config.connection_collapsing.hashtable_enabled}
: `INT`
: Default: `0`
-: Enables (`1`) or disables (`0`) whether requests will first search
- the hashtable to see if another similar request is already being
- served.
+: Enables (`1`) or disables (`0`) whether requests will first search the hashtable to see if another similar request is already being served.
*`proxy.config.connection_collapsing.rww_wait_time`* {#proxy.config.connection_collapsing.rww_wait_time}
: `INT`
: Default: `0`
-: When enabled (`1`) while the write configuration parameter is also
- enabled, secondary clients will wait this amount of time (in msec)
- before cache lookup is retried.
+: When enabled (`1`) while the write configuration parameter is also enabled, secondary clients will wait this amount of time (in msec) before cache lookup is retried.
*`proxy.config.connection_collapsing.revalidate_window_period`* {#proxy.config.connection_collapsing.revalidate_window_period}
: `INT`
: Default: `0`
-: The amount of time (msec) secondary clients for the same URL will
- be served the stale object when revalidation of a cached object is
- in progress.
+: The amount of time (msec) secondary clients for the same URL will be served the stale object when revalidation of a cached object is in progress.
*`proxy.config.http.cache.fuzz.min_time`* {#proxy.config.http.cache.fuzz.min_time}
: `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`).
+: 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`).
*`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.
-
- **Note:** This option should only be enabled if you're having
- problems with caching *and* one of the following is true:
-
- * Your origin server sets `Vary: Accept` when doing content
- negotiation with `Accept` *OR*
- * The server does not send a `406 (Not Acceptable)` response for
- types that it cannot serve.
+: When enabled (`1`), Traffic Server serves documents from cache with a `Content-Type:` header that does not match the `Accept:` header of the request.
+
+ **Note:** This option should only be enabled if you're having problems with caching *and* one of the following is true:
+
+ * Your origin server sets `Vary: Accept` when doing content negotiation with `Accept` *OR*
+ * The server does not send a `406 (Not Acceptable)` response for types that it cannot serve.
*`proxy.config.http.cache.ignore_accept_language_mismatch`* {#proxy.config.http.cache.ignore_accept_language_mismatch}
: `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.
-
- **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`.
+: 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.
+
+ **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`.
*`proxy.config.http.cache.ignore_accept_charset_mismatch`* {#proxy.config.http.cache.ignore_accept_charset_mismatch}
: `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.
-
- **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`.
+: 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.
+
+ **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`.
*`proxy.config.http.cache.ignore_client_cc_max_age`* {#proxy.config.http.cache.ignore_client_cc_max_age}
: `INT`
: Default: `1`
-: When enabled (`1`), Traffic Server ignores any
- `Cache-Control: max-age` headers from the client.
+: When enabled (`1`), Traffic Server ignores any `Cache-Control: max-age` headers from the client.
*`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).
+: When enabled (`1`), Traffic Server will keep certain HTTP objects in the cache for a certain time as specified in [`cache.config`](cache.config).
### Heuristic Expiration ### {#HeuristicExpiration}
*`proxy.config.http.cache.heuristic_min_lifetime`* {#proxy.config.http.cache.heuristic_min_lifetime}
: `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.
+: The minimum amount of time an HTTP object without an expiration date can remain fresh in the cache before is considered to be stale.
*`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.
+: The maximum amount of time an HTTP object without an expiration date can remain fresh in the cache before is considered to be stale.
*`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.
+: The aging factor for freshness computations. Traffic Server stores an object for this percentage of the time that elapsed since it last changed.
*`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.
+: How often Traffic Server checks for an early refresh, during the period before the document stale time. The interval specified must be in seconds.
*`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.
+: The probability that a refresh is made on a document during the specified fuzz time.
### Dynamic Content & Content Negotiation ### {#DynamicContentAndContentNegotiation}
@@ -1024,10 +799,7 @@ the `records.config` file.
: `STRING`
: 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.
+ For example: if you specify `User-agent`, then Traffic Server caches all the different user-agent versions of documents it encounters.
*`proxy.config.http.cache.vary_default_images`* {#proxy.config.http.cache.vary_default_images}
: `STRING`
@@ -1037,8 +809,7 @@ the `records.config` file.
*`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.
+: The header on which Traffic Server varies for anything other than text and images.
### Customizable User Response Pages ### {#CustomizableUserResponsePages}
@@ -1046,22 +817,16 @@ the `records.config` file.
*`proxy.config.body_factory.enable_customizations`* {#proxy.config.body_factory.enable_customizations}
: `INT`
: Default: `0`
-: Specifies whether customizable response pages are enabled or
- disabled and which response pages are used:
+: Specifies whether customizable response pages are enabled or disabled and which response pages are used:
* `0` = disable customizable user response pages
- * `1` = enable customizable user response pages in the default
- directory only
+ * `1` = enable customizable user response pages in the default directory only
* `2` = enable language-targeted user response pages
*`proxy.config.body_factory.enable_logging`* {#proxy.config.body_factory.enable_logging}
: `INT`
: Default: `1`
-: Enables (`1`) or disables (`0`) logging for customizable response
- pages.
-
- When enabled, Traffic Server records a message in the error log
- each time a customized response page is used or modified.
+: Enables (`1`) or disables (`0`) logging for customizable response pages. When enabled, Traffic Server records a message in the error log each time a customized response page is used or modified.
*`proxy.config.body_factory.template_sets_dir`* {#proxy.config.body_factory.template_sets_dir}
: `STRING`
@@ -1083,48 +848,25 @@ the `records.config` file.
*`proxy.config.dns.search_default_domains`* {#proxy.config.dns.search_default_domains}
: `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`.
+: 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`.
*`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).
+: 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).
*`proxy.config.dns.url_expansions`* {#proxy.config.dns.url_expansions}
: `STRING`
: Default: `NULL`
-: Specifies a list of hostname extensions that are automatically
- added to the hostname after a failed lookup.
+: Specifies a list of hostname extensions that are automatically added to the hostname after a failed lookup. For example: if you want Traffic Server to add the hostname extension .org, then specify `org` as the value for this variable (Traffic Server automatically adds the dot (.)).
- For example: if you want Traffic Server to add the hostname
- extension .org, then specify `org` as the value for this variable
- (Traffic Server automatically adds the dot (.)).
-
- **Note:** If the variable
- *`proxy.config.http.enable_url_expandomatic`* is set to `1`
- (the default value), then you do not have to add **`www.`** and
- **`.com`** to this list because Traffic Server automatically tries
- www. and .com after trying the values you've specified.
+ **Note:** If the variable *`proxy.config.http.enable_url_expandomatic`* is set to `1` (the default value), then you do not have to add **`www.`** and **`.com`** to this list because Traffic Server automatically tries www. and .com after trying the values you've specified.
*`proxy.config.dns.resolv_conf`* {#proxy.config.dns.resolv_conf}
: `STRING`
: Default: `/etc/resolv.conf`
-: Allows to specify which `resolv.conf` file to use for finding resolvers.
- While the format of this file must be the same as the standard `resolv.conf` file,
- this option allows an administrator to manage the set of resolvers in an external
- configuration file, without affecting how the rest of the operating system uses DNS.
+: Allows to specify which `resolv.conf` file to use for finding resolvers. While the format of this file must be the same as the standard `resolv.conf` file, this option allows an administrator to manage the set of resolvers in an external configuration file, without affecting how the rest of the operating system uses DNS.
*`proxy.config.dns.round_robin_nameservers`* {#proxy.config.dns.round_robin_nameservers}
: `INT`
@@ -1147,30 +889,24 @@ the `records.config` file.
*`proxy.config.hostdb.serve_stale_for`* {#proxy.config.hostdb.serve_stale_for}
: `INT`
: Default: `0`
-: The number of seconds for which to utilize a stale NS record while
- initiating a background fetch for the new data.
+: The number of seconds for which to utilize a stale NS record whileinitiating a background fetch for the new data.
*`proxy.config.hostdb.storage_size`* {#proxy.config.hostdb.storage_size}
: `INT`
: Default: `33554432`
-: The amount of space (in bytes) used to store *`hostdb`*. The
- value of this variable must be increased if you increase the size
- of the *`proxy.config.hostdb.size`* variable.
+: 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.
*`proxy.config.hostdb.size`* {#proxy.config.hostdb.size}
: `INT`
: Default: `200000`
: The maximum number of entries allowed in the host database.
- **Note:** For values above `200000`, you must increase the value of
- the *`proxy.config.hostdb.storage_size`* variable by at least
- 44 bytes per entry.
+ **Note:** For values above `200000`, you must increase the value ofthe *`proxy.config.hostdb.storage_size`* variable by at least44 bytes per entry.
*`proxy.config.hostdb.ttl_mode`* {#proxy.config.hostdb.ttl_mode}
: `INT`
: Default: `0`
-: The host database time to live mode. You can specify one of the
- following:
+: The host database time to live mode. You can specify one of the following:
* `0` = obey
* `1`= ignore
@@ -1185,9 +921,7 @@ the `records.config` file.
*`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.
+: When disabled (`0`), Traffic Server always uses the same origin server for the same client, for as long as the origin server is available.
### Logging Config ### {#LoggingConfig}
@@ -1207,32 +941,22 @@ the `records.config` file.
*`proxy.config.log.max_secs_per_buffer`* {#proxy.config.log.max_secs_per_buffer}
: `INT`
: Default: `5`
-: The maximum amount of time before data in the buffer is flushed to
- disk.
+: The maximum amount of time before data in the buffer is flushed to disk.
*`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.
+: 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.
*`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.
+: The amount of space allocated to the logging directory (in MB) if this node is acting as a collation client.
*`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.
+: 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.
*`proxy.config.log.hostname`* {#proxy.config.log.hostname}
: `STRING`
@@ -1242,29 +966,20 @@ the `records.config` file.
*`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.
+: 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.
*`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). Permissable values are:
+: The log file permissions. The standard UNIX file permissions are used (owner, group, other). Permissable values are:
`-`no permission
`r`read permission
`w`write permission
`x`execute permission
- Permissions are subject to the umask settings for the Traffic
- Server process. This means that a umask setting of`002`will not
- allow write permission for others, even if specified in the
- configuration file. Permissions for existing log files are not
- changed when the configuration is changed.
+ Permissions are subject to the umask settings for the Traffic Server process. This means that a umask setting of`002`will not allow write permission for others, even if specified in the configuration file. Permissions for existing log files are not changed when the configuration is changed.
*`proxy.config.log.custom_logs_enabled`* {#proxy.config.log.custom_logs_enabled}
: `INT`
@@ -1298,8 +1013,7 @@ the `records.config` file.
*`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.
+: Enables (`1`) or disables (`0`) the Netscape common log file format.
*`proxy.config.log.common_log_is_ascii`* {#proxy.config.log.common_log_is_ascii}
: `INT`
@@ -1322,8 +1036,7 @@ the `records.config` file.
*`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.
+: Enables (`1`) or disables (`0`) the Netscape extended log file format.
*`proxy.confg.log.extended_log_is_ascii`* {#proxy.confg.log.extended_log_is_ascii}
: `INT`
@@ -1346,8 +1059,7 @@ the `records.config` file.
*`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.
+: Enables (`1`) or disables (`0`) the Netscape Extended-2 log file format.
*`proxy.config.log.extended2_log_is_ascii`* {#proxy.config.log.extended2_log_is_ascii}
: `INT`
@@ -1370,8 +1082,7 @@ the `records.config` file.
*`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.
+: When enabled (`1`), configures Traffic Server to store ICP transactions in a separate log file.
* `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.
@@ -1381,11 +1092,7 @@ the `records.config` file.
*`proxy.config.log.separate_host_logs`* {#proxy.config.log.separate_host_logs}
: `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).
+: 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).
*`proxy.local.log.collation_mode`* {#proxy.local.log.collation_mode}
: `INT`
@@ -1394,21 +1101,13 @@ the `records.config` file.
* `0` = collation is disabled
* `1` = this host is a log collation server
- * `2` = this host is a collation client and sends entries using
- standard formats to the collation server
- * `3` = this host is a collation client and sends entries using the
- traditional custom formats to the collation server
- * `4` = this host is a collation client and sends entries that use
- both the standard and traditional custom formats to the collation
- server
-
- For information on sending XML-based custom formats to the
- collation server, refer to
- [logs_xml.config](logs_xml.config).
-
- **Note:** Although Traffic Server supports traditional custom
- logging, you should use the more versatile XML-based custom
- formats.
+ * `2` = this host is a collation client and sends entries using standard formats to the collation server
+ * `3` = this host is a collation client and sends entries using the traditional custom formats to the collation server
+ * `4` = this host is a collation client and sends entries that use both the standard and traditional custom formats to the collation server
+
+ For information on sending XML-based custom formats to the collation server, refer to [logs_xml.config](logs_xml.config).
+
+ **Note:** Although Traffic Server supports traditional custom logging, you should use the more versatile XML-based custom formats.
*`proxy.confg.log.collation_host`* {#proxy.confg.log.collation_host}
: `STRING`
@@ -1418,21 +1117,17 @@ the `records.config` file.
*`proxy.config.log.collation_port`* {#proxy.config.log.collation_port}
: `INT`
: Default: `8085`
-: The port used for communication between the collation server and
- client.
+: The port used for communication between the collation server and client.
*`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.
+: The password used to validate logging data and prevent the exchange of unauthorized information when a collation server is being used.
*`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.
+: When enabled (`1`), configures Traffic Server to include the hostname of the collation client that generated the log entry in each entry.
*`proxy.config.log.collation_retry_sec`* {#proxy.config.log.collation_retry_sec}
: `INT`
@@ -1442,36 +1137,25 @@ the `records.config` file.
*`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:
+: Specifies how log files are rolled. You can specify the following values:
* `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)
- * `2` = enables log file rolling when log files reach a specific size
- (specified with the *`proxy.config.log.rolling_size_mb`*
- variable)
- * `3` = enables log file rolling at specific intervals during the day
- or when log files reach a specific size (whichever occurs first)
- * `4` = enables log file rolling at specific intervals during the day
- when log files reach a specific size (i.e., at a specified time if
- the file is of the specified size)
+ * `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)
+ * `2` = enables log file rolling when log files reach a specific size (specified with the *`proxy.config.log.rolling_size_mb`* variable)
+ * `3` = enables log file rolling at specific intervals during the day or when log files reach a specific size (whichever occurs first)
+ * `4` = enables log file rolling at specific intervals during the day when log files reach a specific size (i.e., at a specified time if the file is of the specified size)
*`proxy.config.log.rolling_interval_sec`* {#proxy.config.log.rolling_interval_sec}
: `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).
+: The log file rolling interval, in seconds. The minimum value is `300` (5 minutes). The maximum value is 86400 seconds (one day).
- **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.
+ **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.
*`proxy.config.log.rolling_offset_hr`* {#proxy.config.log.rolling_offset_hr}
: `INT`
: Default: `0`
-: The file rolling offset hour. The hour of the day that starts the
- log rolling period.
+: The file rolling offset hour. The hour of the day that starts the log rolling period.
*`proxy.config.log.rolling_size_mb`* {#proxy.config.log.rolling_size_mb}
: `INT`
@@ -1481,29 +1165,22 @@ the `records.config` file.
*`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.
+: Enables (`1`) or disables (`0`) automatic deletion of rolled files.
*`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:
+: Configures Traffic Server to log only a sample of transactions rather than every transaction. You can specify the following values:
* `1` = log every transaction
* `2` = log every second transaction
- * `3` = log every third transaction
- and so on...
+ * `3` = log every third transaction and so on...
*`proxy.config.http.slow.log.threshold`* {#proxy.config.http.slow.log.threshold}
: `INT`
: Default: `0`
-: The number of milliseconds before a slow connection's debugging
- stats are dumped.
-
- Specify `1` to enable or `0` to disable.
+: The number of milliseconds before a slow connection's debugging stats are dumped. Specify `1` to enable or `0` to disable.
### Reverse Proxy ### {#ReverseProxy}
@@ -1518,8 +1195,7 @@ the `records.config` file.
*`proxy.config.header.parse.no_host_url_redirect`* {#proxy.config.header.parse.no_host_url_redirect}
: `STRING`
: Default: `NULL`
-: The URL to which to redirect requests with no host headers (reverse
- proxy).
+: The URL to which to redirect requests with no host headers (reverse proxy).
### URL Remap Rules ### {#URLRemapRules}
@@ -1527,47 +1203,22 @@ the `records.config` file.
*`proxy.config.url_remap.default_to_server_pac`* {#proxy.config.url_remap.default_to_server_pac}
: `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`.
+: 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`.
*`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.
+: 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.
*`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.
+: 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.
*`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.
+: Set this variable to `1` if you want to retain the client host header in a request during remapping.
### SSL Termination ### {#SSLTermination}
@@ -1575,25 +1226,20 @@ the `records.config` file.
*`proxy.config.ssl.accelerator_required`* {#proxy.config.ssl.accelerator_required}
: `INT`
: Default: `0`
-: Indicates if an accelerator card is required for operation. Traffic
- Server supports Cavium accelerator cards.
+: Indicates if an accelerator card is required for operation. Traffic Server supports Cavium accelerator cards.
You can specify:
* `0` - not required
- * `1` - accelerator card is required and Traffic Server will not
- enable SSL unless an accelerator card is present.
- * `2` - accelerator card is required and Traffic Server will not
- start unless an accelerator card is present.
+ * `1` - accelerator card is required and Traffic Server will not enable SSL unless an accelerator card is present.
+ * `2` - accelerator card is required and Traffic Server will not start unless an accelerator card is present.
- You can verify operation by
- running`/home/y/bin/openssl_accelerated` (this comes as part of `openssl_engines_init`).
+ You can verify operation by running`/home/y/bin/openssl_accelerated` (this comes as part of `openssl_engines_init`).
*`proxy.config.ssl.enabled`* {#proxy.config.ssl.enabled}
: `INT`
: Default: `0`
-: Enables (`1`) or disables (`0`) the
- [SSL Termination](../security-options#UsingSSLTermination) option.
+: Enables (`1`) or disables (`0`) the [SSL Termination](../security-options#UsingSSLTermination) option.
*`proxy.config.ssl.SSLv2`* {#proxy.config.ssl.SSLv2}
: `INT`
@@ -1613,13 +1259,9 @@ the `records.config` file.
*`proxy.confg.ssl.accelerator.type`* {#proxy.confg.ssl.accelerator.type}
: `INT`
: Default: `0`
-: Specifies if the Cavium SSL accelerator card is installed on (and
- required by) your Traffic Server machine:
-
- * `0` = none (no SSL accelerator card is installed on the Traffic
- Server machine, so the Traffic Server's CPU determines the number
- of requests served per second)
+: Specifies if the Cavium SSL accelerator card is installed on (and required by) your Traffic Server machine:
+ * `0` = none (no SSL accelerator card is installed on the Traffic Server machine, so the Traffic Server's CPU determines the number of requests served per second)
* `1` = accelerator card is present and required by Traffic Server
*`proxy.config.ssl.server_port`* {#proxy.config.ssl.server_port}
@@ -1632,66 +1274,46 @@ the `records.config` file.
: Default: `0`
: Sets the client certification level:
- * `0` = no client certificates are required. Traffic Server does not
- verify client certificates during the SSL handshake. Access to
- Traffic Server depends on Traffic Server configuration options
- (such as access control lists).
-
- * `1` = client certificates are optional. If a client has a
- certificate, then the certificate is validated. If the client does
- not have a certificate, then the client is still allowed access to
- Traffic Server unless access is denied through other Traffic Server
- configuration options.
-
- * `2` = client certificates are required. The client must be
- authenticated during the SSL handshake. Clients without a
- certificate are not allowed to access Traffic Server.
+ * `0` = no client certificates are required. Traffic Server does not verify client certificates during the SSL handshake. Access to Traffic Server depends on Traffic Server configuration options (such as access control lists).
+
+ * `1` = client certificates are optional. If a client has a certificate, then the certificate is validated. If the client does not have a certificate, then the client is still allowed access to Traffic Server unless access is denied through other Traffic Server configuration options.
+
+ * `2` = client certificates are required. The client must be authenticated during the SSL handshake. Clients without a certificate are not allowed to access Traffic Server.
*`proxy.config.ssl.server.cert.filename`* {#proxy.config.ssl.server.cert.filename}
: `STRING`
: Default: `server.pem`
-: The filename of the Traffic Server SSL certificate (the server
- certificate).
+: The filename of the Traffic Server SSL certificate (the server certificate).
*`proxy.config.ssl.server.cert_chain.filename`* {#proxy.config.ssl.server.cert_chain.filename}
: `STRING`
: Default: `NULL`
-: The file, in a chain of certificates, that is the root certificate
- recognized by your website.
+: The file, in a chain of certificates, that is the root certificate recognized by your website.
*`proxy.config.ssl.server.cert.path`* {#proxy.config.ssl.server.cert.path}
: `STRING`
: Default: `/config`
-: The location of the Traffic Server SSL certificate (the server
- certificate).
+: The location of the Traffic Server SSL certificate (the server certificate).
*`proxy.config.ssl.server.private_key.filename`* {#proxy.config.ssl.server.private_key.filename}
: `STRING`
: Default: `NULL`
-: The filename of the Traffic Server private key.
-
- Change this variable only if the private key is not located in the
- Traffic Server SSL certificate file.
+: The filename of the Traffic Server private key. Change this variable only if the private key is not located in the Traffic Server SSL certificate file.
*`proxy.config.ssl.server.private_key.path`* {#proxy.config.ssl.server.private_key.path}
: `STRING`
: Default: `NULL`
-: The location of the Traffic Server private key.
-
- Change this variable only if the private key is not located in the
- SSL certificate file.
+: The location of the Traffic Server private key. Change this variable only if the private key is not located in the SSL certificate file.
*`proxy.config.ssl.CA.cert.filename`* {#proxy.config.ssl.CA.cert.filename}
: `STRING`
: Default: `NULL`
-: The filename of the certificate authority that client certificates
- will be verified against.
+: The filename of the certificate authority that client certificates will be verified against.
*`proxy.config.ssl.CA.cert.path`* {#proxy.config.ssl.CA.cert.path}
: `STRING`
: Default: `NULL`
-: The location of the certificate authority file that client
- certificates will be verified against.
+: The location of the certificate authority file that client certificates will be verified against.
#### Client-Related Configuration #### {#SSLClientRelatedConfigurations}
@@ -1699,48 +1321,37 @@ the `records.config` file.
*`proxy.config.ssl.client.verify.server`* {#proxy.config.ssl.client.verify.server}
: `INT`
: Default: `0`
-: Configures Traffic Server to verify the origin server certificate
- with the Certificate Authority (CA).
+: Configures Traffic Server to verify the origin server certificate with the Certificate Authority (CA).
*`proxy.config.ssl.client.cert.filename`* {#proxy.config.ssl.client.cert.filename}
: `STRING`
: Default: `NULL`
-: The filename of SSL client certificate installed on Traffic
- Server.
+: The filename of SSL client certificate installed on Traffic Server.
*`proxy.config.ssl.client.cert.path`* {#proxy.config.ssl.client.cert.path}
: `STRING`
: Default: `/config`
-: The location of the SSL client certificate installed on Traffic
- Server.
+: The location of the SSL client certificate installed on Traffic Server.
*`proxy.config.ssl.client.private_key.filename`* {#proxy.config.ssl.client.private_key.filename}
: `STRING`
: Default: `NULL`
-: The filename of the Traffic Server private key.
-
- Change this variable only if the private key is not located in the
- Traffic Server SSL client certificate file.
+: The filename of the Traffic Server private key. Change this variable only if the private key is not located in the Traffic Server SSL client certificate file.
*`proxy.config.ssl.client.private_key.path`* {#proxy.config.ssl.client.private_key.path}
: `STRING`
: Default: `NULL`
-: The location of the Traffic Server private key.
-
- Change this variable only if the private key is not located in the
- SSL client certificate file.
+: The location of the Traffic Server private key. Change this variable only if the private key is not located in the SSL client certificate file.
*`proxy.config.ssl.client.CA.cert.filename`* {#proxy.config.ssl.client.CA.cert.filename}
: `STRING`
: Default: `NULL`
-: The filename of the certificate authority against which the origin
- server will be verified.
+: The filename of the certificate authority against which the origin server will be verified.
*`proxy.config.ssl.client.CA.cert.path`* {#proxy.config.ssl.client.CA.cert.path}
: `STRING`
: Default: `NULL`
-: Specifies the location of the certificate authority file against
- which the origin server will be verified.
+: Specifies the location of the certificate authority file against which the origin server will be verified.
### ICP Configuration ### {#ICPConfiguration}
@@ -1761,10 +1372,7 @@ the `records.config` file.
: Default: *`your_interface`*
: Specifies the network interface used for ICP traffic.
- **Note:** The Traffic Server installation script detects your
- network interface and sets this variable appropriately. If your
- system has multiple network interfaces, check that this variable
- specifies the correct interface.
+ **Note:** The Traffic Server installation script detects your network interface and sets this variable appropriately. If your system has multiple network interfaces, check that this variable specifies the correct interface.
*`proxy.config.icp.icp_port`* {#proxy.config.icp.icp_port}
: `INT`
@@ -1787,29 +1395,22 @@ the `records.config` file.
*`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.
+: 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.
*`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.
+: Specifies the number of times Traffic Server can retry the scheduled update of a URL in the event of failure.
*`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.
+: Specifies the delay (in seconds) between each scheduled update retry for a URL in the event of failure.
*`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.
+: Specifies the maximum simultaneous update requests allowed at any time. This option prevents the scheduled update process from overburdening the host.
### Remap Plugin Processor ### {#RemapPluginProcessor}
@@ -1817,14 +1418,12 @@ the `records.config` file.
*`proxy.config.remap.use_remap_processor`* {#proxy.config.remap.use_remap_processor}
: `INT`
: Default: `0`
[... 85 lines stripped ...]