Appendix E - Configuration Files

src ipaddress

Specifies the source (client) IP address in incoming requests Traffic Server must bypass.

The variable ipaddress can be one of the following:

dst ipaddress

Specifies the destination (origin server) IP address in incoming requests Traffic Server must bypass.

The variable ipaddress can be one of the following:

- A simple IP address, such as 123.45.67.8
- In CIDR (Classless Inter-Domain Routing) format, such as 1.1.1.0/24
- A range separated by a dash, such as 1.1.1.1-2.2.2.2
- Any combination of the above separated by commas, such as 1.1.1.0/24, 25.25.25.25, 123.1.23.1-123.1.23.123

src ipaddress AND dst ipaddress

Specifies the source and destination IP address pair Traffic Server must bypass.

The variable ipaddress must be a single IP address, such as 123.45.67.8

dest_domain

A requested domain name. Traffic Server matches the domain name of the destination from the URL in the request.

dest_host

A requested hostname. Traffic Server matches the hostname of the destination from the URL in the request.

dest_ip

A requested IP address. Traffic Server matches the IP address of the destination in the request.

url_regex

A regular expression to be found in a URL.

port

A requested URL port.

scheme

A request URL protocol: http or https.

prefix

A prefix in the path part of a URL.

suffix

A file suffix in the URL.

method

A request URL method: get, put, post, trace.

time

A time range, such as 08:00-14:00.

src_ip

A client IP address.

action

One of the following values:

never-cache configures Traffic Server to never cache specified objects.
ignore-no-cache configures Traffic Server to ignore all Cache-Control: no-cache headers.
ignore-client-no-cache configures Traffic Server to ignore Cache-Control: no-cache headers from client requests.
ignore-server-no-cache configures Traffic Server to ignore Cache-Control: no-cache headers from origin server responses.

pin-in-cache

The amount of time you want to keep the object(s) in the cache. The following time formats are allowed:

d for days; for example: 2d
h for hours; for example: 10h
m for minutes; for example: 5m
s for seconds; for example: 20s
mixed units; for example: 1h15m20s

revalidate

The amount of time object(s) are to be considered fresh. Use the same time formats as pin-in-cache .

ttl-in-cache

The amount of time object(s) are to be kept in the cache, regardless of Cache-Control response headers. Use the same time formats as pin-in-cache and revalidate .

dest_domain

A requested domain name.

dest_host

A requested hostname.

dest_ip

A requested IP address.

url_regex

A regular expression to be found in a URL.

port

A requested URL port or range of ports.

prefix

A prefix in the path part of a URL.

max_connection_failures

The maximum number of connection failures allowed within the fail window described below before Traffic Server marks the origin server as congested. The default value is 5.

fail_window

The time period during which the maximum number of connection failures can occur before Traffic Server marks the origin server as congested. The default value is 120 seconds.

proxy_retry_interval

The number of seconds that Traffic Server waits before contacting a congested origin server again. The default value is 10 seconds

client_wait_interval

The number of seconds that the client is advised to wait before retrying the congested origin server. The default value is 300 seconds.

wait_interval_alpha

The upper limit for a random number that is added to the wait interval. The default value is 30 seconds.

live_os_conn_timeout

The connection timeout to the live (uncongested) origin server. The default value is 60 seconds.
If a client stops a request before the timeout occurs, then Traffic Server does not record a connection failure.

live_os_conn_retries

The maximum number of retries allowed to the live (uncongested) origin server. The default value is 2.

dead_os_conn_timeout

The connection timeout to the congested origin server. The default value is 15 seconds.

dead_os_conn_retries

The maximum number of retries allowed to the congested origin server. The default value is 1.

max_connection

The maximum number of connections allowed from Traffic Server to the origin server. The default value is -1.

error_page

The error page sent to the client when a server is congested. You must enclose the value in quotes; the default value is "congestion#retryAfter".
The error page is sent only if the Custom Responses option is enabled (refer to HTTP Responses).

congestion_scheme

Specifies if Traffic Server applies the rule on a per-host ("per_host") or per-IP basis ("per_ip"). The default value is "per_ip"; you must enclose the value in quotes.
For example: if the server www.host1.com has two IP addresses and you use the tag value "per_ip", then each IP address has its own number of connection failures and is marked as congested independently. If you use the tag value "per_host" and the server www.host1.com is marked as congested, then both IP addresses are marked as congested.

dest_domain

A requested domain name. Traffic Server matches the domain name of the destination from the URL in the request.

dest_host

A requested hostname. Traffic Server matches the hostname of the destination from the URL in the request.

dest_ip

A requested IP address. Traffic Server matches the IP address of the destination in the request.

url_regex

A regular expression to be found in a URL.

port

A requested URL port.

scheme

A request URL protocol: http or https.

prefix

A prefix in the path part of a URL.

suffix

A file suffix in the URL.

method

A request URL method. You can specify one of the following:
get
post
put
trace
PUSH

Note: If the PUSH option is enabled (the PUSH option lets you deliver content directly to the cache without user request), then you must add a filtering rule with the PUSH action to ensure that only known source IP addresses implement PUSH requests to the cache. To enable the PUSH option, set the configuration variable proxy.config.http.push_method_enabled to 1 in the records.config file.

time

A time range, such as 08:00-14:00.

