granicus.if.org Git - apache/blob - docs/manual/mod/mod_cache.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <modulesynopsis>
   5
   6 <name>mod_cache</name>
   7 <description>Content cache keyed to URIs.</description>
   8 <status>Experimental</status>
   9 <sourcefile>mod_cache.c</sourcefile>
  10 <identifier>cache_module</identifier>
  11
  12 <summary>
  13     <note type="warning">
  14     This module is experimental. Documentation is still under development...
  15     </note>
  16     <p>mod_cache implements an RFC 2616 compliant HTTP content
  17     cache that can be used to cache either local or proxied content.
  18     mod_cache requires the services of one or more storage
  19     management modules. Two storage management modules are included in
  20     the base Apache distribution:</p>
  21     <dl>
  22     <dt><em><module>mod_disk_cache</module></em></dt>
  23     <dd>implements a disk based storage manager for use with <module>mod_proxy</module></dd>
  24     <dt><em><module>mod_mem_cache</module></em></dt>
  25     <dd>implements an in-memory based storage manager. mod_mem_cache
  26     can be configured to operate in two modes: caching open file
  27     descriptors or caching objects in heap storage. <em><module>mod_mem_cache</module></em>
  28     is most useful when used to cache locally generated content or to cache
  29     backend server content for mod_proxy configured for ProxyPass (aka <em>reverse proxy</em>)</dd>
  30     </dl>
  31     <p>Content stored and retrived keyed to the URL. Content with
  32     access protections is not cached.</p>
  33 </summary>
  34
  35 <section id="related"><title>Related Modules and Directives</title>
  36     <related>
  37       <modulelist>
  38         <module>mod_disk_cache</module>
  39         <module>mod_mem_cache</module>
  40       </modulelist>
  41       <directivelist>
  42         <directive module="mod_disk_cache">CacheRoot</directive>
  43         <directive module="mod_disk_cache">CacheSize</directive>
  44         <directive module="mod_disk_cache">CacheGcInterval</directive>
  45         <directive module="mod_disk_cache">CacheDirLevels</directive>
  46         <directive module="mod_disk_cache">CacheDirLength</directive>
  47         <directive module="mod_disk_cache">CacheExpiryCheck</directive>
  48         <directive module="mod_disk_cache">CacheMinFileSize</directive>
  49         <directive module="mod_disk_cache">CacheMaxFileSize</directive>
  50         <directive module="mod_disk_cache">CacheTimeMargin</directive>
  51         <directive module="mod_disk_cache">CacheGcDaily</directive>
  52         <directive module="mod_disk_cache">CacheGcUnused</directive>
  53         <directive module="mod_disk_cache">CacheGcClean</directive>
  54         <directive module="mod_disk_cache">CacheGcMemUsage</directive>
  55         <directive module="mod_mem_cache">MCacheSize</directive>
  56         <directive module="mod_mem_cache">MCacheMaxObjectCount</directive>
  57         <directive module="mod_mem_cache">MCacheMinObjectSize</directive>
  58         <directive module="mod_mem_cache">MCacheMaxObjectSize</directive>
  59         <directive module="mod_mem_cache">MCacheRemovalAlgorithm</directive>
  60       </directivelist>
  61     </related>
  62 </section>
  63
  64 <section><title>Sample Configuration</title>
  65 <example><title>Sample httpd.conf</title>
  66 # <br />
  67 # Sample Cache Configuration  <br />
  68 # <br />
  69 LoadModule cache_module modules/mod_cache.so  <br />
  70 &lt;IfModule mod_cache.c&gt;<br />
  71    CacheOn On<br />
  72 <p />
  73    #LoadModule disk_cache_module modules/mod_disk_cache.so <br />
  74    &lt;IfModule mod_disk_cache.c&gt; <br />
  75       CacheRoot c:/cacheroot <br />
  76       CacheSize 256 <br />
  77       CacheEnable disk  / <br />
  78       CacheDirLevels 5 <br />
  79       CacheDirLength 3 <br />
  80    &lt;/IfModule&gt; <br />
  81 <p />
  82    LoadModule mem_cache_module modules/mod_mem_cache.so <br />
  83    &lt;IfModule mod_mem_cache.c&gt; <br />
  84       MCacheEnable mem  / <br />
  85       MCacheSize 4096 <br />
  86       MCacheMaxObjectCount 100 <br />
  87       MCacheMinObjectSize 1 <br />
  88       MCacheMaxObjectSize 2048 <br />
  89    &lt;/IfModule&gt; <br />
  90 <p />
  91 &lt;/IfModule&gt; <br />
  92 </example>
  93 </section>
  94
  95 <directivesynopsis>
  96 <name>CacheOn</name>
  97 <description></description>
  98 <syntax>CacheOn</syntax>
  99 <contextlist><context>server config</context></contextlist>
 100
 101 <usage>
 102     <p>
 103     </p>
 104
 105
 106 <example>
 107   CacheOn
 108 </example>
 109 </usage>
 110 </directivesynopsis>
 111
 112 <directivesynopsis>
 113 <name>CacheEnable</name>
 114 <description>Enable caching specified URLs in a specified storage manager</description>
 115 <syntax>CacheEnable <em>cache_type </em><em> url-string</em></syntax>
 116 <contextlist><context>server config</context></contextlist>
 117
 118 <usage>
 119     <p>The <directive>CacheEnable</directive> directive instructs
 120     mod_cache to cache urls at or below <em>url-string</em>.
 121     The cache store is specified with the <em>cache_type</em> argument.
 122     <em>cache_type </em> <em> mem</em> instructs mod_cache to use the
 123     in-memory cache storage manager implemented by <em>mod_mem_cache</em>.
 124     <em>cache_type </em> <em> disk</em> instructs mod_cache to use the
 125     cache storage manager implemented by <em>mod_disk_cache </em>. </p>
 126
 127 <example>
 128   CacheEnable  disk  / <br />
 129   CacheEnable  mem   /manual <br />
 130   CacheEnable  fd    /images <br />
 131 </example>
 132 </usage>
 133
 134 </directivesynopsis>
 135
 136 <directivesynopsis>
 137 <name>CacheDisable</name>
 138 <description>Disable caching of specified URLs by specified storage manager</description>
 139 <syntax>CacheDisable <em>cache_type </em> <em> url-string</em></syntax>
 140 <contextlist><context>server config</context></contextlist>
 141
 142 <usage>
 143     <p>The <directive>CacheDisable</directive> directive instructs
 144     mod_cache to <em>not</em> cache urls at or above <em>url-string</em>.</p>
 145
 146 <example><title>Example</title>
 147   CacheDisable disk /local_files
 148 </example>
 149 </usage>
 150
 151 </directivesynopsis>
 152 <directivesynopsis>
 153 <name>CacheMaxExpire</name>
 154 <description>The maximum time in seconds to cache a document</description>
 155 <syntax>CacheMaxExpire <em>seconds</em></syntax>
 156 <default>CacheMaxExpire 86400 (one day)</default>
 157 <contextlist><context>server config</context></contextlist>
 158
 159 <usage>
 160     <p>The maximum time in seconds to cache a document. The <directive>CacheMaxExpire</directive>
 161     takes precedence over the <em>Expire</em> field from the header.</p>
 162     <example>
 163     CacheMaxExpire 604800
 164     </example>
 165 </usage>
 166 </directivesynopsis>
 167 <directivesynopsis>
 168 <name>CacheDefaultExpire</name>
 169 <syntax>CacheDefaultExpire <em>seconds</em></syntax>
 170 <default>CacheDefaultExpire 3600 (one hour)</default>
 171 <contextlist><context>server config</context></contextlist>
 172
 173 <usage>
 174     <p>The default time in seconds to cache a document if the page does not have
 175     an expiry date in the <em>Expires</em> field.</p>
 176     <example>
 177     CacheDefaultExpire 86400
 178     </example>
 179 </usage>
 180 </directivesynopsis>
 181
 182 <directivesynopsis>
 183 <name>CacheIgnoreNoLastMod</name>
 184 <description>Ignore responses where there is no Last Modified Header</description>
 185 <syntax>CacheIgnoreNoLastMod</syntax>
 186 <contextlist><context>server config</context></contextlist>
 187
 188 <usage>
 189     <p>Ignore responses where there is no Last Modified Header</p>
 190
 191     <example>
 192     CacheIgnoreNoLastMod
 193     </example>
 194 </usage>
 195 </directivesynopsis>
 196
 197 <directivesynopsis>
 198 <name>CacheIgnoreCacheControl</name>
 199 <description>Ignore requests from the client for uncached content</description>
 200 <syntax>CacheIgnoreCacheControl</syntax>
 201 <contextlist><context>server config</context></contextlist>
 202
 203 <usage>
 204     <p>Ignore requests from the client for uncached content</p>
 205
 206     <example>
 207     CacheIgnoreNoLastMod
 208     </example>
 209 </usage>
 210 </directivesynopsis>
 211
 212 <directivesynopsis>
 213 <name>CacheLastModifiedFactor</name>
 214 <description>The factor used to estimate the Expires date from the LastModified date</description>
 215 <syntax>CacheLastModifiedFactor <em>float</em></syntax>
 216 <default>CacheLastModifiedFactor 0.1</default>
 217 <contextlist><context>server config</context></contextlist>
 218
 219 <usage>
 220     <p>The factor used to estimate the Expires date from the LastModified date.</p>
 221
 222     <example>
 223     CacheLastModifiedFactor
 224     </example>
 225 </usage>
 226 </directivesynopsis>
 227
 228 <directivesynopsis>
 229 <name>CacheForceCompletion</name>
 230 <description>Percentage of download to arrive for the cache to force complete transfert</description>
 231 <syntax>CacheLastModifiedFactor <em>Percentage</em></syntax>
 232 <default>CacheLastModifiedFactor 60</default>
 233 <contextlist><context>server config</context></contextlist>
 234
 235 <usage>
 236     <p>Percentage of download to arrive for the cache to force complete transfert.</p>
 237
 238     <example>
 239     CacheForceCompletion
 240     </example>
 241 <note type="warning">
 242 This feature is currently <em>not</em> implemented.
 243 </note>
 244  </usage>
 245  </directivesynopsis>
 246
 247 <directivesynopsis>
 248 <name>CacheForceCompletion</name>
 249 <description>Percentage of download to arrive for the cache to force complete transfert</description>
 250 <syntax>CacheLastModifiedFactor <em>Percentage</em></syntax>
 251 <default>CacheLastModifiedFactor 60</default>
 252 <contextlist><context>server config</context></contextlist>
 253
 254 <usage>
 255     <p>Percentage of download to arrive for the cache to force complete transfert.</p>
 256
 257     <example>
 258     CacheForceCompletion
 259     </example>
 260 <note type="warning">
 261 This feature is currently <em>not</em> implemented.
 262 </note>
 263 </usage>
 264 </directivesynopsis>
 265
 266 </modulesynopsis>