diff options
Diffstat (limited to 'docs/manual/mod/mod_cache.html.en')
| -rw-r--r-- | docs/manual/mod/mod_cache.html.en | 65 |
1 files changed, 51 insertions, 14 deletions
diff --git a/docs/manual/mod/mod_cache.html.en b/docs/manual/mod/mod_cache.html.en index 1a0f12d38c..5a8059006c 100644 --- a/docs/manual/mod/mod_cache.html.en +++ b/docs/manual/mod/mod_cache.html.en @@ -3,7 +3,7 @@ This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX --><title>mod_cache - Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"></head><body><blockquote><div align="center"><img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]"><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_cache</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap" valign="top"><span class="help">Description: - </span></td><td>Content cache keyed to URIs</td></tr><tr><td nowrap="nowrap"><a href="module-dict.html#Status" class="help">Status: + </span></td><td>Content cache keyed to URIs.</td></tr><tr><td nowrap="nowrap"><a href="module-dict.html#Status" class="help">Status: </a></td><td>Experimental</td></tr><tr><td nowrap="nowrap"><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier: </a></td><td>cache_module</td></tr></table></td></tr></table><h2>Summary</h2> @@ -16,18 +16,20 @@ This module is experimental. Documentation is still under development... management modules. Two storage management modules are included in the base Apache distribution:</p> <dl> - <dt><em>mod_disk_cache</em></dt> - <dd>implements a disk based storage manager for use with mod_proxy</dd> - <dt><em>mod_mem_cache</em></dt> + <dt><em><code><a href="../mod/mod_disk_cache.html">mod_disk_cache</a></code></em></dt> + <dd>implements a disk based storage manager for use with <code><a href="../mod/mod_proxy.html">mod_proxy</a></code></dd> + <dt><em><code><a href="../mod/mod_mem_cache.html">mod_mem_cache</a></code></em></dt> <dd>implements an in-memory based storage manager. mod_mem_cache can be configured to operate in two modes: caching open file - descriptors or caching objects in heap storage. <em>mod_mem_cache</em> + descriptors or caching objects in heap storage. <em><code><a href="../mod/mod_mem_cache.html">mod_mem_cache</a></code></em> is most useful when used to cache locally generated content or to cache backend server content for mod_proxy configured for ProxyPass (aka <em>reverse proxy</em>)</dd> </dl> <p>Content stored and retrived keyed to the URL. Content with access protections is not cached.</p> -<h2>Directives</h2><ul><li><a href="#cachedefaultexpire">CacheDefaultExpire</a></li><li><a href="#cachedisable">CacheDisable</a></li><li><a href="#cacheenable">CacheEnable</a></li><li><a href="#cacheignorecachecontrol">CacheIgnoreCacheControl</a></li><li><a href="#cacheignorenolastmod">CacheIgnoreNoLastMod</a></li><li><a href="#cachelastmodifiedfactor">CacheLastModifiedFactor</a></li><li><a href="#cachemaxexpire">CacheMaxExpire</a></li><li><a href="#cacheon">CacheOn</a></li></ul><h2>Sample Configuration</h2> + + <table border="1"><tr><td valign="top"><strong>Related Modules</strong><br><br><code><a href="../mod/mod_disk_cache.html">mod_disk_cache</a></code><br><code><a href="../mod/mod_mem_cache.html">mod_mem_cache</a></code><br></td><td valign="top"><strong>Related Directives</strong><br><br><a href="../mod/mod_disk_cache.html#cacheroot" class="directive"><code class="directive">CacheRoot</code></a><br><a href="../mod/mod_disk_cache.html#cachesize" class="directive"><code class="directive">CacheSize</code></a><br><a href="../mod/mod_disk_cache.html#cachegcinterval" class="directive"><code class="directive">CacheGcInterval</code></a><br><a href="../mod/mod_disk_cache.html#cachedirlevels" class="directive"><code class="directive">CacheDirLevels</code></a><br><a href="../mod/mod_disk_cache.html#cachedirlength" class="directive"><code class="directive">CacheDirLength</code></a><br><a href="../mod/mod_disk_cache.html#cacheexpirycheck" class="directive"><code class="directive">CacheExpiryCheck</code></a><br><a href="../mod/mod_disk_cache.html#cacheminfilesize" class="directive"><code class="directive">CacheMinFileSize</code></a><br><a href="../mod/mod_disk_cache.html#cachemaxfilesize" class="directive"><code class="directive">CacheMaxFileSize</code></a><br><a href="../mod/mod_disk_cache.html#cachetimemargin" class="directive"><code class="directive">CacheTimeMargin</code></a><br><a href="../mod/mod_disk_cache.html#cachegcdaily" class="directive"><code class="directive">CacheGcDaily</code></a><br><a href="../mod/mod_disk_cache.html#cachegcunused" class="directive"><code class="directive">CacheGcUnused</code></a><br><a href="../mod/mod_disk_cache.html#cachegcclean" class="directive"><code class="directive">CacheGcClean</code></a><br><a href="../mod/mod_disk_cache.html#cachegcmemusage" class="directive"><code class="directive">CacheGcMemUsage</code></a><br><a href="../mod/mod_mem_cache.html#mcachesize" class="directive"><code class="directive">MCacheSize</code></a><br><a href="../mod/mod_mem_cache.html#mcachemaxobjectcount" class="directive"><code class="directive">MCacheMaxObjectCount</code></a><br><a href="../mod/mod_mem_cache.html#mcacheminobjectsize" class="directive"><code class="directive">MCacheMinObjectSize</code></a><br><a href="../mod/mod_mem_cache.html#mcachemaxobjectsize" class="directive"><code class="directive">MCacheMaxObjectSize</code></a><br><a href="../mod/mod_mem_cache.html#mcacheremovalalgorithm" class="directive"><code class="directive">MCacheRemovalAlgorithm</code></a><br></td></tr></table> +<h2>Directives</h2><ul><li><a href="#cachedefaultexpire">CacheDefaultExpire</a></li><li><a href="#cachedisable">CacheDisable</a></li><li><a href="#cacheenable">CacheEnable</a></li><li><a href="#cacheforcecompletion">CacheForceCompletion</a></li><li><a href="#cacheforcecompletion">CacheForceCompletion</a></li><li><a href="#cacheignorecachecontrol">CacheIgnoreCacheControl</a></li><li><a href="#cacheignorenolastmod">CacheIgnoreNoLastMod</a></li><li><a href="#cachelastmodifiedfactor">CacheLastModifiedFactor</a></li><li><a href="#cachemaxexpire">CacheMaxExpire</a></li><li><a href="#cacheon">CacheOn</a></li></ul><h2>Sample Configuration</h2> <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Sample httpd.conf</strong></p><code> @@ -41,7 +43,7 @@ LoadModule cache_module modules/mod_cache.so <br> #LoadModule disk_cache_module modules/mod_disk_cache.so <br> <IfModule mod_disk_cache.c> <br> CacheRoot c:/cacheroot <br> - CacheSize + CacheSize 256 <br> CacheEnable disk / <br> CacheDirLevels 5 <br> CacheDirLength 3 <br> @@ -62,11 +64,13 @@ LoadModule cache_module modules/mod_cache.so <br> <hr><h2><a name="CacheDefaultExpire">CacheDefaultExpire</a> <a name="cachedefaultexpire">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax: - </a></td><td></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context: + </a></td><td>CacheDefaultExpire <em>seconds</em></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Default" class="help">Default: + </a></td><td><code>CacheDefaultExpire 3600 (one hour)</code></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context: </a></td><td>server config</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status: </a></td><td>Experimental</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module: </a></td><td>mod_cache</td></tr></table></td></tr></table> - <p>The default time in seconds to cache a document.</p> + <p>The default time in seconds to cache a document if the page does not have + an expiry date in the <em>Expires</em> field.</p> <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code> CacheDefaultExpire 86400 </code></td></tr></table></blockquote> @@ -101,9 +105,39 @@ LoadModule cache_module modules/mod_cache.so <br> CacheEnable mem /manual <br> CacheEnable fd /images <br> </code></td></tr></table></blockquote> +<hr><h2><a name="CacheForceCompletion">CacheForceCompletion</a> <a name="cacheforcecompletion">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: + </strong></td><td>Percentage of download to arrive for the cache to force complete transfert</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax: + </a></td><td>CacheLastModifiedFactor <em>Percentage</em></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Default" class="help">Default: + </a></td><td><code>CacheLastModifiedFactor 60</code></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context: + </a></td><td>server config</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status: + </a></td><td>Experimental</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module: + </a></td><td>mod_cache</td></tr></table></td></tr></table> + <p>Percentage of download to arrive for the cache to force complete transfert.</p> + + <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code> + CacheForceCompletion + </code></td></tr></table></blockquote> +<blockquote><table><tr><td bgcolor="#ffe5f5"> +This feature is currently <em>not</em> implemented. +</td></tr></table></blockquote> + <hr><h2><a name="CacheForceCompletion">CacheForceCompletion</a> <a name="cacheforcecompletion">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: + </strong></td><td>Percentage of download to arrive for the cache to force complete transfert</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax: + </a></td><td>CacheLastModifiedFactor <em>Percentage</em></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Default" class="help">Default: + </a></td><td><code>CacheLastModifiedFactor 60</code></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context: + </a></td><td>server config</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status: + </a></td><td>Experimental</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module: + </a></td><td>mod_cache</td></tr></table></td></tr></table> + <p>Percentage of download to arrive for the cache to force complete transfert.</p> + + <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code> + CacheForceCompletion + </code></td></tr></table></blockquote> +<blockquote><table><tr><td bgcolor="#ffe5f5"> +This feature is currently <em>not</em> implemented. +</td></tr></table></blockquote> <hr><h2><a name="CacheIgnoreCacheControl">CacheIgnoreCacheControl</a> <a name="cacheignorecachecontrol">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>Ignore requests from the client for uncached content</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax: - </a></td><td></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context: + </a></td><td>CacheIgnoreCacheControl</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context: </a></td><td>server config</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status: </a></td><td>Experimental</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module: </a></td><td>mod_cache</td></tr></table></td></tr></table> @@ -114,7 +148,7 @@ LoadModule cache_module modules/mod_cache.so <br> </code></td></tr></table></blockquote> <hr><h2><a name="CacheIgnoreNoLastMod">CacheIgnoreNoLastMod</a> <a name="cacheignorenolastmod">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>Ignore responses where there is no Last Modified Header</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax: - </a></td><td></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context: + </a></td><td>CacheIgnoreNoLastMod</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context: </a></td><td>server config</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status: </a></td><td>Experimental</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module: </a></td><td>mod_cache</td></tr></table></td></tr></table> @@ -125,7 +159,8 @@ LoadModule cache_module modules/mod_cache.so <br> </code></td></tr></table></blockquote> <hr><h2><a name="CacheLastModifiedFactor">CacheLastModifiedFactor</a> <a name="cachelastmodifiedfactor">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>The factor used to estimate the Expires date from the LastModified date</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax: - </a></td><td></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context: + </a></td><td>CacheLastModifiedFactor <em>float</em></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Default" class="help">Default: + </a></td><td><code>CacheLastModifiedFactor 0.1</code></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context: </a></td><td>server config</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status: </a></td><td>Experimental</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module: </a></td><td>mod_cache</td></tr></table></td></tr></table> @@ -136,11 +171,13 @@ LoadModule cache_module modules/mod_cache.so <br> </code></td></tr></table></blockquote> <hr><h2><a name="CacheMaxExpire">CacheMaxExpire</a> <a name="cachemaxexpire">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>The maximum time in seconds to cache a document</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax: - </a></td><td></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context: + </a></td><td>CacheMaxExpire <em>seconds</em></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Default" class="help">Default: + </a></td><td><code>CacheMaxExpire 86400 (one day)</code></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context: </a></td><td>server config</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status: </a></td><td>Experimental</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module: </a></td><td>mod_cache</td></tr></table></td></tr></table> - <p>The maximum time in seconds to cache a document.</p> + <p>The maximum time in seconds to cache a document. The <code class="directive">CacheMaxExpire</code> + takes precedence over the <em>Expire</em> field from the header.</p> <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code> CacheMaxExpire 604800 </code></td></tr></table></blockquote> |