src_ip

A client IP address.
Note: src_ip is not supported for PNA content.

host

The hostname of the ICP peer.
This field is optional; if you do not specify the hostname of the ICP peer, you must specify the IP address.

host _IP

The IP address of the ICP peer.
This field is optional; if you do not specify the IP address of the ICP peer, you must specify the hostname.

ctype

Use the following options:

1 to indicate an ICP parent cache
2 to indicate an ICP sibling cache

proxy_port

The port number of the TCP port used by the ICP peer for proxy communication.

icp_port

The port number of the UDP port used by the ICP peer for ICP communication.

format

All lines must begin with the word format .

activation flag

Specifies if the custom log file is activated. You can specify one of the following options:

enabled
disabled

unique format identifier

You must use a unique integer for each custom log file you create.

format name

The name for the format you define.

format string

Identifies the printf -style format string specifying the field symbols to be displayed and how they should look in ASCII. Refer to this Appendix for a list of the available field symbols and their meanings.

Field symbols are indicated by %< field_symbol > format. For example: to indicate that chi is the client host IP and not the string chi to be printed, enter % <chi> .

file name

The name of the custom log file you create.

file type

The format of the file: ASCII or BINARY.

file header data

The header text. Enter none if you do not want header text; enter the text of the header if you want your custom log file to have a header.

<Name = "valid_format_name"/>

Required. Valid format names include any name except squid, common, extended, or extended2, which are pre-defined formats. There is no default for this tag.

<Format = "valid_format_specification"/>

Required. A valid format specification is a printf-style string describing each log entry when formatted for ASCII output. Use %< field > as a placeholder for valid field names. For more information, refer to Custom Logging Fields.

The specified field can be one of the following types:

• Simple. For example: %<cqu>

• A field within a container, such as an HTTP header or a statistic. Fields of this type have the syntax: %<{ field } container >
• Aggregates, such as COUNT, SUM, AVG, FIRST, LAST. Fields of this type have the syntax: %<operator ( field )>

Note: You cannot create a format specification that contains both aggregate operators and regular fields.

<Interval = "aggregate_interval_secs"/>

Use this tag when the format contains aggregate operators. The value "aggregate_interval_secs" represents the number of seconds between individual aggregate values being produced.

The valid set of aggregate operators are:
COUNT
SUM
AVG
FIRST
LAST

<Name = "valid_filter_name"/>

Required. All filters must be uniquely named.

<Condition = "valid_log_field valid_operator valid_comparison_value"/>

Required. This field contains the following elements:

valid_log_field - the field that will be compared against the given value. For more information, refer to Logging Format Cross-Reference.

valid_operator_field - any one of the following: MATCH , CASE_INSENSITIVE_MATCH , CONTAIN , CASE_INSENSITIVE_CONTAIN.

• MATCH is true if the field and value are identical (case-sensitive).
• CASE_INSENSITIVE_MATCH is similar to MATCH, except that it is case-insensitive.
• CONTAIN is true if the field contains the value (the value is a substring of the field).
• CASE_INSENSITIVE_CONTAIN is a case-insensitive version of CONTAIN.

valid_comparison_value - any string or integer matching the field type. For integer values, all of the operators are equivalent and mean that the field must be equal to the specified value.

Note: There are no negative comparison operators. If you want to specify a negative condition, then use the Action field to REJECT the record.

<Action = "valid_action_field"/>

This instructs Traffic Server to either accept or reject records that satisfy the filter condition.
Required: ACCEPT or REJECT .

<Format = "valid_format_name"/>

Required. Valid format names include the predefined logging formats: squid, common, extended, and extended2, as well as any previously-defined custom log formats. There is no default for this tag.

<Filename = "file_name"/>

Required. The filename to which the given log file is written on the local file system or on a remote collation server. No local log file will be created if you fail to specify this tag. All filenames are relative to the default logging directory.

If the name does not contain an extension (for example, squid), then the extension .log is automatically appended to it for ASCII logs and .blog for binary logs (refer to Mode = "valid_logging_mode").
If you do not want an extension to be added, then end the filename with a single (.) dot (for example: squid. ).

<Mode = "valid_logging_mode"/>

Valid logging modes include ascii , binary , and ascii_pipe . The default is ascii .

• - Use ascii to create event log files in human-readable form (plain ASCII).
• - Use binary to create event log files in binary format. Binary log files generate lower system overhead and occupy less space on the disk (depending on the information being logged). You must use the logcat utility to translate binary log files to ASCII format before you can read them.
• - Use ascii_pipe to write log entries to a UNIX named pipe (a buffer in memory). Other processes can then read the data using standard I/O functions. The advantage of using this option is that Traffic Server does not have to write to disk, which frees disk space and bandwidth for other tasks. In addition, writing to a pipe does not stop when logging space is exhausted because the pipe does not use disk space.

If you are using a collation server, then the log is written to a pipe on the collation server. A local pipe is created even before a transaction is processed, so you can see the pipe right after Traffic Server starts. Pipes on a collation server, however, are created when Traffic Server starts.

<Filters = "list_of_valid_filter_names"/>

A comma-separated list of names of any previously-defined log filters. If more than one filter is specified, then all filters must accept a record for the record to be logged.

<Protocols = "list_of_valid_protocols"/>

