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

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_cache - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  17 <div id="page-header">
  18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  19 <p class="apache">Apache HTTP Server Version 2.5</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_cache</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_cache.html" title="English">&nbsp;en&nbsp;</a> |
  28 <a href="../fr/mod/mod_cache.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  29 <a href="../ja/mod/mod_cache.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  30 <a href="../ko/mod/mod_cache.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  31 </div>
  32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>RFC 2616 compliant HTTP caching filter.</td></tr>
  33 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  34 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>cache_module</td></tr>
  35 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_cache.c</td></tr></table>
  36 <h3>Summary</h3>
  37
  38     <div class="warning">This module should be used with care, as when the
  39     <code class="directive"><a href="#cachequickhandler">CacheQuickHandler</a></code> directive is
  40     in its default value of <strong>on</strong>, the <code class="directive"><a href="../mod/mod_access_compat.html#allow">Allow</a></code> and <code class="directive"><a href="../mod/mod_access_compat.html#deny">Deny</a></code> directives will be circumvented.
  41     You should not enable quick handler caching for any content to which you
  42     wish to limit access by client host name, address or environment
  43     variable.</div>
  44
  45     <p><code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> implements an <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</a> compliant
  46     <strong>HTTP content caching filter</strong>, with support for the caching
  47     of content negotiated responses containing the Vary header.</p>
  48
  49     <p>RFC 2616 compliant caching provides a mechanism to verify whether
  50     stale or expired content is still fresh, and can represent a significant
  51     performance boost when the origin server supports <strong>conditional
  52     requests</strong> by honouring the
  53     <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26">If-None-Match</a>
  54     HTTP request header. Content is only regenerated from scratch when the content
  55     has changed, and not when the cached entry expires.</p>
  56
  57     <p>As a filter, <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> can be placed in front of
  58     content originating from any handler, including <strong>flat
  59     files</strong> (served from a slow disk cached on a fast disk), the output
  60     of a <strong>CGI script</strong> or <strong>dynamic content
  61     generator</strong>, or content <strong>proxied from another
  62     server</strong>.</p>
  63
  64     <p>In the default configuration, <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> inserts the
  65     caching filter as far forward as possible within the filter stack,
  66     utilising the <strong>quick handler</strong> to bypass all per request
  67     processing when returning content to the client. In this mode of
  68     operation, <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> may be thought of as a caching
  69     proxy server bolted to the front of the webserver, while running within
  70     the webserver itself.</p>
  71
  72     <p>When the quick handler is switched off using the
  73     <code class="directive"><a href="#cachequickhandler">CacheQuickHandler</a></code> directive,
  74     it becomes possible to insert the <strong>CACHE</strong> filter at a
  75     point in the filter stack chosen by the administrator. This provides the
  76     opportunity to cache content before that content is personalised by the
  77     <code class="module"><a href="../mod/mod_include.html">mod_include</a></code> filter, or optionally compressed by the
  78     <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code> filter.</p>
  79
  80     <p>Under normal operation, <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> will respond to
  81     and can be controlled by the
  82     <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9">Cache-Control</a>
  83     and
  84     <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.32">Pragma</a>
  85     headers sent from a client in a request, or from a
  86     server within a response. Under exceptional circumstances,
  87     <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> can be configured to override these headers
  88     and force site specific behaviour, however such behaviour will be limited
  89     to this cache only, and will not affect the operation of other caches
  90     that may exist between the client and server, and as a result is not
  91     recommended unless strictly necessary.</p>
  92
  93     <p>RFC 2616 allows for the cache to return stale data while the existing
  94     stale entry is refreshed from the origin server, and this is supported
  95     by <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> when the
  96     <code class="directive"><a href="#cachelock">CacheLock</a></code> directive is suitably
  97     configured. Such responses will contain a
  98     <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.46">Warning</a>
  99     HTTP header with a 110 response code. RFC 2616 also allows a cache to return
 100     stale data when the attempt made to refresh the stale data returns an
 101     error 500 or above, and this behaviour is supported by default by
 102     <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code>. Such responses will contain a
 103     <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.46">Warning</a>
 104     HTTP header with a 111 response code.</p>
 105
 106     <p><code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> requires the services of one or more
 107     storage management modules. One storage management module is included in
 108     the base Apache distribution:</p>
 109     <dl>
 110     <dt><code class="module"><a href="../mod/mod_cache_disk.html">mod_cache_disk</a></code></dt>
 111     <dd>Implements a disk based storage manager. Headers and bodies are
 112     stored separately on disk, in a directory structure derived from the
 113     md5 hash of the cached URL. Multiple content negotiated responses can
 114     be stored concurrently, however the caching of partial content is not
 115     supported by this module. The <code class="program"><a href="../programs/htcacheclean.html">htcacheclean</a></code> tool is
 116     provided to list cached URLs, remove cached URLs, or to maintain the size
 117     of the disk cache within size and inode limits.</dd>
 118     <dt><code class="module"><a href="../mod/mod_cache_socache.html">mod_cache_socache</a></code></dt>
 119     <dd>Implements a shared object cache based storage manager. Headers and
 120     bodies are stored together beneath a single key based on the URL of the
 121     response being cached. Multiple content negotiated responses can
 122     be stored concurrently, however the caching of partial content is not
 123     supported by this module.</dd>
 124     </dl>
 125
 126     <p>Further details, discussion, and examples, are provided in the
 127     <a href="../caching.html">Caching Guide</a>.</p>
 128 </div>
 129 <div id="quickview"><h3 class="directives">Directives</h3>
 130 <ul id="toc">
 131 <li><img alt="" src="../images/down.gif" /> <a href="#cachedefaultexpire">CacheDefaultExpire</a></li>
 132 <li><img alt="" src="../images/down.gif" /> <a href="#cachedetailheader">CacheDetailHeader</a></li>
 133 <li><img alt="" src="../images/down.gif" /> <a href="#cachedisable">CacheDisable</a></li>
 134 <li><img alt="" src="../images/down.gif" /> <a href="#cacheenable">CacheEnable</a></li>
 135 <li><img alt="" src="../images/down.gif" /> <a href="#cacheheader">CacheHeader</a></li>
 136 <li><img alt="" src="../images/down.gif" /> <a href="#cacheignorecachecontrol">CacheIgnoreCacheControl</a></li>
 137 <li><img alt="" src="../images/down.gif" /> <a href="#cacheignoreheaders">CacheIgnoreHeaders</a></li>
 138 <li><img alt="" src="../images/down.gif" /> <a href="#cacheignorenolastmod">CacheIgnoreNoLastMod</a></li>
 139 <li><img alt="" src="../images/down.gif" /> <a href="#cacheignorequerystring">CacheIgnoreQueryString</a></li>
 140 <li><img alt="" src="../images/down.gif" /> <a href="#cacheignoreurlsessionidentifiers">CacheIgnoreURLSessionIdentifiers</a></li>
 141 <li><img alt="" src="../images/down.gif" /> <a href="#cachekeybaseurl">CacheKeyBaseURL</a></li>
 142 <li><img alt="" src="../images/down.gif" /> <a href="#cachelastmodifiedfactor">CacheLastModifiedFactor</a></li>
 143 <li><img alt="" src="../images/down.gif" /> <a href="#cachelock">CacheLock</a></li>
 144 <li><img alt="" src="../images/down.gif" /> <a href="#cachelockmaxage">CacheLockMaxAge</a></li>
 145 <li><img alt="" src="../images/down.gif" /> <a href="#cachelockpath">CacheLockPath</a></li>
 146 <li><img alt="" src="../images/down.gif" /> <a href="#cachemaxexpire">CacheMaxExpire</a></li>
 147 <li><img alt="" src="../images/down.gif" /> <a href="#cacheminexpire">CacheMinExpire</a></li>
 148 <li><img alt="" src="../images/down.gif" /> <a href="#cachequickhandler">CacheQuickHandler</a></li>
 149 <li><img alt="" src="../images/down.gif" /> <a href="#cachestaleonerror">CacheStaleOnError</a></li>
 150 <li><img alt="" src="../images/down.gif" /> <a href="#cachestoreexpired">CacheStoreExpired</a></li>
 151 <li><img alt="" src="../images/down.gif" /> <a href="#cachestorenostore">CacheStoreNoStore</a></li>
 152 <li><img alt="" src="../images/down.gif" /> <a href="#cachestoreprivate">CacheStorePrivate</a></li>
 153 </ul>
 154 <h3>Topics</h3>
 155 <ul id="topics">
 156 <li><img alt="" src="../images/down.gif" /> <a href="#related">Related Modules and Directives</a></li>
 157 <li><img alt="" src="../images/down.gif" /> <a href="#sampleconf">Sample Configuration</a></li>
 158 <li><img alt="" src="../images/down.gif" /> <a href="#thunderingherd">Avoiding the Thundering Herd</a></li>
 159 <li><img alt="" src="../images/down.gif" /> <a href="#finecontrol">Fine Control with the CACHE Filter</a></li>
 160 <li><img alt="" src="../images/down.gif" /> <a href="#status">Cache Status and Logging</a></li>
 161 </ul><h3>See also</h3>
 162 <ul class="seealso">
 163 <li><a href="../caching.html">Caching Guide</a></li>
 164 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
 165 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 166 <div class="section">
 167 <h2><a name="related" id="related">Related Modules and Directives</a></h2>
 168     <table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="../mod/mod_cache_disk.html">mod_cache_disk</a></code></li><li><code class="module"><a href="../mod/mod_cache_socache.html">mod_cache_socache</a></code></li></ul></td><td><ul><li><code class="directive"><a href="../mod/mod_cache_disk.html#cacheroot">CacheRoot</a></code></li><li><code class="directive"><a href="../mod/mod_cache_disk.html#cachedirlevels">CacheDirLevels</a></code></li><li><code class="directive"><a href="../mod/mod_cache_disk.html#cachedirlength">CacheDirLength</a></code></li><li><code class="directive"><a href="../mod/mod_cache_disk.html#cacheminfilesize">CacheMinFileSize</a></code></li><li><code class="directive"><a href="../mod/mod_cache_disk.html#cachemaxfilesize">CacheMaxFileSize</a></code></li><li><code class="directive"><a href="../mod/mod_cache_socache.html#cachesocache">CacheSocache</a></code></li><li><code class="directive"><a href="../mod/mod_cache_socache.html#cachesocachemaxtime">CacheSocacheMaxTime</a></code></li><li><code class="directive"><a href="../mod/mod_cache_socache.html#cachesocachemintime">CacheSocacheMinTime</a></code></li><li><code class="directive"><a href="../mod/mod_cache_socache.html#cachesocachemaxsize">CacheSocacheMaxSize</a></code></li><li><code class="directive"><a href="../mod/mod_cache_socache.html#cachesocachereadsize">CacheSocacheReadSize</a></code></li><li><code class="directive"><a href="../mod/mod_cache_socache.html#cachesocachereadtime">CacheSocacheReadTime</a></code></li></ul></td></tr></table>
 169 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 170 <div class="section">
 171 <h2><a name="sampleconf" id="sampleconf">Sample Configuration</a></h2>
 172     <div class="example"><h3>Sample httpd.conf</h3><pre class="prettyprint lang-config">
 173 #
 174 # Sample Cache Configuration
 175 #
 176 LoadModule cache_module modules/mod_cache.so
 177 &lt;IfModule mod_cache.c&gt;
 178     LoadModule cache_disk_module modules/mod_cache_disk.so
 179     &lt;IfModule mod_cache_disk.c&gt;
 180         CacheRoot c:/cacheroot
 181         CacheEnable disk  /
 182         CacheDirLevels 5
 183         CacheDirLength 3
 184     &lt;/IfModule&gt;
 185
 186     # When acting as a proxy, don't cache the list of security updates
 187     CacheDisable http://security.update.server/update-list/
 188 &lt;/IfModule&gt;
 189       </pre>
 190 </div>
 191 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 192 <div class="section">
 193 <h2><a name="thunderingherd" id="thunderingherd">Avoiding the Thundering Herd</a></h2>
 194   <p>When a cached entry becomes stale, <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> will submit
 195   a conditional request to the backend, which is expected to confirm whether the
 196   cached entry is still fresh, and send an updated entity if not.</p>
 197   <p>A small but finite amount of time exists between the time the cached entity
 198   becomes stale, and the time the stale entity is fully refreshed. On a busy
 199   server, a significant number of requests might arrive during this time, and
 200   cause a <strong>thundering herd</strong> of requests to strike the backend
 201   suddenly and unpredictably.</p>
 202   <p>To keep the thundering herd at bay, the <code class="directive">CacheLock</code>
 203   directive can be used to define a directory in which locks are created for
 204   URLs <strong>in flight</strong>. The lock is used as a <strong>hint</strong>
 205   by other requests to either suppress an attempt to cache (someone else has
 206   gone to fetch the entity), or to indicate that a stale entry is being refreshed
 207   (stale content will be returned in the mean time).
 208   </p>
 209   <h3>Initial caching of an entry</h3>
 210
 211     <p>When an entity is cached for the first time, a lock will be created for the
 212     entity until the response has been fully cached. During the lifetime of the
 213     lock, the cache will suppress the second and subsequent attempt to cache the
 214     same entity. While this doesn't hold back the thundering herd, it does stop
 215     the cache attempting to cache the same entity multiple times simultaneously.
 216     </p>
 217
 218   <h3>Refreshment of a stale entry</h3>
 219
 220     <p>When an entity reaches its freshness lifetime and becomes stale, a lock
 221     will be created for the entity until the response has either been confirmed as
 222     still fresh, or replaced by the backend. During the lifetime of the lock, the
 223     second and subsequent incoming request will cause stale data to be returned,
 224     and the thundering herd is kept at bay.</p>
 225
 226   <h3>Locks and Cache-Control: no-cache</h3>
 227
 228     <p>Locks are used as a <strong>hint only</strong> to enable the cache to be
 229     more gentle on backend servers, however the lock can be overridden if necessary.
 230     If the client sends a request with a Cache-Control header forcing a reload, any
 231     lock that may be present will be ignored, and the client's request will be
 232     honored immediately and the cached entry refreshed.</p>
 233     <p>As a further safety mechanism, locks have a configurable maximum age.
 234     Once this age has been reached, the lock is removed, and a new request is
 235     given the opportunity to create a new lock. This maximum age can be set using
 236     the <code class="directive">CacheLockMaxAge</code> directive, and defaults to 5
 237     seconds.
 238     </p>
 239
 240   <h3>Example configuration</h3>
 241
 242     <div class="example"><h3>Enabling the cache lock</h3><pre class="prettyprint lang-config">
 243 #
 244 # Enable the cache lock
 245 #
 246 &lt;IfModule mod_cache.c&gt;
 247     CacheLock on
 248     CacheLockPath /tmp/mod_cache-lock
 249     CacheLockMaxAge 5
 250 &lt;/IfModule&gt;
 251       </pre>
 252 </div>
 253
 254 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 255 <div class="section">
 256 <h2><a name="finecontrol" id="finecontrol">Fine Control with the CACHE Filter</a></h2>
 257   <p>Under the default mode of cache operation, the cache runs as a quick handler,
 258   short circuiting the majority of server processing and offering the highest
 259   cache performance available.</p>
 260
 261   <p>In this mode, the cache <strong>bolts onto</strong> the front of the server,
 262   acting as if a free standing RFC 2616 caching proxy had been placed in front of
 263   the server.</p>
 264
 265   <p>While this mode offers the best performance, the administrator may find that
 266   under certain circumstances they may want to perform further processing on the
 267   request after the request is cached, such as to inject personalisation into the
 268   cached page, or to apply authorization restrictions to the content. Under these
 269   circumstances, an administrator is often forced to place independent reverse
 270   proxy servers either behind or in front of the caching server to achieve this.</p>
 271
 272   <p>To solve this problem the <code class="directive"><a href="#cachequickhandler">CacheQuickHandler
 273   </a></code> directive can be set to <strong>off</strong>, and the server will
 274   process all phases normally handled by a non-cached request, including the
 275   <strong>authentication and authorization</strong> phases.</p>
 276
 277   <p>In addition, the administrator may optionally specify the <strong>precise point
 278   within the filter chain</strong> where caching is to take place by adding the
 279   <strong>CACHE</strong> filter to the output filter chain.</p>
 280
 281   <p>For example, to cache content before applying compression to the response,
 282   place the <strong>CACHE</strong> filter before the <strong>DEFLATE</strong>
 283   filter as in the example below:</p>
 284
 285   <pre class="prettyprint lang-config">
 286 # Cache content before optional compression
 287 CacheQuickHandler off
 288 AddOutputFilterByType CACHE;DEFLATE text/plain
 289   </pre>
 290
 291
 292   <p>Another option is to have content cached before personalisation is applied
 293   by <code class="module"><a href="../mod/mod_include.html">mod_include</a></code> (or another content processing filter). In this
 294   example templates containing tags understood by
 295   <code class="module"><a href="../mod/mod_include.html">mod_include</a></code> are cached before being parsed:</p>
 296
 297   <pre class="prettyprint lang-config">
 298 # Cache content before mod_include and mod_deflate
 299 CacheQuickHandler off
 300 AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html
 301   </pre>
 302
 303
 304   <p>You may place the <strong>CACHE</strong> filter anywhere you wish within the
 305   filter chain. In this example, content is cached after being parsed by
 306   <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>, but before being processed by
 307   <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code>:</p>
 308
 309   <pre class="prettyprint lang-config">
 310 # Cache content between mod_include and mod_deflate
 311 CacheQuickHandler off
 312 AddOutputFilterByType INCLUDES;CACHE;DEFLATE text/html
 313   </pre>
 314
 315
 316   <div class="warning"><h3>Warning:</h3>If the location of the
 317   <strong>CACHE</strong> filter in the filter chain is changed for any reason,
 318   you may need to <strong>flush your cache</strong> to ensure that your data
 319   served remains consistent. <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> is not in a position
 320   to enforce this for you.</div>
 321
 322 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 323 <div class="section">
 324 <h2><a name="status" id="status">Cache Status and Logging</a></h2>
 325   <p>Once <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> has made a decision as to whether or not
 326   an entity is to be served from cache, the detailed reason for the decision
 327   is written to the subprocess environment within the request under the
 328   <strong>cache-status</strong> key. This reason can be logged by the
 329   <code class="directive"><a href="../mod/mod_log_config.html#logformat">LogFormat</a></code> directive as
 330   follows:</p>
 331
 332   <pre class="prettyprint lang-config">
 333     LogFormat "%{cache-status}e ..."
 334   </pre>
 335
 336
 337   <p>Based on the caching decision made, the reason is also written to the
 338   subprocess environment under one the following four keys, as appropriate:</p>
 339
 340   <dl>
 341     <dt>cache-hit</dt><dd>The response was served from cache.</dd>
 342     <dt>cache-revalidate</dt><dd>The response was stale and was successfully
 343       revalidated, then served from cache.</dd>
 344     <dt>cache-miss</dt><dd>The response was served from the upstream server.</dd>
 345     <dt>cache-invalidate</dt><dd>The cached entity was invalidated by a request
 346       method other than GET or HEAD.</dd>
 347   </dl>
 348
 349   <p>This makes it possible to support conditional logging of cached requests
 350   as per the following example:</p>
 351
 352   <pre class="prettyprint lang-config">
 353 CustomLog cached-requests.log common env=cache-hit
 354 CustomLog uncached-requests.log common env=cache-miss
 355 CustomLog revalidated-requests.log common env=cache-revalidate
 356 CustomLog invalidated-requests.log common env=cache-invalidate
 357   </pre>
 358
 359
 360   <p>For module authors, a hook called <var>cache_status</var> is available,
 361   allowing modules to respond to the caching outcomes above in customised
 362   ways.</p>
 363 </div>
 364 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 365 <div class="directive-section"><h2><a name="CacheDefaultExpire" id="CacheDefaultExpire">CacheDefaultExpire</a> <a name="cachedefaultexpire" id="cachedefaultexpire">Directive</a></h2>
 366 <table class="directive">
 367 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The default duration to cache a document when no expiry date is specified.</td></tr>
 368 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheDefaultExpire <var>seconds</var></code></td></tr>
 369 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheDefaultExpire 3600 (one hour)</code></td></tr>
 370 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 371 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 372 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 373 </table>
 374     <p>The <code class="directive">CacheDefaultExpire</code> directive specifies a default time,
 375     in seconds, to cache a document if neither an expiry date nor last-modified date are provided
 376     with the document. The value specified with the <code class="directive">CacheMaxExpire</code>
 377     directive does <em>not</em> override this setting.</p>
 378
 379     <pre class="prettyprint lang-config">
 380       CacheDefaultExpire 86400
 381     </pre>
 382
 383
 384 </div>
 385 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 386 <div class="directive-section"><h2><a name="CacheDetailHeader" id="CacheDetailHeader">CacheDetailHeader</a> <a name="cachedetailheader" id="cachedetailheader">Directive</a></h2>
 387 <table class="directive">
 388 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Add an X-Cache-Detail header to the response.</td></tr>
 389 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheDetailHeader <var>on|off</var></code></td></tr>
 390 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheDetailHeader off</code></td></tr>
 391 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 392 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 393 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 394 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.9 and later</td></tr>
 395 </table>
 396   <p>When the <code class="directive"><a href="#cachedetailheader">CacheDetailHeader</a></code> directive
 397   is switched on, an <strong>X-Cache-Detail</strong> header will be added to the response
 398   containing the detailed reason for a particular caching decision.</p>
 399
 400   <p>It can be useful during development of cached RESTful services to have additional
 401   information about the caching decision written to the response headers, so as to
 402   confirm whether <code>Cache-Control</code> and other headers have been correctly
 403   used by the service and client.</p>
 404
 405   <p>If the normal handler is used, this directive may appear within a
 406   <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code> or
 407   <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code> directive. If the quick handler
 408   is used, this directive must appear within a server or virtual host context, otherwise
 409   the setting will be ignored.</p>
 410
 411   <pre class="prettyprint lang-config">
 412 # Enable the X-Cache-Detail header
 413 CacheDetailHeader on
 414   </pre>
 415
 416
 417   <div class="example"><p><code>
 418     X-Cache-Detail: "conditional cache hit: entity refreshed" from localhost<br />
 419   </code></p></div>
 420
 421
 422 </div>
 423 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 424 <div class="directive-section"><h2><a name="CacheDisable" id="CacheDisable">CacheDisable</a> <a name="cachedisable" id="cachedisable">Directive</a></h2>
 425 <table class="directive">
 426 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Disable caching of specified URLs</td></tr>
 427 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheDisable <var>url-string</var> | <var>on</var></code></td></tr>
 428 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 429 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 430 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 431 </table>
 432     <p>The <code class="directive">CacheDisable</code> directive instructs
 433     <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> to <em>not</em> cache urls at or below
 434     <var>url-string</var>.</p>
 435
 436     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">
 437       CacheDisable /local_files
 438       </pre>
 439 </div>
 440
 441     <p>If used in a <code class="directive">&lt;Location&gt;</code> directive,
 442     the path needs to be specified below the Location, or if the word "on"
 443     is used, caching for the whole location will be disabled.</p>
 444
 445     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">
 446 &lt;Location /foo&gt;
 447     CacheDisable on
 448 &lt;/Location&gt;
 449       </pre>
 450 </div>
 451
 452     <p>The <code>no-cache</code> environment variable can be set to
 453     disable caching on a finer grained set of resources in versions
 454     2.2.12 and later.</p>
 455
 456
 457 <h3>See also</h3>
 458 <ul>
 459 <li><a href="../env.html">Environment Variables in Apache</a></li>
 460 </ul>
 461 </div>
 462 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 463 <div class="directive-section"><h2><a name="CacheEnable" id="CacheEnable">CacheEnable</a> <a name="cacheenable" id="cacheenable">Directive</a></h2>
 464 <table class="directive">
 465 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable caching of specified URLs using a specified storage
 466 manager</td></tr>
 467 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheEnable <var>cache_type</var> [<var>url-string</var>]</code></td></tr>
 468 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
 469 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 470 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 471 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>A url-string of '/' applied to forward proxy content in 2.2 and
 472  earlier.</td></tr>
 473 </table>
 474     <p>The <code class="directive">CacheEnable</code> directive instructs
 475     <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> to cache urls at or below
 476     <var>url-string</var>. The cache storage manager is specified with the
 477     <var>cache_type</var> argument. The <code class="directive">CacheEnable</code>
 478     directive can alternatively be placed inside either
 479     <code class="directive">&lt;Location&gt;</code> or
 480     <code class="directive">&lt;LocationMatch&gt;</code> sections to indicate
 481     the content is cacheable.
 482     <var>cache_type</var> <code>disk</code> instructs
 483     <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> to use the disk based storage manager
 484     implemented by <code class="module"><a href="../mod/mod_cache_disk.html">mod_cache_disk</a></code>. <var>cache_type</var>
 485     <code>socache</code> instructs <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code> to use the
 486     shared object cache based storage manager implemented by
 487     <code class="module"><a href="../mod/mod_cache_socache.html">mod_cache_socache</a></code>.</p>
 488     <p>In the event that the URL space overlaps between different
 489     <code class="directive">CacheEnable</code> directives (as in the example below),
 490     each possible storage manager will be run until the first one that
 491     actually processes the request. The order in which the storage managers are
 492     run is determined by the order of the <code class="directive">CacheEnable</code>
 493     directives in the configuration file. <code class="directive">CacheEnable</code>
 494     directives within <code class="directive">&lt;Location&gt;</code> or
 495     <code class="directive">&lt;LocationMatch&gt;</code> sections are processed
 496     before globally defined <code class="directive">CacheEnable</code> directives.</p>
 497
 498     <p>When acting as a forward proxy server, <var>url-string</var> must
 499     minimally begin with a protocol for which caching should be enabled.</p>
 500
 501     <pre class="prettyprint lang-config">
 502 # Cache content (normal handler only)
 503 CacheQuickHandler off
 504 &lt;Location /foo&gt;
 505     CacheEnable disk
 506 &lt;/Location&gt;
 507
 508 # Cache regex (normal handler only)
 509 CacheQuickHandler off
 510 &lt;LocationMatch foo$&gt;
 511     CacheEnable disk
 512 &lt;/LocationMatch&gt;
 513
 514 # Cache all but forward proxy url's (normal or quick handler)
 515 CacheEnable  disk  /
 516
 517 # Cache FTP-proxied url's (normal or quick handler)
 518 CacheEnable  disk  ftp://
 519
 520 # Cache forward proxy content from www.example.org (normal or quick handler)
 521 CacheEnable  disk  http://www.example.org/
 522     </pre>
 523
 524
 525     <p>A hostname starting with a <strong>"*"</strong> matches all hostnames with
 526     that suffix. A hostname starting with <strong>"."</strong> matches all
 527     hostnames containing the domain components that follow.</p>
 528
 529     <pre class="prettyprint lang-config">
 530 # Match www.example.org, and fooexample.org
 531 CacheEnable  disk  http://*example.org/
 532 # Match www.example.org, but not fooexample.org
 533 CacheEnable  disk  http://.example.org/
 534     </pre>
 535
 536
 537     <p> The <code>no-cache</code> environment variable can be set to
 538     disable caching on a finer grained set of resources in versions
 539     2.2.12 and later.</p>
 540
 541
 542 <h3>See also</h3>
 543 <ul>
 544 <li><a href="../env.html">Environment Variables in Apache</a></li>
 545 </ul>
 546 </div>
 547 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 548 <div class="directive-section"><h2><a name="CacheHeader" id="CacheHeader">CacheHeader</a> <a name="cacheheader" id="cacheheader">Directive</a></h2>
 549 <table class="directive">
 550 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Add an X-Cache header to the response.</td></tr>
 551 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheHeader <var>on|off</var></code></td></tr>
 552 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheHeader off</code></td></tr>
 553 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 554 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 555 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 556 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.9 and later</td></tr>
 557 </table>
 558   <p>When the <code class="directive"><a href="#cacheheader">CacheHeader</a></code> directive
 559   is switched on, an <strong>X-Cache</strong> header will be added to the response
 560   with the cache status of this response. If the normal handler is used, this
 561   directive may appear within a <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code>
 562   or <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code> directive. If the quick
 563   handler is used, this directive must appear within a server or virtual host
 564   context, otherwise the setting will be ignored.</p>
 565
 566   <dl>
 567     <dt><strong>HIT</strong></dt><dd>The entity was fresh, and was served from
 568     cache.</dd>
 569     <dt><strong>REVALIDATE</strong></dt><dd>The entity was stale, was successfully
 570     revalidated and was served from cache.</dd>
 571     <dt><strong>MISS</strong></dt><dd>The entity was fetched from the upstream
 572       server and was not served from cache.</dd>
 573   </dl>
 574
 575   <pre class="prettyprint lang-config">
 576 # Enable the X-Cache header
 577 CacheHeader on
 578   </pre>
 579
 580
 581   <pre class="prettyprint lang-config">
 582     X-Cache: HIT from localhost
 583   </pre>
 584
 585
 586
 587 </div>
 588 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 589 <div class="directive-section"><h2><a name="CacheIgnoreCacheControl" id="CacheIgnoreCacheControl">CacheIgnoreCacheControl</a> <a name="cacheignorecachecontrol" id="cacheignorecachecontrol">Directive</a></h2>
 590 <table class="directive">
 591 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ignore request to not serve cached content to client</td></tr>
 592 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheIgnoreCacheControl On|Off</code></td></tr>
 593 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheIgnoreCacheControl Off</code></td></tr>
 594 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 595 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 596 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 597 </table>
 598     <p>Ordinarily, requests containing a Cache-Control: no-cache or
 599     Pragma: no-cache header value will not be served from the cache.  The
 600     <code class="directive">CacheIgnoreCacheControl</code> directive allows this
 601     behavior to be overridden.  <code class="directive">CacheIgnoreCacheControl On</code>
 602     tells the server to attempt to serve the resource from the cache even
 603     if the request contains no-cache header values.</p>
 604
 605     <pre class="prettyprint lang-config">
 606       CacheIgnoreCacheControl On
 607     </pre>
 608
 609
 610     <div class="warning"><h3>Warning:</h3>
 611        This directive will allow serving from the cache even if the client has
 612        requested that the document not be served from the cache.  This might
 613        result in stale content being served.
 614     </div>
 615
 616 <h3>See also</h3>
 617 <ul>
 618 <li><code class="directive"><a href="#cachestoreprivate">CacheStorePrivate</a></code></li>
 619 <li><code class="directive"><a href="#cachestorenostore">CacheStoreNoStore</a></code></li>
 620 </ul>
 621 </div>
 622 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 623 <div class="directive-section"><h2><a name="CacheIgnoreHeaders" id="CacheIgnoreHeaders">CacheIgnoreHeaders</a> <a name="cacheignoreheaders" id="cacheignoreheaders">Directive</a></h2>
 624 <table class="directive">
 625 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Do not store the given HTTP header(s) in the cache.
 626 </td></tr>
 627 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheIgnoreHeaders <var>header-string</var> [<var>header-string</var>] ...</code></td></tr>
 628 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheIgnoreHeaders None</code></td></tr>
 629 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 630 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 631 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 632 </table>
 633     <p>According to RFC 2616, hop-by-hop HTTP headers are not stored in
 634     the cache.  The following HTTP headers are hop-by-hop headers and thus
 635     do not get stored in the cache in <em>any</em> case regardless of the
 636     setting of <code class="directive">CacheIgnoreHeaders</code>:</p>
 637
 638     <ul>
 639       <li><code>Connection</code></li>
 640       <li><code>Keep-Alive</code></li>
 641       <li><code>Proxy-Authenticate</code></li>
 642       <li><code>Proxy-Authorization</code></li>
 643       <li><code>TE</code></li>
 644       <li><code>Trailers</code></li>
 645       <li><code>Transfer-Encoding</code></li>
 646       <li><code>Upgrade</code></li>
 647     </ul>
 648
 649     <p><code class="directive">CacheIgnoreHeaders</code> specifies additional HTTP
 650     headers that should not to be stored in the cache.  For example, it makes
 651     sense in some cases to prevent cookies from being stored in the cache.</p>
 652
 653     <p><code class="directive">CacheIgnoreHeaders</code> takes a space separated list
 654     of HTTP headers that should not be stored in the cache. If only hop-by-hop
 655     headers not should be stored in the cache (the RFC 2616 compliant
 656     behaviour), <code class="directive">CacheIgnoreHeaders</code> can be set to
 657     <code>None</code>.</p>
 658
 659     <div class="example"><h3>Example 1</h3><pre class="prettyprint lang-config">
 660       CacheIgnoreHeaders Set-Cookie
 661       </pre>
 662 </div>
 663
 664     <div class="example"><h3>Example 2</h3><pre class="prettyprint lang-config">
 665       CacheIgnoreHeaders None
 666       </pre>
 667 </div>
 668
 669     <div class="warning"><h3>Warning:</h3>
 670       If headers like <code>Expires</code> which are needed for proper cache
 671       management are not stored due to a
 672       <code class="directive">CacheIgnoreHeaders</code> setting, the behaviour of
 673       mod_cache is undefined.
 674     </div>
 675
 676 </div>
 677 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 678 <div class="directive-section"><h2><a name="CacheIgnoreNoLastMod" id="CacheIgnoreNoLastMod">CacheIgnoreNoLastMod</a> <a name="cacheignorenolastmod" id="cacheignorenolastmod">Directive</a></h2>
 679 <table class="directive">
 680 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ignore the fact that a response has no Last Modified
 681 header.</td></tr>
 682 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheIgnoreNoLastMod On|Off</code></td></tr>
 683 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheIgnoreNoLastMod Off</code></td></tr>
 684 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 685 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 686 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 687 </table>
 688     <p>Ordinarily, documents without a last-modified date are not cached.
 689     Under some circumstances the last-modified date is removed (during
 690     <code class="module"><a href="../mod/mod_include.html">mod_include</a></code> processing for example) or not provided
 691     at all. The <code class="directive">CacheIgnoreNoLastMod</code> directive
 692     provides a way to specify that documents without last-modified dates
 693     should be considered for caching, even without a last-modified date.
 694     If neither a last-modified date nor an expiry date are provided with
 695     the document then the value specified by the
 696     <code class="directive">CacheDefaultExpire</code> directive will be used to
 697     generate an expiration date.</p>
 698
 699     <pre class="prettyprint lang-config">
 700       CacheIgnoreNoLastMod On
 701     </pre>
 702
 703
 704 </div>
 705 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 706 <div class="directive-section"><h2><a name="CacheIgnoreQueryString" id="CacheIgnoreQueryString">CacheIgnoreQueryString</a> <a name="cacheignorequerystring" id="cacheignorequerystring">Directive</a></h2>
 707 <table class="directive">
 708 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ignore query string when caching</td></tr>
 709 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheIgnoreQueryString On|Off</code></td></tr>
 710 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheIgnoreQueryString Off</code></td></tr>
 711 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 712 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 713 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 714 </table>
 715     <p>Ordinarily, requests with query string parameters are cached separately
 716     for each unique query string. This is according to RFC 2616/13.9 done only
 717     if an expiration time is specified. The
 718     <code class="directive">CacheIgnoreQueryString</code> directive tells the cache to
 719     cache requests even if no expiration time is specified, and to reply with
 720     a cached reply even if the query string differs. From a caching point of
 721     view the request is treated as if having no query string when this
 722     directive is enabled.</p>
 723
 724     <pre class="prettyprint lang-config">
 725       CacheIgnoreQueryString On
 726     </pre>
 727
 728
 729
 730 </div>
 731 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 732 <div class="directive-section"><h2><a name="CacheIgnoreURLSessionIdentifiers" id="CacheIgnoreURLSessionIdentifiers">CacheIgnoreURLSessionIdentifiers</a> <a name="cacheignoreurlsessionidentifiers" id="cacheignoreurlsessionidentifiers">Directive</a></h2>
 733 <table class="directive">
 734 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ignore defined session identifiers encoded in the URL when caching
 735 </td></tr>
 736 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheIgnoreURLSessionIdentifiers <var>identifier</var> [<var>identifier</var>] ...</code></td></tr>
 737 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheIgnoreURLSessionIdentifiers None</code></td></tr>
 738 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 739 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 740 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 741 </table>
 742     <p>Sometimes applications encode the session identifier into the URL like in the following
 743     Examples:
 744     </p>
 745     <ul>
 746       <li><code>/someapplication/image.gif;jsessionid=123456789</code></li>
 747       <li><code>/someapplication/image.gif?PHPSESSIONID=12345678</code></li>
 748     </ul>
 749     <p>This causes cachable resources to be stored separately for each session, which
 750     is often not desired. <code class="directive">CacheIgnoreURLSessionIdentifiers</code> lets
 751     define a list of identifiers that are removed from the key that is used to identify
 752     an entity in the cache, such that cachable resources are not stored separately for
 753     each session.
 754     </p>
 755     <p><code>CacheIgnoreURLSessionIdentifiers None</code> clears the list of ignored
 756     identifiers. Otherwise, each identifier is added to the list.</p>
 757
 758     <div class="example"><h3>Example 1</h3><pre class="prettyprint lang-config">
 759       CacheIgnoreURLSessionIdentifiers jsessionid
 760       </pre>
 761 </div>
 762
 763     <div class="example"><h3>Example 2</h3><pre class="prettyprint lang-config">
 764       CacheIgnoreURLSessionIdentifiers None
 765       </pre>
 766 </div>
 767
 768
 769 </div>
 770 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 771 <div class="directive-section"><h2><a name="CacheKeyBaseURL" id="CacheKeyBaseURL">CacheKeyBaseURL</a> <a name="cachekeybaseurl" id="cachekeybaseurl">Directive</a></h2>
 772 <table class="directive">
 773 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Override the base URL of reverse proxied cache keys.</td></tr>
 774 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheKeyBaseURL <var>URL</var></code></td></tr>
 775 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheKeyBaseURL http://example.com</code></td></tr>
 776 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 777 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 778 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 779 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.9 and later</td></tr>
 780 </table>
 781   <p>When the <code class="directive"><a href="#cachekeybaseurl">CacheKeyBaseURL</a></code> directive
 782   is specified, the URL provided will be used as the base URL to calculate
 783   the URL of the cache keys in the reverse proxy configuration. When not specified,
 784   the scheme, hostname and port of the current virtual host is used to construct
 785   the cache key. When a cluster of machines is present, and all cached entries
 786   should be cached beneath the same cache key, a new base URL can be specified
 787   with this directive.</p>
 788
 789   <pre class="prettyprint lang-config">
 790 # Override the base URL of the cache key.
 791 CacheKeyBaseURL http://www.example.com/
 792   </pre>
 793
 794
 795   <div class="warning">Take care when setting this directive. If two separate virtual
 796   hosts are accidentally given the same base URL, entries from one virtual host
 797   will be served to the other.</div>
 798
 799
 800 </div>
 801 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 802 <div class="directive-section"><h2><a name="CacheLastModifiedFactor" id="CacheLastModifiedFactor">CacheLastModifiedFactor</a> <a name="cachelastmodifiedfactor" id="cachelastmodifiedfactor">Directive</a></h2>
 803 <table class="directive">
 804 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The factor used to compute an expiry date based on the
 805 LastModified date.</td></tr>
 806 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheLastModifiedFactor <var>float</var></code></td></tr>
 807 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheLastModifiedFactor 0.1</code></td></tr>
 808 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 809 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 810 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 811 </table>
 812     <p>In the event that a document does not provide an expiry date but does
 813     provide a last-modified date, an expiry date can be calculated based on
 814     the time since the document was last modified. The
 815     <code class="directive">CacheLastModifiedFactor</code> directive specifies a
 816     <var>factor</var> to be used in the generation of this expiry date
 817     according to the following formula:
 818
 819     <code>expiry-period = time-since-last-modified-date * <var>factor</var>
 820     expiry-date = current-date + expiry-period</code>
 821
 822     For example, if the document was last modified 10 hours ago, and
 823     <var>factor</var> is 0.1 then the expiry-period will be set to
 824     10*0.1 = 1 hour. If the current time was 3:00pm then the computed
 825     expiry-date would be 3:00pm + 1hour = 4:00pm.
 826
 827     If the expiry-period would be longer than that set by
 828     <code class="directive">CacheMaxExpire</code>, then the latter takes
 829     precedence.</p>
 830
 831     <pre class="prettyprint lang-config">
 832       CacheLastModifiedFactor 0.5
 833     </pre>
 834
 835
 836 </div>
 837 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 838 <div class="directive-section"><h2><a name="CacheLock" id="CacheLock">CacheLock</a> <a name="cachelock" id="cachelock">Directive</a></h2>
 839 <table class="directive">
 840 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable the thundering herd lock.</td></tr>
 841 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheLock <var>on|off</var></code></td></tr>
 842 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheLock off</code></td></tr>
 843 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 844 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 845 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 846 </table>
 847   <p>The <code class="directive">CacheLock</code> directive enables the thundering herd lock
 848   for the given URL space.</p>
 849
 850   <p>In a minimal configuration the following directive is all that is needed to
 851   enable the thundering herd lock in the default run-time file directory.</p>
 852
 853   <pre class="prettyprint lang-config">
 854 # Enable cache lock
 855 CacheLock on
 856   </pre>
 857
 858
 859   <p>Locks consist of empty files that only exist for stale URLs in flight, so this
 860   is significantly less resource intensive than the traditional disk cache.</p>
 861
 862 </div>
 863 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 864 <div class="directive-section"><h2><a name="CacheLockMaxAge" id="CacheLockMaxAge">CacheLockMaxAge</a> <a name="cachelockmaxage" id="cachelockmaxage">Directive</a></h2>
 865 <table class="directive">
 866 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the maximum possible age of a cache lock.</td></tr>
 867 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheLockMaxAge <var>integer</var></code></td></tr>
 868 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheLockMaxAge 5</code></td></tr>
 869 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 870 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 871 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 872 </table>
 873   <p>The <code class="directive">CacheLockMaxAge</code> directive specifies the maximum
 874   age of any cache lock.</p>
 875
 876   <p>A lock older than this value in seconds will be ignored, and the next
 877   incoming request will be given the opportunity to re-establish the lock.
 878   This mechanism prevents a slow client taking an excessively long time to refresh
 879   an entity.</p>
 880
 881
 882 </div>
 883 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 884 <div class="directive-section"><h2><a name="CacheLockPath" id="CacheLockPath">CacheLockPath</a> <a name="cachelockpath" id="cachelockpath">Directive</a></h2>
 885 <table class="directive">
 886 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the lock path directory.</td></tr>
 887 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheLockPath <var>directory</var></code></td></tr>
 888 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheLockPath mod_cache-lock</code></td></tr>
 889 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 890 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 891 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 892 </table>
 893   <p>The <code class="directive">CacheLockPath</code> directive allows you to specify the
 894   directory in which the locks are created.  If <var>directory</var> is not an absolute
 895   path, the location specified will be relative to the value of
 896   <code class="directive"><a href="../mod/core.html#defaultruntimedir">DefaultRuntimeDir</a></code>.</p>
 897
 898 </div>
 899 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 900 <div class="directive-section"><h2><a name="CacheMaxExpire" id="CacheMaxExpire">CacheMaxExpire</a> <a name="cachemaxexpire" id="cachemaxexpire">Directive</a></h2>
 901 <table class="directive">
 902 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The maximum time in seconds to cache a document</td></tr>
 903 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheMaxExpire <var>seconds</var></code></td></tr>
 904 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheMaxExpire 86400 (one day)</code></td></tr>
 905 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 906 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 907 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 908 </table>
 909     <p>The <code class="directive">CacheMaxExpire</code> directive specifies the maximum number of
 910     seconds for which cachable HTTP documents will be retained without checking the origin
 911     server. Thus, documents will be out of date at most this number of seconds. This maximum
 912     value is enforced even if an expiry date was supplied with the document.</p>
 913
 914     <pre class="prettyprint lang-config">
 915       CacheMaxExpire 604800
 916     </pre>
 917
 918
 919 </div>
 920 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 921 <div class="directive-section"><h2><a name="CacheMinExpire" id="CacheMinExpire">CacheMinExpire</a> <a name="cacheminexpire" id="cacheminexpire">Directive</a></h2>
 922 <table class="directive">
 923 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The minimum time in seconds to cache a document</td></tr>
 924 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheMinExpire <var>seconds</var></code></td></tr>
 925 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheMinExpire 0</code></td></tr>
 926 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 927 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 928 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 929 </table>
 930     <p>The <code class="directive">CacheMinExpire</code> directive specifies the minimum number of
 931     seconds for which cachable HTTP documents will be retained without checking the origin
 932     server. This is only used if no valid expire time was supplied with the document.</p>
 933
 934
 935     <pre class="prettyprint lang-config">
 936       CacheMinExpire 3600
 937     </pre>
 938
 939
 940 </div>
 941 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 942 <div class="directive-section"><h2><a name="CacheQuickHandler" id="CacheQuickHandler">CacheQuickHandler</a> <a name="cachequickhandler" id="cachequickhandler">Directive</a></h2>
 943 <table class="directive">
 944 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Run the cache from the quick handler.</td></tr>
 945 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheQuickHandler <var>on|off</var></code></td></tr>
 946 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheQuickHandler on</code></td></tr>
 947 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 948 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 949 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 950 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Apache HTTP Server 2.3.3 and later</td></tr>
 951 </table>
 952     <p>The <code class="directive"><a href="#cachequickhandler">CacheQuickHandler</a></code> directive
 953     controls the phase in which the cache is handled.</p>
 954
 955     <p>In the default enabled configuration, the cache operates within the quick
 956     handler phase. This phase short circuits the majority of server processing,
 957     and represents the most performant mode of operation for a typical server.
 958     The cache <strong>bolts onto</strong> the front of the server, and the
 959     majority of server processing is avoided.</p>
 960
 961     <p>When disabled, the cache operates as a normal handler, and is subject to
 962     the full set of phases when handling a server request. While this mode is
 963     slower than the default, it allows the cache to be used in cases where full
 964     processing is required, such as when content is subject to authorization.</p>
 965
 966     <pre class="prettyprint lang-config">
 967 # Run cache as a normal handler
 968 CacheQuickHandler off
 969     </pre>
 970
 971
 972     <p>It is also possible, when the quick handler is disabled, for the
 973     administrator to choose the precise location within the filter chain where
 974     caching is to be performed, by adding the <strong>CACHE</strong> filter to
 975     the chain.</p>
 976
 977     <pre class="prettyprint lang-config">
 978 # Cache content before mod_include and mod_deflate
 979 CacheQuickHandler off
 980 AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html
 981     </pre>
 982
 983
 984     <p>If the CACHE filter is specified more than once, the last instance will
 985     apply.</p>
 986
 987
 988 </div>
 989 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 990 <div class="directive-section"><h2><a name="CacheStaleOnError" id="CacheStaleOnError">CacheStaleOnError</a> <a name="cachestaleonerror" id="cachestaleonerror">Directive</a></h2>
 991 <table class="directive">
 992 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Serve stale content in place of 5xx responses.</td></tr>
 993 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheStaleOnError <var>on|off</var></code></td></tr>
 994 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheStaleOnError on</code></td></tr>
 995 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 996 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 997 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
 998 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.9 and later</td></tr>
 999 </table>
