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 2010/03/01 20:53:48 UTC
svn commit: r917681 [2/8] - /incubator/trafficserver/site/trunk/docs/admin/
Modified: incubator/trafficserver/site/trunk/docs/admin/files.htm
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/admin/files.htm?rev=917681&r1=917680&r2=917681&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/admin/files.htm (original)
+++ incubator/trafficserver/site/trunk/docs/admin/files.htm Mon Mar 1 19:53:47 2010
@@ -1,77 +1,53 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
-<head>
-<title>Traffic Server Configuration Files</title>
+ <head>
+ <title>Configuration Files</title>
+ <meta content="text/html; charset=UTF-8" http-equiv="content-type"/>
-<!--#include file="top.html" -->
-
-<h1>Appendix E - Configuration Files</h1>
+<link rel="stylesheet" href="doc.css" type="text/css" media="all" /></head>
+ <body>
+<h1><a name="63579">Appendix E - Configuration Files</a></h1>
<p>
-This appendix describes the Traffic Server configuration files that you can edit. </p>
+This appendix describes the Traffic Server configuration files that you can edit. For a list of all the configuration files used by Traffic Server, including files that you must not edit, refer to the <em>Traffic Server Installation Guide</em>. </p>
<ul>
-<li><a href="#bypass.config">bypass.config</a> </li>
-<li><a href="#cache.config">cache.config</a></li>
-<li><a href="#congestion.config">congestion.config</a></li>
-<li><a href="#filter.config">filter.config</a></li>
-<li><a href="#hosting.config">hosting.config</a></li>
-<li><a href="#icp.config">icp.config</a></li>
-<li><a href="#ip_allow.config">ip_allow.config</a></li>
-<li><a href="#logs.config">logs.config</a></li>
-<li><a href="#logs_hosts.config">log_hosts.config</a></li>
-<li><a href="#logs_xml.config">logs_xml.config</a></li>
-<li><a href="#parent.config">parent.config</a></li>
-<li><a href="#partition.config">partition.config</a></li>
-<li><a href="#records.config">records.config</a>
- <ul>
- <li><a href="#records.config.system">System Variables</a></li>
- <li><a href="#records.config.local">Local Manager</a></li>
- <li><a href="#records.config.process">Process Manager</a></li>
- <li><a href="#records.config.alarm">Alarm Configuration</a></li>
- <li><a href="#records.config.auth">Authentication Basic Realm</a></li>
- <li><a href="#records.config.congestion">Congestion Control</a></li>
- <li><a href="#records.config.negative">Negative Response Caching</a></li>
- <li><a href="#records.config.proxy">Proxy User Variables</a></li>
- <li><a href="#records.config.security">Security</a></li>
- <li><a href="#records.config.cache">Cache Control</a></li>
- <li><a href="#records.config.user">Customizable User Response Pages</a></li>
- <li><a href="#records.config.DNS">DNS</a></li>
- <li><a href="#records.config.HostDB">HostDB</a></li>
- <li><a href="#records.config.reverse">Reverse Proxy</a></li>
- <li><a href="#records.config.remap">URL Remap Rules</a></li>
- <li><a href="#records.config.SSL">SSL Termination</a></li>
- <li><a href="#records.config.client">Client-Related Configuration</a></li>
- <li><a href="#records.config.ICP">ICP Configuration</a></li>
- <li><a href="#records.config.update">Scheduled Update Configuration</a></li>
- <li><a href="#records.config.remapplugin">Remap Plugin Processor</a></li>
- <li><a href="#records.config.plugin">Plug-in Configuration</a></li>
- <li><a href="#records.config.sockets">Sockets</a></li>
- </ul>
-</li>
-<li><a href="#remap.config">remap.config</a></li>
-<li><a href="#splitdns.config">splitdns.config</a></li>
-<li><a href="#ssl_multicert.config">ssl_multicert.config</a></li>
-<li><a href="#storage.config">storage.config</a></li>
-<li><a href="#update.config">update.config</a></li>
-<li><a href="#url_regex">Specifying URL Regular Expressions (url_regex)</a></li>
+<li><a href="#69422"><em>bypass.config</em></a> </li>
+<li><a href="#48049"><em>cache.config</em></a></li>
+<li><a href="#220539"><em>congestion.config</em></a></li>
+<li><a href="#234878"><em>filter.config</em></a></li>
+<li><a href="#139053"><em>hosting.config</em></a></li>
+<li><a href="#115203"><em>icp.config</em></a></li>
+<li><a href="#53256"><em>ip_allow.config</em></a></li>
+<li><a href="#149839"><em>logs.config</em></a></li>
+<li><a href="#109741"><em>log_hosts.config</em></a></li>
+<li><a href="#131440"><em>logs_xml.config</em></a></li>
+<li><a href="#150269"><em>parent.config</em></a></li>
+<li><a href="#50072"><em>partition.config</em></a></li>
+<li><a href="#115367"><em>records.config</em></a></li>
+<li><a href="#232990"><em>remap.config</em></a></li>
+<li><a href="#132448"><em>splitdns.config</em></a></li>
+<li><a href="#151382"><em>ssl_multicert.config</em></a></li>
+<li><a href="#151089"><em>storage.config</em></a></li>
+<li><a href="#235005"><em>update.config</em></a></li>
+<li><a href="#112065"><em>Specifying URL Regular Expressions (url_regex)</em></a></li>
</ul>
<h2>
-<a name="bypass.config">bypass.config</a></h2>
- <p> The <code> bypass.config</code> file contains static bypass rules that Traffic Server uses in transparent proxy caching mode. <em> Static</em> bypass rules instruct Traffic Server to bypass certain incoming client requests so they are served by the origin server. The <code>bypass.config</code> file also accepts <a href="#dynamic.deny_bypass">Dynamic Deny Bypass Rules</a>.</p>
+<a name="69422">bypass.config</a></h2>
+ <p> The <code> bypass.config</code> file contains static bypass rules that Traffic Server uses in transparent proxy caching mode. <em> Static</em> bypass rules instruct Traffic Server to bypass certain incoming client requests so they are served by the origin server. The <code>bypass.config</code> file also accepts <a href="#62813">Dynamic Deny Bypass Rules</a>.</p>
<p>You can configure three types of static bypass rules: </p>
<ul>
- <li> <b>Source bypass rules</b> configure Traffic Server to bypass a particular source IP address or range of IP addresses. For example: bypass clients that do not want to use caching. </li><br />
- <li><b> Destination bypass rules</b> configure Traffic Server to bypass a particular destination IP address or range of IP addresses. For example: bypass origin servers that use IP authentication based on the client's real IP address.<br />
+ <li><em> Source </em>bypass rules configure Traffic Server to bypass a particular source IP address or range of IP addresses. For example: bypass clients that do not want to use caching. </li><br />
+ <li><em> Destination </em>bypass rules configure Traffic Server to bypass a particular destination IP address or range of IP addresses. For example: bypass origin servers that use IP authentication based on the client's real IP address.<br />
<strong>IMPORTANT</strong>: Destination bypass rules prevent Traffic Server from caching an entire site. You will experience hit rate impacts if the site you bypass is popular.</li>
<br />
- <li><b>Source/destination pair bypass rules</b> configure Traffic Server to bypass requests that originate from the specified source to the specified destination. For example: route around specific client-server pairs that experience broken IP authentication or out-of-band HTTP traffic problems when cached. Source/destination bypass rules can be preferable to destination rules because they block a destination server only for users that experience problems. </li>
+ <li><em>Source/destination pair </em>bypass rules configure Traffic Server to bypass requests that originate from the specified source to the specified destination. For example: route around specific client-server pairs that experience broken IP authentication or out-of-band HTTP traffic problems when cached. Source/destination bypass rules can be preferable to destination rules because they block a destination server only for users that experience problems. </li>
</ul>
<p><strong>IMPORTANT: </strong>After you modify the <code>bypass.config</code> file, you must restart Traffic Server. </p>
- <h3>Format</h3>
+ <h3>
+ <a name="61408">Format</a> </h3>
<p>Bypass rules follow the format below: <br />
<code>bypass src <em>ipaddress</em> | dst <em>ipaddress</em> | <em>src ipaddress</em> AND dst <em>ipaddress</em></code></p>
- <p>The following table describes the variables. </p>
+ <p>The following table describes the options. </p>
<table border="1"><code>
<tr>
<th> <p>Option </p></th>
@@ -103,26 +79,27 @@
</tr>
</table>
<h4>
- <a name="dynamic.deny_bypass">Dynamic Deny Bypass Rules</a> </h4>
- <p>In addition to static bypass rules, the <code>bypass.config</code> file also accepts <em>dynamic deny</em> bypass rules that prevent Traffic Server from bypassing certain incoming client requests dynamically (a deny bypass rule can prevent Traffic Server from bypassing itself). Dynamic deny bypass rules can be source, destination, or source/destination and have the following format: <br />
+ <a name="62813">Dynamic Deny Bypass Rules</a> </h4>
+ <p>In addition to static bypass rules, the <code>bypass.confi</code>g file also accepts <em>dynamic deny </em>bypass rules that prevent Traffic Server from bypassing certain incoming client requests dynamically (a deny bypass rule can prevent Traffic Server from bypassing itself). Dynamic deny bypass rules can be source, destination, or source/destination and have the following format: <br />
<code>deny_dyn_bypass src <em>ipaddress</em> | dst <em>ipaddress</em> | src <em>ipaddresss</em> AND <em>ipaddress</em></code> </p>
<p>For a description of the options, refer to the table above. For the dynamic deny bypass rules to work, you must set the variable <code><i>proxy.config.arm.bypass_dynamic_enabled</i></code> to <code>1</code> in the <code>records.config</code> file. </p>
<p><strong>IMPORTANT:</strong> Static bypass rules overwrite dynamic deny bypass rules. If a static bypass rule and a dynamic bypass rule contain the same IP address, then the dynamic deny bypass rule will be ignored. </p>
- <h3>Examples</h3>
- <p>The following example shows source, destination, and source/destination <b>bypass rules</b>: <br />
+ <h3>
+ <a name="157525">Examples</a> </h3>
+ <p>The following example shows source, destination, and source/destination <em>bypass</em> rules: <br />
<code>bypass src 1.1.1.0/24, 25.25.25.25, 128.252.11.11-128.252.11.255</code> <br />
<code>bypass dst 24.24.24.0/24</code> <br />
<code>bypass src 25.25.25.25 AND dst 24.24.24.0</code></p>
- <p>The following example shows source, destination, and source/destination <b>dynamic deny bypass rules</b>: <br />
+ <p>The following example shows source, destination, and source/destination <em>dynamic deny </em><em>bypass </em>rules: <br />
<code>deny_dyn_bypass src 128.252.11.11-128.252.11.255 </code><br />
<code>deny_dyn_bypass dst 111.111.11.1</code> <br />
<code>deny_dyn_bypass src 111.11.11.1 AND dst 111.11.1.1</code></p>
<h2>
- <a name="cache.config"></a>cache.config</h2>
+ <a name="48049"></a>cache.config</h2>
<p>The <code>cache.config</code> file defines how Traffic Server caches web objects. You can add caching rules to specify the following: </p>
<ul>
<li>Not to cache objects from specific IP addresses</li>
@@ -132,7 +109,7 @@
</ul>
<p><strong>IMPORTANT: </strong>After you modify the <code>cache.config</code> file, navigate to the Traffic Server<code> bin</code> directory; then run the <code>traffic_line -x </code>command to apply changes. When you apply the changes to a node in a cluster, Traffic Server automatically applies the changes to all other nodes in the cluster. </p>
<h3>
- <strong>Format</strong> </h3>
+ <strong><a name="49095">Format</a></strong> </h3>
<p>Each line in the <code>cache.config</code> file contains a caching rule. Traffic Server recognizes three space-delimited tags: <br />
<code><em>primary_destination</em>=<em>value</em> <em>secondary_specifier</em>=<em>value</em> <em>action</em>=<em>value</em></code></p>
<p>You can use more than one secondary specifier in a rule. However, you cannot repeat a secondary specifier. <br />
@@ -226,7 +203,8 @@
<td><p>The amount of time object(s) are to be kept in the cache, regardless of <code>Cache-Control</code> response headers. Use the same time formats as <code> pin-in-cache</code> and <code> revalidate</code> .</p></td>
</tr>
</table>
- <h3><strong>Examples</strong></h3>
+ <h3>
+ <strong><a name="74394">Examples</a></strong></h3>
<p>The following example configures Traffic Server to revalidate <code>gif</code> and <code>jpeg</code> objects in the domain <code>mydomain.com</code> every 6 hours, and all other objects in <code>mydomain.com</code> every hour. The rules are applied in the order listed. </p>
<p>
<code>dest_domain=mydomain.com suffix=gif revalidate=6h</code> <br />
@@ -234,7 +212,7 @@
<code>dest_domain=mydomain.com revalidate=1h</code> </p>
<h2>
- <a name="congestion.config">congestion.config</a> </h2>
+ <a name="220539">congestion.config</a> </h2>
<p>The <code>congestion.config</code> file enables you to configure Traffic Server to stop forwarding HTTP requests to origin servers when they become congested, and then send the client a message to retry the congested origin server later. After you modify the <code>congestion.control</code> file, navigate to the Traffic Server<code> bin</code> directory; then run the <code>traffic_line -x</code> command to apply changes. When you apply the changes to a node in a cluster, Traffic Server automatically applies the changes to all other nodes in the cluster. Traffic Server uses the <code>congestion.config</code> file only if you enable the <a href="http.htm#UsingCongestionControl">Congestion Control</a> option.</p>
<p>You can create rules in the <code>congestion.config</code> file to specify: </p>
<ul>
@@ -243,7 +221,8 @@
<li>The page Traffic Server sends to the client when a server becomes congested.</li>
<li>If Traffic Server tracks the origin servers per IP address or per hostname.</li>
</ul>
- <h3>Format</h3>
+ <h3>
+ <a name="220862">Format</a> </h3>
<p>Each line in <code>congestion.config</code> must follow the format below. Traffic Server applies the rules in the order listed, starting at the top of the file. <br />Traffic Server recognizes three space-delimited tags: <br />
<code><em>primary_destination</em>=<em>value</em> <em>secondary_specifier</em>=<em>value</em> <em>action</em>=<em>value</em></code> </p>
<p>The following table lists possible primary destinations with allowed values. </p>
@@ -342,13 +321,13 @@
</tr>
</table>
<p>
-<strong>Examples</strong></p>
+<strong><a name="220707">Examples</a></strong></p>
<p>The following <code>congestion.config</code> rule configures Traffic Server to stop forwarding requests to the server <code>www.host.com</code> on port 80 (HTTP traffic) if the server is congested, according to the timeouts specified. Traffic Server uses the default tag values because no tag has been specified.
<br /><code>dest_host=www.host.com port=80</code> </p>
<p>You can use one or more tags in a rule, but each tag must have one value only. If you specify no tags in the rule, then Traffic Server uses default values. </p>
<p>You can override any of the default tag values by adding configuration variables at the end of <code>records.config</code> as follows: <br />
<code>CONFIG proxy.config.http.congestion_control.default.<em>tag</em> INT|STRING <em>value</em></code> <br />
- where <code><i><b>tag</b></i></code> is one of the tags described in the table under <a href="#congestion.config">congestion.config</a> and <code><i><b>value</b></i></code> is the value you want to use.</p>
+ where <code><i><b>tag</b></i></code> is one of the tags described in the table under <a href="#220539">congestion.config</a> and <code><i><b>value</b></i></code> is the value you want to use.</p>
<p>For example: <br /><code>CONFIG<br />
proxy.config.http.congestion_control.default.congestion_scheme STRING per_host</code> </p>
<p><strong>IMPORTANT: </strong>Rules in the <code>congestion.config</code> file override the following variables in the <code>records.config</code> file: </p>
@@ -359,9 +338,10 @@
<code>proxy.config.http.down_server.cache_time</code> <br />
<code>proxy.config.http.down_server.abort_threshold</code></i></p>
<h2>
-<a name="filter.config">filter.config</a></h2>
+<a name="234878">filter.config</a></h2>
<p>The <code>filter.config</code> file enables you to deny or allow particular requests and strip header information from client requests. After you modify <code>filter.config</code>, you must restart Traffic Server. </p>
-<h3>Format</h3>
+<h3>
+ <a name="49585">Format</a></h3>
<p>Each line in <code>filter.config</code> contains a filtering rule. Traffic Server applies the rules in the order listed, starting at the top of the file. <br />Traffic Server recognizes three space-delimited tags:
<br /><code>primary_destination=<em>value</em> secondary_specifier=<em>value</em> action=<em>value</em></code> </p>
<p>The following table lists possible primary destinations with their allowed values. </p>
@@ -430,7 +410,8 @@
<b>Note:</b> <code> src_ip</code> is not supported for PNA content.</p></td>
</tr>
</table>
- <h3>Examples</h3>
+ <h3>
+ <a name="188928">Examples</a></h3>
<p>The following example configures Traffic Server to keep the client IP address header for URL requests that contain the regular expression <code>giraffes</code> and whose path prefix is <code>/habitat</code>: <br />
<code>url_regex=giraffes prefix=/habitat keep_hdr=client_ip</code> </p>
@@ -456,30 +437,34 @@
<code>dest_host=401k.fidelity.com action=ldap server=ldap.com:389 dn="o=ldap.com" attr=ou attr_val="Accounting Department"</code><br />
<code>dest_ip=0.0.0.0-255.255.255.255 action=lda</code></p>
<h2>
-<a name="hosting.config">hosting.config</a> </h2>
+<a name="139053">hosting.config</a> </h2>
<p>The <code>hosting.config</code> file enables you to assign cache partitions to specific origin servers and/or domains so that you can manage cache space efficiently and restrict disk usage. For step-by-step instructions on partitioning the cache according to origin servers and/or domains, refer to <a href="cache.htm">Partitioning the Cache According to Origin Server or Domain</a>.
-<br />Before you can assign cache partitions to specific origin servers and/or domains, you must first partition your cache according to size and protocol in the <code>partition.config</code> file. For step-by-step instructions about partitioning your cache, refer to <a href="cache.htm">Partitioning the Cache</a>. For a description of the <code>partition.config</code> file, refer to <a href="#partition.config">partition.config</a>. </p>
- <p>After you modify <code>hosting.config, </code> navigate to the Traffic Server<code> bin</code> directory and run the <code>traffic_line -x</code> command to apply your changes. When you apply the changes to a node in a cluster, Traffic Server automatically applies the changes to all other nodes in the cluster. </p>
+<br />Before you can assign cache partitions to specific origin servers and/or domains, you must first partition your cache according to size and protocol in the <code>partition.config</code> file. For step-by-step instructions about partitioning your cache, refer to <a href="cache.htm">Partitioning the Cache</a>. For a description of the <code>partition.config</code> file, refer to <a href="#50072">partition.config</a>. </p>
+ <p>After you modify <code>hosting.config, </code> navigate to the Traffic Server<code> bin</code> directory and run the <code>traffic_line -x</code> command to apply the changes. When you apply the changes to a node in a cluster, Traffic Server automatically applies the changes to all other nodes in the cluster. </p>
<p><strong>IMPORTANT:</strong> The partition configuration must be the same on all nodes in a cluster. </p>
- <h3>Format</h3>
+ <h3>
+ <a name="121420">Format</a> </h3>
<p>Each line in the <code>hosting.config</code> file must have one of the following formats: <br />
<code>hostname=<em> hostname</em> partition=<em> partition_numbers</em></code> <br />
<code> domain=<em> domain_name</em> partition=<em> partition_numbers</em></code></p>
- <p>where <code><em>hostname</em></code> is the fully-qualified hostname of the origin server whose content you want to store on a particular partition (for example, <code>www.myhost.com</code>); <code><em>domain_name</em></code> is the domain whose content you want to store on a particular partition(for example, <code>mydomain.com</code>); and <code><em>partition_numbers</em></code> is a comma-separated list of the partitions on which you want to store the content that belongs to the origin server or domain listed. The partition numbers must be valid numbers listed in the <a href="#partition.config"><code>partition.config</code></a> file. </p>
+ <p>where <code><em>hostname</em></code> is the fully-qualified hostname of the origin server whose content you want to store on a particular partition (for example, <code>www.myhost.com</code>); <code><em>domain_name</em></code> is the domain whose content you want to store on a particular partition(for example, <code>mydomain.com</code>); and <code><em>partition_numbers</em></code> is a comma-separated list of the partitions on which you want to store the content that belongs to the origin server or domain listed. The partition numbers must be valid numbers listed in the <a href="#50072"><code>partition.config</code></a> file. </p>
<p><strong>Note: </strong>To allocate more than one partition to an origin server or domain, you must enter the partitions in a comma-separated list on one line, as shown in the example below. The <code>hosting.config</code> file cannot contain multiple entries for the same origin server or domain. </p>
- <h4>Generic Partition</h4>
+ <h4>
+ <a name="121493">Generic Partition</a> </h4>
<p>When configuring the <code>hosting.config </code>file, you must assign a generic partition to use for content that does not belong to any of the origin servers or domains listed. If all partitions for a particular origin server become corrupt, Traffic Server will also use the generic partition to store content for that origin server. </p>
<p>The generic partition must have the following format: <br />
<code>hostname=* partition=<em>partition_numbers</em> </code><br />
where <code><i>partition_numbers</i></code> is a comma-separated list of generic partitions. </p>
- <h3>Examples</h3>
+ <h3>
+ <a name="121477">Examples</a> </h3>
<p>The following example configures Traffic Server to store content from the domain <code>mydomain.com</code> in partition 1 and content from <code>www.myhost.com</code> in partition 2. Traffic Server stores content from all other origin servers in partitions 3 and 4. </p>
<p><code>domain=mydomain.com partition=1</code> <br /><code>hostname=www.myhost.com partition=2</code><br /><code>hostname=* partition=3,</code></p>
<h2>
- <a name="icp.config">icp.config</a> </h2>
+ <a name="115203">icp.config</a> </h2>
<p>The <code>icp.config</code> file defines ICP peers (parent and sibling caches). </p>
<p><strong>IMPORTANT: </strong>After you modify the <code>icp.config</code> file, navigate to the Traffic Server<code> bin</code> directory and run the <code>traffic_line -x</code> command to apply the changes. When you apply the changes to a node in a cluster, Traffic Server automatically applies the changes to all other nodes in the cluster. </p>
- <h3>Format</h3>
+ <h3>
+ <a name="52528">Format</a> </h3>
<p>Each line in the <code>icp.config</code> file contains the name and configuration information for a single ICP peer in the following format:
<br /><code> <em> host</em> :<em> host_IP</em> :<em> peer_type : proxy_port : icp_port : MC_on : MC_IP : MC_TTL :</em></code></p>
<p>Each field is described in the following table. </p>
@@ -513,7 +498,8 @@
<td><p>The port number of the UDP port used by the ICP peer for ICP communication. </p></td>
</tr>
</table>
- <h3>Examples</h3>
+ <h3>
+ <a name="52662">Examples </a> </h3>
<p>The following example configuration is for three nodes: the local host, one parent, and one sibling. </p>
<p>
@@ -521,29 +507,32 @@
</code><code>host1:123.12.1.23:1:8080:3131:0:0.0.0.0:1 <br />
</code><code>host2:123.12.1.24:2:8080:3131:0:0.0.0.0:1 </code></p>
<h2>
-<a name="ip_allow.config">ip_allow.config</a></h2>
+<a name="53256">ip_allow.config</a></h2>
<p>The <code>ip_allow.config</code> file controls client access to the Traffic Server proxy cache. You can specify ranges of IP addresses that are allowed to use the Traffic Server as a web proxy cache. <br />
After you modify the <code>ip_allow.config</code> file, navigate to the Traffic Server<code> bin</code> directory and run the <code>traffic_line -x</code> command to apply changes. When you apply the changes to a node in a cluster, Traffic Server automatically applies the changes to all other nodes in the cluster. </p>
-<h3>Format</h3>
+<h3>
+<a name="52049">Format</a></h3>
<p>Each line in the <code>ip_allow.config</code> file must have the following format: <br />
<code>src_ip=<em>ipaddress </em>action=ip_allow | ip_deny</code> </p>
<p>where <code><i>ipaddress</i></code> is the IP address or range of IP addresses of the clients allowed to access the Traffic Server proxy cache, the action <code>ip_allow</code> enables the specified clients to access the Traffic Server proxy cache, and <code>ip_deny</code> denies the specified clients to access the Traffic Server proxy cache. </p>
-<p>By default, the <code>ip_allow.config</code> file contains the following line, which allows all clients to access the Traffic Server proxy cache. To restrict access, comment out or delete this line before adding rules: <br />
+<p>By default, the <code>ip_allow.config</code> file contains the following line, which allows all clients to access the Traffic Server proxy cache. To restrict access, comment out or delete this line before adding rules. <br />
<code>src_ip=0.0.0.0-255.255.255.255 action=ip_allow </code></p>
-<h3>Examples</h3>
- <p> The following example enables all clients to access the Traffic Server proxy cache: <br />
+<h3>
+<a name="167137">Examples</a></h3>
+ <p> The following example allows all clients to access the Traffic Server proxy cache: <br />
<code>src_ip=0.0.0.0-255.255.255.255 action=ip_allow </code></p>
<p>The following example allows all clients on a specific subnet to access the Traffic Server proxy cache: <br />
<code>src_ip=123.12.3.000-123.12.3.123 action=ip_allow</code></p>
<p>The following example denies all clients on a specific subnet to access the Traffic Server proxy cache: <br />
<code>src_ip=123.45.6.0-123.45.6.123 action=ip_deny</code></p>
<h2>
-<a name="logs.config">logs.config</a></h2>
- <p>The <code>logs.config</code> file establishes and formats <b>traditional</b> custom transaction log files. <br />
- Although Traffic Server supports traditional custom logging, you should use the more versatile XML-based custom logging (refer to <a href="log.htm">Using the Custom Format</a> and <a href="#logs_xml.config">logs_xml.config</a>). If you opt to use traditional custom logging instead of the more versatile XML-based custom logging, then you must enable the traditional custom logging option manually (refer to <a href="log.htm">Support for Traditional Custom Logging</a>). </p>
+<a name="149839">logs.config</a></h2>
+ <p>The <code>logs.config</code> file establishes and formats <em>traditional</em> custom transaction log files. <br />
+ Although Traffic Server supports traditional custom logging, you should use the more versatile XML-based custom logging. Refer to <a href="log.htm">Using the Custom Format</a>, and <a href="#131440"><em>l</em>ogs_xml.config</a>. If you opt to use traditional custom logging instead of the more versatile XML-based custom logging, then you must enable the traditional custom logging option manually. Refer to <a href="log.htm">Support for Traditional Custom Logging</a>. </p>
<p><strong>IMPORTANT: </strong>After you modify <code>logs.config</code>, navigate to the Traffic Server<code> bin</code> directory and run the <code>traffic_line -x</code> command to apply changes. When you apply the changes to a node in a cluster, Traffic Server automatically applies the changes to all other nodes in the cluster. </p>
- <h3>Format</h3>
+ <h3>
+ <a name="49793">Format</a> </h3>
<p>Each line in the <code>logs.config</code> file establishes and formats a custom transaction log file. Lines consist of the following fields, separated by colons (:). </p>
<table border="1">
<tr>
@@ -570,8 +559,7 @@
</tr>
<tr>
<td><p><i><code> format string</code> </i></p></td>
- <td><p>Identifies the <code> printf</code> -style format string specifying the field symbols to be displayed and how they should look in ASCII. Refer to this <a href="logfmts.htm"> Appendix</a> for a list of the available field symbols and their meanings. </p>
- <p>Field symbols are indicated by %<<code> field_symbol</code> > format. For example: to indicate that <code> chi</code> is the client host IP and not the string <code> chi</code> to be printed, enter <code>% <chi></code> . </p></td>
+ <td><p>Identifies the <code> printf</code> -style format string specifying the field symbols to be displayed and how they should look in ASCII. Refer to the <a href="logfmts.htm"> Appendix</a> for a list of the available field symbols and their meanings. Field symbols are indicated by %<<code> field_symbol</code> > format; for example, to indicate that <code> chi</code> is the client host IP and not the string <code> chi</code> to be printed, enter %<code> <chi></code> . </p></td>
</tr>
<tr>
<td><p><i><code> file name</code> </i></p></td>
@@ -583,45 +571,47 @@
</tr>
<tr>
<td><p><i><code> file header data</code> </i></p></td>
- <td><p>The header text. Enter <code> none</code> if you do not want header text; enter the text of the header if you want your custom log file to have a header.</p></td>
+ <td><p>The header text; enter <code> none</code> if you do not want header text. Enter the text of the header if you want your custom log file to have a header.</p></td>
</tr>
</table>
- <h3>Examples</h3>
- <p>The following example shows a custom log format for a file named <code><b>minimalist</b></code>. It records the client host IP address (<code>chi</code>), the client request universal resource identifier (<code>cqu</code>), and the proxy response status code (<code>pssc</code>). <br />
+ <h3>
+ <a name="132135">Examples</a> </h3>
+ <p>The following example shows a custom log format for a file named <code>minimalist</code>. It records the client host IP address (<code>chi</code>), the client request universal resource identifier (<code>cqu</code>), and the proxy response status code (<code>pssc</code>) <br />
<code>format:enabled:1:minimal:%<chi> / %<cqu> / %<pssc>:minimalist:ASCII:none</code> </p>
<p>The output file for the above example format is: <br />
<code>123.12.3.123 / GET http://earth/ocean/index.html HTTP/1.0 / 200</code> </p>
-<p>The following example shows a custom log format for a file named <code><b>test</b></code>. It records the <code>User-Agent </code>value of the client request header (<code>cqh</code>) and the <code>Retry-After</code> value of the proxy response header (<code>psh</code>). <br />
+<p>The following example shows a custom log format for a file named <code>test</code>. It records the User-Agent value of the client request header (<code>cqh</code>) and the Retry-After value of the proxy response header (<code>psh</code>). <br />
<code>format:enabled:1:test:%<{User-Agent}cqh> %<{Retry-After}psh>:test:ASCII:none</code></p>
-<h3>WELF</h3>
- <p>Traffic Server supports <b>WELF</b>, the WebTrends Enhanced Log format, so you can analyze Traffic Server log files with WebTrends reporting tools. A predefined custom format for WELF is provided in the <code>logs.config</code> file. To create a WELF format log file, comment out the following section at the end of the file and replace <code><FORMAT_ID></code> with a unique integer. </p>
+<h3>
+<a name="139951">WELF</a></h3>
+ <p>Traffic Server supports WELF, the WebTrends Enhanced Log format, so that you can analyze Traffic Server log files with WebTrends reporting tools. A predefined custom format for WELF is provided in the <code>logs.config</code> file. To create a WELF format log file, comment out the following section at the end of the file and replace <code><FORMAT_ID></code> with a unique integer. </p>
<p>
<code>#format:enabled:<FORMAT_ID>:welf:id=firewall time="%<cqtd> %<cqtt>" fw=%<phn> pri=6 proto=%<cqus> duration=%<ttmsf> sent=%<psql> rcvd=%<cqhl> src=%<chi> dst=%<shi> dstname=%<shn> user=%<caun> op=%<cqhm> arg="%<cqup>" result=%<pssc> ref="%<{Referer}cqh>" agent="%<{user-agent}cqh>" cache=%<crc>:welf:ASCII:none<br />
<br />
#</code></p>
<h2>
- <a name="logs_hosts.config">log_hosts.config</a> </h2>
+ <a name="109741">log_hosts.config</a> </h2>
<p>To record HTTP transactions for different origin servers in separate log files, you must list each origin server hostname in the <code>log_hosts.config</code> file. In addition, you must enable the <a href="log.htm">HTTP Host Log Splitting</a> option. You should use the same <code>log_hosts.config</code> file on every Traffic Server node in your cluster. <strong> </strong> After you modify the <code>log_hosts.config</code> file, navigate to the Traffic Server<code> bin</code> directory and run the <code>traffic_line -x</code> command to apply the changes. When you apply the changes to a node in a cluster, Traffic Server automatically applies the changes to all other nodes in the cluster. </p>
<h3>
Format </h3>
<p>Each line in the <code>log_hosts.config</code> file has the following format: <code><br />
- <i>hostname</i> </code></p>
- <p>
- where <code><i>hostname</i></code> is the hostname of the origin server. </p>
+ <i>hostname</i> </code><br />where <code><i>hostname</i></code> is the hostname of the origin server. </p>
<p><strong>Tip:</strong> You can specify keywords in the <code>log_hosts.config</code> file to record all transactions from origin servers with the specified keyword in their names in a separate log file. See the example below.</p>
- <h3>Examples</h3>
+ <h3>
+ <a name="131568">Examples</a> </h3>
<p>The following example configures Traffic Server to create separate log files containing all HTTP transactions for the origin servers <code>webserver1</code>, <code>webserver2</code>, and <code>webserver3</code>. </p>
<p><code>webserver1</code> <code><br />
</code><code>webserver2</code> <code><br />
</code><code>webserver3</code></p>
-<p>The following example records all HTTP transactions from origin servers that contain <code>sports</code> in their names. For example: <code>sports.yahoo.com</code> and <code>www.foxsports.com</code> in a log file called <code>squid-sport.log</code> (the Squid format is enabled). </p>
+<p>The following example records all HTTP transactions from origin servers that contain <code>sports</code> in their names: for example, <code>sports.yahoo.com</code> and <code>www.foxsports.com</code>, in a log file called <code>squid-sport.log</code> (the Squid format is enabled): </p>
<p><code>sports</code> </p>
<h2>
- <a name="logs_xml.config">logs_xml.config</a> </h2>
- <p>The <code>logs_xml.config</code> file defines the custom log file formats, filters, and processing options. The format of this file is modeled after <b>XML</b>, the Extensible Markup Language. </p>
+ <a name="131440">logs_xml.config</a> </h2>
+ <p>The <code>logs_xml.config</code> file defines the custom log file formats, filters, and processing options. The format of this file is modeled after XML, the Extensible Markup Language. </p>
- <h3>Format</h3>
+ <h3>
+ <a name="109866">Format</a> </h3>
<p>The <code>logs_xml.config</code> file contains the specifications below: </p>
<ul>
<li><code> LogFormat</code> specifies the fields to be gathered from each protocol event access.</li>
@@ -630,7 +620,8 @@
</ul>
<p>The <code>logs_xml.config</code> file ignores extra white space, blank lines, and all comments.</p>
- <h3>LogFormat</h3>
+ <h3>
+ <a name="104881">LogFormat</a> </h3>
<p>The following table lists <code><b>LogFormat</b></code> specifications. </p>
<table border="1">
<tr>
@@ -645,24 +636,24 @@
<td><p><code><Format = "valid_format_specification"/></code></p></td>
<td><p>Required. A valid format specification is a printf-style string describing each log entry when formatted for ASCII output. Use <code> %< <em> field</em> ></code> as a placeholder for valid field names. For more information, refer to <a href="logfmts.htm#66912"> Custom Logging Fields</a>. </p>
<p>The specified field can be one of the following types:
- </p><ul> <li>Simple. For example: <code>%<cqu><br />
- </code></li>
- <li>A field within a container, such as an HTTP header or a statistic. Fields of this type have the syntax: <code> %<{ <em> field</em> } <em> container</em> ></code></li><li>
- Aggregates, such as <code>COUNT</code>, <code>SUM</code>, <code>AVG</code>, <code>FIRST</code>, <code>LAST</code>. Fields of this type have the syntax: <code> %<operator ( <em> field</em> )></code></li>
+ </p><ul> <li>Simple - for example, <code>%<cqu><br />
+ </code></li><li>A field within a container, such as an HTTP header or a statistic. Fields of this type have the syntax: '<code> %<{ <em> field</em> } <em> container</em> ></code> '.</li><li>
+ Aggregates, such as <code>COUNT</code>, <code>SUM</code>, <code>AVG</code>, <code>FIRST</code>, <code>LAST</code>. Fields of this type have the syntax:<BR />
+ '<code> %<operator ( <em> field</em> )></code> '.</li> <p></p>
<p><b>Note:</b> You cannot create a format specification that contains both aggregate operators and regular fields.</p></ul></td>
</tr>
<tr>
<td><p><code><Interval = "aggregate_interval_secs"/></code></p></td>
- <td><p>Use this tag when the format contains aggregate operators. The value "<code>aggregate_interval_secs</code>" represents the number of seconds between individual aggregate values being produced. </p>
- <p>The valid set of aggregate operators are:<code><br />
- </code><code>COUNT</code> <code><br />
+ <td><p>Use this tag when the format contains aggregate operators. The value "<code>aggregate_interval_secs</code>" represents the number of seconds between individual aggregate values being produced. The valid set of aggregate operators are:</p>
+ <p><code> COUNT</code> <code><br />
</code><code>SUM</code><code><br />
</code><code>AVG</code> <code><br />
</code><code>FIRST</code> <code><br />
</code><code>LAST</code> </p></td>
</tr>
</table>
- <h3>LogFilters</h3>
+ <h3>
+ <a name="105718">LogFilters</a> </h3>
<p> The following table lists the <code><b>LogFilter</b></code> specifications.</p>
<table border="1">
<tr>
@@ -688,11 +679,11 @@
</tr>
<tr>
<td><p><code><Action = "valid_action_field"/></code></p></td>
- <td><p>This instructs Traffic Server to either accept or reject records that satisfy the filter condition. <code><br />
- </code>Required:<code> ACCEPT</code> or <code> REJECT</code> . </p></td>
+ <td><p>This instructs Traffic Server to either accept or reject records satisfying the condition of the filter. Required:<code> ACCEPT</code> or <code> REJECT</code> . </p></td>
</tr>
</table>
- <h3>LogObject</h3>
+ <h3>
+ <a name="103986">LogObject</a> </h3>
<p>The following table lists the <code><b>LogObject</b></code> specifications. </p>
<table border="1">
<tr>
@@ -701,29 +692,28 @@
</tr>
<tr>
<td><p><code><Format = "valid_format_name"/></code></p></td>
- <td><p>Required. Valid format names include the predefined logging formats: <code>squid</code>, <code>common</code>, <code>extended</code>, and <code>extended2</code>, as well as any previously-defined custom log formats. There is no default for this tag.</p></td>
+ <td><p>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.</p></td>
</tr>
<tr>
<td><p><code><Filename = "file_name"/></code></p></td>
<td><p>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.</p>
- <p>If the name does not contain an extension (for example, <code> squid</code>), then the extension <code> .log</code> is automatically appended to it for ASCII logs and <code> .blog</code> for binary logs (refer to <a href="files.htm#0_73225">Mode = "valid_logging_mode"</a>). <code><br />
- </code>If you do not want an extension to be added, then end the filename with a single (.) dot (for example: <code> squid.</code> ).</p></td>
+ <p>If the name does not contain an extension (for example, <code> squid</code>), then the extension <code> .log</code> is automatically appended to it for ASCII logs and <code> .blog</code> for binary logs (refer to <a href="files.htm#0_73225">Mode = "valid_logging_mode"</a>). If you do not want an extension to be added, then end the filename with a single (.) dot (for example: <code> squid.</code> ).</p></td>
</tr>
<tr>
- <td><p><code><Mode = "valid_logging_mode"/></code></p></td>
+ <td><p><code><a name="0_73225"></a><Mode = "valid_logging_mode"/></code></p></td>
<td><p>Valid logging modes include <code> ascii</code> , <code> binary</code> , and <code> ascii_pipe</code> . The default is <code> ascii</code> .</p>
- <ul><li>- Use <code> ascii</code> to create event log files in human-readable form (plain ASCII).</li>
- <li>- Use <code> binary</code> 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 <code>logcat</code> utility to translate binary log files to ASCII format before you can read them.</li>
- <li>- Use <code> ascii_pipe</code> 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.</li> </ul>
-<p>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, <em> are</em> created when Traffic Server starts.</p></td>
+ <p>- Use <code> ascii</code> to create event log files in human-readable form (plain ASCII).<code><br />
+ </code>- Use <code> binary</code> 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 <code>logcat</code> utility to translate binary log files to ASCII format before you can read them.<code><br />
+ </code>- Use <code> ascii_pipe</code> 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.</p>
+<p>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 that you can see the pipe right after Traffic Server starts. However, pipes on a collation server <em> are</em> created when Traffic Server starts.</p></td>
</tr>
<tr>
<td><p><code><Filters = "list_of_valid_filter_names"/></code></p></td>
- <td><p>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.</p></td>
+ <td><p>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.</p></td>
</tr>
<tr>
<td><p><code><Protocols = "list_of_valid_protocols"/></code></p></td>
- <td><p>A comma-separated list of the protocols this object should log. Valid protocol names for this release are <code>HTTP</code> (FTP is deprecated).</p></td>
+ <td><p>A comma-separated list of the protocols this object should log. Valid protocol names for this release are <code>HTTP</code>; FTP is deprecated.</p></td>
</tr>
<tr>
<td><p><code><ServerHosts = "list_of_valid_servers"/></code></p></td>
@@ -739,7 +729,7 @@
</tr>
<tr>
<td><p><code><RollingEnabled = "truth value"/></code></p></td>
- <td><p>Enables or disables log file rolling for the <code>LogObject</code>. This setting overrides the value for the <code> <i>proxy.config.log2.rolling_enabled</i></code> variable in the <code> records.config</code> file. Set <code> <i>truth value</i></code> to one of the following values:</p>
+ <td><p>Enables or disables log file rolling for the <code>LogObject</code>. This setting overrides the value for the <code> <i>proxy.config.log2.rolling_enabled</i></code> variable in the <code> records.config</code> file. Set <code> "truth value"</code> to one of the following values:</p>
<p><code> 0</code> to disable rolling for this particular <code>LogObject</code>.<br />
<code> 1</code> to roll log files at specific intervals during the day (you specify time intervals with the <code> RollingIntervalSec</code> and <code> RollingOffsetHr </code> fields).<br />
<code>2</code> to roll log files when they reach a certain size (you specify the size with the<code> RollingSizeMb </code> field).<br />
@@ -749,12 +739,12 @@
<tr>
<td><p><code><RollingIntervalSec = "seconds"/></code></p></td>
<td><p>The seconds between log file rolling for the <code>LogObject</code>; enables you to specify different rolling intervals for different <code>LogObjects</code>. <br />
- This setting overrides the value for <code> <i>proxy.config.log2.rolling_interval_sec </i></code> in the <code> records.config</code> file. </p></td>
+ This setting overrides the value for <code> <i>proxy.config.log2.rolling_interval_sec</i></code> in the <code> records.config</code> file. </p></td>
</tr>
<tr>
<td><p><code><RollingOffsetHr = "hour"/></code></p></td>
<td><p>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. <br />
- This setting overrides the configuration setting for<code> <i>proxy.config.log2.rolling_offset_hr </i></code> in the <code> records.config</code> file. </p></td>
+ This setting overrides the configuration setting for<code> <i>proxy.config.log2.rolling_offset_hr</i></code> in the <code> records.config</code> file. </p></td>
</tr>
<tr>
<td><p><code><RollingSizeMb = "size_in_MB"/></code></p></td>
@@ -762,14 +752,14 @@
</tr>
</table>
<p>
- <strong>Examples</strong> </p>
- <p>The following is an example of a <code><b>LogFormat</b></code> specification that collects information using three common fields:</p>
+ <strong><a name="106972">Examples</a></strong> </p>
+ <p>The following is an example of a <code><b>LogFormat</b></code> specification collecting information using three common fields:</p>
<pre>
<LogFormat>
<Name = "minimal"/>
<Format = "%<chi> : %<cqu> : %<pssc>"/>
</LogFormat></pre>
- <p>The following is an example of a <code><b>LogFormat</b></code> specification that uses aggregate operators:</p>
+ <p>The following is an example of a <code><b>LogFormat</b></code> specification using aggregate operators:</p>
<pre>
<LogFormat>
<Name = "summary"/>
@@ -809,8 +799,10 @@
<Protocols = "http"/>
<CollationHosts = "logs.company.com:4000,209.131.52.129:5000"/>
</LogObject> </pre></code>
- <h3>WELF</h3>
- <p>Traffic Server supports WELF (WebTrends Enhanced Log Format) so you can analyze Traffic Server log files with WebTrends reporting tools. A predefined <code><LogFormat></code> that is compatible with WELF is provided at the end of the <code><code>logs.config</code></code> file (shown below). To create a WELF format log file, create a <code><code><LogObject></code></code> that uses this predefined format.</p><code>
+ <h3>
+ <a name="140052">WELF</a> </h3>
+ <p>
+<a name="140064">Traffic Server supports WELF (WebTrends Enhanced Log Format) so that you can </a>analyze Traffic Server log files with WebTrends reporting tools. A predefined <code><LogFormat></code> that is compatible with WELF is provided at the end of the <code><code>logs.config</code></code> file (shown below). To create a WELF format log file, create a <code><code><LogObject></code></code> that uses this predefined format.</p><code>
<pre>
<LogFormat>
<Name = "welf"/>
@@ -822,16 +814,17 @@
</LogFormat>
</pre></code>
<h2>
-<a name="parent.config">parent.config</a></h2>
+<a name="150269">parent.config</a></h2>
<p>The <code>parent.config</code> file identifies the parent proxies used in an cache hierarchy. Use this file to perform the following configuration: </p>
<ul>
<li>Set up parent cache hierarchies, with multiple parents and parent failover</li>
<li>Configure selected URL requests to bypass parent proxies </li>
</ul>
- <p>Traffic Server uses the <code>parent.config</code> file only when the parent caching option is enabled (refer to <a href="hier.htm">Configuring Traffic Server to Use a Parent Cache</a>).</p>
- <p><strong>IMPORTANT:</strong> After you modify the <code>parent.config</code> file, navigate to the Traffic Server<code> bin</code> directory and run the <code>traffic_line -x</code> command to apply your changes. When you apply the changes to one node in a cluster, Traffic Server automatically applies the changes to all other nodes in the cluster. </p>
+ <p>Traffic Server uses the <code>parent.config</code> file only when the parent caching option is enabled; refer to <a href="hier.htm"><i>Configuring Traffic Server to Use a Parent Cache</i></a>. </p>
+ <p><strong>IMPORTANT:</strong> After you modify the <code>parent.config</code> file, navigate to the Traffic Server<code> bin</code> directory and run the <code>traffic_line -x</code> command to apply the changes. When you apply the changes to a node in a cluster, Traffic Server automatically applies the changes to all other nodes in the cluster. </p>
- <h3>Format</h3>
+ <h3>
+ <a name="50080">Format</a> </h3>
<p>Each line in the <code>parent.config</code> file must contain a parent caching rule. Traffic Server recognizes three space-delimited tags: <br />
<code><em>primary_destination</em>=<em>value secondary_specifier</em>=<em>value action</em>=<em>value</em> </code></p>
<p>The following table lists the possible primary destinations and their allowed values. </p>
@@ -881,8 +874,8 @@
</tr>
<tr>
<td><p><i><code> method</code> </i></p></td>
- <td><p>A request URL method. It can be one of the following:<br />
-<code>get</code> <br />
+ <td><p>A request URL method; one of the following:</p>
+ <p><code> get</code> <br />
<code>post</code> <br />
<code>put</code> <br />
<code>trace</code> </p></td>
@@ -904,7 +897,7 @@
</tr>
<tr>
<td><p><code> parent</code> </p></td>
- <td><p>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.</p></td>
+ <td><p>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; you must specify the port number.</p></td>
</tr>
<tr>
<td><p><code> round_robin</code> </p></td>
@@ -916,51 +909,56 @@
<tr>
<td><p><code> go_direct</code> </p></td>
<td><p>One of the following values:</p>
- <p><code> true</code> - requests bypass parent hierarchies and go directly to the origin server.<br />
- <code>false</code> - requests do not bypass parent hierarchies.</p></td>
+ <p><code> true</code> - requests bypass parent hierarchies and go directly to the origin server.</p>
+ <p><code> false</code> - requests do not bypass parent hierarchies.</p></td>
</tr>
</table>
- <h3>Examples</h3>
- <p>The following rule configures a parent cache hierarchy consisting of Traffic Server (which is the child) and two parents, <code>p1.x.com</code> and <code>p2.x.com</code>. Traffic Server forwards the requests it cannot serve to the parent servers <code>p1.x.com</code> and <code>p2.x.com</code> in a round-robin fashion because:<code><br />
- </code> <code>round_robin=true. <br />
+ <h3>
+ <a name="50088">Examples</a> </h3>
+ <p>The following rule configures a parent cache hierarchy consisting of Traffic Server (which is the child) and two parents, <code>p1.x.com</code> and <code>p2.x.com</code>. Traffic Server forwards the requests it cannot serve to the parent servers <code>p1.x.com</code> and <code>p2.x.com</code> in a round-robin fashion because <code>round_robin=true. <br />
</code><code>dest_domain=. method=get parent=âp1.x.com:8080; p2.y.com:8080â round_robin=true </code></p>
<code></code>
<p>The following rule configures Traffic Server to route all requests containing the regular expression <code>politics</code> and the path /<code>viewpoint</code> directly to the origin server (bypassing any parent hierarchies): <br />
<code>url_regex=politics prefix=/viewpoint go_direct=true </code></p>
<p>Every line in the <code>parent.config</code> file must contain either a <code>parent=</code> or <code>go_direct=</code> directive.</p>
<h2>
- <a name="partition.config">partition.config</a> </h2>
- <p>The <code>partition.config</code> file enables you to manage your cache space more efficiently and restrict disk usage by creating cache partitions of different sizes for specific protocols. You can further configure these partitions to store data from certain origin servers and/or domains in the<code> </code><a href="#hosting.config">hosting.config</a> file. </p>
+ <a name="50072">partition.config</a> </h2>
+ <p>The <code>partition.config</code> file lets you manage your cache space more efficiently and restrict disk usage by creating cache partitions of different sizes for specific protocols. You can further configure these partitions to store data from certain origin servers and/or domains in the <code>hosting.config</code> file (refer to <a href="#139053">hosting.config</a>). </p>
<p><strong>IMPORTANT: </strong> The partition configuration must be the same on all nodes in a cluster. You must stop Traffic Server before you change the cache partition size and protocol assignment. For step-by-step instructions about partitioning the cache, refer to <a href="cache.htm">Partitioning the Cache</a>. </p>
-<h3>Format</h3>
+<h3>
+ <a name="115449">Format</a> </h3>
<p>For each partition you want to create, enter a line with the following format: <br />
<code>partition=<em>partition_number</em> scheme=<em>protocol_type</em> size=<em>partition_size</em></code></p>
- <p>where <code><i>partition_number </i></code> is a number between 1 and 255 (the maximum number of partitions is 255) and
- <code><i>protocol_type </i></code> is <code>http</code>. Traffic Server supports <code>http</code> for HTTP partition types; <code><i>partition_size </i></code> is the amount of cache space allocated to the partition. This value can be either a percentage of the total cache space or an absolute value. The absolute value must be a multiple of 128 MB, where 128 MB is the smallest value. If you specify a percentage, then the size is rounded down to the closest multiple of 128 MB. </p>
+ <p>where <code><i>partition_number</i></code> is a number between 1 and 255 (the maximum number of partitions is 255) and
+ <code><i>protocol_type</i></code> is <code>http</code>. Traffic Server supports <code>http</code> for HTTP partition types; <code><i>partition_size</i></code> is the amount of cache space allocated to the partition. This value can be either a percentage of the total cache space or an absolute value. The absolute value must be a multiple of 128 MB, where 128 MB is the smallest value. If you specify a percentage, then the size is rounded down to the closest multiple of 128 MB. </p>
<p>Each partition is striped across several disks to achieve parallel I/O. For example: if there are four disks, then a 1-GB partition will have 256 MB on each disk (assuming each disk has enough free space available). If you do not allocate all the disk space in the cache, then the extra disk space is not used. You can use the extra space later to create new partitions without deleting and clearing the existing partitions. </p>
-<h3>Examples</h3>
+<h3>
+ <a name="121818">Examples</a> </h3>
<p>The following example partitions the cache evenly between HTTP and HTTPS requests: </p>
<p>
<code>partition=<em>1</em> scheme=http size=50% <br />
</code><code>partition=<em>2</em> scheme=https size=50% </code></p>
<h2>
-<a name="records.config">records.config</a></h2>
- <p>The <code>records.config</code> file is a list of configurable variables used by the Traffic Server software. Many of the variables in the <code>records.config</code> file are set automatically when you set configuration options in Traffic Line or Traffic Shell. After you modify the <code>records.config</code> file, navigate to the Traffic Server<code> bin</code> directory and run the command <code>traffic_line -x</code> to apply the changes. When you apply changes to one node in a cluster, Traffic Server automatically applies the changes to all other nodes in the cluster.</p>
- <h3>Format</h3>
+<a name="115367">records.config</a></h2>
+ <p>The <code>records.config</code> file is a list of configurable variables used by the Traffic Server software. Many of the variables in the <code>records.config</code> file are set automatically when you set configuration options in Traffic Line or Traffic Shell. After you modify the <code>records.config</code> file, navigate to the Traffic Server<code> bin</code> directory and run the command <code>traffic_line -x</code> to apply the changes. When you apply changes to a node in a cluster, Traffic Server automatically applies the changes to all other nodes in the cluster.</p>
+ <h3>
+ <a name="48806">Format</a></h3>
<p>Each variable has the following format: <code><br />
CONFIG <em>variable_name</em> DATATYPE <em>variable_value</em> </code></p>
<p>where <code>DATATYPE</code> is <code>INT</code> (integer), <code>STRING</code> (string), or <code>FLOAT</code> (floating point). </p>
- <h3>Examples</h3>
- <p>In the following example, the variable<code> <i>proxy.config.proxy_name </i></code> is a <code>STRING</code> datatype with the value <code>my_server</code>. This means that the name of the Traffic Server proxy is <code>my_server</code>.<br />
+ <h3>
+ <a name="48839">Examples</a> </h3>
+ <p>In the following example, the variable<code> <i>proxy.config.proxy_name</i></code> is a <code>STRING</code> datatype with the value <code>my_server</code>. This means that the name of the Traffic Server proxy is <code>my_server</code>.<br />
<code>CONFIG proxy.config.proxy_name STRING my_server </code></p>
<p>In the following example, the variable <code><em>proxy.config.arm.enabled </em></code>is a yes/no flag. A value of <code>0</code> (zero) disables the option; a value of <code>1</code> enables the option. <br />
<code>CONFIG proxy.config.arm.enabled INT 0 </code></p>
<p>In the following example, the variable sets the cluster startup timeout to 10 seconds. <br />
<code>CONFIG proxy.config.cluster.startup_timeout INT 10 </code></p>
<h3>
- <a name="config_var">Configuration Variables</a> </h3>
- <p>The following table describes the configuration variables listed in the <code>records.config</code> file.</p>
+ <a name="49000">Configuration Variables</a> </h3>
+ <p>
+ <a name="228674">The following table describes the configuration variables listed in the </a><code>records.config</code> file.</p>
<table border="1">
<tr>
<th width="488"> <p>Configuration Variable<br />
@@ -969,7 +967,7 @@
<th width="632"> <p>Description</p></th>
</tr>
<tr>
- <td rowspan="1" colspan="3"><strong><a name="records.config.system">System Variables</a></strong></td>
+ <td rowspan=="1" colspan="3"><p><Strong> System Variables</Strong> </p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.proxy_name</i></code></p>
@@ -1085,16 +1083,16 @@
<td><p><code><i>proxy.config.accept_threads</i></code></p>
<p><code>INT</code></p></td>
<td><code>0</code></td>
- <td>When enabled (<code>1</code>), runs a separate thread for accept processing. If disabled (<code>0</code>), then only 1 thread can be created.</td>
+ <td>When enabled (1), runs a separate thread for accept processing. If disabled (0), then only 1 thread can be created.</td>
</tr>
<tr>
<td><p><code><i>proxy.config.thread.default.stacksize</i></code></p>
<p><code>INT</code></p></td>
<td><code>1096908</code></td>
- <td>The new default thread stack size, for all threads. The original default is set at 1 MB.</td>
+ <td>The new default thread stack size, for all threads. Original default is set at 1 MB.</td>
</tr>
<tr>
- <td rowspan="1" colspan="3"><strong><a name="records.config.local">Local Manager</a></strong></td>
+ <td rowspan=="1" colspan="3"><p><strong> Local Manager</strong></p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.lm.sem_id </i></code></p>
@@ -1107,9 +1105,9 @@
<p><code>INT</code></p></td>
<td><p><code>3</code></p></td>
<td><p>Sets the clustering mode:</p>
- <p><code>1</code> = full-clustering mode<br />
- <code>2</code> = management-only mode<br />
- <code>3</code> = no clustering</p></td>
+ <p>1 = full-clustering mode<br />
+ 2 = management-only mode<br />
+ 3 = no clustering</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.cluster.rsport</i></code></p>
@@ -1135,6 +1133,18 @@
<td><p><code>3</code></p></td>
<td><p>The maximum number of copies of rolled configuration files to keep.</p></td>
</tr>
+ <tr>
+ <td><p><code><i>proxy.config.admin.admin_password</i></code></p>
+ <p><code>STRING</code></p></td>
+ <td></td>
+ <td>Specifies the encrypted administrator password that controls access to Traffic Manager. The format can be recreated with:<br />
+ <code>
+#!/usr/bin/php<br />
+<?php<br />
+$foo = md5('admin',true); <br />
+echo strtoupper(substr(bin2hex($foo),0,23)) . "\n";<br />
+?></code></td>
+ </tr>
<tr>
<td><p><code><i>proxy.config.admin.user_id </i></code></p>
<p><code>STRING</code></p></td>
@@ -1143,22 +1153,22 @@
<p>The nonprivileged user account designated to Traffic Server.</p></td>
</tr>
<tr>
- <td rowspan="1" colspan="3"><strong><a name="records.config.process">Process Manager</a></strong></td>
+ <td rowspan=="1" colspan="3"><p><strong> Process Manager</strong></p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.process_manager.mgmt_port</i></code></p>
<p><code>INT</code></p></td>
<td><p><code>8084</code></p></td>
- <td><p>The port used for internal communication between the <code>traffic_manager</code> and <code>traffic_server</code> processes.</p></td>
+ <td><p>The port used for internal communication between the <code>traffic_manager</code> process and the <code>traffic_server</code> process.</p></td>
</tr>
<tr>
- <td rowspan="1" colspan="3"><strong><a name="records.config.alarm">Alarm Configuration</a></strong></td>
+ <td rowspan=="1" colspan="3"><p><strong> Alarm Configuration</strong></p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.alarm.bin</i></code></p>
<p><code>STRING</code></p></td>
<td><p><code>example_alarm_bin.sh </code></p></td>
- <td><p>Name of the script file that can execute certain actions when an alarm is signaled. The default file is a sample script named <code> example_alarm_bin.sh</code> located in the <code> bin</code> directory. You must edit the script to suit your needs.</p></td>
+ <td><p>The name of the script file that can execute certain actions when an alarm is signaled. The default file is a sample script named <code> example_alarm_bin.sh</code> located in the <code> bin</code> directory. You must edit the script to suit your needs.</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.alarm.abs_path</i></code></p>
@@ -1167,7 +1177,7 @@
<td><p>The full path to the script file that sends email to alert someone about Traffic Server problems.</p></td>
</tr>
<tr>
- <td rowspan="1" colspan="3"><strong><a name="records.config.auth">Authentication Basic Realm</a></strong></td>
+ <td rowspan=="1" colspan="3"><p><strong> Authentication Basic Realm</strong></p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.proxy.authenticate.basic.realm</i></code></p></td>
@@ -1175,7 +1185,7 @@
<td><p>The authentication realm name. If the default of <code> NULL</code> is specified, then<code> traffic_edge</code> is used.</p></td>
</tr>
<tr>
- <td rowspan="1" colspan="3"><p><strong>HTTP Engine</strong></p></td>
+ <td rowspan=="1" colspan="3"><p><strong> HTTP Engine</strong></p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.server_port</i></code></p>
@@ -1210,84 +1220,84 @@
<p><code>INT</code></p></td>
<td><p><code>1</code></p></td>
<td><p>You can specify one of the following:</p>
- <p><code>0</code> = no extra information is added to the string.<br />
- <code>1</code> = all extra information is added.<br />
- <code>2</code> = some extra information is added.</p></td>
+ <p>0 = no extra information is added to the string.<br />
+ 1 = all extra information is added.<br />
+ 2 = some extra information is added.</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.insert_response_via_str </i></code></p>
<p><code>INT</code></p></td>
<td><p><code>1</code></p></td>
<td><p>You can specify one of the following:</p>
- <p><code>0</code><code> </code>= no extra information is added to the string.<br />
- <code>1 </code>= all extra information is added.<br />
- <code>2</code><code> </code>= some extra information is added.</p></td>
+ <p>0 = no extra information is added to the string.<br />
+ 1 = all extra information is added.<br />
+ 2 = some extra information is added.</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.enable_url_expandomatic</i></code></p>
<p><code>INT</code></p></td>
<td><p><code>1</code></p></td>
- <td><p>Enables (<code>1</code>) or disables (<code>0</code>) <code> .com</code> domain expansion. This configures the Traffic Server to resolve unqualified hostnames by prepending with <code> www.</code> and appending with <code> .com</code> before redirecting to the expanded address. </p>
+ <td><p>Enables (1) or disables (0) <code> .com</code> domain expansion. This configures the Traffic Server to resolve unqualified hostnames by prepending with <code> www.</code> and appending with <code> .com</code> before redirecting to the expanded address. </p>
<p>For example: if a client makes a request to <code> host</code> , then Traffic Server redirects the request to <code> www.host.com</code> .</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.no_dns_just_forward_to_parent </i></code></p>
<p><code>INT</code></p></td>
<td><p><code>0</code></p></td>
- <td><p>When enabled (<code>1</code>) and if parent caching is enabled, then Traffic Server does not perform DNS lookups on request hostnames.</p></td>
+ <td><p>When enabled (1) and if parent caching is enabled, then Traffic Server does no DNS lookups on request hostnames.</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.uncacheable_requests_bypass_parent</i></code></p>
<p><code>INT</code></p></td>
<td><p><code>1</code></p></td>
- <td><p>When enabled (<code>1</code>), Traffic Server bypasses the parent proxy for a request that is not cacheable.</p></td>
+ <td><p>When enabled (1), Traffic Server bypasses the parent proxy for a request that is not cacheable.</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.keep_alive_enabled </i></code></p>
<p><code>INT</code></p></td>
<td><p><code>1</code></p></td>
- <td><p>Enables (<code>1</code>) or disables (<code>0</code>) the use of keep-alive connections to either origin servers or clients.</p></td>
+ <td><p>Enables (1) or disables (0) the use of keep-alive connections to either origin servers or clients.</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.chunking_enabled </i></code></p>
<p><code>INT</code></p></td>
<td><p><code>0</code></p></td>
<td><p>Specifies whether Traffic Sever can generate a chunked response:</p>
- <code>0</code> = Never<br />
- <code>1</code> = Always<br />
- <code>2</code> = Generate a chunked response if the server has returned HTTP 1.1 before<br />
- <code>3</code> = Generate a chunked response if the client request is HTTP 1.1 and the origin server has returned HTTP 1.1 before <p></p></td>
+ 0 = Never<br />
+ 1 = Always<br />
+ 2 = Generate a chunked response if the server has returned HTTP 1.1 before<br />
+ 3 = Generate a chunked response if the client request is HTTP 1.1 and the origin server has returned HTTP 1.1 before<p></p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.send_http11_requests </i></code></p>
<p><code>INT</code></p></td>
<td><p><code>3</code></p></td>
<td><p>Configures Traffic Server to use HTTP Version 1.1 when communicating with origin servers. You can specify one of the following values:</p>
- <p><code>1</code> = Traffic Server always uses HTTP 1.1 when communicating with origin servers.<br />
- <code>2</code> = Traffic Server uses HTTP 1.1 if the origin server has previously used HTTP 1.1.<br />
- <code>3</code> = Traffic Server uses HTTP 1.1 if the client request is HTTP 1.1 and the origin server has previously used HTTP 1.1.</p>
+ <p>1 = Traffic Server always uses HTTP 1.1 when communicating with origin servers.<br />
+ 2 = Traffic Server uses HTTP 1.1 if the origin server has previously used HTTP 1.1.<br />
+ 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.</p>
<p><b>Note:</b> 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.</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.share_server_sessions </i></code></p>
<p><code>INT</code></p></td>
<td><p><code>1</code></p></td>
- <td><p>Enables (<code>1</code>) or disables (<code>0</code>) the reuse of server sessions.</p></td>
+ <td><p>Enables (1) or disables (0) the reuse of server sessions.</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.record_heartbeat </i></code></p>
<p><code>INT</code></p></td>
<td><p><code>0</code></p></td>
- <td><p>Enables (<code>1</code>) or disables (<code>0</code>) <code>traffic_cop</code> heartbeat logging.</p></td>
+ <td><p>Enables (1) or disables (0) <code>traffic_cop</code> heartbeat logging.</p></td>
</tr>
<tr>
- <td rowspan="1" colspan="3"><p><b>Parent Proxy Configuration</b></p></td>
+ <td rowspan=="1" colspan="3"><p><b>Parent Proxy Configuration</b></p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.parent_proxy_routing_enable</i></code></p>
<p><code>INT</code></p></td>
<td><p><code>0</code></p></td>
- <td><p>Enables (<code>1</code>) or disables (<code>0</code>) the parent caching option.</p>
+ <td><p>Enables (1) or disables (0) the parent caching option.</p>
<p>Refer to <a href="hier.htm">Hierarchical Caching</a>.</p></td>
</tr>
<tr>
@@ -1306,7 +1316,7 @@
<td><p><code><i>proxy.config.http.parent_proxy.total_connect_attempts</i></code></p>
<p><code>INT</code></p></td>
<td><p><code>4</code></p></td>
- <td><p>The total number of connection attempts allowed to a parent cache before Traffic Server bypasses the parent or fails the request (depending on the <code><i>go_direct</i></code> option in the <code> bypass.config</code> file).</p></td>
+ <td><p>The total number of connection attempts allowed to a parent cache before Traffic Server bypasses the parent or fails the request (depending on the <code>go_direct</code> option in the <code> bypass.config</code> file).</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.parent_proxy.per_parent_connect_attempts </i></code></p>
@@ -1327,7 +1337,7 @@
<td><p>Configures Traffic Server to send proxy authentication headers on to the parent cache.</p></td>
</tr>
<tr>
- <td rowspan="1" colspan="3"><p><b>HTTP Connection Timeouts (secs)</b></p></td>
+ <td rowspan=="1" colspan="3"><p><b>HTTP Connection Timeouts (secs)</b></p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.keep_alive_no_activity_timeout_in</i></code></p>
@@ -1357,15 +1367,15 @@
<td><p><code><i>proxy.config.http.transaction_active_timeout_in </i></code></p>
<p><code>INT</code></p></td>
<td><p><code>0</code></p></td>
- <td><p>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.</p>
- <p>The default value of <code>0</code> specifies that there is no timeout.</p></td>
+ <td><p>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, Traffic Server closes the connection.</p>
+ <p>The default value of 0 specifies that there is no timeout.</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.transaction_active_timeout_out</i></code></p>
<p><code>INT</code></p></td>
<td><p><code>0</code></p></td>
<td><p>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.</p>
- <p>The default value of <code>0</code> specifies that there is no timeout.</p></td>
+ <p>The default value of 0 specifies that there is no timeout.</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.accept_no_activity_timeout </i></code></p>
@@ -1383,10 +1393,10 @@
<td><p><code><i>proxy.config.http.background_fill_completed_threshold</i></code></p>
<p><code>FLOAT</code></p></td>
<td><p><code>0.50000</code></p></td>
- <td><p>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 <b>background fill</b>).</p></td>
+ <td><p>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 ).</p></td>
</tr>
<tr>
- <td rowspan="1" colspan="3"><p><b>Origin Server Connect Attempts</b></p></td>
+ <td rowspan=="1" colspan="3"><p><b>Origin Server Connect Attempts</b></p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.connect_attempts_max_retries</i></code></p>
@@ -1405,20 +1415,20 @@
<p><code>INT</code></p></td>
<td><p><code>0</code></p></td>
<td><p>Limits the number of socket connections across all origin servers to the value specified.</p>
- <p>To disable, set to zero (<code>0</code>). </p></td>
+ <p>To disable, set to zero (0). </p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.origin_max_connections</i></code></p>
<p><code>INT</code></p></td>
<td>0</td>
<td><p>Limits the number of socket connections per origin server to the value specified.</p>
- <p>To disable, set to zero (<code>0</code>). </p></td>
+ <p>To disable, set to zero (0). </p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.connect_attempts_rr_retries </i></code></p>
<p><code>INT</code></p></td>
<td>2</td>
- <td>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.</td>
+ <td>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.</td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.connect_attempts_timeout </i></code></p>
@@ -1442,27 +1452,27 @@
<td><p><code><i>proxy.config.http.down_server.abort_threshold </i></code></p>
<p><code>INT</code></p></td>
<td><p><code>10</code></p></td>
- <td><p>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.</p></td>
+ <td><p>The number of seconds before Traffic Server marks an origin server as unavailable when a client abandons a request because the origin server was too slow in sending the response header.</p></td>
</tr>
<tr>
- <td rowspan="1" colspan="3"><strong><a name="records.config.congestion">Congestion Control</a></strong></td>
+ <td rowspan=="1" colspan="3"><p><strong> Congestion Control</strong></p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.congestion_control.enabled</i></code></p>
<p><code>INT</code></p></td>
<td><p><code>0</code></p></td>
- <td><p>Enables (<code>1</code>) or disables (<code>0</code>) 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. </p>
- <p>Refer to <a href="http.htm#UsingCongestionControl">Using Congestion Control</a>.</p></td>
+ <td><p>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 <a href="http.htm#UsingCongestionControl">Using Congestion Control</a>.</p></td>
</tr>
<tr>
- <td rowspan="1" colspan="3"><strong><a name="records.config.negative">Negative Response Caching</a></strong></td>
+ <td rowspan=="1" colspan="3"><p><strong> Negative Response Caching</strong></p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.negative_caching_enabled</i></code></p>
<p><code>INT</code></p></td>
<td><p><code>0</code></p></td>
- <td><p>When enabled (<code>1</code>), Traffic Server caches negative responses (such as <code>404 Not Found</code>) 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.</p>
- <p><b>Note</b>: <code>Cache-Control</code> directives from the server forbidding cache are ignored for the following HTTP response codes, regardless of the value specified for the <code><i>proxy.config.http.negative_caching_enabled</i></code> variable. The following negative responses are cached by Traffic Server: </p>
+ <td><p>When enabled (1), Traffic Server caches negative responses (such as <code>404 Not Found</code>) when a requested page does not exist. The next time a client requests the same page, Traffic Server serves the negative response from cache.</p>
+ <p><b>Note</b>: <code>Cache-Control</code> directives from the server forbidding cache are ignored for the following HTTP response codes, regardless of the value specified for the <code><i>proxy.config.http.negative_caching_enabled</i></code> variable. </p>
+ <p>The following negative responses are cached by Traffic Server: </p>
<p><code>204 No Content <br />
305 Use Proxy <br />
400 Bad Request <br />
@@ -1479,53 +1489,53 @@
<td><p><code><i>proxy.config.http.negative_caching_lifetime</i></code></p>
<p><code>INT</code></p></td>
<td><p><code>1800</code></p></td>
- <td><p>The how long (in seconds) Traffic Server keeps the negative responses valid in cache. </p>
- <p><b>Note:</b> This value only affects negative responses that do have explicit <code>Expires: </code> or <code>Cache-Control: </code> lifetimes set by the server.</p></td>
+ <td><p>The how long (in seconds) Traffic Server keeps the negative responses as valid in cache. </p>
+ <p><b>Note:</b> This value only affects negative responses that do have explicit <code>Expires</code>: or <code>Cache-Control:</code> lifetimes set by the server.</p></td>
</tr>
<tr>
- <td rowspan="1" colspan="3"><strong><a name="records.config.proxy">Proxy User Variables</a></strong></td>
+ <td rowspan=="1" colspan="3"><p><strong> Proxy User Variables</strong></p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.anonymize_remove_from</i></code></p>
<p><code>INT</code></p></td>
<td><p><code>0</code></p></td>
- <td><p>When enabled (<code>1</code>), Traffic Server removes the <code> From</code> header to protect the privacy of your users.</p></td>
+ <td><p>When enabled (1), Traffic Server removes the <code> From</code> header to protect the privacy of your users.</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.anonymize_remove_referer </i></code></p>
<p><code>INT</code></p></td>
<td><p><code>0</code></p></td>
- <td><p>When enabled (<code>1</code>), Traffic Server removes the <code> Referrer</code> header to protect the privacy of your site and users.</p></td>
+ <td><p>When enabled (1), Traffic Server removes the <code> Referer</code> header to protect the privacy of your site and users.</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.anonymize_remove_user_agent </i></code></p>
<p><code>INT</code></p></td>
<td><p><code>0</code></p></td>
- <td><p>When enabled (<code>1</code>), Traffic Server removes the <code> User-agent</code> header to protect the privacy of your site and users.</p></td>
+ <td><p>When enabled (1), Traffic Server removes the <code> User-agent</code> header to protect the privacy of your site and users.</p></td>
</tr>
<tr>
<td><p><code><i>proxy.config.http.anonymize_remove_cookie</i></code></p>
<p><code>INT</code></p></td>
<td><p><code>0</code></p></td>
- <td><p>When enabled (<code>1</code>), Traffic Server removes the <code> Cookie</code> header to protect the privacy of your site and users.</p></td>
[... 1234 lines stripped ...]