A comma-separated list of the protocols this object should log. Valid protocol names for this release are HTTP (FTP is deprecated).

<ServerHosts = "list_of_valid_servers"/>

A comma-separated list of valid hostnames.This tag indicates that only entries from the named servers will be included in the file.

<CollationHosts = "list_of_valid_hostnames"/>

A comma-separated list of collation servers to which all log entries (for this object) are forwarded. Collation servers can be specified by name or IP address. Specify the collation port with a colon after the name; for example, host:port .

<Header = "header"/>

The header text you want the log files to contain. The header text appears at the beginning of the log file, just before the first record.

<RollingEnabled = "truth value"/>

Enables or disables log file rolling for the LogObject. This setting overrides the value for the proxy.config.log2.rolling_enabled variable in the records.config file. Set truth value to one of the following values:

0 to disable rolling for this particular LogObject.
1 to roll log files at specific intervals during the day (you specify time intervals with the RollingIntervalSec and RollingOffsetHr fields).
2 to roll log files when they reach a certain size (you specify the size with the RollingSizeMb field).
3 to roll log files at specific intervals during the day or when they reach a certain size (whichever occurs first).
4 to roll log files at specific intervals during the day when log files reach a specific size (at a specified time if the file is of the specified size).

<RollingIntervalSec = "seconds"/>

The seconds between log file rolling for the LogObject; enables you to specify different rolling intervals for different LogObjects.
This setting overrides the value for proxy.config.log2.rolling_interval_sec in the records.config file.

<RollingOffsetHr = "hour"/>

Specifies an hour (from 0 to 23) at which rolling is guaranteed to align. Rolling might start before then, but a rolled file will be produced only at that time. The impact of this setting is only noticeable if the rolling interval is larger than one hour.
This setting overrides the configuration setting for proxy.config.log2.rolling_offset_hr in the records.config file.

<RollingSizeMb = "size_in_MB"/>

The size at which log files are rolled.

dest_domain

A requested domain name.

dest_host

A requested hostname.

dest_ip

A requested IP address or range of IP addresses separated by a dash (-).

url_regex

A regular expression to be found in a URL

port

A requested URL port.

scheme

A request URL protocol: http or https.

prefix

A prefix in the path part of a URL.

suffix

A file suffix in the URL.

method

A request URL method. It can be one of the following:
get
post
put
trace

time

A time range, such as 08:00-14:00, during which the parent cache is used to serve requests.

src_ip

A client IP address.

parent

An ordered list of parent servers. If the request cannot be handled by the last parent server in the list, then it will be routed to the origin server. You can specify either a hostname or an IP address, but; you must specify the port number.

round_robin

One of the following values:

true - Traffic Server goes through the parent cache list in a round robin-based on client IP address.
strict - Traffic Server machines serve requests strictly in turn. For example: machine proxy1 serves the first request, proxy2 serves the second request, and so on.
false - Round robin selection does not occur.

go_direct

One of the following values:

true - requests bypass parent hierarchies and go directly to the origin server.
false - requests do not bypass parent hierarchies.

proxy.config.proxy_name

STRING

The name of the Traffic Server node.

proxy.config.bin_path

STRING

bin

The location of the Traffic Server bin directory.

proxy.config.proxy_binary

STRING

traffic_server

The name of the executable that runs the traffic_server process.

proxy.config.proxy_binary_opts

STRING

-M

The command-line options for starting Traffic Server.

proxy.config.manager_binary

STRING

traffic_manager

The name of the executable that runs the traffic_manager process.

proxy.config.cli_binary

STRING

traffic_line

The name of the executable that runs the command-line interface (Traffic Line).

proxy.config.watch_script

STRING

traffic_cop

The name of the executable that runs the traffic_cop process.

proxy.config.env_prep

STRING

example_prep.sh

The script executed before the traffic_manager process spawns the traffic_server process.

proxy.config.config_dir

STRING

config

The directory that contains Traffic Server configuration files.

proxy.config.temp_dir

STRING

/tmp

The directory used for Traffic Server temporary files.

proxy.config.alarm_email

STRING

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

STRING

LOG_DAEMON

The facility used to record system log files.

Refer to Understanding Traffic Server Log Files.

proxy.config.cop.core_signal

INT

0

The signal sent to traffic_cop's managed processes to stop them.

0 = no signal is sent.

proxy.config.cop.linux_min_swapfree_kb

INT

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.

proxy.config.cop.linux_min_memfree_kb

INT

10240

The minimum amount of free memory 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 disabled in Linux 2.2 only.

proxy.config.output.logfile

STRING

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.

proxy.config.snapshot_dir

STRING

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.

proxy.config.accept_threads

INT

proxy.config.thread.default.stacksize

INT

proxy.config.lm.sem_id

INT

11452

The semaphore ID for the local manager.

proxy.local.cluster.type

INT

3

Sets the clustering mode:

1 = full-clustering mode
2 = management-only mode
3 = no clustering

proxy.config.cluster.rsport

INT

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.

proxy.config.admin.autoconf_port

INT

8083

The autoconfiguration port.

proxy.config.admin.overseer_port

INT

8082

The port used for retrieving and setting statistics and configuration variables.

proxy.config.admin.number_config_bak

INT

3

The maximum number of copies of rolled configuration files to keep.