1000   <p>When the <code class="directive"><a href="#cachestaleonerror">CacheStaleOnError</a></code> directive
1001   is switched on, and when stale data is available in the cache, the cache will
1002   respond to 5xx responses from the backend by returning the stale data instead of
1003   the 5xx response. While the Cache-Control headers sent by clients will be respected,
1004   and the raw 5xx responses returned to the client on request, the 5xx response so
1005   returned to the client will not invalidate the content in the cache.</p>
1006
1007   <pre class="prettyprint lang-config">
1008 # Serve stale data on error.
1009 CacheStaleOnError on
1010   </pre>
1011
1012
1013
1014 </div>
1015 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1016 <div class="directive-section"><h2><a name="CacheStoreExpired" id="CacheStoreExpired">CacheStoreExpired</a> <a name="cachestoreexpired" id="cachestoreexpired">Directive</a></h2>
1017 <table class="directive">
1018 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Attempt to cache responses that the server reports as expired</td></tr>
1019 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheStoreExpired On|Off</code></td></tr>
1020 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheStoreExpired Off</code></td></tr>
1021 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1022 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1023 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
1024 </table>
1025     <p>Since httpd 2.2.4, responses which have already expired are not
1026        stored in the cache.  The <code class="directive">CacheStoreExpired</code>
1027        directive allows this behavior to be overridden.
1028        <code class="directive">CacheStoreExpired</code> On
1029        tells the server to attempt to cache the resource if it is stale.
1030        Subsequent requests would trigger an If-Modified-Since request of
1031        the origin server, and the response may be fulfilled from cache
1032        if the backend resource has not changed.</p>
1033
1034     <pre class="prettyprint lang-config">
1035       CacheStoreExpired On
1036     </pre>
1037
1038
1039 </div>
1040 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1041 <div class="directive-section"><h2><a name="CacheStoreNoStore" id="CacheStoreNoStore">CacheStoreNoStore</a> <a name="cachestorenostore" id="cachestorenostore">Directive</a></h2>
1042 <table class="directive">
1043 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Attempt to cache requests or responses that have been marked as no-store.</td></tr>
1044 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheStoreNoStore On|Off</code></td></tr>
1045 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheStoreNoStore Off</code></td></tr>
1046 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1047 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1048 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
1049 </table>
1050     <p>Ordinarily, requests or responses with Cache-Control: no-store header
1051        values will not be stored in the cache.  The
1052        <code class="directive">CacheStoreNoStore</code> directive allows this
1053        behavior to be overridden.  <code class="directive">CacheStoreNoStore</code> On
1054        tells the server to attempt to cache the resource even if it contains
1055        no-store header values.</p>
1056
1057     <pre class="prettyprint lang-config">
1058       CacheStoreNoStore On
1059     </pre>
1060
1061
1062     <div class="warning"><h3>Warning:</h3>
1063        As described in RFC 2616, the no-store directive is intended to
1064        "prevent the inadvertent release or retention of sensitive information
1065        (for example, on backup tapes)."  Enabling this option could store
1066        sensitive information in the cache.  You are hereby warned.
1067     </div>
1068
1069 <h3>See also</h3>
1070 <ul>
1071 <li><code class="directive"><a href="#cacheignorecachecontrol">CacheIgnoreCacheControl</a></code></li>
1072 <li><code class="directive"><a href="#cachestoreprivate">CacheStorePrivate</a></code></li>
1073 </ul>
1074 </div>
1075 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1076 <div class="directive-section"><h2><a name="CacheStorePrivate" id="CacheStorePrivate">CacheStorePrivate</a> <a name="cachestoreprivate" id="cachestoreprivate">Directive</a></h2>
1077 <table class="directive">
1078 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Attempt to cache responses that the server has marked as private</td></tr>
1079 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheStorePrivate On|Off</code></td></tr>
1080 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheStorePrivate Off</code></td></tr>
1081 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1082 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1083 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
1084 </table>
1085     <p>Ordinarily, responses with Cache-Control: private header values will not
1086        be stored in the cache.  The <code class="directive">CacheStorePrivate</code>
1087        directive allows this behavior to be overridden.
1088        <code class="directive">CacheStorePrivate</code> On
1089        tells the server to attempt to cache the resource even if it contains
1090        private header values.</p>
1091
1092     <pre class="prettyprint lang-config">
1093       CacheStorePrivate On
1094     </pre>
1095
1096
1097     <div class="warning"><h3>Warning:</h3>
1098        This directive will allow caching even if the upstream server has
1099        requested that the resource not be cached.  This directive is only
1100        ideal for a 'private' cache.
1101     </div>
1102
1103 <h3>See also</h3>
1104 <ul>
1105 <li><code class="directive"><a href="#cacheignorecachecontrol">CacheIgnoreCacheControl</a></code></li>
1106 <li><code class="directive"><a href="#cachestorenostore">CacheStoreNoStore</a></code></li>
1107 </ul>
1108 </div>
1109 </div>
1110 <div class="bottomlang">
1111 <p><span>Available Languages: </span><a href="../en/mod/mod_cache.html" title="English">&nbsp;en&nbsp;</a> |
1112 <a href="../fr/mod/mod_cache.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
1113 <a href="../ja/mod/mod_cache.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
1114 <a href="../ko/mod/mod_cache.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
1115 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
1116 <script type="text/javascript"><!--//--><![CDATA[//><!--
1117 var comments_shortname = 'httpd';
1118 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_cache.html';
1119 (function(w, d) {
1120     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
1121         d.write('<div id="comments_thread"><\/div>');
1122         var s = d.createElement('script');
1123         s.type = 'text/javascript';
1124         s.async = true;
1125         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
1126         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
1127     }
1128     else {
1129         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
1130     }
1131 })(window, document);
1132 //--><!]]></script></div><div id="footer">
1133 <p class="apache">Copyright 2014 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
1134 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
1135 if (typeof(prettyPrint) !== 'undefined') {
1136     prettyPrint();
1137 }
1138 //--><!]]></script>
1139 </body></html>