trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r789764 - in /websites/staging/trafficserver/trunk/content/docs/trunk/admin: configuration-files/records.config.en.html getting-started/index.en.html http-proxy-caching/index.en.html index.en.html
Date Wed, 18 May 2011 20:55:26 GMT
Author: buildbot
Date: Wed May 18 20:55:25 2011
New Revision: 789764

Log:
Staging update by buildbot

Modified:
    websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/records.config.en.html
    websites/staging/trafficserver/trunk/content/docs/trunk/admin/getting-started/index.en.html
    websites/staging/trafficserver/trunk/content/docs/trunk/admin/http-proxy-caching/index.en.html
    websites/staging/trafficserver/trunk/content/docs/trunk/admin/index.en.html

Modified: websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/records.config.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/records.config.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/admin/configuration-files/records.config.en.html Wed May 18 20:55:25 2011
@@ -1003,10 +1003,12 @@ headers in responses</p>
 <p><code>INT</code></p>
 </dd>
 <dd>
-<p>Default: <code>0</code></p>
+<p>Default: <code>1</code></p>
 </dd>
 <dd>
-<p>Enables (<code>1</code>) or disables (<code>0</code>) caching of URLs that look dynamic.</p>
+<p>Enables (<code>1</code>) or disables (<code>0</code>) caching of URLs that look dynamic, i.e.: URLs that end in <strong><code>.asp</code></strong> or
+contain a question mark (<strong><code>?</code></strong>), a semicolon (<strong><code>;</code></strong>), or <strong><code>cgi</code></strong>.</p>
+<p>For a full list, please refer to <a href="/link/to/doxygen">HttpTransact::url_looks_dynamic</a></p>
 </dd>
 <dt id="proxy.config.http.cache.enable_default_vary_headers"><em><code>proxy.config.http.cache.enable_default_vary_headers</code></em></dt>
 <dd>
@@ -1220,6 +1222,17 @@ problems with caching and your origin se
 <p>When enabled (<code>1</code>), Traffic Server ignores any
 <code>Cache-Control:  max-age</code> headers from the client.</p>
 </dd>
+<dt id="proxy.config.cache.permit.pinning"><em><code>proxy.config.cache.permit.pinning</code></em></dt>
+<dd>
+<p><code>INT</code></p>
+</dd>
+<dd>
+<p>Default: <code>0</code></p>
+</dd>
+<dd>
+<p>When enabled (<code>1</code>), Traffic Server will keep certain HTTP objects in the cache for a certain time as 
+specified in <a href="cache.config"><code>cache.config</code></a>.</p>
+</dd>
 </dl>
 <h3 id="HeuristicExpiration">Heuristic Expiration</h3>
 <dl>
@@ -1257,7 +1270,7 @@ specified fuzz time.</dd>
 <dd>Default: <code>NULL</code></dd>
 <dd>
 <p>The header on which Traffic Server varies for text documents.</p>
-<p>For example: if you specify <code>user-agent</code>, then Traffic Server
+<p>For example: if you specify <code>User-agent</code>, then Traffic Server
 caches all the different user-agent versions of documents it
 encounters.</p>
 </dd>

Modified: websites/staging/trafficserver/trunk/content/docs/trunk/admin/getting-started/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/admin/getting-started/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/admin/getting-started/index.en.html Wed May 18 20:55:25 2011
@@ -45,29 +45,26 @@ refer to our <a href="https://cwiki.apac
 for <a href="https://cwiki.apache.org/confluence/display/TS/Building">build instructions</a></p>
 <p>After you have installed Traffic Server on your system, you can do any of the
 following:</p>
+<div class="toc">
 <ul>
+<li><a href="#GettingStarted">Getting Started</a></li>
 <li><a href="#StartTS">Start Traffic Server</a></li>
 <li><a href="#StartTrafficLine">Start Traffic Line</a></li>
 <li><a href="#StartTrafficShell">Start Traffic Shell</a></li>
 <li><a href="#StopTS">Stop Traffic Server</a></li>
 </ul>
-<h2 id="StartTS">Start Traffic Server</h2>
+</div>
+<h1 id="StartTS">Start Traffic Server</h1>
 <p>To start Traffic Server manually, issue the <code>trafficserver</code> command, passing
 in the attribute <code>start</code>. This command starts all the processes that work together
 to process Traffic Server requests as well as manage, control, and monitor
 the health of the Traffic Server system.</p>
-<h5 id="runTSstartcommand">To run the <code>trafficserver start</code> command:</h5>
-<ol>
-<li>Log on to the Traffic Server node as the Traffic Server administrator and navigate to the Traffic Server <code>bin</code> directory.</li>
-<li>
-<p>Enter the following command:</p>
-<div class="codehilite"><pre><span class="o">./</span><span class="n">trafficserver</span> <span class="n">start</span>
+<p>To run the <code>trafficserver start</code> command, e.g.:</p>
+<div class="codehilite"><pre>    <span class="o">./</span><span class="n">trafficserver</span> <span class="n">start</span>
 </pre></div>
 
 
-</li>
-</ol>
-<h2 id="StartTrafficLine">Start Traffic Line</h2>
+<h1 id="StartTrafficLine">Start Traffic Line</h1>
 <p>Traffic Line provides a quick way of viewing Traffic Server statistics and
 configuring the Traffic Server system via command-line interface. To execute
 individual commands or script multiple commands, refer to <a href="../traffic-line-commands">Traffic Line Commands</a>.</p>
@@ -81,7 +78,7 @@ individual commands or script multiple c
 </pre></div>
 
 
-<h2 id="StartTrafficShell">Start Traffic Shell</h2>
+<h1 id="StartTrafficShell">Start Traffic Shell</h1>
 <p>Traffic Shell is a command-line tool that enables you to monitor and configure
 Traffic Server; it can be used instead of Traffic Line. Traffic Server provides
 documentation for Traffic Shell in the form of manual (<code>man</code>) pages.</p>
@@ -95,7 +92,7 @@ commands, and how to obtain documentatio
 </pre></div>
 
 
-<h2 id="StopTS">Stop Traffic Server</h2>
+<h1 id="StopTS">Stop Traffic Server</h1>
 <p>To stop Traffic Server, always use the <code>trafficserver</code> command, passing in
 the attribute <code>stop</code>. This command stops all the Traffic Server processes (<code>traffic_manager</code>,
 <code>traffic_server</code>, and <code>traffic_cop</code>). Do not manually stop processes, as this

Modified: websites/staging/trafficserver/trunk/content/docs/trunk/admin/http-proxy-caching/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/admin/http-proxy-caching/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/admin/http-proxy-caching/index.en.html Wed May 18 20:55:25 2011
@@ -45,29 +45,70 @@
 users on demand. It improves performance and frees up Internet bandwidth for 
 other tasks. </p>
 <p>This chapter discusses the following topics: </p>
+<div class="toc">
 <ul>
+<li><a href="#HTTPProxyCaching">HTTP Proxy Caching</a></li>
 <li><a href="#UnderstandingHTTPWebProxyCaching">Understanding HTTP Web Proxy Caching</a></li>