proxy.config.admin.user_id

STRING

nobody

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.

proxy.config.process_manager.mgmt_port

INT

8084

The port used for internal communication between the traffic_manager and traffic_server processes.

proxy.config.alarm.bin

STRING

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.

proxy.config.alarm.abs_path

STRING

NULL

The full path to the script file that sends email to alert someone about Traffic Server problems.

proxy.config.proxy.authenticate.basic.realm

NULL

The authentication realm name. If the default of NULL is specified, then traffic_edge is used.

HTTP Engine

proxy.config.http.server_port

INT

8080

The port that Traffic Server uses when acting as a web proxy server for web traffic.

proxy.config.http.server_port_attr

STRING

X

The server port options. You can specify one of the following:

C=SERVER_PORT_COMPRESSED
X=SERVER_PORT_DEFAULT
T=SERVER_PORT_BLIND_TUNNEL

proxy.config.http.server_other_ports

STRING

NULL

The ports other than the port specified by the variable proxy.config.http.server_port to bind for incoming HTTP requests.

proxy.config.http.ssl_ports

STRING

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.

proxy.config.http.insert_request_via_str

INT

1

You can specify one of the following:

0 = no extra information is added to the string.
1 = all extra information is added.
2 = some extra information is added.

proxy.config.http.insert_response_via_str

INT

1

You can specify one of the following:

0 = no extra information is added to the string.
1 = all extra information is added.
2 = some extra information is added.

proxy.config.http.enable_url_expandomatic

INT

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 .

proxy.config.http.no_dns_just_forward_to_parent

INT

0

When enabled (1) and if parent caching is enabled, then Traffic Server does not perform DNS lookups on request hostnames.

proxy.config.http.uncacheable_requests_bypass_parent

INT

1

When enabled (1), Traffic Server bypasses the parent proxy for a request that is not cacheable.

proxy.config.http.keep_alive_enabled

INT

1

Enables (1) or disables (0) the use of keep-alive connections to either origin servers or clients.

proxy.config.http.chunking_enabled

INT

0

Specifies whether Traffic Sever can generate a chunked response:

proxy.config.http.send_http11_requests

INT

3

Configures Traffic Server to use HTTP Version 1.1 when communicating with origin servers. You can specify one of the following values:

1 = Traffic Server always uses HTTP 1.1 when communicating with origin servers.
2 = Traffic Server uses HTTP 1.1 if the origin server has previously used HTTP 1.1.
3 = Traffic Server uses HTTP 1.1 if the client request is HTTP 1.1 and the origin server has previously used HTTP 1.1.

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

INT

1

Enables (1) or disables (0) the reuse of server sessions.

proxy.config.http.record_heartbeat

INT

0

Enables (1) or disables (0) traffic_cop heartbeat logging.

Parent Proxy Configuration

proxy.config.http.parent_proxy_routing_enable

INT

0

Enables (1) or disables (0) the parent caching option.

Refer to Hierarchical Caching.

proxy.config.http.parent_proxy.retry_time

INT

300

The amount of time allowed between connection retries to a parent cache that is unavailable.

proxy.config.http.parent_proxy.fail_threshold

INT

10

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

INT

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).

proxy.config.http.parent_proxy.per_parent_connect_attempts

INT

2

The total number of connection attempts allowed per parent, if multiple parents are used.

proxy.config.http.parent_proxy.connect_attempts_timeout

INT

30

The timeout value (in seconds) for parent cache connection attempts.

proxy.config.http.forward.proxy_auth_to_parent

INT

0

Configures Traffic Server to send proxy authentication headers on to the parent cache.

HTTP Connection Timeouts (secs)

proxy.config.http.keep_alive_no_activity_timeout_in

INT

10

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

INT

10

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

INT

120

Specifies how long Traffic Server keeps connections to clients open if a transaction stalls.

proxy.config.http.transaction_no_activity_timeout_out

INT

120

Specifies how long Traffic Server keeps connections to origin servers open if the transaction stalls.

proxy.config.http.transaction_active_timeout_in

INT

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.

proxy.config.http.transaction_active_timeout_out

INT

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.

proxy.config.http.accept_no_activity_timeout

INT

120

The timeout interval in seconds before Traffic Server closes a connection that has no activity.

proxy.config.http.background_fill_active_timeout

INT

60

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

FLOAT

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).

Origin Server Connect Attempts

proxy.config.http.connect_attempts_max_retries

INT

6

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

INT

2

The maximum number of connection retries Traffic Server can make when the origin server is unavailable.

proxy.config.http.server_max_connections

INT

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

INT

Limits the number of socket connections per origin server to the value specified.

To disable, set to zero (0).

proxy.config.http.connect_attempts_rr_retries

INT

proxy.config.http.connect_attempts_timeout

INT

30

The timeout value (in seconds) for an origin server connection.

proxy.config.http.post_connect_attempts_timeout

INT

1800

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

INT

900

Specifies how long (in seconds) Traffic Server remembers that an origin server was unreachable.

proxy.config.http.down_server.abort_threshold

INT

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.

proxy.config.http.congestion_control.enabled

INT

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.

proxy.config.http.negative_caching_enabled

INT

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:

