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 [1/8] - /incubator/trafficserver/site/trunk/docs/admin/
Author: mlibbey
Date: Mon Mar 1 19:53:47 2010
New Revision: 917681
URL: http://svn.apache.org/viewvc?rev=917681&view=rev
Log:
reverting revision 917621 back to revision 896690
Removed:
incubator/trafficserver/site/trunk/docs/admin/bottom.html
incubator/trafficserver/site/trunk/docs/admin/template.html
Modified:
incubator/trafficserver/site/trunk/docs/admin/Glossary.htm
incubator/trafficserver/site/trunk/docs/admin/cache.htm
incubator/trafficserver/site/trunk/docs/admin/cli.htm
incubator/trafficserver/site/trunk/docs/admin/configure.htm
incubator/trafficserver/site/trunk/docs/admin/doc.css (contents, props changed)
incubator/trafficserver/site/trunk/docs/admin/errors.htm
incubator/trafficserver/site/trunk/docs/admin/explicit.htm
incubator/trafficserver/site/trunk/docs/admin/files.htm
incubator/trafficserver/site/trunk/docs/admin/getstart.htm
incubator/trafficserver/site/trunk/docs/admin/hier.htm
incubator/trafficserver/site/trunk/docs/admin/http.htm
incubator/trafficserver/site/trunk/docs/admin/intro.htm
incubator/trafficserver/site/trunk/docs/admin/leftnav.html (contents, props changed)
incubator/trafficserver/site/trunk/docs/admin/log.htm
incubator/trafficserver/site/trunk/docs/admin/logfmts.htm
incubator/trafficserver/site/trunk/docs/admin/monitor.htm
incubator/trafficserver/site/trunk/docs/admin/preface.htm
incubator/trafficserver/site/trunk/docs/admin/reverse.htm
incubator/trafficserver/site/trunk/docs/admin/secure.htm
incubator/trafficserver/site/trunk/docs/admin/top.html (contents, props changed)
incubator/trafficserver/site/trunk/docs/admin/trouble.htm
Modified: incubator/trafficserver/site/trunk/docs/admin/Glossary.htm
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/admin/Glossary.htm?rev=917681&r1=917680&r2=917681&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/admin/Glossary.htm (original)
+++ incubator/trafficserver/site/trunk/docs/admin/Glossary.htm Mon Mar 1 19:53:47 2010
@@ -1,10 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
-<title>Traffic Server Administrator's Guide Glossary</title>
-
-<!--#include file="top.html" -->
-
+<title>Glossary</title>
+<style type="text/css">
+<!--
+body {
+ font-family: Verdana, Geneva, sans-serif;
+}
+-->
+</style>
+<meta content="text/html; charset=UTF-8" http-equiv="content-type"/>
+<link rel="stylesheet" href="doc.css" type="text/css" media="all" /></head>
+ <body>
<h1>
<a name="561">Glossary</a> </h1>
<dl>
@@ -226,5 +232,5 @@
</dt>
<dd>Web Proxy Auto-Discovery. A protocol that allows clients to automatically locate a web proxy, providing the benefits of a proxy without the need for explicit client configuration. </dd>
</dl>
-
-<!--#include file="bottom.html" -->
\ No newline at end of file
+</body>
+</html>
\ No newline at end of file
Modified: incubator/trafficserver/site/trunk/docs/admin/cache.htm
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/admin/cache.htm?rev=917681&r1=917680&r2=917681&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/admin/cache.htm (original)
+++ incubator/trafficserver/site/trunk/docs/admin/cache.htm Mon Mar 1 19:53:47 2010
@@ -1,187 +1,175 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
-<html>
-<head>
-<title>Traffic Edge Administrator's Guide</title>
-
-<!--#include file="top.html" -->
-
-<h1>Configuring the Cache</h1>
-<p>The Traffic Server cache consists of a high-speed object database called the <b>object store </b>that indexes objects according to URLs and their associated headers.</p>
-<p>This chapter discusses the following topics: </p>
-<ul>
-<li><a href="#TrafficEdgeCache">The Traffic Server Cache</a></li>
-<li><a href="#RAMCache">The RAM Cache</a></li>
-<li><a href="#ChangingSizeRAMCache">Changing the Size of the RAM Cache</a></li>
-<li><a href="#ChangingCacheCapacity">Changing Cache Capacity</a></li>
-<li><a href="#PartitioningCache">Partitioning the Cache</a></li>
-<li><a href="#ConfiguringCacheObjectSizeLimit">Configuring the Cache Object Size Limit</a></li>
-<li><a href="#ClearingCache">Clearing the Cache</a></li>
-<li><a href="#RemoveObjectFromCache">Removing an Object From the Cache</a></li>
-<li><a href="#InspectingCache">Inspecting the Cache</a></li>
-</ul>
-<h2 id="TrafficEdgeCache">The Traffic Server Cache</h2>
-<p>The Traffic Server cache consists of a high-speed object database called the <b>object store</b>. The object store indexes objects according to URLs and associated headers. This enables Traffic Server to store, retrieve, and serve not only web pages, but also parts of web pages - which provides optimum bandwidth savings. Using sophisticated object management, the object store can cache alternate versions of the same object (versions may differ because of dissimilar language or encoding types). It can also efficiently store very small and very large documents, thereby minimizing wasted space. When the cache is full, Traffic Server removes stale data to ensure the most requested objects are kept readily available and fresh. </p>
-<p>Traffic Server is designed to tolerate total disk failures on any of the cache disks. If the disk fails completely, then Traffic Server marks the entire disk as corrupt and continues using the remaining disks. An alarm is then created to indicate which disk failed. If all of the cache disks fail, then Traffic Server goes into proxy-only mode. </p>
-<p>You can perform the following cache configuration tasks: </p>
-<ul>
- <li>Change the total amount of disk space allocated to the cache: refer to <a href="#ChangingCacheCapacity">Changing Cache Capacity</a>. </li>
- <li>Partition the cache by reserving cache disk space for specific protocols and origin servers/domains: refer to <a href="#PartitioningCache">Partitioning the Cache</a>. </li>
- <li>Delete all data in the cache: refer to <a href="#ClearingCache">Clearing the Cache</a>.</li>
-</ul>
-<h2 id="RAMCache">The RAM Cache</h2>
-<p>Traffic Server maintains a small RAM cache of extremely popular objects. This RAM cache serves the most popular objects as quickly as possible and reduces load on disks, especially during temporary traffic peaks. You can configure the RAM cache size to suit your needs, as described in <a href="#ChangingSizeRAMCache">Changing the Size of the RAM Cache</a> below. </p>
-<h2 id="ChangingSizeRAMCache">Changing the Size of the RAM Cache</h2>
-<p>Traffic Server provides a dedicated RAM cache for fast retrieval of popular small objects. The default RAM cache size is automatically calculated based on the number and size of the cache partitions you have configured. If you've partitioned your cache according to protocol and/or hosts, then the size of the RAM cache for each partition is proportional to the size of that partition. </p>
-<p>You can increase the RAM cache size for better cache hit performance. However, if you increase the size of the RAM cache and observe a decrease in performance (such as increased latencies), then it's possible that the operating system requires more memory for network resources. In such instances, you should return the RAM cache size to its previous value.</p>
-<h5>To change the RAM cache size: </h5>
-<ol>
- <li>Stop Traffic Server. </li>
- <li>In a text editor, open the <code>records.config</code> file located in the Traffic Server <code>config</code> directory. </li>
- <li>Edit the following variable:</li>
-
-
-<table width="1232" border="1">
- <tr>
- <th width="322" scope="col">Variable</th>
- <th width="894" scope="col">Description</th>
- </tr>
- <tr>
- <td><i><code>proxy.config.cache.ram_cache.size</code></i></td>
- <td>Set this variable to specify the size of the RAM cache.<br />
- The default value of -1 means that the RAM cache is automatically sized at approximately 1MB per gigabyte of disk.</td>
- </tr>
-</table>
-
-
- <li>Save and close the <code>records.config</code> file. </li>
- <li>Restart Traffic Server. If you increase the RAM cache to a size or 1GB or more, then restart with the <code>start_traffic_server</code> command (refer to <a href="getstart.htm#StartingTrafficEdge">Starting Traffic Server</a>). </li>
-</ol>
-<p> </p>
-<h2 id="ChangingCacheCapacity">Changing Cache Capacity</h2>
-<p>You can increase or reduce the total amount of disk space allocated to the cache without clearing the content. To check the size of the cache (in bytes), enter the command <code>traffic_line -r proxy.process.cache.bytes_total</code>. </p>
-<h3>Increasing Cache Capacity </h3>
-<p>To increase the total amount of disk space allocated to the cache on existing disks or to add new disks to a Traffic Server node, follow the steps below:</p>
-<ol>
- <li>Stop Traffic Server. </li>
- <li>Add hardware, if necessary. </li>
- <li>Edit the Traffic Server <code>storage.config</code> file: increase the amount of disk space allocated to the cache on existing disks or describe the new hardware you are adding (refer to <a href="files.htm#storage.config">storage.config</a>).</li>
- <li>If you add a new disk, then you must edit the <code>/etc/rc.d/init.d/traffic_server</code> file to add a raw disk binding. Instructions for adding a raw disk binding are located in the Traffic Server <code>storage.config</code> file. </li>
- <li>Restart Traffic Server. </li>
-</ol>
-<h3>Reducing Cache Capacity </h3>
-<p>To reduce the total amount of disk space allocated to the cache on an existing disk or to remove disks from a Traffic Server node, follow the steps below:</p>
-<ol>
- <li>Stop Traffic Server. </li>
- <li>Remove hardware, if necessary. </li>
- <li>Edit the Traffic Server <code>storage.config</code> file: reduce the amount of disk space allocated to the cache on existing disks or delete the reference to the hardware you're removing (refer to <a href="files.htm#storage.config">storage.config</a>). </li>
- <li>If you remove a disk, then you must edit the <code>/etc/rc.d/init.d/traffic_server</code> file to remove the raw disk binding for the disk. </li>
- <li>Restart Traffic Server. </li>
-</ol>
-<p><strong>IMPORTANT:</strong> In the <code>storage.config</code> file, a formatted or raw disk must be at least 128 MB. </p>
-<h2 id="PartitioningCache">Partitioning the Cache</h2>
-<p>You can manage your cache space more efficiently and restrict disk usage by creating cache partitions with different sizes for specific protocols. You can further configure these partitions to store data from specific origin servers and/or domains. The partition configuration must be the same on all nodes in a cluster. </p>
-<h3 id="CreatingCachePartitionsSpecificProtocols">Creating Cache Partitions for Specific Protocols</h3>
-<p>You can create separate partitions for your cache that vary in size to store content according to protocol. This ensures that a certain amount of disk space is always available for a particular protocol. Traffic Server currently supports the <b>http</b> partition type for HTTP objects.</p>
-<h5>To partition the cache according to protocol: </h5>
-<ol>
- <li>In a text editor, open the <code>partition.config</code> file located in the Traffic Server <code>config</code> directory. </li>
- <li>Enter a line in the file for each partition you want to create (refer to <a href="files.htm#partition.config">partition.config</a>). </li>
- <li>Save and close the <code>partition.config</code> file. </li>
- <li>Restart Traffic Server. </li>
-</ol>
-<h4>Making Changes to Partition Sizes and Protocols </h4>
-<p>After you've configured your cache partitions based on protocol, you can make changes to the configuration at any time. Before making changes, note the following: </p>
-<ul>
- <li>You must stop Traffic Server before you change the cache partition size and protocol assignment. </li>
- <li>When you increase the size of a partition, the contents of the partition are <em>not</em> deleted However, when you reduce the size of a partition, the contents of the partition <em>are</em> deleted. </li>
- <li>When you change the partition number, the partition is deleted and then recreated, even if the size and protocol type remain the same. </li>
- <li>When you add new disks to your Traffic Server node, partition sizes specified in percentages will increase proportionately. </li>
- <li>A lot of changes to partition sizes might result in disk fragmentation, which affects performance and hit rate. You should clear the cache before making many changes to cache partition sizes (refer to <a href="#ClearingCache">Clearing the Cache</a>).</li>
-</ul>
-<h3>Partitioning the Cache According to Origin Server or Domain</h3>
-<p>After you have partitioned the cache according to size and protocol, you can assign the partitions you created to specific origin servers and/or domains. You can assign a partition to a single origin server or to multiple origin servers. However, if a partition is assigned to multiple origin servers, then there is no guarantee on the space available in the partition for each origin server. Content is stored in the partition according to popularity. In addition to assigning partitions to specific origin servers and domains, you must assign a generic partition to store content from all origin servers and domains that are not listed. This generic partition is also used if the partitions for a particular origin server or domain become corrupt. If you do not assign a generic partition, then Traffic Server will run in proxy-only mode. </p>
-<p><strong>Note: </strong>You do <em>not</em> need to stop Traffic Server before you assign partitions to particular hosts or domains. However, this type of configuration is time-consuming and can cause a spike in memory usage. Therefore, it's best to configure partition assignment during periods of low traffic. </p>
-<h5>To partition the cache according to hostname and domain: </h5>
-<ol>
- <li>Configure the cache partitions according to size and protocol, as described in <a href="#CreatingCachePartitionsSpecificProtocols">Creating Cache Partitions for Specific Protocols</a>. </li>
- <li>Create a separate partition based on protocol for each host and domain, as well as an additional generic partition to use for content that does not belong to these origin servers or domains. The partitions do not need to be the same size. </li>
- <li>In a text editor, open the <code>hosting.config</code> file located in the Traffic Server <code>config</code> directory. </li>
- <li>Enter a line in the file to allocate the partition(s) used for each origin server and/or domain (refer to <a href="files.htm#hosting.config">hosting.config</a>). </li>
- <li>Assign a generic partition to use for content that does not belong to any of the origin servers or domains listed in the file. If all partitions for a particular origin server become corrupt, then Traffic Server will also use the generic partition to store content for that origin server (see <a href="files.htm#hosting.config">hosting.config</a>). </li>
- <li>Save and close the <code>hosting.config</code> file. </li>
- <li>Navigate to the Traffic Server <code>bin</code> directory. </li>
- <li>Run the command <code>traffic_line -x</code> to apply the configuration changes. </li>
-</ol>
-<h2 id="ConfiguringCacheObjectSizeLimit">Configuring the Cache Object Size Limit</h2>
-<p>By default, Traffic Server allows objects of any size to be cached. You can change the default behavior and specify a size limit for objects in the cache via the steps below:</p>
-<ol>
- <li>In a text editor, open the <code>records.config</code> file located in the Traffic Server <code>config</code> directory. </li>
- <li>Edit the following variable:<br />
- <table width="1232" border="1">
- <tr>
- <th width="322" scope="col">Variable</th>
- <th width="894" scope="col">Description</th>
- </tr>
- <tr>
- <td><code><i>proxy.config.cache.max_doc_size</i></code></td>
- <td>Set this variable to specify the maximum size allowed for objects in the cache in bytes.<br /> Enter <code>0</code> (zero) if you do not want a size limit.</td>
- </tr>
- </table>
- </li>
- <li>Save and close the <code>records.config</code> file. </li>
- <li>Navigate to the Traffic Server <code>bin</code> directory. </li>
- <li>Run the command <code>traffic_line -x</code> to apply the configuration changes. </li>
-</ol>
-<h2 id="ClearingCache">Clearing the Cache</h2>
-
-<p>When you clear the cache, you remove all data from the entire cache - including data in the host database. You should clear the cache before performing certain cache configuration tasks, such as partitioning. You cannot clear the cache when Traffic Server is running. </p>
-<h5>To clear the cache: </h5>
-<ol>
- <li>Stop Traffic Server (refer to <a href="getstart.htm#StoppingTrafficEdge">Stopping Traffic Server</a>). </li>
- <li>Enter the following command to clear the cache:<br /><code>traffic_server -Cclear</code><br />The <code>clear</code> command deletes all data in the object store and the host database. Traffic Server does not prompt you to confirm the deletion. </li>
- <li>Restart Traffic Server (refer to <a href="getstart.htm#StartingTrafficEdge">Starting Traffic Server</a>).</li>
-</ol>
-
-<h2 id="RemoveObjectFromCache">Removing an Object From the Cache</h2>
-<p>Traffic Server accepts the custom HTTP request method <code>PURGE</code> when removing a specific object from cache. If the object is found in the cache and is successfully removed, then Traffic Server responds with a <code>200 OK </code> HTTP message; otherwise, a <code>404 File Not Found</code> message is returned. </p>
-<p>In the following example, Traffic Server is running on the domain <u><code>example.com</code></u> and you want to remove the image <code>remove_me.jpg</code> from cache:</p>
-<p><code>$ curl -X PURGE -v "http://example.com/remove_me.jpg"</code></p>
-<p><code>* About to connect() to example.com port 80 (#0) <br />
- * Trying 192.0.32.11... connected <br />
- * Connected to example.com (192.0.32.11) port 80 (#0)</code></p>
-<p><code> > PURGE /remove_me.jpg HTTP/1.1 <br /> > User-Agent: curl/7.19.7 <br />
- > Host: example.com <br /> > Accept: */* <br /> > <br /> < HTTP/1.1 200 Ok <br />
- < Date: Thu, 08 Jan 2010 20:32:07 GMT <br /> < Connection: keep-alive</code></p>
-<p>The next time Traffic Server receives a request for the removed object, it will contact the origin server to retrieve it (i.e., it has been purged from the Traffic Server cache).</p>
-<p>Note: The procedure above only removes an object from a <i>specific</i> Traffic Server cache. Users may still see the old (removed) content if it was cached by intermediary caches or by the end-users' web browser.</p>
-<h2 id="InspectingCache">Inspecting the Cache</h2>
-<p>Traffic Server provides a Cache Inspector utility that enables you to view, delete, and invalidate URLs in the cache (HTTP only). The Cache Inspector utility is a powerful tool that's capable of deleting <i>all</i> the objects in your cache; therefore, make sure that only authorized administrators are allowed to access this utility. To control which hosts have access via the <code>mgmt_allow.config</code> file, see <a href="secure.htm#ControllingHostAccessTrafficManager">Controlling Host Access to Traffic Manager</a>. </p>
-<h3>Accessing the Cache Inspector Utility </h3>
-<p>To access the Cache Inspector utility, follow the steps below:</p>
-<ol>
- <li>In a text editor, open the <code>records.config</code> file located in the Traffic Server <code>config</code> directory. </li>
- <li>Add the following variable at the end of the file:<br /><code><i>CONFIG proxy.config.http_ui_enabled INT 1</i></code></li>
- <li>To access the cache inspector in reverse proxy mode, you must add a remap rule to <code>remap.config</code> to expose the URL. <br />
- For example: <br />
- <code>map http://yourhost.com/myCI http://{cache} @action=allow @src_ip=corp_internal_address</code></li>
- <li>From the Traffic Server <code>bin</code> directory, enter the following command to re-read the configuration file:<br />
- <code>traffic_line -x</code></li>
- <li>Open your web browser and configure it to use your Traffic Server as a proxy server. Type the following URL:
-<br /><code>http://{cache}</code></li>
- <li>The Cache page opens (see <a href="#UsingCachePage">Using the Cache Page</a> below).</li>
-</ol>
-<h3 id="UsingCachePage">Using the Cache Page </h3>
-<p>The <b>Cache page</b> provides several options that enable you to view and delete the contents of your cache: </p>
-<ul>
- <li>Click <strong>Lookup url</strong> to search for a particular URL in the cache. When Traffic Server finds the URL in the cache, it displays details about the object that corresponds to the URL (such as the header length and the number of alternates). From the display page, you can delete the URL from the cache. </li>
- <li>Click <strong>Delete url</strong> to delete a particular URL or list of URLs from the cache. Traffic Server indicates if a delete is successful. </li>
- <li>Click <strong>Regex lookup</strong> to search for URLs that match one or more regular expressions. From the display page, you can delete the URLs listed.<br />
- For example, enter the following to search for all URLs that end in html and are prefixed with <code>http://www.dianes.com: <br />
- http://www.dianes.com/.*\.html$</code></li>
- <li>Click <strong>Regex delete</strong> to delete all URLs that match a specified regular expression.<br /> For example, enter the following to delete all HTTP URLs that end in <code>html</code>: <br /><code>http://.*\.html$</code> </li>
- <li>Click <strong>Regex invalidate</strong> to invalidate URLs that match a specified regular expression. When you invalidate a URL, Traffic Server marks the object that corresponds to the URL as stale in the cache. Traffic Server then contacts the origin server to check if the object is still fresh (revalidates) before serving it from the cache. </li>
-</ul>
-<p><strong>Note:</strong> Only one administrator should delete and invalidate cache entries from the Cache page at any point in time. Changes made by multiple administrators at the same time can lead to unpredictable results.</p>
-
-
-<!--#include file="bottom.html" -->
\ No newline at end of file
+<html>
+<head>
+<title>Traffic Edge Administratorâs Guide</title>
+<meta content="text/html; charset=UTF-8" http-equiv="content-type"/>
+
+<link rel="stylesheet" href="doc.css" type="text/css" media="all" />
+</head>
+
+<body>
+<h1>Configuring the Cache</h1>
+<p>The Traffic Server cache consists of a high-speed object database called the <i>object store</i> that indexes objects according to URLs and associated headers.</p>
+<p>This chapter discusses the following topics: </p>
+<ul>
+<li><a href="#TrafficEdgeCache"><em>The Traffic Server Cache</em></a></li>
+<li><a href="#RAMCache"><em>The RAM Cache</em></a></li>
+<li><a href="#ChangingSizeRAMCache"><em>Changing the Size of the RAM Cache</em></a></li>
+<li><a href="#ChangingCacheCapacity"><em>Changing Cache Capacity</em></a></li>
+<li><a href="#PartitioningCache"><em>Partitioning the Cache</em></a></li>
+<li><a href="#ConfiguringCacheObjectSizeLimit"><em>Configuring the Cache Object Size Limit</em></a></li>
+<li><a href="#ClearingCache"><em>Clearing the Cache</em></a></li>
+<li><a href="#InspectingCache"><em>Inspecting the Cache</em></a></li>
+</ul>
+<h2 id="TrafficEdgeCache">The Traffic Server Cache</h2>
+<p>The Traffic Server cache consists of a high-speed object database called the <em>object store</em>. The object store indexes objects according to URLs and associated headers. This enables Traffic Server to store, retrieve, and serve not only web pages, but also parts of web pages, providing optimum bandwidth savings. Using sophisticated object management, the object store can cache alternate versions of the same object (perhaps due to dissimilar language or encoding type). It can also efficiently store very small and very large documents, thereby minimizing wasted space. When the cache is full, Traffic Server removes stale data, ensuring that the most requested objects are kept on-hand and fresh. </p>
+<p>Traffic Server is designed to tolerate total disk failures on any of the cache disks. If the disk fails completely, then Traffic Server marks the entire disk as corrupt and continues using the remaining disks. An alarm is created, indicating which disk failed. If all of the cache disks fail, then Traffic Server goes into proxy-only mode. </p>
+<p>You can perform the following cache configuration tasks: </p>
+<ul>
+ <li>Change the total amount of disk space allocated to the cache; refer to <a href="#ChangingCacheCapacity"><em>Changing Cache Capacity</em></a>. </li>
+ <li>Partition the cache by reserving cache disk space for specific protocols and origin servers/domains; refer to <a href="#PartitioningCache"><em>Partitioning the Cache</em></a>. </li>
+ <li>Delete all data in the cache; refer to <a href="#ClearingCache"><em>Clearing the Cache</em></a>.</li>
+</ul>
+<h2 id="RAMCache">The RAM Cache</h2>
+<p>Traffic Server maintains a small RAM cache of 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, as described in the next section, <a href="#ChangingSizeRAMCache"><em>Changing the Size of the RAM Cache</em></a>. </p>
+<h2 id="ChangingSizeRAMCache">Changing the Size of the RAM Cache</h2>
+<p>Traffic Server provides a dedicated RAM cache for fast retrieval of popular small objects. The default RAM cache size is automatically calculated based on the number and size of the cache partitions you have configured. If you have partitioned your cache according to protocol and/or hosts, then the size of the RAM cache for each partition is proportional to the size of that partition. </p>
+<p>You can increase the RAM cache size for better cache hit performance. However, if you increase the size of the RAM cache and observe a decrease in performance (such as increased latencies), then the operating system might require more memory for network resources. In such instances, you should return the RAM cache size to its previous value.</p>
+<h5>To change RAM cache size: </h5>
+<ol>
+ <li>Stop Traffic Server. </li>
+ <li>In a text editor, open the <code>records.config</code> file located in the Traffic Server <code>config</code> directory. </li>
+ <li>Edit the following variable:</li>
+</ol>
+<br />
+<table width="1232" border="1">
+ <tr>
+ <th width="322" scope="col">Variable</th>
+ <th width="894" scope="col">Description</th>
+ </tr>
+ <tr>
+ <td><i><code>proxy.config.cache.ram_cache.size</code></i></td>
+ <td>Set this variable to specify the size of the RAM cache.<br />
+ The default value of -1 means that the RAM cache is automatically sized at approximately one MB per gigabyte of disk.</td>
+ </tr>
+</table>
+<br />
+<ol>
+ <li>Save and close the <code>records.config</code> file. </li>
+ <li>Restart Traffic Server. If you increase the RAM cache to a size or 1GB or more, then restart with the <code>start_traffic_server</code> command; refer to <a href="getstart.htm#StartingTrafficEdge"><em>Starting Traffic Server</em></a>. </li>
+</ol>
+<p> </p>
+<h2 id="ChangingCacheCapacity">Changing Cache Capacity</h2>
+<p>You can increase or reduce the total amount of disk space allocated to the cache without clearing the content. <br /> To check the size of the cache (in bytes), enter the command <code>traffic_line -r proxy.process.cache.bytes_total</code>. </p>
+<h3>Increasing Cache Capacity </h3>
+<p>To increase the total amount of disk space allocated to the cache on existing disks or to add new disks to a Traffic Server node, follow the steps below:</p>
+<ol>
+ <li>Stop Traffic Server. </li>
+ <li>Add hardware, if necessary. </li>
+ <li>Edit the Traffic Server <code>storage.config</code> file: increase the amount of disk space allocated to the cache on existing disks or describe the new hardware you are adding; refer to <a href="files.htm#151089"><em>storage.config</em></a>.</li>
+ <li>If you add a new disk, then you must edit the <code>/etc/rc.d/init.d/traffic_server</code> file to add a raw disk binding. Instructions for adding a raw disk binding are located in the Traffic Server <code>storage.config</code> file. </li>
+ <li>Restart Traffic Server. </li>
+</ol>
+<h3>Reducing Cache Capacity </h3>
+<p>To reduce the total amount of disk space allocated to the cache on an existing disk or to remove disks from a Traffic Server node, follow the steps below:</p>
+<ol>
+ <li>Stop Traffic Server. </li>
+ <li>Remove hardware, if necessary. </li>
+ <li>Edit the Traffic Server <code>storage.config</code> file: reduce the amount of disk space allocated to the cache on existing disks or delete the reference to the hardware you're removing; refer to <a href="files.htm#151089"><em>storage.config</em></a>. </li>
+ <li>If you remove a disk, then you must edit the <code>/etc/rc.d/init.d/traffic_server</code> file to remove the raw disk binding for the disk. </li>
+ <li>Restart Traffic Server. </li>
+</ol>
+<p><strong>IMPORTANT:</strong> In the <code>storage.config</code> file, a formatted or raw disk must be at least 128 MB. </p>
+<h2 id="PartitioningCache">Partitioning the Cache</h2>
+<p>You can manage your cache space more efficiently and restrict disk usage by creating cache partitions with different sizes for specific protocols. You can further configure these partitions to store data from specific origin servers and/or domains. The partition configuration must be the same on all nodes in a cluster. </p>
+<h3 id="CreatingCachePartitionsSpecificProtocols">Creating Cache Partitions for Specific Protocols</h3>
+<p>You can create separate partitions for your cache that vary in size to store content according to protocol. This ensures that a certain amount of disk space is always available for a particular protocol. Traffic Server supports the <b>http</b> partition type for HTTP objects.</p>
+<h5>To partition the cache according to protocol: </h5>
+<ol>
+ <li>In a text editor, open the <code>partition.config</code> file located in the Traffic Server <code>config</code> directory. </li>
+ <li>Enter a line in the file for each partition you want to create; refer to <a href="files.htm#50072"><em>partition.config</em></a>. </li>
+ <li>Save and close the <code>partition.config</code> file. </li>
+ <li>Restart Traffic Server. </li>
+</ol>
+<h4>Making Changes to Partition Sizes and Protocols </h4>
+<p>After you've configured your cache partitions based on protocol, you can make changes to the configuration at any time. Before making changes, note the following: </p>
+<ul>
+ <li>You must stop Traffic Server before you change the cache partition size and protocol assignment. </li>
+ <li>When you increase the size of a partition, the contents of the partition are <em>not</em> deleted However, when you reduce the size of a partition, the contents of the partition <em>are</em> deleted. </li>
+ <li>When you change the partition number, the partition is deleted and then re-created, even if the size and protocol type remain the same. </li>
+ <li>When you add new disks to your Traffic Server node, the partition sizes specified in percentages increase proportionately. </li>
+ <li>A lot of changes to the partition sizes might result in disk fragmentation, which affects performance and hit rate. You should clear the cache before making many changes to cache partition sizes (refer to <a href="#ClearingCache"><em>Clearing the Cache</em></a>).</li>
+</ul>
+<h3>Partitioning the Cache According to Origin Server or Domain</h3>
+<p>After you have partitioned the cache according to size and protocol, you can assign the partitions you created to specific origin servers and/or domains. You can assign a partition to a single origin server or multiple origin servers. However, if a partition is assigned to multiple origin servers, then there is no guarantee on the space available in the partition for each origin server. Content is stored in the partition according to popularity. In addition to assigning partitions to specific origin servers and domains, you must assign a generic partition to store content from all origin servers and domains that are not listed. This generic partition is also used if the partitions for a particular origin server or domain become corrupt. If you do not assign a generic partition, then Traffic Server will run in proxy-only mode. </p>
+<p><strong>Note: </strong>You do <em>not</em> need to stop Traffic Server before you assign partitions to particular hosts or domains. However, this type of configuration is time-consuming and can cause a spike in memory usage. Therefore, it's best to configure partition assignment during periods of low traffic. </p>
+<h5>To partition the cache according to hostname and domain: </h5>
+<ol>
+ <li>Configure the cache partitions according to size and protocol, as described in <a href="#CreatingCachePartitionsSpecificProtocols"><em>Creating Cache Partitions for Specific Protocols</em></a>. </li>
+ <li>Create a separate partition based on protocol for each host and domain, as well as an additional generic partition to use for content that does not belong to these origin servers or domains. The partitions do not need to be the same size. </li>
+ <li>In a text editor, open the <code>hosting.config</code> file located in the Traffic Server <code>config</code> directory. </li>
+ <li>Enter a line in the file to allocate the partition(s) used for each origin server and/or domain; refer to <a href="files.htm#139053"><em>hosting.config</em></a>. </li>
+ <li>Assign a generic partition to use for content that does not belong to any of the origin servers or domains listed in the file. If all partitions for a particular origin server become corrupt, then Traffic Server will also use the generic partition to store content for that origin server; refer to <a href="files.htm#139053"><em>hosting.config</em></a>. </li>
+ <li>Save and close the <code>hosting.config</code> file. </li>
+ <li>Navigate to the Traffic Server <code>bin</code> directory. </li>
+ <li>Run the command <code>traffic_line -x</code> to apply the configuration changes. </li>
+</ol>
+<h2 id="ConfiguringCacheObjectSizeLimit">Configuring the Cache Object Size Limit</h2>
+<p>By default, Traffic Server allows objects of any size to be cached. You can change the default behavior and specify a size limit for objects in the cache via the steps below:</p>
+<ol>
+ <li>In a text editor, open the <code>records.config</code> file located in the Traffic Server <code>config</code> directory. </li>
+ <li>Edit the following variable:</li>
+ <br />
+<table width="1232" border="1">
+ <tr>
+ <th width="322" scope="col">Variable</th>
+ <th width="894" scope="col">Description</th>
+ </tr>
+ <tr>
+ <td><code><i>proxy.config.cache.max_doc_size</i></code></td>
+ <td>Set this variable to specify the maximum size allowed for objects in the cache in bytes.<br /> Enter <code>0</code> (zero) if you do not want a size limit.</td>
+ </tr>
+</table>
+<br />
+ <li>Save and close the <code>records.config</code> file. </li>
+ <li>Navigate to the Traffic Server <code>bin</code> directory. </li>
+ <li>Run the command <code>traffic_line -x</code> to apply the configuration changes. </li>
+</ol>
+<h2 id="ClearingCache">Clearing the Cache</h2>
+<p>When you clear the cache, you remove all data from the entire cache - including data in the host database. You should clear the cache before performing certain cache configuration tasks, such as partitioning. You cannot clear the cache when Traffic Server is running. </p>
+<h5>To clear the cache: </h5>
+<ol>
+ <li>Stop Traffic Server; refer to <a href="getstart.htm#StoppingTrafficEdge"><em>Stopping Traffic Server</em></a>. </li>
+ <li>Enter the following command to clear the cache:<br /><code>traffic_server -Cclear</code><br />The <code>clear</code> command deletes all data in the object store and the host database. Traffic Server does not prompt you to confirm the deletion. </li>
+ <li>Restart Traffic Server; refer to <a href="getstart.htm#StartingTrafficEdge"><em>Starting Traffic Server</em></a>.</li>
+</ol>
+<h2 id="InspectingCache">Inspecting the Cache</h2>
+<p>Traffic Server provides a Cache Inspector utility that enables you to view, delete, and invalidate URLs in the cache (HTTP only). The Cache Inspector utility is a powerful tool that's capable of deleting <i>all</i> the objects in your cache. Make sure that only authorized administrators are allowed to access this utility. To control which hosts have access via the <code>mgmt_allow.config</code> file, refer to <a href="secure.htm#ControllingHostAccessTrafficManager"><em>Controlling Host Access to Traffic Manager</em></a>. </p>
+<h3>Accessing the Cache Inspector Utility </h3>
+<p>To access the Cache Inspector utility, follow the steps below:</p>
+<ol>
+ <li>In a text editor, open the <code>records.config</code> file located in the Traffic Server <code>config</code> directory. </li>
+ <li>Add the following variable at the end of the file:<br /><code><i>CONFIG proxy.config.http_ui_enabled INT 1</i></code></li>
+ <li>To access the cache inspector in reverse proxy mode, you must add a remap rule to <code>remap.config</code> to expose the URL. <br />
+ For example: <br />
+ <code>map http://yourhost.com/myCI http://{cache} @action=allow @src_ip=corp_internal_address</code></li>
+ <li>From the Traffic Server <code>bin</code> directory, enter the following command to re-read the configuration file:<br />
+ <code>traffic_line -x</code></li>
+ <li>Open your web browser and configure it to use your Traffic Server as a proxy server. Type the following URL:
+<br /><code>http://{cache}</code></li>
+ <li>The Cache page opens; refer to <a href="#UsingCachePage"><em>Using the Cache Page</em></a> below.</li>
+</ol>
+<h3 id="UsingCachePage">Using the Cache Page </h3>
+<p>The <b>Cache page</b> provides several options that enable you to view and delete the contents of your cache: </p>
+<ul>
+ <li>Click <strong>Lookup url</strong> to search for a particular URL in the cache. When Traffic Server finds the URL in the cache, it displays details about the object that corresponds to the URL (such as the header length and the number of alternates). From the display page, you can delete the URL from the cache. </li>
+ <li>Click <strong>Delete url</strong> to delete a particular URL or list of URLs from the cache. Traffic Server indicates if a delete is successful. </li>
+ <li>Click <strong>Regex lookup</strong> to search for URLs that match one or more regular expressions. From the display page, you can delete the URLs listed.<br />
+ For example, enter the following to search for all URLs that end in html and are prefixed with <code>http://www.dianes.com: <br />
+ http://www.dianes.com/.*\.html$</code></li>
+ <li>Click <strong>Regex delete</strong> to delete all URLs that match a specified regular expression.<br /> For example, enter the following to delete all HTTP URLs that end in <code>html</code>: <br /><code>http://.*\.html$</code> </li>
+ <li>Click <strong>Regex invalidate</strong> to invalidate URLs that match a specified regular expression. When you invalidate a URL, Traffic Server marks the object that corresponds to the URL as stale in the cache. Traffic Server then contacts the origin server to check if the object is still fresh (revalidates) before serving it from the cache. </li>
+</ul>
+<p><strong>Note:</strong> Only one administrator should delete and invalidate cache entries from the Cache page at any point in time. Changes made by multiple administrators at the same time can lead to unpredictable results.</p>
+
+</body>
+</html>
\ No newline at end of file
Modified: incubator/trafficserver/site/trunk/docs/admin/cli.htm
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/admin/cli.htm?rev=917681&r1=917680&r2=917681&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/admin/cli.htm (original)
+++ incubator/trafficserver/site/trunk/docs/admin/cli.htm Mon Mar 1 19:53:47 2010
@@ -1,22 +1,23 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
-<head>
-<title>Traffic Line Commands</title>
-
-<!--#include file="top.html" -->
+ <head>
+ <title>Traffic Line Commands</title>
+<meta content="text/html; charset=UTF-8" http-equiv="content-type"/>
+<link rel="stylesheet" href="doc.css" type="text/css" media="all" />
+</head>
+ <body>
<h1><a name="1053643">Appendix C - Traffic Line Commands</a>
</h1>
<p> This appendix contains the following sections: </p>
<ul>
-<li><a href="#1053987">Traffic Line Commands</a></li>
-<li><a href="#1025718">Traffic Line Variables</a></li>
+<li><a href="#1053987"><em>Traffic Line Commands</em></a></li>
+<li><a href="#1025718"><em>Traffic Line Variables</em></a></li>
</ul>
<h2>
<a name="1053987">Traffic Line Commands</a> </h2>
- <p> Use Traffic Line to execute individual Traffic Server commands and to script multiple commands in a shell. Execute Traffic Line commands from the Traffic Server <code>bin</code> directory. If the Traffic Server <code>bin</code> directory is not in your path, then prepend the Traffic Line command with <code>./</code> (for example: <code>./traffic_line -p</code>). </p>
+ <p> Use Traffic Line to execute individual Traffic Server commands and to script multiple commands in a shell. You execute Traffic Line commands from the Traffic Server <code>bin</code> directory. If the Traffic Server <code>bin</code> directory is not in your path, then prepend the Traffic Line command with <code>./</code> (for example: <code>./traffic_line -p</code>). </p>
<p> The following table describes all the commands available in Traffic Line. </p>
<table border="1">
<tr>
@@ -25,33 +26,34 @@
</tr>
<tr>
<td><p> <code> traffic_line -b</code> </p></td>
- <td><p> Bounces Traffic Server on the local node. Bouncing Traffic Server shuts down and immediately restarts the Traffic Server node.</p></td>
+ <td><p> Bounces the Traffic Server on the local node. Bouncing the Traffic Server shuts down and immediately restarts the Traffic Server node.</p></td>
</tr>
<tr>
<td><p> <code> traffic_line -c</code> </p></td>
- <td><p> Clears accumulated statistics on the local node.</p></td>
+ <td><p> Clears the accumulated statistics on the local node.</p></td>
</tr>
<tr>
<td><p> <code> traffic_line -h</code> </p></td>
- <td><p> Displays a list of Traffic Line commands.</p></td>
+ <td><p> Displays the list of Traffic Line commands.</p></td>
</tr>
<tr>
<td><p> <code> traffic_line -p <em>socket_path</em></code> </p></td>
- <td><p> Specifies location (directory and path) of the socket used for Traffic Line communication.<br />
- The default path is: <code><em>install_dir</em> /config/cli</code> </p></td>
+ <td><p> Specifies the location (directory and path) of the socket used for Traffic Line communication.<br />
+ The default path is: <br />
+ <code><em>install_dir</em> /config/cli</code> </p></td>
</tr>
<tr>
<td><p> <code> traffic_line -q</code> </p></td>
<td><p> Displays a list of the origin servers that are currently congested. </p>
- <p> <b>Note:</b> To use this command, you must set the variable <code> <i>proxy.config.raf.enabled</i></code> to 1 and set the variable <code> <i>proxy.config.raf.port</i></code> to a different port <em CLASS="Emphasis"> only</em> if there is a conflict with the default port 9000.</p></td>
+ <p> <b>Note:</b> To use this command, you must set the variable <code> <i>proxy.config.raf.enabled</i></code> to 1 and then set the variable <code> <i>proxy.config.raf.port</i></code> to a different port <em CLASS="Emphasis"> only</em> if there is a conflict with the default port 9000.</p></td>
</tr>
<tr>
<td><p> <code> traffic_line -r <em>variable</em></code> </p></td>
- <td><p> Displays specific performance statistics or a current configuration setting. For a list of the variables you can specify, see <a href="cli.htm#1025718">Traffic Line Variables</a>.</p></td>
+ <td><p> Displays specific performance statistics or a current configuration setting. For a list of the variables you can specify, refer to <a href="cli.htm#1025718"><em>Traffic Line Variables</em></a>.</p></td>
</tr>
<tr>
<td><p> <code> traffic_line -s <em>variable</em> -v <em>value</em></code> </p></td>
- <td><p> Sets configuration variables, where <code><i>variable</i></code> is the configuration variable you want to change and <code> <i>value</i></code> is the value you want to set. Refer to <a href="files.htm#records.config">records.config</a> for a list of the configuration variables you can specify.</p></td>
+ <td><p> Sets configuration variables, where <code><i>variable</i></code> is the configuration variable you want to change and <code> <i>value</i></code> is the value you want to set. Refer to <a href="files.htm#115367"><em> records.config</em></a> for a list of the configuration variables you can specify.</p></td>
</tr>
<tr>
<td><p> <code> traffic_line -x</code> </p></td>
@@ -59,15 +61,15 @@
</tr>
<tr>
<td><p> <code> traffic_line -B</code> </p></td>
- <td><p> Bounces all Traffic Server nodes in the cluster. Bouncing Traffic Server shuts down and immediately restarts Traffic Server, node-by-node.</p></td>
+ <td><p> Bounces all the Traffic Server nodes in the cluster. Bouncing the Traffic Server shuts down and immediately restarts Traffic Server node by node.</p></td>
</tr>
<tr>
<td><p> <code> traffic_line -C</code> </p></td>
- <td><p> Clears accumulated statistics on all nodes in the cluster.</p></td>
+ <td><p> Clears the accumulated statistics on all the nodes in the cluster.</p></td>
</tr>
<tr>
<td><p> <code> traffic_line -L</code> </p></td>
- <td><p> Restarts the <code> traffic_manager</code> and <code> traffic_server</code> processes on the local node.</p></td>
+ <td><p> Restarts the <code> traffic_manager</code> process and the <code> traffic_server</code> process on the local node.</p></td>
</tr>
<tr>
<td><p> <code> traffic_line -M</code> </p></td>
@@ -75,18 +77,18 @@
</tr>
<tr>
<td><p> <code> traffic_line -S</code> </p></td>
- <td><p> Shuts down Traffic Server on the local node.</p></td>
+ <td><p> Shuts down the Traffic Server on the local node.</p></td>
</tr>
<tr>
<td><p> <code> traffic_line -U</code> </p></td>
- <td><p> Starts Traffic Server on the local node.</p></td>
+ <td><p> Starts the Traffic Server on the local node.</p></td>
</tr>
</table>
<p>
<strong><a name="1025718">Traffic Line Variables</a></strong>
</p>
- <p> You can view statistics and change configuration options in Traffic Line by using specific variables. The variables used for gathering statistics are described below. The variables used for viewing and changing configuration options are described in <a href="files.htm#records.config">records.config</a>. For procedures about specifying the variables, refer to <a href="monitor.htm">Viewing Statistics from Traffic Line</a> and <a href="configure.htm">Configuring Traffic Server Using Traffic Line</a>. </p>
-<p> The variables used for viewing individual statistics are described in the following table. To view a statistic in Traffic Line, enter the command <code>traffic_line -r <em>variable</em> </code>at the prompt. </p>
+ <p> You can view statistics and change configuration options in Traffic Line by using specific variables. The variables used for gathering statistics are described below. The variables used for viewing and changing configuration options are described in <a href="files.htm#115367"><em>records.config</em></a>. For procedures on how to specify the variables, refer to <a href="monitor.htm"><em>Viewing Statistics from Traffic Line</em></a>, and <a href="configure.htm"><em>Configuring Traffic Server Using Traffic Line</em></a>. </p>
+ <p> The variables used for viewing individual statistics are described in the following table. To view a statistic in Traffic Line, enter the command <code>traffic_line -r <em>variable</em> </code>at the prompt. </p>
<table border="1">
<tr>
<td><p><strong> Statistic</strong></p></td>
@@ -336,7 +338,7 @@
<td><p> <i><code> proxy.process.dns.total_dns_lookups</code> </i></p></td>
</tr>
<tr>
- <td><p> Average lookup time (msec)</p></td>
+ <td><p> Average lookup time (ms)</p></td>
<td><p> <i><code> proxy.process.dns.lookup_avg_time</code> </i></p></td>
</tr>
<tr>
@@ -374,7 +376,7 @@
<td rowspan="1" colspan="2"><p><strong> Logging </strong></p></td>
</tr>
<tr>
- <td><p> Log files currently open</p></td>
+ <td><p> Currently open log files</p></td>
<td><p> <i><code> proxy.process.log2.log_files_open</code> </i></p></td>
</tr>
<tr>
@@ -397,13 +399,14 @@
<td rowspan="1" colspan="2"><p><strong> Congestion Control</strong></p></td>
</tr>
<tr>
- <td><p> Number of congestions Traffic Server has observed because the maximum number of connections was exceeded.</p></td>
+ <td><p> Number of congestions Traffic Server has observed because the maximum number of connections were exceeded.</p></td>
<td><p> <i><code>proxy.process.congestion.congested_on_max_connection</code></i></p></td>
</tr>
<tr>
- <td><p> Number of congestions Traffic Server has observed because of an OS response or timeout failure.</p></td>
+ <td><p> Number of congestions Traffic Server has observed because of an operating system response or timeout failure.</p></td>
<td><p><i><code>proxy.process.congestion.congested_on_conn_failures</code></i></p></td>
</tr>
</table>
-<!--#include file="bottom.html" -->
\ No newline at end of file
+</body>
+</html>
\ No newline at end of file
Modified: incubator/trafficserver/site/trunk/docs/admin/configure.htm
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/admin/configure.htm?rev=917681&r1=917680&r2=917681&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/admin/configure.htm (original)
+++ incubator/trafficserver/site/trunk/docs/admin/configure.htm Mon Mar 1 19:53:47 2010
@@ -1,35 +1,38 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
-<html>
-<head>
-<title>Traffic Edge Administrator's Guide</title>
-
-<!--#include file="top.html" -->
-
-<h1>Configuring Traffic Server</h1>
-<p>Traffic Server provides several options for configuring the system.</p>
-<p>This chapter discusses the following topics: </p>
-<ul>
-<li><a href="#ConfiguringTrafficEdgeUsingTrafficLine">Configure Traffic Server Using Traffic Line</a></li>
-<li><a href="#ConfiguringTrafficEdgeUsingConfigFiles">Configure Traffic Server Using Configuration Files</a></li>
-</ul>
-<h2 id="ConfiguringTrafficEdgeUsingTrafficLine">Configure Traffic Server Using Traffic Line</h2>
-<p>Traffic Line enables you to quickly and easily change your Traffic Server configuration via command-line interface. Alternatively, you can also use <a href="getstart.htm#StartingTrafficShell">Traffic Shell</a> to configure Traffic Server.</p>
-<h5>To view or change configuration options in Traffic Line: </h5>
-<ol>
- <li>Log on to a Traffic Server node as the Traffic Server administrator and navigate to the Traffic Server <code>bin</code> directory. </li>
- <li>To view a configuration setting, enter the following command: <br /><code>traffic_line -r <em>var</em></code><br />
- where <em><code>var</code></em> is the variable associated with the configuration option. For a list of variables, refer to <a href="files.htm#config_var">Configuration Variables</a>.</li>
- <li>To change the value of a configuration setting, enter the following command:
- <br /><code>traffic_line -s <em>var</em> -v <em>value</em></code> <br />
- where <em><code>var</code></em> is the variable associated with the configuration option and <em><code>value</code></em> is the value you want to use. For a list of the variables, see <a href="files.htm#config_var">Configuration Variables</a>.<br /> <br /> If the Traffic Server <code>bin</code> directory is not in your path, then prepend the Traffic Line command with <code>./</code> (for example, <code>./traffic_line -r variable</code>).</li>
-</ol>
-<h2 id="ConfiguringTrafficEdgeUsingConfigFiles">Configure Traffic Server Using Configuration Files</h2>
-<p>As an alternative to using Traffic Line or Traffic Shell, you can change Traffic Server configuration options by manually editing specific variables in the <code>records.config</code> file located in the Traffic Server <code>config</code> directory. To edit the variables, open the file in a text editor (such as <code>vi</code> or <code>emacs</code>) and change variable values. After you modify the <code>records.config</code> file, Traffic Server must reread the configuration files. From the Traffic Server <code>bin</code> directory, enter the Traffic Line command <code>traffic_line -x</code>. You may need to restart Traffic Server to apply the configuration changes. </p>
-<p>The following is a sample portion of the <code>records.config</code> file: </p>
-<p><img src="images/records.jpg" width="812" height="609" /></p>
-<blockquote>
- <p><em><b>Sample records.config file </b></em></p>
-</blockquote>
-<p>In addition to the <code>records.config</code> file, Traffic Server provides other configuration files that are used to configure specific features. All configuration files you can manually edit are described in <a href="files.htm">Configuration Files</a>. </p>
-
-<!--#include file="bottom.html" -->
\ No newline at end of file
+<html>
+<head>
+<title>Traffic Edge Administratorâs Guide</title>
+<meta content="text/html; charset=UTF-8" http-equiv="content-type"/>
+
+<link rel="stylesheet" href="doc.css" type="text/css" media="all" /></head>
+
+<body>
+<h1>Configuring Traffic Server</h1>
+<p>Traffic Server provides several options for configuring the system.</p>
+<p>This chapter discusses the following topics: </p>
+<ul>
+<li><a href="#ConfiguringTrafficEdgeUsingTrafficLine"><em>Configure Traffic Server Using Traffic Line</em></a></li>
+<li><a href="#ConfiguringTrafficEdgeUsingConfigFiles"><em>Configure Traffic Server Using Configuration Files</em></a></li>
+</ul>
+<h2 id="ConfiguringTrafficEdgeUsingTrafficLine">Configure Traffic Server Using Traffic Line</h2>
+<p>Traffic Line enables you to quickly and easily change your Traffic Server configuration via command-line interface. Alternatively, you can also use <a href="getstart.htm#StartingTrafficShell"><em>Traffic Shell</em></a> to configure Traffic Server.</p>
+<h5>To view or change configuration options in Traffic Line: </h5>
+<ol>
+ <li>Log on to a Traffic Server node as the Traffic Server administrator and navigate to the Traffic Server <code>bin</code> directory. </li>
+ <li>To view a configuration setting, enter the following command: <br /><code>traffic_line -r <em>var</em></code><br />
+ where <em><code>var</code></em> is the variable associated with the configuration option (for a list of the variables, refer to <a href="files.htm#49000"><em>Configuration Variables</em></a>). </li>
+ <li>To change the value of a configuration setting, enter the following command:
+ <br /><code>traffic_line -s <em>var</em> -v <em>value</em></code> <br />
+ where <em><code>var</code></em> is the variable associated with the configuration option (for a list of the variables, refer to <a href="files.htm#49000"><em>Configuration Variables</em></a>) and <em><code>value</code></em> is the value you want to use. <br /> <br /> If the Traffic Server <code>bin</code> directory is not in your path, then prepend the Traffic Line command with <code>./</code> (for example, <code>./traffic_line -r variable</code>).</li>
+</ol>
+<h2 id="ConfiguringTrafficEdgeUsingConfigFiles">Configure Traffic Server Using Configuration Files</h2>
+<p>As an alternative to using Traffic Line or Traffic Shell, you can change Traffic Server configuration options by manually editing specific variables in the <code>records.config</code> file located in the Traffic Server <code>config</code> directory. To edit the variables, open the file in a text editor (such as <code>vi</code> or <code>emacs</code>) and change variable values. After you modify the <code>records.config</code> file, Traffic Server must reread the configuration files. From the Traffic Server <code>bin</code> directory, enter the Traffic Line command <code>traffic_line -x</code>. You may need to restart Traffic Server to apply the configuration changes. </p>
+<p>The following is a sample portion of the <code>records.config</code> file: </p>
+<p><img src="images/records.jpg" width="812" height="609" /></p>
+<blockquote>
+ <p><em><b>Sample records.config file </b></em></p>
+</blockquote>
+<p>In addition to the <code>records.config</code> file, Traffic Server provides other configuration files that are used to configure specific features. All configuration files that you can manually edit are described in <em><a href="files.htm">Configuration Files</a></em>. </p>
+<h2 id="SavingRestoringTrafficEdgeConfigs"> </h2>
+<p> </p>
+</body>
+</html>
\ No newline at end of file
Modified: incubator/trafficserver/site/trunk/docs/admin/doc.css
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/admin/doc.css?rev=917681&r1=917680&r2=917681&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/admin/doc.css (original)
+++ incubator/trafficserver/site/trunk/docs/admin/doc.css Mon Mar 1 19:53:47 2010
@@ -1,28 +1,11 @@
body{
font-family:Tahoma, Geneva, sans-serif;
- width:95%;
-}
-h1{
- font-family:Arial;
+ width:580px;
}
+h1{font-family:Arial;}
h2{border-style: solid none none; border-color: grey; border-width: 3px 0px 0px;font-family:Arial;}
h3{font-family:Arial;}
h5{font-family:Arial; padding: 5px 5px 5px 15px; background:url(http://us.i1.yimg.com/us.yimg.com/i/us/pim/bn/downbr1.gif) no-repeat left center;}
code{padding:15px 0px;}
table{border:thin solid;border-collapse:collapse;}
td{border:thin solid grey; border-top-style:solid;}
-h1.doctitle{
- position:relative;
- top:-8px;
- display:inline;
- margin-left:10px;
-}
-ul.leftnav{
- margin-left:0px;
- padding-left:15px;
- font-family: Tahoma, Geneva, sans-serif;
- width:170px;
-}
-#ft #incu_logo{float:right;}
-#cse-search-box{display:inline; float:right;margin:15px 5px 0 5px;}
-img{border:0;}
\ No newline at end of file
Propchange: incubator/trafficserver/site/trunk/docs/admin/doc.css
('svn:executable' removed)
Modified: incubator/trafficserver/site/trunk/docs/admin/errors.htm
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/admin/errors.htm?rev=917681&r1=917680&r2=917681&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/admin/errors.htm (original)
+++ incubator/trafficserver/site/trunk/docs/admin/errors.htm Mon Mar 1 19:53:47 2010
@@ -1,9 +1,9 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
-<head>
-<title>Traffic Server Error Messages</title>
-
-<!--#include file="top.html" -->
+ <head>
+ <title>Traffic Edge Error Messages</title>
+<meta content="text/html; charset=UTF-8" http-equiv="content-type"/>
+<link rel="stylesheet" href="doc.css" type="text/css" media="all" /></head>
+<body>
<h1><a name="48024">Appendix F - Traffic Server Error Messages</a>
</h1>
@@ -91,7 +91,7 @@
</tr>
<tr>
<td><p><code> No cache disks specified in storage.config file: cache disabled</code></p></td>
- <td><p> The Traffic Server <code> storage.config</code> file does not list any cache disks; Traffic Server is running in proxy-only mode. You must add the disks you want to use for the cache to the <a href="files.htm#storage.config">storage.config</a> file.</p></td>
+ <td><p> The Traffic Server <code> storage.config</code> file does not list any cache disks; Traffic Server is running in proxy-only mode. You must add the disks you want to use for the cache to the <a href="files.htm#151089">storage.config</a> file.</p></td>
</tr>
</table>
<h2>
@@ -405,5 +405,5 @@
<td><p> Gateway Timeout</p></td>
</tr>
</table>
-
-<!--#include file="bottom.html" -->
\ No newline at end of file
+</body>
+</html>
\ No newline at end of file
Modified: incubator/trafficserver/site/trunk/docs/admin/explicit.htm
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/admin/explicit.htm?rev=917681&r1=917680&r2=917681&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/admin/explicit.htm (original)
+++ incubator/trafficserver/site/trunk/docs/admin/explicit.htm Mon Mar 1 19:53:47 2010
@@ -1,57 +1,60 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
-<html>
-<head>
-<title>Traffic Edge Administrator's Guide</title>
-
-<!--#include file="top.html" -->
-
-<h1>Explicit Proxy Caching</h1>
-<p>If you want to use Traffic Server as an explicit proxy cache, you must configure client software (i.e., browsers) to send requests directly to Traffic Server.</p>
-<h2 id="ExplicitProxyCachingHTTP">Explicit Proxy Caching for HTTP</h2>
-<p> If you do not configure Traffic Server to use the transparency option (with which client requests are intercepted en route to origin servers by a switch/router and rerouted to the Traffic Server machine), then clients must configure their web browsers to send HTTP requests to the Traffic Server proxy cache by configuring their browsers to download proxy configuration instructions from a <a href="#UsingPACFile">PAC file</a> (Proxy Auto-Configuration file).</p>
-<h3 id="ConfiguringBrowsersManually">Configuring Browsers Manually </h3>
-<p>To manually configure a browser to send HTTP requests to Traffic Server, clients must provide the following information: </p>
-<ul>
- <li>The fully-qualified hostname or IP address of the Traffic Server node</li>
- <li>The Traffic Server proxy server port (port 8080)</li>
-</ul>
-<p>In addition, clients can specify <i>not</i> to use Traffic Server for certain sites - in such cases, requests to the listed sites go directly to the origin server. The procedures for manual configuration vary among browser versions; refer to specific browser documentation for complete proxy configuration instructions. You do not need to set any special configuration options on Traffic Server if you want to accept requests from manually-configured browsers. </p>
-<h3 id="UsingPACFile">Using a PAC File </h3>
-<p>A <b>PAC file</b> is a specialized JavaScript function definition that a browser calls to determine how requests are handled. Clients must specify (in their browser settings) the URL from which the PAC file is loaded. You can store a PAC file on Traffic Server (or on any server in your network) and then provide the URL for this file to your clients. </p>
-<p>If you want to store a PAC file on the Traffic Server system, then you must perform the following configuration: </p>
-<ul>
- <li>Either copy an existing PAC file into the Traffic Server <code>config</code> directory or enter a script that defines the proxy server configuration settings in the <code>proxy.pac</code> file provided (the file is empty by default). </li>
- <li>Specify the port Traffic Server uses to serve the PAC file. The default port is 8083.</li>
-</ul>
-<h5>Configure Traffic Server to provide a PAC file manually: </h5>
-<ol>
- <li>If you have an existing PAC file, then replace the <code>proxy.pac</code> file located in the Traffic Server <code>config</code> directory with the existing file. </li>
- <li>In a text editor, open the <code>records.config</code> file located in the Traffic Server <code>config</code> directory. </li>
- <li>Edit the following variable:</li>
- <table width="1232" border="1">
- <tr>
- <th width="322" scope="col">Variable</th>
- <th width="894" scope="col">Description</th>
- </tr>
- <tr>
- <td><code><i>proxy.config.admin.autoconf_port</i></code></td>
- <td><p>Set this variable to specify the port Traffic Server uses to serve the PAC file. The default port is 8083.</p> </td>
- </tr>
-</table>
- <li>Save and close the <code>records.config</code> file. </li>
- <li>In a text editor, open the <code>proxy.pac</code> file located in the Traffic Server <code>config</code> directory. </li>
- <ul>
- <li>If you copied an existing PAC file into the Traffic Server config directory, then the <code>proxy.pac</code> file contains your proxy configuration settings. Check the settings and make changes if necessary. </li>
- <li>If you did not copy an existing PAC file into the Traffic Server <code>config</code> directory, then the <code>proxy.pac</code> file is empty. Enter a script that will provide the proxy server configuration settings. A sample script is provided in <a href="#SamplePACFile">Sample PAC File</a>. </li>
-</ul>
-<li>Save and close the <code>proxy.pac</code> file. </li>
- <li>Restart Traffic Server. </li>
- <li>Inform your users to set their browsers to point to this PAC file; <a href="#SetBrowsersPointPACFile">click here for browser settings</a>. </li>
-</ol>
-<h4 id="SamplePACFile">Sample PAC File </h4>
-<p>The following sample PAC file instructs browsers to connect directly to all hosts without a fully-qualified domain name and to all hosts in the local domain. All other requests go to the Traffic Server named <code>myproxy.company.com</code>.</p>
-<pre>function FindProxyForURL(url, host) <br />{<br /> if (isPlainHostName(host)) ||<br /> (localHostOrDomainIs(host, ".company.com")) {<br /> return "DIRECT";<br /> }<br /> else<br /> return "PROXY myproxy.company.com:8080;" +<br /> "DIRECT"; <br />} </pre>
-<h3 id="UsingWPAD"> </h3>
-<p> </p>
-
-<!--#include file="bottom.html" -->
\ No newline at end of file
+<html>
+<head>
+<title>Traffic Edge Administratorâs Guide</title>
+<meta content="text/html; charset=UTF-8" http-equiv="content-type"/>
+
+<link rel="stylesheet" href="doc.css" type="text/css" media="all" /></head>
+
+<body>
+<h1>Explicit Proxy Caching</h1>
+<p>If you want to use Traffic Server as an explicit proxy cache, you must configure client software (i.e., browsers) to send requests directly to Traffic Server.</p>
+<h2 id="ExplicitProxyCachingHTTP">Explicit Proxy Caching for HTTP</h2>
+<p> If you do not configure Traffic Server to use the transparency option (with which client requests are intercepted on the way to origin servers by a switch or router and rerouted to the Traffic Server machine), then clients must configure their web browsers to send HTTP requests to the Traffic Server proxy cache by configuring their browsers to download proxy configuration instructions from a <a href="#UsingPACFile"><em>PAC file</em></a> (Proxy Auto-Configuration file).</p>
+<h3 id="ConfiguringBrowsersManually">Configuring Browsers Manually </h3>
+<p>To manually configure a browser to send HTTP requests to Traffic Server, clients must provide the following information: </p>
+<ul>
+ <li>The fully-qualified hostname or IP address of the Traffic Server node</li>
+ <li>The Traffic Server proxy server port (port 8080)</li>
+</ul>
+<p>In addition, clients can specify <i>not</i> to use Traffic Server for certain sites - in such cases, requests to the listed sites go directly to the origin server. The procedures for manual configuration vary among browser versions; refer to specific browser documentation for complete proxy configuration instructions. You do not need to set any special configuration options on Traffic Server if you want to accept requests from manually-configured browsers. </p>
+<h3 id="UsingPACFile">Using a PAC File </h3>
+<p>A PAC file is a specialized JavaScript function definition that a browser calls to determine how requests are handled. Clients must specify (in their browser settings) the URL from which the PAC file is loaded. You can store a PAC file on Traffic Server (or on any server in your network) and then provide the URL for this file to your clients. </p>
+<p>If you want to store a PAC file on the Traffic Server system, then you must perform the following configuration: </p>
+<ul>
+ <li>Either copy an existing PAC file into the Traffic Server <code>config</code> directory or enter a script that defines the proxy server configuration settings in the <code>proxy.pac</code> file provided (the file is empty by default). </li>
+ <li>Specify the port that Traffic Server uses to serve the PAC file. The default port is 8083.</li>
+</ul>
+<h5>Configure Traffic Server to provide a PAC file manually: </h5>
+<ol>
+ <li>If you have an existing PAC file, then replace the <code>proxy.pac</code> file located in the Traffic Server <code>config</code> directory with the existing file. </li>
+ <li>In a text editor, open the <code>records.config</code> file located in the Traffic Server <code>config</code> directory. </li>
+ <li>Edit the following variable:</li>
+<br />
+<table width="1232" border="1">
+ <tr>
+ <th width="322" scope="col">Variable</th>
+ <th width="894" scope="col">Description</th>
+ </tr>
+ <tr>
+ <td><code><i>proxy.config.admin.autoconf_port</i></code></td>
+ <td><p>Set this variable to specify the port Traffic Server uses to serve the PAC file. The default port is 8083.</p> </td>
+ </tr>
+</table>
+<br />
+ <li>Save and close the <code>records.config</code> file. </li>
+ <li>In a text editor, open the <code>proxy.pac</code> file located in the Traffic Server <code>config</code> directory. </li>
+ <ul>
+ <li>If you copied an existing PAC file into the Traffic Server config directory, then the <code>proxy.pac</code> file contains your proxy configuration settings. Check the settings and make changes if necessary. </li>
+ <li>If you did not copy an existing PAC file into the Traffic Server <code>config</code> directory, then the <code>proxy.pac</code> file is empty. Enter a script that will provide the proxy server configuration settings. A sample script is provided in <a href="#SamplePACFile"><em>Sample PAC File</em></a>. </li>
+</ul>
+<li>Save and close the <code>proxy.pac</code> file. </li>
+ <li>Restart Traffic Server. </li>
+ <li>Inform your users to set their browsers to point to this PAC file; <a href="#SetBrowsersPointPACFile"><em>click here for browser settings</em></a>. </li>
+</ol>
+<h4 id="SamplePACFile">Sample PAC File </h4>
+<p>The following sample PAC file instructs browsers to connect directly to all hosts without a fully-qualified domain name and to all hosts in the local domain. All other requests go to the Traffic Server named <code>myproxy.company.com</code>.</p>
+<pre>function FindProxyForURL(url, host) <br />{<br /> if (isPlainHostName(host)) ||<br /> (localHostOrDomainIs(host, ".company.com")) {<br /> return "DIRECT";<br /> }<br /> else<br /> return "PROXY myproxy.company.com:8080;" +<br /> "DIRECT"; <br />} </pre>
+<h3 id="UsingWPAD"> </h3>
+<p> </p>
+</body>
+</html>
\ No newline at end of file