-<li><a href="#EnsuringCachedObjectFreshness">Ensuring Cached Object Freshness</a></li>
-<li><a href="#SchedulingUpdatesToLocalCacheContent">Scheduling Updates to Local Cache Content</a></li>
-<li><a href="#PushingContentIntoCache">Pushing Content into the Cache</a></li>
-<li><a href="#PinningContentInCache">Pinning Content in the Cache</a></li>
-<li><a href="#ToCacheOrNotToCache">To Cache or Not to Cache?</a></li>
+<li><a href="#EnsuringCachedObjectFreshness">Ensuring Cached Object Freshness</a><ul>
+<li><a href="#HTTPObjectFreshness">HTTP Object Freshness</a></li>
+<li><a href="#ModifyingAgingFactorFreshnessComputations">Modifying Aging Factor for Freshness Computations</a></li>
+<li><a href="#SettinganAbsoluteFreshnessLimit">Setting absolute Freshness Limits</a></li>
+<li><a href="#SpecifyingHeaderRequirements">Specifying Header Requirements</a></li>
+<li><a href="#Cache-ControlHeaders">Cache-Control Headers</a></li>
+<li><a href="#RevalidatingHTTPObjects">Revalidating HTTP Objects</a></li>
+</ul>
+</li>
+<li><a href="#SchedulingUpdatesLocalCacheContent">Scheduling Updates to Local Cache Content</a><ul>
+<li><a href="#ConfiguringScheduledUpdateOption">Configuring the Scheduled Update Option</a></li>
+<li><a href="#ForcingImmediateUpdate">Forcing an Immediate Update</a></li>
+</ul>
+</li>
+<li><a href="#PushingContentintoCache">Pushing Content into the Cache</a><ul>
+<li><a href="#ConfiguringTSPUSHRequests">Configuring Traffic Server for PUSH Requests</a></li>
+<li><a href="#UnderstandingHTTPPUSH">Understanding HTTP PUSH</a></li>
+</ul>
+</li>
+<li><a href="#PinningContentinCache">Pinning Content in the Cache</a></li>
+<li><a href="#CacheNotCache">To Cache or Not to Cache?</a></li>
+<li><a href="#CachingHTTPObjects">Caching HTTP Objects</a><ul>
+<li><a href="#ClientDirectives">Client Directives</a><ul>
+<li><a href="#ConfiguringTSIgnoreClientnocacheHeaders">Configuring Traffic Server to Ignore Client no-cache Headers</a></li>
+</ul>
+</li>
+<li><a href="#OriginServerDirectives">Origin Server Directives</a><ul>
+<li><a href="#ConfiguringTSIgnoreServernocacheHeaders">Configuring Traffic Server to Ignore Server no-cache Headers</a></li>
+<li><a href="#ConfiguringTSIgnoreWWWAuthenticateHeaders">Configuring Traffic Server to Ignore WWW-Authenticate Headers</a></li>
+</ul>
+</li>
+<li><a href="#ConfigurationDirectives">Configuration Directives</a><ul>
+<li><a href="#DisablingHTTPObjectCaching">Disabling HTTP Object Caching</a></li>
+<li><a href="#CachingDynamicContent">Caching Dynamic Content</a></li>
+<li><a href="#CachingCookiedObjects">Caching Cookied Objects</a></li>
+</ul>
+</li>
+</ul>
+</li>
 <li><a href="#ForcingObjectCaching">Forcing Object Caching</a></li>
-<li><a href="#CachingHTTPAlternates">Caching HTTP Alternates</a></li>
+<li><a href="#CachingHTTPAlternates">Caching HTTP Alternates</a><ul>
+<li><a href="#ConfiguringHowTSCachesAlternates">Configuring How Traffic Server Caches Alternates</a></li>
+<li><a href="#LimitingNumberofAlternatesforanObject">Limiting the Number of Alternates for an Object</a></li>
+</ul>
+</li>
 <li><a href="#UsingCongestionControl">Using Congestion Control</a></li>
 </ul>
-<h2 id="UnderstandingHTTPWebProxyCaching">Understanding HTTP Web Proxy Caching</h2>
+</div>
+<h1 id="UnderstandingHTTPWebProxyCaching">Understanding HTTP Web Proxy Caching</h1>
 <p>Internet users direct their requests to web servers all over the Internet. 
 A caching server must act as a <strong>web proxy server</strong> so it can serve those requests. 
 After a web proxy server receives requests for web objects, it either serves 
 the requests or forwards them to the <strong>origin server</strong> (the web server that 
 contains the original copy of the requested information). The Traffic Server 
-proxy supports <strong>explicit proxy caching</strong>, in which the user’s client software 
+proxy supports <strong>explicit proxy caching</strong>, in which the user's client software 
 must be configured to send requests directly to the Traffic Server proxy. The 
-following overview illustrates how Traffic Server serves a user request.</p>
+following overview illustrates how Traffic Server serves a request.</p>
 <ol>
 <li>
-<p>Traffic Server receives a user request for a web object. </p>
+<p>Traffic Server receives a client request for a web object. </p>
 </li>
 <li>
 <p>Using the object address, Traffic Server tries to locate the requested 