204 No Content
305 Use Proxy
400 Bad Request
403 Forbidden
404 Not Found
405 Method Not Allowed
500 Internal Server Error
501 Not Implemented
502 Bad Gateway
503 Service Unavailable
504 Gateway Timeout

proxy.config.http.negative_caching_lifetime

INT

1800

The how long (in seconds) Traffic Server keeps the negative responses valid in cache.

Note: This value only affects negative responses that do have explicit Expires: or Cache-Control: lifetimes set by the server.

proxy.config.http.anonymize_remove_from

INT

0

When enabled (1), Traffic Server removes the From header to protect the privacy of your users.

proxy.config.http.anonymize_remove_referer

INT

0

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

INT

0

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

INT

0

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

INT

0

When enabled (1), Traffic Server removes Client-IP headers for more privacy.

proxy.config.http.anonymize_insert_client_ip

INT

1

When enabled (1), Traffic Server inserts Client-IP headers to retain the client IP address.

proxy.config.http.append_xforwards_header

INT

0

When enabled (1), Traffic Server appends X-Forwards headers to outgoing requests.

proxy.config.http.anonymize_other_header_list

STRING

NULL

The headers Traffic Server should remove from outgoing requests.

proxy.config.http.insert_squid_x_forwarded_for

INT

0

When enabled (1), Traffic Server adds the client IP address to the X-Forwarded-For header.

proxy.config.http.normalize_ae_gzip

INT

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.

proxy.config.http.push_method_enabled

INT

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 file to allow only certain machines to push content into the cache.

proxy.config.http.cache.http

INT

1

Enables (1) or disables (0) caching of HTTP requests.

proxy.config.http.cache.ignore_client_no_cache

INT

0

When enabled (1), Traffic Server ignores client requests to bypass the cache.

proxy.config.http.cache.ims_on_client_no_cache

INT

0

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

INT

0

When enabled (1), Traffic Server ignores origin server requests to bypass the cache.

proxy.config.http.cache.cache_responses_to_cookies

INT

3

Specifies how cookies are cached:

0 = do not cache any responses to cookies
1 = cache for any content-type
2 = cache only for image types
3 = cache for all but text content-types

proxy.config.http.cache.ignore_authentication

INT

0

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

INT

0

Enables (1) or disables (0) caching of URLs that look dynamic.

proxy.config.http.cache.enable_default_vary_headers

INT

0

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

INT

0

Specifies when to revalidate content:

0 = use cache directives or heuristic (the default value)
1 = stale if heuristic
2 = always stale (always revalidate)
3 = never stale
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.

proxy.config.http.cache.when_to_add_no_cache_to_msie_requests

INT

0

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
2 = no-cache is added to all MSIE requests

proxy.config.http.cache.required_headers

INT

0

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

proxy.config.http.cache.max_stale_age

INT

604800

The maximum age allowed for a stale response before it cannot be cached.

proxy.config.http.cache.range.lookup

INT

1

When enabled (1), Traffic Server looks up range requests in the cache.

proxy.config.http.cache.enable_read_while_writer

INT

proxy.config.connection_collapsing.hashtable_enabled

INT

proxy.config.connection_collapsing.rww_wait_time

INT

proxy.config.connection_collapsing.revalidate_window_period

INT

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

INT

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

INT

Note: This option should only be enabled if you're having problems with caching and one of the following is true:

proxy.config.http.cache.ignore_accept_language_mismatch

INT

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_encoding_mismatch

INT

When enabled (1), Traffic Server serves documents from cache with a Content-Encoding: header that does not match the Accept-Encoding: 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-Encoding when doing content negotiation with Accept-Encoding.

proxy.config.http.cache.ignore_accept_charset_mismatch

INT

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

INT

Heuristic Expiration

proxy.config.http.cache.heuristic_min_lifetime

INT

3600

The minimum amount of time a document in the cache is considered to be fresh.

proxy.config.http.cache.heuristic_max_lifetime

INT

86400

The maximum amount of time a document in the cache remains fresh.

proxy.config.http.cache.heuristic_lm_factor

FLOAT

0.10000

The aging factor for freshness computations.

proxy.config.http.cache.fuzz.time

INT

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.

proxy.config.http.cache.fuzz.probability

FLOAT

0.00500

The probability that a refresh is made on a document during the specified fuzz time.

Dynamic Content & Content Negotiation

proxy.config.http.cache.vary_default_text

STRING

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.

proxy.config.http.cache.vary_default_images

STRING

NULL

The header on which Traffic Server varies for images.

proxy.config.http.cache.vary_default_other

STRING

NULL

The header on which Traffic Server varies for anything other than text and images.

proxy.config.body_factory.enable_customizations

INT

0

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
2 = enable language-targeted user response pages

proxy.config.body_factory.enable_logging

INT

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.

proxy.config.body_factory.template_sets_dir

config/body_factory

The customizable response page default directory.

proxy.config.body_factory.response_suppression_mode

INT

0

Specifies when Traffic Server suppresses generated response pages:

0 = never suppress generated response pages
1 = always suppress generated response pages
2 = suppress response pages only for intercepted traffic

proxy.config.dns.search_default_domains

INT

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.

proxy.config.dns.splitDNS.enabled

INT

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).

proxy.config.dns.splitdns.def_domain

STRING

NULL

