mod_cache.xml revision 721fdd19e2abef2e8dc46eb5c022ef14efe3367e
45N/A<?xml version="1.0"?>
45N/A<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
45N/A<?xml-stylesheet type="text/xsl" href="/style/manual.xsl"?>
45N/A<modulesynopsis>
45N/A
45N/A<name>mod_cache</name>
45N/A<description>Content cache keyed to URIs</description>
45N/A<status>Experimental</status>
45N/A<sourcefile>mod_cache.c</sourcefile>
45N/A<identifier>cache_module</identifier>
45N/A
45N/A<summary>
45N/A
45N/A<note type="warning">
45N/AThis module is experimental. Documentation is still under development...
45N/A</note>
45N/A <p>mod_cache implements an RFC 2616 compliant HTTP content
45N/A cache that can be used to cache either local or proxied content.
45N/A mod_cache requires the services of one or more storage
45N/A management modules. Two storage management modules are included in
45N/A the base Apache distribution: <em>mod_disk_cache</em> implements a
45N/A disk based storage manager (generally used for proxy caching) and
45N/A <em>mod_mem_cache</em> implements an in-memory based storage
45N/A manager (primarily useful for caching local content). </p>
45N/A
45N/A <p>Content stored and retrived keyed to the URL. Content with
45N/A access protections is not cached.</p>
45N/A
45N/A</summary>
45N/A
45N/A<section><title>Sample Configuration</title>
45N/A
45N/A<example><title>Sample httpd.conf</title>
45N/A
45N/A# <br />
45N/A# Sample Cache Configuration <br />
45N/A# <br />
45N/ALoadModule cache_module modules/mod_cache.so <br />
45N/A&lt;IfModule mod_cache.c&gt;<br />
45N/A CacheOn On<br />
45N/A<p />
45N/A #LoadModule disk_cache_module modules/mod_disk_cache.so <br />
45N/A &lt;IfModule mod_disk_cache.c&gt; <br />
45N/A CacheRoot c:/cacheroot <br />
45N/A CacheEnable disk / <br />
45N/A CacheDirLevels 5 <br />
45N/A CacheDirLength 3 <br />
45N/A &lt;/IfModule&gt; <br />
45N/A<p />
45N/A LoadModule mem_cache_module modules/mod_mem_cache.so <br />
45N/A &lt;IfModule mod_mem_cache.c&gt; <br />
45N/A CacheEnable mem / <br />
45N/A CacheSize 4096 <br />
45N/A CacheMaxObjectCount 100 <br />
45N/A CacheMinObjectSize 1 <br />
45N/A CacheMaxObjectSize 2048 <br />
45N/A &lt;/IfModule&gt; <br />
45N/A<p />
45N/A&lt;/IfModule&gt; <br />
45N/A
45N/A</example>
45N/A
45N/A</section>
45N/A
45N/A<directivesynopsis>
45N/A<name>CacheOn</name>
45N/A<description></description>
45N/A<syntax>CacheOn</syntax>
45N/A<contextlist><context>server config</context></contextlist>
45N/A
45N/A<usage>
45N/A <p>
45N/A </p>
45N/A
45N/A
45N/A<example>
45N/A CacheOn
45N/A</example>
45N/A</usage>
45N/A</directivesynopsis>
45N/A
45N/A<directivesynopsis>
45N/A<name>CacheEnable</name>
45N/A<description>Enable caching specified URLs in a specified storage manager</description>
45N/A<syntax>CacheEnable <em>cache_type </em><em> url-string</em></syntax>
45N/A<contextlist><context>server config</context></contextlist>
45N/A
45N/A<usage>
45N/A <p>The <directive>CacheEnable</directive> directive instructs
45N/A mod_cache to cache urls at or below <em>url-string</em>.
45N/A The cache store is specified with the <em>cache_type</em> argument.
45N/A <em>cache_type </em> <em> mem</em> instructs mod_cache to use the
45N/A in-memory cache storage manager implemented by <em>mod_mem_cache</em>.
45N/A <em>cache_type </em> <em> disk</em> instructs mod_cache to use the
45N/A cache storage manager implemented by <em>mod_disk_cache </em>. </p>
45N/A
45N/A<example>
45N/A CacheEnable disk / <br />
45N/A CacheEnable mem /manual
45N/A</example>
45N/A</usage>
45N/A
45N/A</directivesynopsis>
45N/A
45N/A<directivesynopsis>
45N/A<name>CacheDisable</name>
45N/A<description>Disable caching of specified URLs by specified storage manager</description>
45N/A<syntax>CacheDisable <em>cache_type </em> <em> url-string</em></syntax>
45N/A<contextlist><context>server config</context></contextlist>
45N/A
45N/A<usage>
45N/A <p>The <directive>CacheDisable</directive> directive instructs
45N/A mod_cache to <em>not</em> cache urls at or above <em>url-string</em>.</p>
45N/A
45N/A<example><title>Example</title>
45N/A CacheDisable disk /local_files
45N/A</example>
45N/A</usage>
45N/A
45N/A</directivesynopsis>
45N/A<directivesynopsis>
45N/A<name>CacheMaxExpire</name>
45N/A<description>The maximum time in seconds to cache a document</description>
45N/A<syntax></syntax>
45N/A<contextlist><context>server config</context></contextlist>
45N/A
45N/A<usage>
45N/A <p>The maximum time in seconds to cache a document.</p>
45N/A <example>
45N/A CacheMaxExpire 604800
45N/A </example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>CacheDefaultExpire</name>
<syntax></syntax>
<contextlist><context>server config</context></contextlist>
<usage>
<p>The default time in seconds to cache a document.</p>
<example>
CacheDefaultExpire 86400
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>CacheIgnoreNoLastMod</name>
<description>Ignore responses where there is no Last Modified Header</description>
<syntax></syntax>
<contextlist><context>server config</context></contextlist>
<usage>
<p>Ignore responses where there is no Last Modified Header</p>
<example>
CacheIgnoreNoLastMod
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>CacheIgnoreCacheControl</name>
<description>Ignore requests from the client for uncached content</description>
<syntax></syntax>
<contextlist><context>server config</context></contextlist>
<usage>
<p>Ignore requests from the client for uncached content</p>
<example>
CacheIgnoreNoLastMod
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>CacheLastModifiedFactor</name>
<description>The factor used to estimate the Expires date from the LastModified date</description>
<syntax></syntax>
<contextlist><context>server config</context></contextlist>
<usage>
<p>The factor used to estimate the Expires date from the LastModified date.</p>
<example>
CacheLastModifiedFactor
</example>
</usage>
</directivesynopsis>
</modulesynopsis>