@@ -76,19 +117,19 @@ object in its object database (<strong>c
 <li>
 <p>If the object is in the cache, then Traffic Server checks to see 
 if the object is fresh enough to serve. If it is fresh, then Traffic Server 
-serves it to the user as a <strong>cache hit</strong> (see the figure below).</p>
+serves it to the client as a <strong>cache hit</strong> (see the figure below).</p>
 <p><img alt="A cache hit" src="/images/admin/cache_hit.jpg" /></p>
 </li>
 <li>
 <p>If the data in the cache is stale, then Traffic Server connects 
 to the origin server and checks if the object is still fresh (a <strong>revalidation</strong>). 
-If it is, then Traffic Server immediately sends the cached copy to the user. </p>
+If it is, then Traffic Server immediately sends the cached copy to the client. </p>
 </li>
 <li>
 <p>If the object is not in the cache (a <strong>cache miss</strong>) or if the server 
 indicates the cached copy is no longer valid, then Traffic Server obtains the 
 object from the origin server. The object is then simultaneously streamed to 
-the user and the Traffic Server local cache (see the figure below). Subsequent 
+the client and the Traffic Server local cache (see the figure below). Subsequent 
 requests for the object can be served faster because the object is retrieved 
 directly from cache.</p>
 <p><img alt="A cache miss" src="/images/admin/cache_miss.jpg" /></p>
@@ -98,7 +139,7 @@ directly from cache.</p>
 particular, the overview does not discuss how Traffic Server ensures freshness, 
 serves correct HTTP alternates, and treats requests for objects that cannot/should 
 not be cached. The following sections discuss these issues in greater detail. </p>
-<h2 id="EnsuringCachedObjectFreshness">Ensuring Cached Object Freshness</h2>
+<h1 id="EnsuringCachedObjectFreshness">Ensuring Cached Object Freshness</h1>
 <p>When Traffic Server receives a request for a web object, it first tries to 
 locate the requested object in its cache. If the object is in cache, then Traffic 
 Server checks to see if the object is fresh enough to serve. For HTTP objects, 
@@ -146,33 +187,37 @@ and <code>Date</code> headers, Traffic S
 <p>Revalidate rules apply freshness limits to specific HTTP objects. You can set freshness
 limits for objects originating from particular domains or IP addresses, objects with URLs
 that contain specified regular expressions, objects requested by particular clients,
-and so on (refer to <a href="files.htm#cache.config">cache.config</a>).</p>
+and so on (refer to <a href="../configuration-files/cache.config"><code>cache.config</code></a>).</p>
 </li>
 </ul>
-<h3 id="ModifyingAgingFactorFreshnessComputations">Modifying the Aging Factor for Freshness Computations</h3>
+<h2 id="ModifyingAgingFactorFreshnessComputations">Modifying Aging Factor for Freshness Computations</h2>
 <p>If an object does not contain any expiration information, then Traffic Server 
 can estimate its freshness from the <code>Last-Modified</code> and <code>Date</code> headers. By 
 default, Traffic Server stores an object for 10% of the time that elapsed since 
 it last changed. You can increase or reduce the percentage according to your 
 needs. </p>
-<h5 id="modifyagingfactorfreshnesscomputations">To modify the aging factor for freshness computations:</h5>
+<p>To modify the aging factor for freshness computations</p>
 <ol>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.http.cache.heuristic_lm_factor"><em><code>proxy.config.http.cache.heuristic_lm_factor</code></em></a></li>
+<li>Edit the following variables in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.http.cache.heuristic_lm_factor"><em><code>proxy.config.http.cache.heuristic_lm_factor</code></em></a></li>
+</ul>
+</li>
 <li>Run the <code>traffic_line -x</code> command to apply the configuration changes.</li>
 </ol>
-<h3 id="SettinganAbsoluteFreshnessLimit">Setting an Absolute Freshness Limit</h3>
+<h2 id="SettinganAbsoluteFreshnessLimit">Setting absolute Freshness Limits</h2>
 <p>Some objects do not have <code>Expires</code> headers or do not have both <code>Last-Modified</code> 
 and <code>Date</code> headers. To control how long these objects are considered fresh 
 in the cache, specify an <strong>absolute freshness limit</strong>.</p>
-<h5 id="specifyanabsolutefreshnesslimit">To specify an absolute freshness limit:</h5>
+<p>To specify an absolute freshness limit</p>
 <ol>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.http.cache.heuristic_min_lifetime"><em><code>proxy.config.http.cache.heuristic_min_lifetime</code></em></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.http.cache.heuristic_max_lifetime"><em><code>proxy.config.http.cache.heuristic_max_lifetime</code></em></a></li>
+<li>Edit the following variables in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.http.cache.heuristic_min_lifetime"><em><code>proxy.config.http.cache.heuristic_min_lifetime</code></em></a></li>
+<li><a href="../configuration-files/records.config#proxy.config.http.cache.heuristic_max_lifetime"><em><code>proxy.config.http.cache.heuristic_max_lifetime</code></em></a></li>
+</ul>
+</li>
 <li>Run the <code>traffic_line -x</code> command to apply the configuration changes.</li>
 </ol>
-<h3 id="SpecifyingHeaderRequirements">Specifying Header Requirements</h3>
+<h2 id="SpecifyingHeaderRequirements">Specifying Header Requirements</h2>
 <p>To further ensure freshness of the objects in the cache, configure Traffic 
 Server to cache only objects with specific headers. By default, Traffic Server 
 caches all objects (including objects with no headers); you should change the 
@@ -180,13 +225,15 @@ default setting only for specialized pro
 Server to cache only HTTP objects with <code>Expires</code> or <code>max-age</code> headers, then 
 the cache hit rate will be noticeably reduced (since very few objects will 
 have explicit expiration information).</p>
-<h5 id="configureTScacheobjectswithspecificheaders">To configure Traffic Server to cache objects with specific headers:</h5>
+<p>To configure Traffic Server to cache objects with specific headers</p>
 <ol>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.http.cache.required_headers"><em><code>proxy.config.http.cache.required_headers</code></em></a></li>
+<li>Edit the following variable in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.http.cache.required_headers"><em><code>proxy.config.http.cache.required_headers</code></em></a></li>
+</ul>
+</li>
 <li>Run the <code>traffic_line -x</code> command to apply the configuration changes.</li>
 </ol>
-<h3 id="Cache-ControlHeaders">Cache-Control Headers</h3>
+<h2 id="Cache-ControlHeaders">Cache-Control Headers</h2>
 <p>Even though an object might be fresh in the cache, clients or servers often 
 impose their own constraints that preclude retrieval of the object from the 
 cache. For example, a client might request that a object <em>not</em> be retrieved 
@@ -200,7 +247,7 @@ headers that appear in both client reque
   not to serve any objects directly from the cache; therefore, Traffic Server will
   always obtain the object from the origin server. You can configure Traffic Server
   to ignore client <code>no-cache</code> headers - refer to
-  <a href="#NoCacheHeaders">Configuring Traffic Server to Ignore Client no-cache Headers</a> for more information.</p>
+  <a href="#ConfiguringTSIgnoreClientnocacheHeaders">Configuring Traffic Server to Ignore Client no-cache Headers</a> for more information.</p>
 </li>
 <li>
 <p>The <code>max-age</code> header, sent by servers, is compared to the object age.
@@ -209,7 +256,7 @@ headers that appear in both client reque
 <li>
 <p>The <code>min-fresh</code> header, sent by clients, is an <strong>acceptable freshness tolerance</strong>.
   This means that the client wants the object to be at least this fresh.
-  If a cached object does not remain fresh at least this long in the future, then it is revalidated. </p>
+  Unless a cached object remains fresh at least this long in the future, it is revalidated. </p>
 </li>
 <li>
 <p>The <code>max-stale</code> header, sent by clients, permits Traffic Server to serve stale
@@ -218,10 +265,10 @@ headers that appear in both client reque
   periods of poor Internet availability. </p>
 </li>
 </ul>
-<p>Traffic Server applies <code>Cache-Control</code> servability criteria after HTTP freshness 
+<p>Traffic Server applies <code>Cache-Control</code> servability criteria <strong><em>after</em></strong> HTTP freshness 
 criteria. For example, an object might be considered fresh but will not be 
 served if its age is greater than its <code>max-age</code>.</p>
-<h3 id="RevalidatingHTTPObjects">Revalidating HTTP Objects</h3>
+<h2 id="RevalidatingHTTPObjects">Revalidating HTTP Objects</h2>
 <p>When a client requests an HTTP object that is stale in the cache, Traffic Server 
 revalidates the object. A <strong>revalidation</strong> is a query to the origin server 
 to check if the object is unchanged. The result of a revalidation is one of 
@@ -233,7 +280,7 @@ the following:</p>
 </li>
 <li>
 <p>If a new copy of the object is available, then Traffic Server caches the
-  new object (thereby replacing the stale copy) and simultaneously serves the object to the user. </p>
+  new object (thereby replacing the stale copy) and simultaneously serves the object to the client. </p>
 </li>
 <li>
 <p>If the object no longer exists on the origin server, then Traffic Server
@@ -255,32 +302,31 @@ how Traffic Server evaluates freshness b
 </ul>
 <p>To configure how Traffic Server revalidates objects in the cache, you can set 
 specific revalidation rules in <a href="../configuration-files/records.config"><code>cache.config</code></a>. </p>
-<h5 id="configurerevalidationoptions">To configure revalidation options:</h5>
+<p>To configure revalidation options</p>
 <ol>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.http.cache.when_to_revalidate"><em><code>proxy.config.http.cache.when_to_revalidate</code></em></a></li>
+<li>Edit the following variable in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.http.cache.when_to_revalidate"><em><code>proxy.config.http.cache.when_to_revalidate</code></em></a></li>
+</ul>
+</li>
 <li>Run the <code>traffic_line -x</code> command to apply the configuration changes.</li>
 </ol>
-<h2 id="SchedulingUpdatesLocalCacheContent">Scheduling Updates to Local Cache Content</h2>
+<h1 id="SchedulingUpdatesLocalCacheContent">Scheduling Updates to Local Cache Content</h1>
 <p>To further increase performance and to ensure that HTTP objects are fresh in 
 the cache, you can use the <strong>Scheduled Update</strong> option. This configures Traffic 
 Server to load specific objects into the cache at scheduled times. You might 
-find this especially beneficial when using Traffic Server as a reverse proxy 
-so you can preload content you anticipate will be in demand. </p>
+find this especially beneficial in a reverse proxy setup, where you can
+<em>preload</em> content you anticipate will be in demand. </p>
 <p>To use the Scheduled Update option, you must perform the following tasks. </p>
 <ul>
-<li>
-<p>Specify the list of URLs that contain the objects you want to schedule
-  for update, the time the update should take place, and the recursion depth for the URL.</p>
-</li>
-<li>
-<p>Enable the scheduled update option and configure optional retry settings.</p>
-</li>
+<li>Specify the list of URLs that contain the objects you want to schedule for update,</li>
+<li>the time the update should take place,</li>
+<li>and the recursion depth for the URL.</li>
+<li>Enable the scheduled update option and configure optional retry settings.</li>
 </ul>
 <p>Traffic Server uses the information you specify to determine URLs for which 
 it is responsible. For each URL, Traffic Server derives all recursive URLs 
 (if applicable) and then generates a unique URL list. Using this list, Traffic 
-Server initiates an HTTP <code>GET</code> for each unaccessed URL, ensuring that it remains 
+Server initiates an HTTP <code>GET</code> for each unaccessed URL. It ensures that it remains 
 within the user-defined limits for HTTP concurrency at any given time. The 
 system logs the completion of all HTTP <code>GET</code> operations so you can monitor 
 the performance of this feature. </p>
@@ -288,44 +334,47 @@ the performance of this feature. </p>
 you to update URLs immediately without waiting for the specified update time 
 to occur. You can use this option to test your scheduled update configuration 
 (refer to <a href="#ForcingImmediateUpdate">Forcing an Immediate Update</a>). </p>
-<h3 id="ConfiguringScheduledUpdateOption">Configuring the Scheduled Update Option</h3>
-<h5 id="configurescheduledupdateoption">To configure the scheduled update option:</h5>
+<h2 id="ConfiguringScheduledUpdateOption">Configuring the Scheduled Update Option</h2>
+<p>To configure the scheduled update option</p>
 <ol>
-<li>In <a href="../configuration-files/update.config"><code>update.config</code></a> enter a line in the file for each URL you want to update.</li>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.http.update.enabled"><em><code>proxy.config.update.enabled</code></em></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.http.update.retry_count"><em><code>proxy.config.update.retry_count</code></em></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.http.update.retry_interval"><em><code>proxy.config.update.retry_interval</code></em></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.http.update.concurrent_updates"><em><code>proxy.config.update.concurrent_updates</code></em></a></li>
+<li>Edit <a href="../configuration-files/update.config"><code>update.config</code></a> to enter a line in the file for each URL you want to update.</li>
+<li>Edit the following variables in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.http.update.enabled"><em><code>proxy.config.update.enabled</code></em></a></li>
+<li><a href="../configuration-files/records.config#proxy.config.http.update.retry_count"><em><code>proxy.config.update.retry_count</code></em></a></li>
+<li><a href="../configuration-files/records.config#proxy.config.http.update.retry_interval"><em><code>proxy.config.update.retry_interval</code></em></a></li>
+<li><a href="../configuration-files/records.config#proxy.config.http.update.concurrent_updates"><em><code>proxy.config.update.concurrent_updates</code></em></a></li>
+</ul>
+</li>
 <li>Run the <code>traffic_line -x</code> command to apply the configuration changes.</li>
 </ol>
-<h3 id="ForcingImmediateUpdate">Forcing an Immediate Update</h3>
+<h2 id="ForcingImmediateUpdate">Forcing an Immediate Update</h2>
 <p>Traffic Server provides a <strong>Force Immediate Update</strong> option that enables you 
 to immediately verify the URLs listed in the <code>update.config</code> file. The Force 
 Immediate Update option disregards the offset hour and interval set in the 
 <code>update.config</code> file and immediately updates the URLs listed. </p>
-<h5 id="configureForceImmediateUpdateoption">To configure the Force Immediate Update option:</h5>
+<p>To configure the Force Immediate Update option</p>
 <ol>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.http.update.force"><em><code>proxy.config.update.force</code></em></a></li>
+<li>Edit the following variables in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.http.update.force"><em><code>proxy.config.update.force</code></em></a></li>
 <li>Make sure the variable <a href="../configuration-files/records.config#proxy.config.http.update.enabled"><em><code>proxy.config.update.enabled</code></em></a> is set to 1.</li>
+</ul>
+</li>
 <li>Run the <code>command traffic_line -x</code> to apply the configuration changes. </li>
 </ol>
 <p><strong>IMPORTANT:</strong> When you enable the Force Immediate Update option, Traffic Server 
 continually updates the URLs specified in the <code>update.config</code> file until you 
 disable the option. To disable the Force Immediate Update option, set the variable 
 <a href="../configuration-files/records.config#proxy.config.http.update.force"><em><code>proxy.config.update.force</code></em></a> to <code>0</code> (zero).</p>
-<h2 id="PushingContentintoCache">Pushing Content into the Cache</h2>
+<h1 id="PushingContentintoCache">Pushing Content into the Cache</h1>
 <p>Traffic Server supports the HTTP <code>PUSH</code> method of content delivery. Using HTTP 
-<code>PUSH</code>, you can deliver content directly into the cache without user requests. </p>
-<h3 id="ConfiguringTSAcceptPUSHRequests">Configuring Traffic Server to Accept PUSH Requests</h3>
+<code>PUSH</code>, you can deliver content directly into the cache without client requests. </p>
+<h2 id="ConfiguringTSPUSHRequests">Configuring Traffic Server for PUSH Requests</h2>
 <p>Before you can deliver content into your cache using HTTP <code>PUSH</code>, you must 
 configure Traffic Server to accept <code>PUSH</code> requests.</p>
-<h5 id="configureTSacceptPUSHrequests">To configure Traffic Server to accept <code>PUSH</code> requests:</h5>
+<p>To configure Traffic Server to accept <code>PUSH</code> requests</p>
 <ol>
-<li>In <a href="../configuration-files/filter.config"><code>filter.config</code></a></li>
 <li>
-<p>Add the following filter rules to the file to ensure that only certain IP addresses can deliver <code>PUSH</code> requests to the cache:</p>
+<p>Edit <a href="../configuration-files/filter.config"><code>filter.config</code></a>, adding the following filter rules to the file to ensure that only certain IP addresses can deliver <code>PUSH</code> requests to the cache:</p>
 <div class="codehilite"><pre>domain=. src_ip=ipaddress method=PUSH action=allow
 domain=. method=PUSH action=deny
 </pre></div>
@@ -335,12 +384,14 @@ domain=. method=PUSH action=deny
    which Traffic Server accepts <code>PUSH</code> requests. </p>
 </li>
 <li>
-<p>In <a href="../configuration-files/records.config"><code>records.config</code></a></p>
+<p>Edit the following variable in <a href="../configuration-files/records.config"><code>records.config</code></a></p>
+<ul>
+<li><a href="../configuration-files/records.config#proxy.config.http.push_method_enabled"><em><code>proxy.config.http.push_method_enabled</code></em></a></li>
+</ul>
 </li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.http.push_method_enabled"><em><code>proxy.config.http.push_method_enabled</code></em></a></li>
 <li>Run the command <code>traffic_line -x</code> to apply the configuration changes. </li>
 </ol>
-<h3 id="UnderstandingHTTPPUSH">Understanding HTTP PUSH</h3>
+<h2 id="UnderstandingHTTPPUSH">Understanding HTTP PUSH</h2>
 <p><code>PUSH</code> uses the HTTP 1.1 message format. The body of a <code>PUSH</code> request contains 
 the response header and response body that you want to place in the cache. 
 The following is an example of a <code>PUSH</code> request: </p>
@@ -357,50 +408,53 @@ a
 </pre></div>
 
 
-<p><strong>IMPORTANT:</strong> Your header must include <code>Content-length</code>; <code>Content-length</code> 
+<p><strong>IMPORTANT:</strong> Your header must include <code>Content-length</code> - <code>Content-length</code> 
 must include both <code>header</code> and <code>body byte count</code>.</p>
-<h2 id="PinningContentinCache">Pinning Content in the Cache</h2>
+<h1 id="PinningContentinCache">Pinning Content in the Cache</h1>
 <p>The <strong>Cache Pinning Option</strong> configures Traffic Server to keep certain HTTP 
 objects in the cache for a specified time. You can use this option to ensure 
 that the most popular objects are in cache when needed and to prevent Traffic 
 Server from deleting important objects. Traffic Server observes <code>Cache-Control</code> 
 headers and pins an object in the cache only if it is indeed cacheable.</p>
-<h5 id="setcachepinningrulesenableCachePinning">To set cache pinning rules and enable Cache Pinning:</h5>
+<p>To set cache pinning rules</p>
 <ol>
-<li>In <a href="../configuration-files/cache.config"><code>cache.config</code></a></li>
+<li>Make sure the following variable in <a href="../configuration-files/records.config"><code>records.config</code></a> is set<ul>
+<li><a href="../configuration-files/records.config#proxy.config.cache.permit.pinning"><em><code>proxy.config.cache.permit.pinning</code></em></a></li>
+</ul>
+</li>
 <li>
-<p>Add a rule in the file for each URL you want Traffic Server to pin in the cache, as shown below.</p>
-<div class="codehilite"><pre><span class="n">url_regex</span><span class="o">=</span><span class="n">URL</span> <span class="n">pin</span><span class="o">-</span><span class="n">in</span><span class="o">-</span><span class="n">cache</span><span class="o">=</span><span class="mi">12</span><span class="n">h</span>
+<p>Add a rule in <a href="../configuration-files/cache.config"><code>cache.config</code></a> for each URL you want Traffic Server to pin in the cache. For example:</p>
+<div class="codehilite"><pre>url_regex=^https?://(www.)?apache.org/dev/ pin-in-cache=12h
 </pre></div>
 
 
-<p>where <em><code>URL</code></em> is the URL you want Traffic Server to pin in the cache. The time format can be <code>d</code> for days,
-   <code>h</code> for hours (as shown), <code>m</code> for minutes, and <code>s</code> for seconds. You can also use mixed units:
-   for example, <code>1h15m20s</code>. You can add secondary specifiers (such as prefix and suffix) to the rule.</p>
 </li>
 <li>
-<p>In <a href="../configuration-files/records.config"><code>records.config</code></a></p>
+<p>Run the command <code>traffic_line -x</code> to apply the configuration changes. </p>
 </li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.cache.permit.pinning"><em><code>proxy.config.cache.permit.pinning</code></em></a></li>
-<li>Run the command <code>traffic_line -x</code> to apply the configuration changes. </li>
 </ol>
-<h2 id="CacheNotCache">To Cache or Not to Cache?</h2>
+<h1 id="CacheNotCache">To Cache or Not to Cache?</h1>
 <p>When Traffic Server receives a request for a web object that is not in the 
 cache, it retrieves the object from the origin server and serves it to the 
 client. At the same time, Traffic Server checks if the object is cacheable 
 before storing it in its cache to serve future requests. </p>
-<h2 id="CachingHTTPObjects">Caching HTTP Objects</h2>
+<h1 id="CachingHTTPObjects">Caching HTTP Objects</h1>
 <p>Traffic Server responds to caching directives from clients and origin servers, 
 as well as directives you specify through configuration options and files. </p>
-<h3 id="ClientDirectives">Client Directives</h3>
-<p>By default, Traffic Server does <em>not</em> cache objects with the following <strong>request</strong> 
-<strong>headers</strong>: </p>
+<h2 id="ClientDirectives">Client Directives</h2>
+<p>By default, Traffic Server does <em>not</em> cache objects with the following <strong>request
+headers</strong>: </p>
 <ul>
-<li><code>Cache-Control: no-store</code> header </li>
+<li>
+<p><code>Authorization</code>: header </p>
+</li>
+<li>
+<p><code>Cache-Control: no-store</code> header </p>
+</li>
 <li>
 <p><code>Cache-Control: no-cache</code> header</p>
 <p>To configure Traffic Server to ignore the <code>Cache-Control: no-cache</code> header,
-refer to <a href="#NoCacheHeaders">Configuring Traffic Server to Ignore Client no-cache Headers</a>. </p>
+refer to <a href="#ConfiguringTSIgnoreClientnocacheHeaders">Configuring Traffic Server to Ignore Client no-cache Headers</a>. </p>
 </li>
 <li>
 <p><code>Cookie</code>: header (for text objects) </p>
@@ -410,24 +464,23 @@ to not cache cookied content of any type
 cookied content that is of image type only. For more information,
 refer to <a href="#CachingCookiedObjects">Caching Cookied Objects</a>.</p>
 </li>
-<li>
-<p><code>Authorization</code>: header </p>
-</li>
 </ul>
-<h4 id="ConfiguringTSIgnoreClientnocacheHeaders">Configuring Traffic Server to Ignore Client no-cache Headers</h4>
+<h3 id="ConfiguringTSIgnoreClientnocacheHeaders">Configuring Traffic Server to Ignore Client no-cache Headers</h3>
 <p>By default, Traffic Server strictly observes client <code>Cache-Control: no-cache</code> 
 directives. If a requested object contains a <code>no-cache</code> header, then Traffic 
 Server forwards the request to the origin server even if it has a fresh copy 
 in cache. You can configure Traffic Server to ignore client <code>no-cache</code> directives 
 such that it ignores <code>no-cache</code> headers from client requests and serves the 
 object from its cache. </p>
-<h5 id="configureTSignoreclientnocacheheaders">To configure Traffic Server to ignore client <code>no-cache</code> headers:</h5>
+<p>To configure Traffic Server to ignore client <code>no-cache</code> headers</p>
 <ol>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.cache.ignore_client_no_cache"><em><code>proxy.config.cache.ignore_client_no_cache</code></em></a></li>
+<li>Edit the following variable in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.cache.ignore_client_no_cache"><em><code>proxy.config.cache.ignore_client_no_cache</code></em></a></li>
+</ul>
+</li>
 <li>Run the command <code>traffic_line -x</code> to apply the configuration changes. </li>
 </ol>
-<h3 id="OriginServerDirectives">Origin Server Directives</h3>
+<h2 id="OriginServerDirectives">Origin Server Directives</h2>
 <p>By default, Traffic Server does <em>not</em> cache objects with the following <strong>response</strong> 
 <strong>headers</strong>: </p>
 <ul>
@@ -450,20 +503,22 @@ object from its cache. </p>
 <p><code>Expires</code>: header with value of 0 (zero) or a past date </p>
 </li>
 </ul>
-<h4 id="ConfiguringTSIgnoreServernocacheHeaders">Configuring Traffic Server to Ignore Server <strong>no-cache</strong> Headers</h4>
-<p>By default, Traffic Server strictly observes <code>Cache-Control:no-cache</code> directives. 
+<h3 id="ConfiguringTSIgnoreServernocacheHeaders">Configuring Traffic Server to Ignore Server no-cache Headers</h3>
+<p>By default, Traffic Server strictly observes <code>Cache-Control: no-cache</code> directives. 
 A response from an origin server with a <code>no-cache</code> header is not stored in 
 the cache and any previous copy of the object in the cache is removed. If you 
 configure Traffic Server to ignore <code>no-cache</code> headers, then Traffic Server 
-also ignores <code>no-store</code> headers. The default behavior of observing <code>no-cache</code> 
+also ignores <code>no-</code><strong><code>store</code></strong> headers. The default behavior of observing <code>no-cache</code> 
 directives is appropriate in most cases. </p>
-<h5 id="to_configure_traffic_server_to_ignore_server_no-cache_headers___configuretsignoreserverno-cacheheaders">To configure Traffic Server to ignore server <code>no-cache</code> headers:  ##### {#configureTSignoreserver<code>no-cache</code>headers}</h5>
+<p>To configure Traffic Server to ignore server <code>no-cache</code> headers</p>
 <ol>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.cache.ignore_server_no_cache"><em><code>proxy.config.cache.ignore_server_no_cache</code></em></a></li>
+<li>Edit the following variable in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.cache.ignore_server_no_cache"><em><code>proxy.config.cache.ignore_server_no_cache</code></em></a></li>
+</ul>
+</li>
 <li>Run the command <code>traffic_line -x</code> to apply the configuration changes. </li>
 </ol>
-<h4 id="ConfiguringTSIgnoreWWWAuthenticateHeaders">Configuring Traffic Server to Ignore WWW-Authenticate Headers</h4>
+<h3 id="ConfiguringTSIgnoreWWWAuthenticateHeaders">Configuring Traffic Server to Ignore WWW-Authenticate Headers</h3>
 <p>By default, Traffic Server does not cache objects that contain <code>WWW-Authenticate</code> 
 response headers. The <code>WWW-Authenticate</code> header contains authentication parameters 
 the client uses when preparing the authentication challenge response to an 
@@ -474,13 +529,15 @@ for future requests. However, the defaul
 <code>WWW-Authenticate</code> headers is appropriate in most cases. Only configure Traffic 
 Server to ignore server <code>WWW-Authenticate</code> headers if you are knowledgeable 
 about HTTP 1.1.</p>
-<h5 id="configureTSignoreserverWWWAuthenticateheaders">To configure Traffic Server to ignore server <code>WWW-Authenticate</code> headers:</h5>
+<p>To configure Traffic Server to ignore server <code>WWW-Authenticate</code> headers</p>
 <ol>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.cache.ignore_authentication"><em><code>proxy.config.cache.ignore_authentication</code></em></a></li>
+<li>Edit the following variable in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.cache.ignore_authentication"><em><code>proxy.config.cache.ignore_authentication</code></em></a></li>
+</ul>
+</li>
 <li>Run the command <code>traffic_line -x</code> to apply the configuration changes. </li>
 </ol>
-<h3 id="ConfigurationDirectives">Configuration Directives</h3>
+<h2 id="ConfigurationDirectives">Configuration Directives</h2>
 <p>In addition to client and origin server directives, Traffic Server responds to directives
 you specify through configuration options and files.</p>
 <p>You can configure Traffic Server to do the following: </p>
@@ -489,58 +546,67 @@ you specify through configuration option
 <li>Cache <strong>dynamic content</strong> - that is, objects with URLs that end in <strong><code>.asp</code></strong> or contain a question mark (<strong><code>?</code></strong>),
   semicolon (<strong><code>;</code></strong>), or <strong><code>cgi</code></strong>. For more information, refer to <a href="#CachingDynamicContent">Caching Dynamic Content</a>. </li>
 <li>Cache objects served in response to the <code>Cookie:</code> header (refer to <a href="#CachingCookiedObjects">Caching Cookied Objects)</a>. </li>
-<li>Observe never-cache rules in the <code>cache.config</code> file (refer to <a href="../configuration-files/records.config"><code>records.config</code></a>).</li>
+<li>Observe <code>never-cache</code> rules in the <a href="../configuration-files/cache.config"><code>cache.config</code></a> file.</li>
 </ul>
-<h4 id="DisablingHTTPObjectCaching">Disabling HTTP Object Caching</h4>
+<h3 id="DisablingHTTPObjectCaching">Disabling HTTP Object Caching</h3>
 <p>By default, Traffic Server caches all HTTP objects except those for which you 
-have set never-cache rules in the <code>cache.config</code> file. You can disable HTTP 
+have set <a href="../configuration-files/cache.config#action"><code>never-cache</code></a> rules in the
+<a href="../configuration-files/cache.config"><code>cache.config</code></a> file. You can disable HTTP 
 object caching so that all HTTP objects are served directly from the origin 
 server and never cached, as detailed below.</p>
-<h5 id="disableHTTPobjectcachingmanually">To disable HTTP object caching manually:</h5>
+<p>To disable HTTP object caching manually</p>
 <ol>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.cache.http"><em><code>proxy.config.cache.http</code></em></a></li>
+<li>Edit the following variable in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.cache.http"><em><code>proxy.config.cache.http</code></em></a></li>
+</ul>
+</li>
 <li>Run the command <code>traffic_line -x</code> to apply the configuration changes.</li>
 </ol>
-<h4 id="CachingDynamicContent">Caching Dynamic Content</h4>
+<h3 id="CachingDynamicContent">Caching Dynamic Content</h3>
 <p>A URL is considered <strong>dynamic</strong> if it ends in <strong><code>.asp</code></strong> or contains a question 
 mark (<strong><code>?</code></strong>), a semicolon (<strong><code>;</code></strong>), or <strong><code>cgi</code></strong>. By default, Traffic Server 
-does <em>not</em> cache dynamic content. You can configure Traffic Server to cache 
-dynamic content, although it's recommended for specialized proxy situations only.</p>
-<h5 id="configureTScachedynamiccontent">To configure Traffic Server to cache dynamic content:</h5>
+caches dynamic content. You can configure the system to ignore dyanamic looking
+content, although this is recommended only if the content is <em>truely</em> dyanamic,
+but fails to advertise so with appropriate <code>Cache-Control</code> headers.</p>
+<p>To configure Traffic Server's cache behaviour in regard to dynamic content</p>
 <ol>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.cache_urls_that_look_dynamic"><em><code>proxy.config.cache_urls_that_look_dynamic</code></em></a></li>
+<li>Edit the following variable in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.http.cache.cache_urls_that_look_dynamic"><em><code>proxy.config.http.cache.cache_urls_that_look_dynamic</code></em></a></li>
+</ul>
+</li>
 <li>Run the command <code>traffic_line -x</code> to apply the configuration changes.</li>
 </ol>
-<h4 id="CachingCookiedObjects">Caching Cookied Objects</h4>
+<h3 id="CachingCookiedObjects">Caching Cookied Objects</h3>
+<!-- XXX This should be extended to xml as well! -->
+
 <p>By default, Traffic Server caches objects served in response to requests that 
-contain cookies (unless the object is text). Traffic Server does not cache 
-cookied text content because object headers are stored along with the object, 
-and personalized cookie header values could be saved with the object. With 
-non-text objects, it is unlikely that personalized headers are delivered or 
-used. </p>
+contain cookies. This is true for all types of objects except for text.
+Traffic Server does not cache cookied text content because object headers are
+stored along with the object, and personalized cookie header values could be
+saved with the object. With non-text objects, it is unlikely that personalized
+headers are delivered or used. </p>
 <p>You can reconfigure Traffic Server to: </p>
 <ul>
 <li><em>Not</em> cache cookied content of any type. </li>
 <li>Cache cookied content that is of image type only. </li>
 <li>Cache all cookied content regardless of type.</li>
 </ul>
-<h5 id="configurehowTScachescookiedcontent">To configure how Traffic Server caches cookied content:</h5>
+<p>To configure how Traffic Server caches cookied content</p>
 <ol>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>edit <a href="../configuration-files/records.config#proxy.config.cache_responses_to_cookies"><em><code>proxy.config.cache_responses_to_cookies</code></em></a></li>
+<li>Edit the following variable in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.cache_responses_to_cookies"><em><code>proxy.config.cache_responses_to_cookies</code></em></a></li>
+</ul>
+</li>
 <li>Run the command <code>traffic_line -x</code> to apply the configuration changes. </li>
 </ol>
-<h2 id="ForcingObjectCaching">Forcing Object Caching</h2>
+<h1 id="ForcingObjectCaching">Forcing Object Caching</h1>
 <p>You can force Traffic Server to cache specific URLs (including dynamic URLs) 
 for a specified duration, regardless of <code>Cache-Control</code> response headers. </p>
-<h5 id="forcedocumentcaching">To force document caching:</h5>
+<p>To force document caching</p>
 <ol>
-<li>In <a href="../configuration-files/cache.config"><code>cache.config</code></a></li>
 <li>
-<p>Add a rule in the file for each URL you want Traffic Server to pin in the cache, as shown below.</p>
-<div class="codehilite"><pre><span class="n">url_regex</span><span class="o">=</span><span class="n">URL</span> <span class="n">ttl</span><span class="o">-</span><span class="n">in</span><span class="o">-</span><span class="n">cache</span><span class="o">=</span><span class="mi">6</span><span class="n">h</span>
+<p>Add a rule for each URL you want Traffic Server to pin to the cache <a href="../configuration-files/cache.config"><code>cache.config</code></a>:</p>
+<div class="codehilite"><pre>url_regex=^https?://(www.)?apache.org/dev/ ttl-in-cache=6h
 </pre></div>
 
 
@@ -549,76 +615,61 @@ for a specified duration, regardless of 
 <p>Run the command <code>traffic_line -x</code> to apply the configuration changes. </p>
 </li>
 </ol>
-<h2 id="CachingHTTPAlternates">Caching HTTP Alternates</h2>
+<h1 id="CachingHTTPAlternates">Caching HTTP Alternates</h1>
 <p>Some origin servers answer requests to the same URL with a variety of objects. 
 The content of these objects can vary widely, according to whether a server 
 delivers content for different languages, targets different browsers with different 
-presentation styles, or provides different document formats (HTML, PDF). Different 
+presentation styles, or provides different document formats (HTML, XML). Different 
 versions of the same object are termed <strong>alternates</strong> and are cached by Traffic 
 Server based on <code>Vary</code> response headers. You can specify additional request 
-and response headers for specific content types that Traffic Server will identify 
+and response headers for specific <code>Content-Type</code>s that Traffic Server will identify 
 as alternates for caching. You can also limit the number of alternate versions 
 of an object allowed in the cache. </p>
-<h3 id="ConfiguringHowTSCachesAlternates">Configuring How Traffic Server Caches Alternates</h3>
-<h5 id="configurehowTScachesalternates">To configure how Traffic Server caches alternates, follow the steps below:</h5>
+<h2 id="ConfiguringHowTSCachesAlternates">Configuring How Traffic Server Caches Alternates</h2>
+<p>To configure how Traffic Server caches alternates, follow the steps below</p>
 <ol>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>set <a href="../configuration-files/records.config#proxy.config.cache.enable_default_vary_headers"><em><code>proxy.config.cache.enable_default_vary_headers</code></em></a> to <code>1</code>
-   to cache alternate versions of HTTP objects that do not contain the Vary header.</li>
-<li>set <a href="../configuration-files/records.config#proxy.config.cache.vary_default_text"><em><code>proxy.config.cache.vary_default_text</code></em></a> to to specify the HTTP
-   header field on which you want to vary if the request is for text: for example, an HTML document.</li>
-<li>set <a href="../configuration-files/records.config#proxy.config.cache.vary_default_images"><em><code>proxy.config.cache.vary_default_images</code></em></a> to to specify the HTTP
-   header field on which you want to vary if the request is for images: for example, a <code>.gif</code> file.</li>
-<li>
-<p>set <a href="../configuration-files/records.config#proxy.config.cache.vary_default_other"><em><code>proxy.config.cache.vary_default_other</code></em></a> to to specify the HTTP
-   header field on which you want to vary  if the request is for anything other than text or image.</p>
-</li>
-<li>
-<p><strong>Note:</strong> If you specify <code>Cookie</code> as the header field on which to vary in the above variables,
-   then make sure that the variable <a href="../configuration-files/records.config#proxy.config.cache.cache_responses_to_cookies"><em><code>proxy.config.cache.cache_responses_to_cookies</code></em></a> is set appropriately.</p>
-<p>For example, if you set <a href="../configuration-files/records.config#proxy.config.cache.cache_responses_to_cookies"><em><code>proxy.config.cache.cache_responses_to_cookies</code></em></a> to
-2 (cache responses to cookies of image type only) and set the <a href="../configuration-files/records.config#proxy.config.cache.vary_default_text"><em><code>proxy.config.cache.vary_default_text</code></em></a>
-variable to specify cookie, then alternates by cookie will not apply to text. </p>
-</li>
-<li>
-<p>Run the command <code>traffic_line -x</code> to apply the configuration changes. </p>
+<li>Edit the following variables in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.http.cache.enable_default_vary_headers"><em><code>proxy.config.http.cache.enable_default_vary_headers</code></em></a></li>
+<li><a href="../configuration-files/records.config#proxy.config.http.cache.vary_default_text"><em><code>proxy.config.http.cache.vary_default_text</code></em></a></li>
+<li><a href="../configuration-files/records.config#proxy.config.cache.vary_default_images"><em><code>proxy.config.http.cache.vary_default_images</code></em></a></li>
+<li><a href="../configuration-files/records.config#proxy.config.http.cache.vary_default_other"><em><code>proxy.config.http.cache.vary_default_other</code></em></a></li>
+</ul>
 </li>
+<li>Run the command <code>traffic_line -x</code> to apply the configuration changes. </li>
 </ol>
-<h3 id="LimitingNumberofAlternatesforanObject">Limiting the Number of Alternates for an Object</h3>
+<p><strong>Note:</strong> If you specify <code>Cookie</code> as the header field on which to vary in the above variables,
+make sure that the variable <a href="../configuration-files/records.config#proxy.config.cache.cache_responses_to_cookies"><em><code>proxy.config.cache.cache_responses_to_cookies</code></em></a> is set appropriately.</p>
+<h2 id="LimitingNumberofAlternatesforanObject">Limiting the Number of Alternates for an Object</h2>
 <p>You can limit the number of alternates Traffic Server can cache per object 
 (the default is 3). </p>
 <p><strong>IMPORTANT:</strong> Large numbers of alternates can affect Traffic Server cache 
 performance because all alternates have the same URL. Although Traffic Server 
 can look up the URL in the index very quickly, it must scan sequentially through 
 available alternates in the object store.</p>
-<h5 id="limitnumberofalternates">To limit the number of alternates:</h5>
+<p>To limit the number of alternates</p>
 <ol>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>set <a href="../configuration-files/records.config#proxy.config.cache.limits.http.max_alts"><em><code>proxy.config.cache.limits.http.max_alts</code></em></a>
-   to specify the maximum number of alternate versions of an object you want Traffic Server to cache.</li>
+<li>Edit the following variable in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.cache.limits.http.max_alts"><em><code>proxy.config.cache.limits.http.max_alts</code></em></a></li>
+</ul>
+</li>
 <li>Run the command <code>traffic_line -x</code> to apply the configuration changes. </li>
 </ol>
-<h2 id="UsingCongestionControl">Using Congestion Control</h2>
+<h1 id="UsingCongestionControl">Using Congestion Control</h1>
 <p>The <strong>Congestion Control</strong> option enables you to configure Traffic Server to 
 stop forwarding HTTP requests to origin servers when they become congested. 
 Traffic Server then sends the client a message to retry the congested origin 
 server later. </p>
 <p>To use the <strong>Congestion Control</strong> option, you must perform the following tasks: </p>
-<ul>
-<li>Enable the Congestion Control option. </li>
-<li>Create rules in the <code>congestion.config</code> file to specify: </li>
-<li>which origin servers Traffic Server tracks for congestion
-   the timeouts Traffic Server uses, depending on whether a server is congested 
-   the page Traffic Server sends to the client when a server becomes congested 
-   if Traffic Server tracks the origin servers per IP address or per hostname </li>
-</ul>
-<h5 id="enableconfigureCongestionControloption">To enable and configure the Congestion Control option:</h5>
-<ol>
-<li>In <a href="../configuration-files/records.config"><code>records.config</code></a></li>
-<li>set <a href="../configuration-files/records.config#proxy.config.http.congestion_control.enabled"><em><code>proxy.config.http.congestion_control.enabled</code></em></a>
-   to 1 to enable the congestion control option.</li>
-<li>In <a href="../configuration-files/congestion.config"><code>congestion.config</code></a></li>
-<li>Enter rules to specify which origin servers are tracked for congestion and the timeout values Traffic Server uses to determine congestion.</li>
+<ol>
+<li>Set the following variable in <a href="../configuration-files/records.config"><code>records.config</code></a><ul>
+<li><a href="../configuration-files/records.config#proxy.config.http.congestion_control.enabled"><em><code>proxy.config.http.congestion_control.enabled</code></em></a> to <code>1</code></li>
+</ul>
+</li>
+<li>Create rules in the <a href="../configuration-files/congestion.config"><code>congestion.config</code></a> file to specify: </li>
+<li>which origin servers Traffic Server tracks for congestion</li>
+<li>the timeouts Traffic Server uses, depending on whether a server is congested </li>
+<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>
 <li>Run the command <code>traffic_line -x</code> to apply the configuration changes. </li>
 </ol>
     </div>

Modified: websites/staging/trafficserver/trunk/content/docs/trunk/admin/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/admin/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/admin/index.en.html Wed May 18 20:55:25 2011
@@ -8,7 +8,7 @@
     <link rel="stylesheet" href="/styles/ts.css" />
     
     
-    <title>Administrators&#39;s Guide</title>
+    <title>Administrators&#39;s Guide - Overview</title>
     <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file to you under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License.  You may obtain a copy of the License at . http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and limitations under the License. -->
   </head>
 
@@ -20,7 +20,7 @@
         
           <span class="doc-title">Apache Traffic Server</span><br />
         
-        <span class="title">Administrators&#39;s Guide</span>
+        <span class="title">Administrators&#39;s Guide - Overview</span>
       </td>
       </tr></table>
     </div><!-- header -->
@@ -37,18 +37,37 @@
   <div class="main">
     
     <div id="content">
-      <h1 id="overview">Overview</h1>
+      <!-- TODO: Remove all references of different protocols here, since we only support one.
+           https is just a different scheme:// of the same protocol: HTTP -->
+
+<h1 id="overview">Overview</h1>
 <p>Apache Traffic Server™ speeds Internet access, enhances website
 performance, and delivers unprecedented web hosting capabilities.</p>
 <p>This chapter discusses the following topics:</p>
+<div class="toc">
 <ul>
+<li><a href="#overview">Overview</a></li>
 <li><a href="#what-is-ats">What Is Apache Traffic Server?</a></li>
-<li><a href="#deployment-options">Traffic Server Deployment Options</a></li>
-<li><a href="#ats-components">Traffic Server Components</a></li>
+<li><a href="#deployment-options">Traffic Server Deployment Options</a><ul>
+<li><a href="#web-proxy-cache">Traffic Server as a Web Proxy Cache</a></li>
+<li><a href="#reverse-proxy">Traffic Server as a Reverse Proxy</a></li>
+<li><a href="#cache-hierachy">Traffic Server in a Cache Hierarchy</a></li>
+</ul>
+</li>
+<li><a href="#ats-components">Traffic Server Components</a><ul>
+<li><a href="#ats-server-cache">The Traffic Server Cache</a></li>
+<li><a href="#ram-cache">The RAM Cache</a></li>
+<li><a href="#host-db">The Host Database</a></li>
+<li><a href="#dns-resolver">The DNS Resolver</a></li>
+<li><a href="#traffic-server-processes">Traffic Server Processes</a></li>
+<li><a href="#admin-tools">Administration Tools</a></li>
+</ul>
+</li>
 <li><a href="#traffic-analysis">Traffic Analysis Options</a></li>
 <li><a href="#security">Traffic Server Security Options</a></li>
 </ul>
-<h2 id="what-is-ats">What Is Apache Traffic Server?</h2>
+</div>
+<h1 id="what-is-ats">What Is Apache Traffic Server?</h1>
 <p>Global data networking has become part of everyday life: internet users
 request billions of documents and terabytes of data, on a daily basis,
 to and from all parts of the world. Information is free, abundant, and
@@ -63,7 +82,7 @@ closer to end users, while enabling fast
 bandwidth use. Traffic Server is designed to improve content delivery
 for enterprises, Internet service providers (ISPs), backbone providers,
 and large intranets by maximizing existing and available bandwidth.</p>
-<h2 id="deployment-options">Traffic Server Deployment Options</h2>
+<h1 id="deployment-options">Traffic Server Deployment Options</h1>
 <p>To best suit your needs, Traffic Server can be deployed in several ways:</p>
 <ul>
 <li>As a web proxy cache</li>
@@ -71,8 +90,9 @@ and large intranets by maximizing existi
 <li>In a cache hierarchy</li>
 </ul>
 <p>The following sections provide a summary of these Traffic Server
-deployment options.</p>
-<h3 id="web-proxy-cache">Traffic Server as a Web Proxy Cache</h3>
+deployment options. Please keep in mind that with every of these options
+Traffic Server can be run as a <em>single instance</em>, or as a <em>multi-node cluster</em>.</p>
+<h2 id="web-proxy-cache">Traffic Server as a Web Proxy Cache</h2>
 <p>As a web proxy cache, Traffic Server receives user requests for web
 content as those requests travel to the destined web server (origin
 server). If Traffic Server contains the requested content, then it
@@ -83,15 +103,15 @@ satisfy future requests.</p>
 <p>Traffic Server provides explicit proxy caching, in which the user’s
 client software must be configured to send requests directly to Traffic
 Server. Explicit proxy caching is described in the
-<a href="explicit-proxy-caching">Explicit Proxy Caching</a> section.</p>
-<h3 id="reverse-proxy">Traffic Server as a Reverse Proxy</h3>
+<a href="explicit-proxy-caching">Explicit Proxy Caching</a> chapter.</p>
+<h2 id="reverse-proxy">Traffic Server as a Reverse Proxy</h2>
 <p>As a reverse proxy, Traffic Server is configured to be the origin
 server to which the user is trying to connect (typically, the origin
 server’s advertised hostname resolves to Traffic Server, which acts as
 the real origin server). The reverse proxy feature is also called
 server acceleration. Reverse proxy is described in more detail in
 <a href="reverse-proxy-http-redirects">Reverse Proxy and HTTP Redirects</a>.</p>
-<h3 id="cache-hierachy">Traffic Server in a Cache Hierarchy</h3>
+<h2 id="cache-hierachy">Traffic Server in a Cache Hierarchy</h2>
 <p>Traffic Server can participate in flexible cache hierarchies, in which
 Internet requests not fulfilled from one cache are routed to other
 regional caches, thereby leveraging the contents and proximity of
@@ -101,11 +121,11 @@ to similar caching products.</p>
 <p>Traffic Server supports ICP (Internet Cache Protocol) peering.
 Hierarchical caching is described in more detail in
 <a href="hierachical-caching">Hierarchical Caching</a>.</p>
-<h2 id="ats-components">Traffic Server Components</h2>
+<h1 id="ats-components">Traffic Server Components</h1>
 <p>Traffic Server consists of several components that work together to
 form a web proxy cache you can easily monitor and configure. These main
 components are described below.</p>
-<h3 id="ats-server-cache">The Traffic Server Cache</h3>
+<h2 id="ats-server-cache">The Traffic Server Cache</h2>
 <p>The Traffic Server cache consists of a high-speed object database
 called the object store. The object store indexes objects according to
 URLs and associated headers. Using sophisticated object management, the
@@ -122,14 +142,14 @@ proxy-only mode. You can partition the c
 amount of disk space for storing data for specific protocols and origin
 servers. For more information about the cache, see
 <a href="configuring-cache">Configuring the Cache</a>.</p>
-<h3 id="ram-cache">The RAM Cache</h3>
+<h2 id="ram-cache">The RAM Cache</h2>
 <p>Traffic Server maintains a small RAM cache that contains extremely
 popular objects. This RAM cache serves the most popular objects as fast
 as possible and reduces load on disks, especially during temporary
 traffic peaks. You can configure the RAM cache size to suit your needs;
 for detailed information, refer to
 <a href="configuring-cache#ChangingSizeRAMCache">Changing the Size of the RAM Cache</a>.</p>
-<h3 id="host-db">The Host Database</h3>
+<h2 id="host-db">The Host Database</h2>
 <p>The Traffic Server host database stores the domain name server (DNS)
 entries of origin servers to which Traffic Server connects to fulfill
 user requests. This information is used to adapt future protocol
@@ -142,47 +162,53 @@ the host database tracks:</p>
 <li>Host reliability and availability information (so users will not
   wait for servers that are not running)</li>
 </ul>
-<h3 id="dns-resolver">The DNS Resolver</h3>
+<h2 id="dns-resolver">The DNS Resolver</h2>
 <p>Traffic Server includes a fast, asynchronous DNS resolver to streamline
 conversion of hostnames to IP addresses. Traffic Server implements the
 DNS resolver natively by directly issuing DNS command packets rather
 than relying on slower, conventional resolver libraries. Since many DNS
 queries can be issued in parallel and a fast DNS cache maintains
 popular bindings in memory, DNS traffic is reduced.</p>
-<h3 id="traffic-server-processes">Traffic Server Processes</h3>
+<h2 id="traffic-server-processes">Traffic Server Processes</h2>
 <p>Traffic Server contains three processes that work together to serve
-Traffic Server requests and manage/control/monitor the health of the
-Traffic Server system. The three processes are described below:</p>
+requests and manage/control/monitor the health of the system.
+The three processes are described below:</p>
 <ul>
-<li>The traffic_server process is the transaction processing engine of
+<li>
+<p>The <code>traffic_server</code> process is the transaction processing engine of
   Traffic Server. It is responsible for accepting connections,
   processing protocol requests, and serving documents from the cache
-  or origin server.</li>
-<li>The traffic_manager process is the command and control facility of
+  or origin server.</p>
+</li>
+<li>
+<p>The <code>traffic_manager</code> process is the command and control facility of
   the Traffic Server, responsible for launching, monitoring, and
-  reconfiguring the traffic_server process. The traffic_manager
+  reconfiguring the <code>traffic_server</code> process. The <code>traffic_manager</code>
   process is also responsible for the proxy autoconfiguration port,
   the statistics interface, cluster administration, and virtual IP
-  failover.
-  If the traffic_manager process detects a traffic_server process
+  failover.</p>
+<p>If the <code>traffic_manager</code> process detects a <code>traffic_server</code> process
   failure, it instantly restarts the process but also maintains a
   connection queue of all incoming requests. All incoming connections
   that arrive in the several seconds before full server restart are
   saved in the connection queue and processed in first-come,
   first-served order. This connection queueing shields users from any
-  server restart downtime.</li>
-<li>The traffic_cop process monitors the health of both the
-  traffic_server and traffic_manager processes. The traffic_cop
+  server restart downtime.</p>
+</li>
+<li>
+<p>The <code>traffic_cop</code> process monitors the health of both the
+  <code>traffic_server</code> and <code>traffic_manager</code> processes. The <code>traffic_cop</code>
   process periodically (several times each minute) queries the
-  traffic_server and traffic_manager process by issuing heartbeat
+  <code>traffic_server</code> and <code>traffic_manager</code> process by issuing heartbeat
   requests to fetch synthetic web pages. In the event of failure (if
   no response is received within a timeout interval or if an
-  incorrect response is received), traffic_cop restarts the
-  traffic_manager and traffic_server processes.</li>
+  incorrect response is received), <code>traffic_cop</code> restarts the
+  <code>traffic_manager</code> and <code>traffic_server</code> processes.</p>
+</li>
 </ul>
 <p>The figure below illustrates the three Traffic Server processes.</p>
 <p><img alt="Illustration of the three Traffic Server Processes" src="/images/admin/process.jpg" /></p>
