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