The default domain for split DNS requests. This value is appended automatically to the hostname if it does not include a domain before split DNS determines which DNS server to use.

proxy.config.dns.url_expansions

STRING

NULL

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 (.).

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.round_robin_nameservers

INT

0

Enables (1) or disables (0) DNS server round-robin.

proxy.config.dns.nameservers

STRING

NULL

The DNS servers.

proxy.config.srv_enabled

INT

proxy.config.hostdb.serve_stale_for

INT

proxy.config.hostdb.storage_size

INT

proxy.config.hostdb.size

INT

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.

proxy.config.hostdb.ttl_mode

INT

0

The host database time to live mode. You can specify one of the following:

0 = obey
1 = ignore
2 = min(X,ttl)
3 = max(X,ttl)

proxy.config.hostdb.timeout

INT

1440

The foreground timeout (in minutes).

proxy.config.hostdb.strict_round_robin

INT

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.

Logging Config

proxy.config.log2.logging_enabled

INT

3

Enables and disables event logging:

0 = logging disabled
1 = log errors only
2 = log transactions only
3 = full logging (errors + transactions)

Refer to Working with Log Files.

proxy.config.log2.max_secs_per_buffer

INT

5

The maximum amount of time before data in the buffer is flushed to disk.

proxy.config.log2.max_space_mb_for_logs

INT

2000

The amount of space allocated to the logging directory (in MB).

proxy.config.log2.max_space_mb_for_orphan_logs

INT

25

The amount of space allocated to the logging directory (in MB) if this node is acting as a collation client.

proxy.config.log2.max_space_mb_headroom

INT

10

The tolerance for the log space limit (in bytes).

If the variable proxy.config.log2.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.log2.hostname

STRING

localhost

The hostname of the machine running Traffic Server.

proxy.config.log2.logfile_dir

STRING

install_dir /logs

The full path to the logging directory.

proxy.config.log2.logfile_perm

STRING

rw-r--r--

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.

proxy.config.log2.custom_logs_enabled

INT

0

Enables (1) or disables (0) custom logging.

proxy.config.log2.xml_logs_config

INT

1

Enables (1) or disables (0) extended custom logging using an XML-based configuration file.
A value of 0 instructs Traffic Server to use the traditional custom log formats.

Note: Although Traffic Server supports traditional custom logging, you should use the more versatile XML-based custom formats.

proxy.config.log2.squid_log_enabled

INT

1

Enables (1) or disables (0) the squid log file format.

proxy.config.log2.squid_log_is_ascii

INT

1

The squid log file type:

1 = ASCII
0 = binary

proxy.config.log2.squid_log_name

STRING

squid

The squid log filename.

proxy.config.log2.squid_log_header

STRING

NULL

The squid log file header text.

proxy.config.log2.common_log_enabled

INT

0

Enables (1) or disables (0) the Netscape common log file format.

proxy.config.log2.common_log_is_ascii

INT

1

The Netscape common log file type:

1 = ASCII
0 = binary

proxy.config.log2.common_log_name

STRING

common

The Netscape common log filename.

proxy.config.log2.common_log_header

STRING

NULL

The Netscape common log file header text.

proxy.config.log2.extended_log_enabled

INT

0

Enables (1) or disables (0) the Netscape extended log file format.

proxy.confg.log2.extended_log_is_ascii

INT

1

The Netscape extended log file type:

1 = ASCII
0 = binary

proxy.config.log2.extended_log_name

STRING

extended

The Netscape extended log filename.

proxy.config.log2.extended_log_header

STRING

NULL

The Netscape extended log file header text.

proxy.config.log2.extended2_log_enabled

INT

0

Enables (1) or disables (0) the Netscape Extended-2 log file format.

proxy.config.log2.extended2_log_is_ascii

INT

1

The Netscape Extended-2 log file type:

1 = ASCII
0 = binary

proxy.config.log2.extended2_log_name

STRING

extended2

The Netscape Extended-2 log filename.

proxy.config.log2.extended2_log_header

STRING

NULL

The Netscape Extended-2 log file header text.

proxy.config.log2.separate_icp_logs

INT

0

When enabled (1), configures Traffic Server to store ICP transactions in a separate log file.

proxy.config.log2.separate_host_logs

INT

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.

proxy.local.log2.collation_mode

INT

0

The log collation mode:

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.

Note: Although Traffic Server supports traditional custom logging, you should use the more versatile XML-based custom formats.

proxy.confg.log2.collation_host

STRING

NULL

The hostname of the log collation server.

proxy.config.log2.collation_port

INT

8085

The port used for communication between the collation server and client.

proxy.config.log2.collation_secret

STRING

foobar

The password used to validate logging data and prevent the exchange of unauthorized information when a collation server is being used.

proxy.config.log2.collation_host_tagged

INT

0

When enabled (1), configures Traffic Server to include the hostname of the collation client that generated the log entry in each entry.

proxy.config.log2.collation_retry_sec

INT

5

The number of seconds between collation server connection retries.

proxy.config.log2.rolling_enabled

INT

1

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.log2.rolling_interval_sec and proxy.config.log2.rolling_offset_hr variables)

