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