-<h3 id="admin-tools">Administration Tools</h3>
+<h2 id="admin-tools">Administration Tools</h2>
 <p>Traffic Server offers the following administration options:</p>
 <ul>
 <li>The Traffic Line command-line interface is a text-based interface
@@ -197,33 +223,40 @@ Traffic Server system. The three process
   through a simple file-editing and signal-handling interface. Any
   changes you make through Traffic Line or Traffic Shell are
   automatically made to the configuration files as well.</li>
+<li>Finally there is a clean C API which can be put to good use from
+  a multitude of languages. The Traffic Server Admin Client 
+  demonstrates this for Perl.</li>
 </ul>
-<h2 id="traffic-analysis">Traffic Analysis Options</h2>
+<h1 id="traffic-analysis">Traffic Analysis Options</h1>
 <p>Traffic Server provides several options for network traffic analysis
 and monitoring:</p>
 <ul>
-<li>Traffic Line and Traffic Shell enable you to collect and process
-  statistics obtained from network traffic information.</li>
-<li>Transaction logging enables you to record information (in a log
+<li>
+<p>Traffic Line and Traffic Shell enable you to collect and process
+  statistics obtained from network traffic information.</p>
+</li>
+<li>
+<p>Transaction logging enables you to record information (in a log
   file) about every request Traffic Server receives and every error
   it detects. By analyzing the log files, you can determine how many
-  people used the Traffic Server cache, how much information each
-  person requested, and what pages were most popular. You can also
+  clients used the Traffic Server cache, how much information each
+  of them requested, and what pages were most popular. You can also
   see why a particular transaction was in error and what state the
   Traffic Server was in at a particular time; for example, you can
   see that Traffic Server was restarted or that cluster communication
-  timed out.
-  Traffic Server supports several standard log file formats, such as
+  timed out.</p>
+<p>Traffic Server supports several standard log file formats, such as
   Squid and Netscape, and its own custom format. You can analyze the
   standard format log files with off-the-shelf analysis packages. To
   help with log file analysis, you can separate log files so that
-  they contain information specific to protocol or hosts.</li>
+  they contain information specific to protocol or hosts.</p>
+</li>
 </ul>
 <p>Traffic analysis options are described in more detail in
-<a href="monitoring-traffic">Monitoring Traffic</a>;
-Traffic Server logging options are described in
+<a href="monitoring-traffic">Monitoring Traffic</a>.</p>
+<p>Traffic Server logging options are described in
 <a href="working-log-files">Working with Log Files</a>.</p>
-<h2 id="security">Traffic Server Security Options</h2>
+<h1 id="security">Traffic Server Security Options</h1>
 <p>Traffic Server provides numerous options that enable you to establish
 secure communication between the Traffic Server system and other
 computers on the network. Using the security options, you can do the
@@ -231,7 +264,7 @@ following:</p>
 <ul>
 <li>Control client access to the Traffic Server proxy cache.</li>
 <li>Configure Traffic Server to use multiple DNS servers to match your
-  site’s security configuration. For example, Traffic Server can use
+  site's security configuration. For example, Traffic Server can use
   different DNS servers, depending on whether it needs to resolve
   hostnames located inside or outside a firewall. This enables you to
   keep your internal network configuration secure while continuing to



Mime
View raw message