2 = enables log file rolling when log files reach a specific size (specified with the proxy.config.log2.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.log2.rolling_interval_sec

INT

86400

The log file rolling interval, in seconds. The minimum value is 300 (5 minutes). The maximum value is 86400 seconds (one day).

proxy.config.log2.rolling_offset_hr

INT

0

The file rolling offset hour. The hour of the day that starts the log rolling period.

proxy.config.log2.rolling_size_mb

INT

10

The size that log files must reach before rolling takes place.

proxy.config.log2.auto_delete_rolled_files

INT

1

Enables (1) or disables (0) automatic deletion of rolled files.

proxy.config.log2.sampling_frequency

INT

1

Configures Traffic Server to log only a sample of transactions rather than every transaction. You can specify the following values:

proxy.config.http.slow.log.threshold

INT

proxy.config.reverse_proxy.enabled

INT

0

Enables (1) or disables (0) HTTP reverse proxy.

proxy.config.header.parse.no_host_url_redirect

STRING

NULL

The URL to which to redirect requests with no host headers (reverse proxy).

proxy.config.url_remap.default_to_server_pac

INT

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.

proxy.config.url_remap.default_to_server_pac_port

INT

-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.

proxy.config.url_remap.remap_required

INT

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.

proxy.config.url_remap.pristine_host_hdr

INT

0

Set this variable to 1 if you want to retain the client host header in a request during remapping.

proxy.config.ssl.accelerator_required

INT

0

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.

You can verify operation by running /home/y/bin/openssl_accelerated
(this comes as part of openssl_engines_init).

proxy.config.ssl.enabled

INT

0

Enables (1) or disables (0) the SSL Termination option.

proxy.config.ssl.SSLv2

INT

1

Enables (1) or disables (0) SSLv2.

proxy.config.ssl.SSLv3

INT

1

Enables (1) or disables (0) SSLv3.

proxy.config.ssl.TLSv1

INT

1

Enables (1) or disables (0) TLSv1.

Note: IBM web servers do not support the TLS (Transport Layer Security) protocol. For IBM web servers to work with Traffic Server, you must set this variable to 0.

proxy.confg.ssl.accelerator.type

INT

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)

1 = accelerator card is present and required by Traffic Server

proxy.config.ssl.server_port

INT

443

The port used for SSL communication.

proxy.config.ssl.client.certification_level

INT

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.

proxy.config.ssl.server.cert.filename

STRING

server.pem

The filename of the Traffic Server SSL certificate (the server certificate).

proxy.config.ssl.server.cert_chain.filename

STRING

NULL

The file, in a chain of certificates, that is the root certificate recognized by your website.

proxy.config.ssl.server.cert.path

STRING

/config

The location of the Traffic Server SSL certificate (the server certificate).

proxy.config.ssl.server.private_key.filename

STRING

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.

proxy.config.ssl.server.private_key.path

STRING

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.

proxy.config.ssl.CA.cert.filename

STRING

NULL

The filename of the certificate authority that client certificates will be verified against.

proxy.config.ssl.CA.cert.path

STRING

NULL

The location of the certificate authority file that client certificates will be verified against.

Client-Related Configuration

proxy.config.ssl.client.verify.server

INT

0

Configures Traffic Server to verify the origin server certificate with the Certificate Authority (CA).

proxy.config.ssl.client.cert.filename

STRING

NULL

The filename of SSL client certificate installed on Traffic Server.

proxy.config.ssl.client.cert.path

STRING

/config

The location of the SSL client certificate installed on Traffic Server.

proxy.config.ssl.client.private_key.filename

STRING

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.

proxy.config.ssl.client.private_key.path

STRING

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.

proxy.config.ssl.client.CA.cert.filename

STRING

NULL

The filename of the certificate authority against which the origin server will be verified.

proxy.config.ssl.client.CA.cert.path

STRING

NULL

Specifies the location of the certificate authority file against which the origin server will be verified.

proxy.config.icp.enabled

INT

0

Sets ICP mode for hierarchical caching:

0 = disables ICP
1 = allows Traffic Server to receive ICP queries only
2 = allows Traffic Server to send and receive ICP queries

Refer to ICP Peering.

proxy.config.icp.icp_interface

STRING

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.

proxy.config.icp.icp_port

INT

3130

Specifies the UDP port that you want to use for ICP messages.

proxy.config.icp.query_timeout

INT

2

Specifies the timeout used for ICP queries.

proxy.config.update.enabled

INT

0

Enables (1) or disables (0) the Scheduled Update option.

proxy.config.update.force

INT

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.

proxy.config.update.retry_count

INT

10

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

INT

2

Specifies the delay (in seconds) between each scheduled update retry for a URL in the event of failure.

proxy.config.update.concurrent_updates

INT

100

Specifies the maximum simultaneous update requests allowed at any time. This option prevents the scheduled update process from overburdening the host.

proxy.config.remap.use_remap_processor

INT

0

Enables (1) or disables (0) the ability to run separate threads for remap plugin processing.

proxy.config.remap.num_remap_threads

INT

1

Specifies the number of threads that will be used for remap plugin processing.

proxy.config.plugin.plugin_dir

STRING

config/plugins

Specifies the location of Traffic Server plugins.

proxy.config.net.sock_send_buffer_size_in

INT

0

Sets the send buffer size for connections from the client to Traffic Server.

proxy.config.net.sock_recv_buffer_size_in

INT

proxy.config.net.sock_option_flag_in

INT

Turns different options "on" for the socket handling client connections:

TCP_NODELAY (1)
SO_KEEPALIVE (2)

Note: This is a flag and you look at the bits set. Therefore, you must set the value to 3 if you want to enable both options above.

proxy.config.net.sock_send_buffer_size_out

INT

proxy.config.net.sock_recv_buffer_size_out

INT

proxy.config.net.sock_option_flag_out

INT

Turns different options "on" for the origin server socket:

TCP_NODELAY (1)
SO_KEEPALIVE (2)

Note: This is a flag and you look at the bits set. Therefore, you must set the value to 3 if you want to enable both options above.

proxy.config.net.sock_mss_in

INT

type

Enter one of the following:

map --translates an incoming request URL to the appropriate origin server URL.

reverse_map --translates the URL in origin server redirect responses to point to the Traffic Server.

redirect --redirects HTTP requests permanently without having to contact the origin server. Permanent redirects notify the browser of the URL change (by returning an HTTP status code 301) so that the browser can update bookmarks.

redirect_temporary --redirects HTTP requests temporarily without having to contact the origin server. Temporary redirects notify the browser of the URL change for the current request only (by returning an HTTP status code 307).

Note: use the regex_ prefix to indicate that the line has a regular expression.

target

Enter the origin ("from") URL. You can enter up to four components:

scheme :// host : port / path_prefix

where scheme is http.

replacement

Enter the destination ("to") URL. You can enter up to four components:

scheme://host:port/path_prefix

where scheme can be http or https.

http://www.x.com/Widgets/index.html

http://server.hoster.com/Widgets/index.html

http://www.x.com/cgi/form/submit.sh?arg=true

http://server.hoster.com/cgi/form/submit.sh?arg=true

http://www.y.com/marketing/projects/manhattan/specs.html

http://marketing.y.com/projects/manhattan/specs.html

http://www.y.com/stuff/marketing/projects/boston/specs.html

http://info.y.com/marketing/projects/boston/specs.html

http://www.y.com/engineering/marketing/requirements.html

http://engineering.y.com/marketing/requirements.html

http://www.g.com/stuff/a.gif

http://external.g.com/stuff/a.gif

http://www.h.com/a/b/c/d/doc.html

http://server.h.com/customers/x/y/c/d/doc.html

http://www.h.com/a/index.html

Translation fails

http://www.x.com/Widgets

http://server.hoster.com/x/Widgets

http://www.x.com/Widgets

http://server.hoster.com/x/Widgets/

http://www.x.com/Widgets/

dest_domain

A valid domain name. This specifies that DNS server selection will be based on the destination domain. You can prefix the domain with an exclamation mark (!) to indicate the NOT logical operator.

dest_host

A valid hostname. This specifies that DNS server selection will be based on the destination host. You can prefix the host with an exclamation mark (!) to indicate the NOT logical operator.

url_regex

A valid URL regular expression. This specifies that DNS server selection will be based on a regular expression.

dns_server

This is a required directive. It identifies the DNS server that Traffic Server should use with the given destination specifier. You can specify a port using a colon (:). If you do not specify a port, then 53 is used. Specify multiple DNS servers with spaces or semicolons (;) as separators.

You must specify the domains with IP addresses in CIDR ("dot") notation.

def_domain

A valid domain name. This optional directive specifies the default domain name to use for resolving hosts. Only one entry is allowed. If you do not provide the default domain, the system determines its value from /etc/resolv.conf

search_list

A list of domains separated by spaces or semicolons (;). This specifies the domain search order. If you do not provide the search list, the system determines the value from /etc/resolv.conf

URL

HTTP-based URLs.

request_headers

Optional. A list of headers (separated by semicolons) passed in each GET request. You can define any request header that conforms to the HTTP specification. The default is no request header.

offset_hour

The base hour used to derive the update periods. The range is 00-23 hours.

interval

The interval (in seconds) at which updates should occur, starting at the offset hour.

recursion_depth

The depth to which referenced URLs are recursively updated, starting at the given URL. This field applies only to HTTP.

x

Matches the character x

.

Match any character

^

Specifies beginning of line

$

Specifies end of line

[xyz]

A character class. In this case, the pattern matches either x, y, or z

[abj-oZ]

A character class with a range. This pattern matches a, b, any letter from j thru o, or Z

[^A-Z]

A negated character class. For example, this pattern matches any character except those in the class.

r*

Zero or more r, where r is any regular expression.

r+

One or more r, where r is any regular expression.

r?

Zero or one r, where r is any regular expression.

r{2,5}

From two to five r, where r is any regular expression.

r{2,}

Two or more r, where r is any regular expression.

r{4}

Exactly four r, where r is any regular expression.

"[xyz]\"images"

The literal string [xyz]"images"

\X

If X is a, b, f, n, r, t, or v, then the ANSI-C interpretation of \x; otherwise, a literal X. This is used to escape operators such as *

\0

A NULL character

\123

The character with octal value 123

\x2a

The character with hexadecimal value 2a

(r)

Matches an r, where r is any regular expression. You can use parentheses to override precedence.

rs

The regular expression r, followed by the regular expression s

r|s

Either an r or an s

#<n>#

Inserts an end node, which causes regular expression matching to stop when reached. The value n is returned.