mod_cache.html.en revision a547340d7d0f0e79c9ba921c7dec7b18d0c800ff
8a77240a809197c92c0736c431b4b88947a7bac1Christian Maeder<?xml version="1.0" encoding="ISO-8859-1"?>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder This file is generated from xml source: DO NOT EDIT
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder -->
98890889ffb2e8f6f722b00e265a211f13b5a861Corneliu-Claudiu Prodescu<title>mod_cache - Apache HTTP Server</title>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
6820f0de92751e29d73d64db48e776591f529a76Christian Maeder<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<link href="/images/favicon.ico" rel="shortcut icon" /></head>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<body>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<div id="page-header">
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
6820f0de92751e29d73d64db48e776591f529a76Christian Maeder<p class="apache">Apache HTTP Server Version 2.3</p>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<img alt="" src="/images/feather.gif" /></div>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div>
6820f0de92751e29d73d64db48e776591f529a76Christian Maeder<div id="path">
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<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.3</a> &gt; <a href="./">Modules</a></div>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<div id="page-content">
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<div id="preamble"><h1>Apache Module mod_cache</h1>
6820f0de92751e29d73d64db48e776591f529a76Christian Maeder<div class="toplang">
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<p><span>Available Languages: </span><a href="/en/mod/mod_cache.html" title="English">&nbsp;en&nbsp;</a> |
6820f0de92751e29d73d64db48e776591f529a76Christian Maeder<a href="/fr/mod/mod_cache.html" hreflang="fr" rel="alternate" title="Fran�ais">&nbsp;fr&nbsp;</a> |
6820f0de92751e29d73d64db48e776591f529a76Christian Maeder<a href="/ja/mod/mod_cache.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<a href="/ko/mod/mod_cache.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder</div>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Content cache keyed to URIs.</td></tr>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>cache_module</td></tr>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_cache.c</td></tr></table>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<h3>Summary</h3>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <div class="warning">This module should be used with care, as when the
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <code class="directive"><a href="#cachequickhandler">CacheQuickHandler</a></code> directive is
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder in its default value of <strong>on</strong>, the <code class="directive"><a href="/mod/mod_authz_host.html#allow">Allow</a></code> and <code class="directive"><a href="/mod/mod_authz_host.html#deny">Deny</a></code> directives will be circumvented.
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder You should not enable quick handler caching for any content to which you
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder wish to limit access by client host name, address or environment
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder variable.</div>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <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 HTTP
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder content cache that can be used to cache either local or proxied content.
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <code class="module"><a href="/mod/mod_cache.html">mod_cache</a></code> requires the services of one or more storage
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder management modules. One storage management module is included in
c56a356d3fcc5e123efa790aab320781d94df3c7Jonathan von Schroeder the base Apache distribution:</p>
c56a356d3fcc5e123efa790aab320781d94df3c7Jonathan von Schroeder <dl>
c56a356d3fcc5e123efa790aab320781d94df3c7Jonathan von Schroeder <dt><code class="module"><a href="/mod/mod_disk_cache.html">mod_disk_cache</a></code></dt>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <dd>implements a disk based storage manager.</dd>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder </dl>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <p>Content is stored in and retrieved from the cache using URI based keys. Content with
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder access protection is not cached.</p>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <p>Further details, discussion, and examples, are provided in the
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <a href="/caching.html">Caching Guide</a>.</p>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder</div>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<div id="quickview"><h3 class="directives">Directives</h3>
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder<ul id="toc">
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cachedefaultexpire">CacheDefaultExpire</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cachedetailheader">CacheDetailHeader</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cachedisable">CacheDisable</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cacheenable">CacheEnable</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cacheheader">CacheHeader</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cacheignorecachecontrol">CacheIgnoreCacheControl</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cacheignoreheaders">CacheIgnoreHeaders</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cacheignorenolastmod">CacheIgnoreNoLastMod</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cacheignorequerystring">CacheIgnoreQueryString</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cacheignoreurlsessionidentifiers">CacheIgnoreURLSessionIdentifiers</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cachelastmodifiedfactor">CacheLastModifiedFactor</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cachelock">CacheLock</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cachelockmaxage">CacheLockMaxAge</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cachelockpath">CacheLockPath</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cachemaxexpire">CacheMaxExpire</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cacheminexpire">CacheMinExpire</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cachequickhandler">CacheQuickHandler</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cachestoreexpired">CacheStoreExpired</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cachestorenostore">CacheStoreNoStore</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#cachestoreprivate">CacheStorePrivate</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder</ul>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<h3>Topics</h3>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<ul id="topics">
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#related">Related Modules and Directives</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#sampleconf">Sample Configuration</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#thunderingherd">Avoiding the Thundering Herd</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#finecontrol">Fine Control with the CACHE Filter</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><img alt="" src="/images/down.gif" /> <a href="#status">Cache Status and Logging</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder</ul><h3>See also</h3>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<ul class="seealso">
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<li><a href="/caching.html">Caching Guide</a></li>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder</ul></div>
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder<div class="section">
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<h2><a name="related" id="related">Related Modules and Directives</a></h2>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="/mod/mod_disk_cache.html">mod_disk_cache</a></code></li></ul></td><td><ul><li><code class="directive"><a href="/mod/mod_disk_cache.html#cacheroot">CacheRoot</a></code></li><li><code class="directive"><a href="/mod/mod_disk_cache.html#cachedirlevels">CacheDirLevels</a></code></li><li><code class="directive"><a href="/mod/mod_disk_cache.html#cachedirlength">CacheDirLength</a></code></li><li><code class="directive"><a href="/mod/mod_disk_cache.html#cacheminfilesize">CacheMinFileSize</a></code></li><li><code class="directive"><a href="/mod/mod_disk_cache.html#cachemaxfilesize">CacheMaxFileSize</a></code></li></ul></td></tr></table>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<div class="section">
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<h2><a name="sampleconf" id="sampleconf">Sample Configuration</a></h2>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <div class="example"><h3>Sample httpd.conf</h3><p><code>
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder #<br />
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder # Sample Cache Configuration<br />
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder #<br />
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder LoadModule cache_module modules/mod_cache.so<br />
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder <br />
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder &lt;IfModule mod_cache.c&gt;<br />
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <span class="indent">
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder LoadModule disk_cache_module modules/mod_disk_cache.so<br />
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder &lt;IfModule mod_disk_cache.c&gt;<br />
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder <span class="indent">
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder CacheRoot c:/cacheroot<br />
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder CacheEnable disk /<br />
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder CacheDirLevels 5<br />
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder CacheDirLength 3<br />
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder </span>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder &lt;/IfModule&gt; <br />
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <br />
c56a356d3fcc5e123efa790aab320781d94df3c7Jonathan von Schroeder # When acting as a proxy, don't cache the list of security updates<br />
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder CacheDisable http://security.update.server/update-list/<br />
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder </span>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder &lt;/IfModule&gt;
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder </code></p></div>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder<div class="section">
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder<h2><a name="thunderingherd" id="thunderingherd">Avoiding the Thundering Herd</a></h2>
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder <p>When a cached entry becomes stale, <code class="module"><a href="/mod/mod_cache.html">mod_cache</a></code> will submit
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder a conditional request to the backend, which is expected to confirm whether the
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder cached entry is still fresh, and send an updated entity if not.</p>
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder <p>A small but finite amount of time exists between the time the cached entity
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder becomes stale, and the time the stale entity is fully refreshed. On a busy
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder server, a significant number of requests might arrive during this time, and
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder cause a <strong>thundering herd</strong> of requests to strike the backend
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder suddenly and unpredicably.</p>
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder <p>To keep the thundering herd at bay, the <code class="directive">CacheLock</code>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder directive can be used to define a directory in which locks are created for
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder URLs <strong>in flight</strong>. The lock is used as a <strong>hint</strong>
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder by other requests to either suppress an attempt to cache (someone else has
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder gone to fetch the entity), or to indicate that a stale entry is being refreshed
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder (stale content will be returned in the mean time).
80d2ec8f37d5ddec13c14b17b1bab01e9c94630aChristian Maeder </p>
a669e4685b32ff5ca1bca785eacc5e30a545b010Christian Maeder <h3>Initial caching of an entry</h3>
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder <p>When an entity is cached for the first time, a lock will be created for the
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder entity until the response has been fully cached. During the lifetime of the
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder lock, the cache will suppress the second and subsequent attempt to cache the
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder same entity. While this doesn't hold back the thundering herd, it does stop
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder the cache attempting to cache the same entity multiple times simultaneously.
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder </p>
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder <h3>Refreshment of a stale entry</h3>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder <p>When an entity reaches its freshness lifetime and becomes stale, a lock
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder will be created for the entity until the response has either been confirmed as
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder still fresh, or replaced by the backend. During the lifetime of the lock, the
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder second and subsequent incoming request will cause stale data to be returned,
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder and the thundering herd is kept at bay.</p>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder <h3>Locks and Cache-Control: no-cache</h3>
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <p>Locks are used as a <strong>hint only</strong> to enable the cache to be
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder more gentle on backend servers, however the lock can be overridden if necessary.
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder If the client sends a request with a Cache-Control header forcing a reload, any
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder lock that may be present will be ignored, and the client's request will be
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder honoured immediately and the cached entry refreshed.</p>
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder <p>As a further safety mechanism, locks have a configurable maximum age.
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder Once this age has been reached, the lock is removed, and a new request is
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder given the opportunity to create a new lock. This maximum age can be set using
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder the <code class="directive">CacheLockMaxAge</code> directive, and defaults to 5
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder seconds.
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder </p>
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <h3>Example configuration</h3>
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder
ece3b1a5353a9af3c966a1d5453594ed35334f7bJonathan von Schroeder <div class="example"><h3>Enabling the cache lock</h3><p><code>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder #<br />
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder # Enable the cache lock<br />
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder #<br />
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder &lt;IfModule mod_cache.c&gt;<br />
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder <span class="indent">
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder CacheLock on<br />
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder CacheLockPath /tmp/mod_cache-lock<br />
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder CacheLockMaxAge 5<br />
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder </span>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder &lt;/IfModule&gt;
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder </code></p></div>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder<div class="section">
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder<h2><a name="finecontrol" id="finecontrol">Fine Control with the CACHE Filter</a></h2>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder <p>Under the default mode of cache operation, the cache runs as a quick handler,
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder short circuiting the majority of server processing and offering the highest
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder cache performance available.</p>
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder
d71447e45047d07006b4c20409fbd8ea287df01fJonathan von Schroeder <p>In this mode, the cache <strong>bolts onto</strong> the front of the server,
b35e053c2c5a5ea0f13decfd0303894861d82b4dJonathan von Schroeder acting as if a free standing RFC2616 caching proxy had been placed in front of
the server.</p>
<p>While this mode offers the best performance, the administrator may find that
under certain circumstances they may want to perform further processing on the
request after the request is cached, such as to inject personalisation into the
cached page, or to apply authorisation restrictions to the content. Under these
circumstances, an administrator is often forced to place independent reverse
proxy servers either behind or in front of the caching server to achieve this.</p>
<p>To solve this problem the <code class="directive"><a href="#cachequickhandler&#10; ">CacheQuickHandler
</a></code> directive can be set to <strong>off</strong>, and the server will
process all phases normally handled by a non-cached request, including the
<strong>authentication and authorisation</strong> phases.</p>
<p>In addition, the administrator may optionally specify the <strong>precise point
within the filter chain</strong> where caching is to take place by adding the
<strong>CACHE</strong> filter to the output filter chain.</p>
<p>For example, to cache content before applying compression to the response,
place the <strong>CACHE</strong> filter before the <strong>DEFLATE</strong>
filter as in the example below:</p>
<div class="example"><p><code>
# Cache content before optional compression<br />
CacheQuickHandler off<br />
AddOutputFilterByType CACHE;DEFLATE text/plain<br /><br />
</code></p></div>
<p>Another option is to have content cached before personalisation is applied
by <code class="module"><a href="/mod/mod_include.html">mod_include</a></code> (or another content processing filter). In this
example templates containing tags understood by
<code class="module"><a href="/mod/mod_include.html">mod_include</a></code> are cached before being parsed:</p>
<div class="example"><p><code>
# Cache content before mod_include and mod_deflate<br />
CacheQuickHandler off<br />
AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html<br /><br />
</code></p></div>
<p>You may place the <strong>CACHE</strong> filter anywhere you wish within the
filter chain. In this example, content is cached after being parsed by
<code class="module"><a href="/mod/mod_include.html">mod_include</a></code>, but before being processed by
<code class="module"><a href="/mod/mod_deflate.html">mod_deflate</a></code>:</p>
<div class="example"><p><code>
# Cache content between mod_include and mod_deflate<br />
CacheQuickHandler off<br />
AddOutputFilterByType INCLUDES;CACHE;DEFLATE text/html<br /><br />
</code></p></div>
<div class="warning"><h3>Warning:</h3>If the location of the
<strong>CACHE</strong> filter in the filter chain is changed for any reason,
you may need to <strong>flush your cache</strong> to ensure that your data
served remains consistent. <code class="module"><a href="/mod/mod_cache.html">mod_cache</a></code> is not in a position
to enforce this for you.</div>
</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="section">
<h2><a name="status" id="status">Cache Status and Logging</a></h2>
<p>Once <code class="module"><a href="/mod/mod_cache.html">mod_cache</a></code> has made a decision as to whether or not
an entity is to be served from cache, the detailed reason for the decision
is written to the subprocess environment within the request under the
<strong>cache-status</strong> key. This reason can be logged by the
<code class="directive"><a href="/mod/mod_log_config.html#logformat">LogFormat</a></code> directive as
follows:</p>
<div class="example"><p><code>
LogFormat "%{cache-status}e ..."
</code></p></div>
<p>Based on the caching decision made, the reason is also written to the
subprocess environment under one the following three keys, as appropriate:</p>
<dl>
<dt>cache-hit</dt><dd>The response was served from cache.</dd>
<dt>cache-revalidate</dt><dd>The response was stale and was successfully
revalidated, then served from cache.</dd>
<dt>cache-miss</dt><dd>The response was served from the upstream server.</dd>
</dl>
<p>This makes it possible to support conditional logging of cached requests
as per the following example:</p>
<div class="example"><p><code>
CustomLog cached-requests.log common env=cache-hit<br />
CustomLog uncached-requests.log common env=cache-miss<br />
CustomLog revalidated-requests.log common env=cache-revalidate<br />
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheDefaultExpire" id="CacheDefaultExpire">CacheDefaultExpire</a> <a name="cachedefaultexpire" id="cachedefaultexpire">Directive</a></h2>
<table class="directive">
<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>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheDefaultExpire <var>seconds</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheDefaultExpire 3600 (one hour)</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>The <code class="directive">CacheDefaultExpire</code> directive specifies a default time,
in seconds, to cache a document if neither an expiry date nor last-modified date are provided
with the document. The value specified with the <code class="directive">CacheMaxExpire</code>
directive does <em>not</em> override this setting.</p>
<div class="example"><p><code>
CacheDefaultExpire 86400
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheDetailHeader" id="CacheDetailHeader">CacheDetailHeader</a> <a name="cachedetailheader" id="cachedetailheader">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Add an X-Cache-Detail header to the response.</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheDetailHeader <var>on|off</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheDetailHeader off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.9 and later</td></tr>
</table>
<p>When the <code class="directive"><a href="#cachedetailheader">CacheDetailHeader</a></code> directive
is switched on, an <strong>X-Cache-Detail</strong> header will be added to the response
containing the detailed reason for a particular caching decision.</p>
<p>It can be useful during development of cached RESTful services to have additional
information about the caching decision written to the response headers, so as to
confirm whether <code>Cache-Control</code> and other headers have been correctly
used by the service and client.</p>
<p>If the normal handler is used, this directive may appear within a
<code class="directive"><a href="/mod/core.html#&lt;directory&gt;">&lt;Directory&gt;</a></code> or
<code class="directive"><a href="/mod/core.html#&lt;location&gt;">&lt;Location&gt;</a></code> directive. If the quick handler
is used, this directive must appear within a server or virtual host context, otherwise
the setting will be ignored.</p>
<div class="example"><p><code>
# Enable the X-Cache-Detail header<br />
CacheDetailHeader on<br />
</code></p></div>
<div class="example"><p><code>
X-Cache-Detail: "conditional cache hit: entity refreshed" from localhost<br />
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheDisable" id="CacheDisable">CacheDisable</a> <a name="cachedisable" id="cachedisable">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Disable caching of specified URLs</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheDisable <var>url-string</var> | <var>on</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>The <code class="directive">CacheDisable</code> directive instructs
<code class="module"><a href="/mod/mod_cache.html">mod_cache</a></code> to <em>not</em> cache urls at or below
<var>url-string</var>.</p>
<div class="example"><h3>Example</h3><p><code>
CacheDisable /local_files
</code></p></div>
<p>If used in a <code class="directive">&lt;Location&gt;</code> directive,
the path needs to be specified below the Location, or if the word "on"
is used, caching for the whole location will be disabled.</p>
<div class="example"><h3>Example</h3><p><code>
&lt;Location /foo&gt;<br />
CacheDisable on<br />
&lt;/Location&gt;<br />
</code></p></div>
<p> The <code>no-cache</code> environment variable can be set to
disable caching on a finer grained set of resources in versions
2.2.12 and later.</p>
<h3>See also</h3>
<ul>
<li><a href="/env.html">Environment Variables in Apache</a></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheEnable" id="CacheEnable">CacheEnable</a> <a name="cacheenable" id="cacheenable">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable caching of specified URLs using a specified storage
manager</td></tr>
<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>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>The <code class="directive">CacheEnable</code> directive instructs
<code class="module"><a href="/mod/mod_cache.html">mod_cache</a></code> to cache urls at or below
<var>url-string</var>. The cache storage manager is specified with the
<var>cache_type</var> argument. If the <code class="directive">CacheEnable</code>
directive is placed inside a <code class="directive">&lt;Location&gt;</code>
directive, the <var>url-string</var> becomes optional.
<var>cache_type</var> <code>disk</code> instructs
<code class="module"><a href="/mod/mod_cache.html">mod_cache</a></code> to use the disk based storage manager
implemented by <code class="module"><a href="/mod/mod_disk_cache.html">mod_disk_cache</a></code>.</p>
<p>In the event that the URL space overlaps between different
<code class="directive">CacheEnable</code> directives (as in the example below),
each possible storage manager will be run until the first one that
actually processes the request. The order in which the storage managers are
run is determined by the order of the <code class="directive">CacheEnable</code>
directives in the configuration file.</p>
<p>When acting as a forward proxy server, <var>url-string</var> can
also be used to specify remote sites and proxy protocols which
caching should be enabled for.</p>
<div class="example"><p><code>
# Cache proxied url's<br />
CacheEnable disk /<br /><br />
# Cache FTP-proxied url's<br />
CacheEnable disk ftp://<br /><br />
# Cache content from www.apache.org<br />
CacheEnable disk http://www.apache.org/<br />
</code></p></div>
<p>A hostname starting with a <strong>"*"</strong> matches all hostnames with
that suffix. A hostname starting with <strong>"."</strong> matches all
hostnames containing the domain components that follow.</p>
<div class="example"><p><code>
# Match www.apache.org, and fooapache.org<br />
CacheEnable disk http://*apache.org/<br />
# Match www.apache.org, but not fooapache.org<br />
CacheEnable disk http://.apache.org/<br />
</code></p></div>
<p> The <code>no-cache</code> environment variable can be set to
disable caching on a finer grained set of resources in versions
2.2.12 and later.</p>
<h3>See also</h3>
<ul>
<li><a href="/env.html">Environment Variables in Apache</a></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheHeader" id="CacheHeader">CacheHeader</a> <a name="cacheheader" id="cacheheader">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Add an X-Cache header to the response.</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheHeader <var>on|off</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheHeader off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.9 and later</td></tr>
</table>
<p>When the <code class="directive"><a href="#cacheheader">CacheHeader</a></code> directive
is switched on, an <strong>X-Cache</strong> header will be added to the response
with the cache status of this response. If the normal handler is used, this
directive may appear within a <code class="directive"><a href="/mod/core.html#&lt;directory&gt;">&lt;Directory&gt;</a></code>
or <code class="directive"><a href="/mod/core.html#&lt;location&gt;">&lt;Location&gt;</a></code> directive. If the quick
handler is used, this directive must appear within a server or virtual host
context, otherwise the setting will be ignored.</p>
<dl>
<dt><strong>HIT</strong></dt><dd>The entity was fresh, and was served from
cache.</dd>
<dt><strong>REVALIDATE</strong></dt><dd>The entity was stale, was successfully
revalidated and was served from cache.</dd>
<dt><strong>MISS</strong></dt><dd>The entity was fetched from the upstream
server and was not served from cache.</dd>
</dl>
<div class="example"><p><code>
# Enable the X-Cache header<br />
CacheHeader on<br />
</code></p></div>
<div class="example"><p><code>
X-Cache: HIT from localhost<br />
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheIgnoreCacheControl" id="CacheIgnoreCacheControl">CacheIgnoreCacheControl</a> <a name="cacheignorecachecontrol" id="cacheignorecachecontrol">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ignore request to not serve cached content to client</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheIgnoreCacheControl On|Off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheIgnoreCacheControl Off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>Ordinarily, requests containing a Cache-Control: no-cache or
Pragma: no-cache header value will not be served from the cache. The
<code class="directive">CacheIgnoreCacheControl</code> directive allows this
behavior to be overridden. <code class="directive">CacheIgnoreCacheControl On</code>
tells the server to attempt to serve the resource from the cache even
if the request contains no-cache header values. Resources requiring
authorization will <em>never</em> be cached.</p>
<div class="example"><p><code>
CacheIgnoreCacheControl On
</code></p></div>
<div class="warning"><h3>Warning:</h3>
This directive will allow serving from the cache even if the client has
requested that the document not be served from the cache. This might
result in stale content being served.
</div>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#cachestoreprivate">CacheStorePrivate</a></code></li>
<li><code class="directive"><a href="#cachestorenostore">CacheStoreNoStore</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheIgnoreHeaders" id="CacheIgnoreHeaders">CacheIgnoreHeaders</a> <a name="cacheignoreheaders" id="cacheignoreheaders">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Do not store the given HTTP header(s) in the cache.
</td></tr>
<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>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheIgnoreHeaders None</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>According to RFC 2616, hop-by-hop HTTP headers are not stored in
the cache. The following HTTP headers are hop-by-hop headers and thus
do not get stored in the cache in <em>any</em> case regardless of the
setting of <code class="directive">CacheIgnoreHeaders</code>:</p>
<ul>
<li><code>Connection</code></li>
<li><code>Keep-Alive</code></li>
<li><code>Proxy-Authenticate</code></li>
<li><code>Proxy-Authorization</code></li>
<li><code>TE</code></li>
<li><code>Trailers</code></li>
<li><code>Transfer-Encoding</code></li>
<li><code>Upgrade</code></li>
</ul>
<p><code class="directive">CacheIgnoreHeaders</code> specifies additional HTTP
headers that should not to be stored in the cache. For example, it makes
sense in some cases to prevent cookies from being stored in the cache.</p>
<p><code class="directive">CacheIgnoreHeaders</code> takes a space separated list
of HTTP headers that should not be stored in the cache. If only hop-by-hop
headers not should be stored in the cache (the RFC 2616 compliant
behaviour), <code class="directive">CacheIgnoreHeaders</code> can be set to
<code>None</code>.</p>
<div class="example"><h3>Example 1</h3><p><code>
CacheIgnoreHeaders Set-Cookie
</code></p></div>
<div class="example"><h3>Example 2</h3><p><code>
CacheIgnoreHeaders None
</code></p></div>
<div class="warning"><h3>Warning:</h3>
If headers like <code>Expires</code> which are needed for proper cache
management are not stored due to a
<code class="directive">CacheIgnoreHeaders</code> setting, the behaviour of
mod_cache is undefined.
</div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheIgnoreNoLastMod" id="CacheIgnoreNoLastMod">CacheIgnoreNoLastMod</a> <a name="cacheignorenolastmod" id="cacheignorenolastmod">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ignore the fact that a response has no Last Modified
header.</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheIgnoreNoLastMod On|Off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheIgnoreNoLastMod Off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>Ordinarily, documents without a last-modified date are not cached.
Under some circumstances the last-modified date is removed (during
<code class="module"><a href="/mod/mod_include.html">mod_include</a></code> processing for example) or not provided
at all. The <code class="directive">CacheIgnoreNoLastMod</code> directive
provides a way to specify that documents without last-modified dates
should be considered for caching, even without a last-modified date.
If neither a last-modified date nor an expiry date are provided with
the document then the value specified by the
<code class="directive">CacheDefaultExpire</code> directive will be used to
generate an expiration date.</p>
<div class="example"><p><code>
CacheIgnoreNoLastMod On
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheIgnoreQueryString" id="CacheIgnoreQueryString">CacheIgnoreQueryString</a> <a name="cacheignorequerystring" id="cacheignorequerystring">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ignore query string when caching</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheIgnoreQueryString On|Off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheIgnoreQueryString Off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>Ordinarily, requests with query string parameters are cached separately
for each unique query string. This is according to RFC 2616/13.9 done only
if an expiration time is specified. The
<code class="directive">CacheIgnoreQueryString</code> directive tells the cache to
cache requests even if no expiration time is specified, and to reply with
a cached reply even if the query string differs. From a caching point of
view the request is treated as if having no query string when this
directive is enabled.</p>
<div class="example"><p><code>
CacheIgnoreQueryString On
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheIgnoreURLSessionIdentifiers" id="CacheIgnoreURLSessionIdentifiers">CacheIgnoreURLSessionIdentifiers</a> <a name="cacheignoreurlsessionidentifiers" id="cacheignoreurlsessionidentifiers">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ignore defined session identifiers encoded in the URL when caching
</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheIgnoreURLSessionIdentifiers <var>identifier</var> [<var>identifier</var>] ...</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheIgnoreURLSessionIdentifiers None</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>Sometimes applications encode the session identifier into the URL like in the following
Examples:
</p>
<ul>
<li><code>/someapplication/image.gif;jsessionid=123456789</code></li>
<li><code>/someapplication/image.gif?PHPSESSIONID=12345678</code></li>
</ul>
<p>This causes cachable resources to be stored separately for each session, which
is often not desired. <code class="directive">CacheIgnoreURLSessionIdentifiers</code> lets
define a list of identifiers that are removed from the key that is used to identify
an entity in the cache, such that cachable resources are not stored separately for
each session.
</p>
<p><code>CacheIgnoreURLSessionIdentifiers None</code> clears the list of ignored
identifiers. Otherwise, each identifier is added to the list.</p>
<div class="example"><h3>Example 1</h3><p><code>
CacheIgnoreURLSessionIdentifiers jsessionid
</code></p></div>
<div class="example"><h3>Example 2</h3><p><code>
CacheIgnoreURLSessionIdentifiers None
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheLastModifiedFactor" id="CacheLastModifiedFactor">CacheLastModifiedFactor</a> <a name="cachelastmodifiedfactor" id="cachelastmodifiedfactor">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The factor used to compute an expiry date based on the
LastModified date.</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheLastModifiedFactor <var>float</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheLastModifiedFactor 0.1</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>In the event that a document does not provide an expiry date but does
provide a last-modified date, an expiry date can be calculated based on
the time since the document was last modified. The
<code class="directive">CacheLastModifiedFactor</code> directive specifies a
<var>factor</var> to be used in the generation of this expiry date
according to the following formula:
<code>expiry-period = time-since-last-modified-date * <var>factor</var>
expiry-date = current-date + expiry-period</code>
For example, if the document was last modified 10 hours ago, and
<var>factor</var> is 0.1 then the expiry-period will be set to
10*0.1 = 1 hour. If the current time was 3:00pm then the computed
expiry-date would be 3:00pm + 1hour = 4:00pm.
If the expiry-period would be longer than that set by
<code class="directive">CacheMaxExpire</code>, then the latter takes
precedence.</p>
<div class="example"><p><code>
CacheLastModifiedFactor 0.5
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheLock" id="CacheLock">CacheLock</a> <a name="cachelock" id="cachelock">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable the thundering herd lock.</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheLock <var>on|off</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheLock off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.2.15 and later</td></tr>
</table>
<p>The <code class="directive">CacheLock</code> directive enables the thundering herd lock
for the given URL space.</p>
<p>In a minimal configuration the following directive is all that is needed to
enable the thundering herd lock in the default system temp directory.</p>
<div class="example"><p><code>
# Enable cache lock<br />
CacheLock on<br /><br />
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheLockMaxAge" id="CacheLockMaxAge">CacheLockMaxAge</a> <a name="cachelockmaxage" id="cachelockmaxage">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the maximum possible age of a cache lock.</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheLockMaxAge <var>integer</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheLockMaxAge 5</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>The <code class="directive">CacheLockMaxAge</code> directive specifies the maximum
age of any cache lock.</p>
<p>A lock older than this value in seconds will be ignored, and the next
incoming request will be given the opportunity to re-establish the lock.
This mechanism prevents a slow client taking an excessively long time to refresh
an entity.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheLockPath" id="CacheLockPath">CacheLockPath</a> <a name="cachelockpath" id="cachelockpath">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the lock path directory.</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheLockPath <var>directory</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheLockPath /tmp/mod_cache-lock</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>The <code class="directive">CacheLockPath</code> directive allows you to specify the
directory in which the locks are created. By default, the system's temporary
folder is used. Locks consist of empty files that only exist for stale URLs
in flight, so is significantly less resource intensive than the traditional
disk cache.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheMaxExpire" id="CacheMaxExpire">CacheMaxExpire</a> <a name="cachemaxexpire" id="cachemaxexpire">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The maximum time in seconds to cache a document</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheMaxExpire <var>seconds</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheMaxExpire 86400 (one day)</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>The <code class="directive">CacheMaxExpire</code> directive specifies the maximum number of
seconds for which cachable HTTP documents will be retained without checking the origin
server. Thus, documents will be out of date at most this number of seconds. This maximum
value is enforced even if an expiry date was supplied with the document.</p>
<div class="example"><p><code>
CacheMaxExpire 604800
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheMinExpire" id="CacheMinExpire">CacheMinExpire</a> <a name="cacheminexpire" id="cacheminexpire">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The minimum time in seconds to cache a document</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheMinExpire <var>seconds</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheMinExpire 0</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>The <code class="directive">CacheMinExpire</code> directive specifies the minimum number of
seconds for which cachable HTTP documents will be retained without checking the origin
server. This is only used if no valid expire time was supplied with the document.</p>
<div class="example"><p><code>
CacheMinExpire 3600
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheQuickHandler" id="CacheQuickHandler">CacheQuickHandler</a> <a name="cachequickhandler" id="cachequickhandler">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Run the cache from the quick handler.</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheQuickHandler <var>on|off</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheQuickHandler on</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>The <code class="directive"><a href="#cachequickhandler">CacheQuickHandler</a></code> directive
controls the phase in which the cache is handled.</p>
<p>In the default enabled configuration, the cache operates within the quick
handler phase. This phase short circuits the majority of server processing,
and represents the most performant mode of operation for a typical server.
The cache <strong>bolts onto</strong> the front of the server, and the
majority of server processing is avoided.</p>
<p>When disabled, the cache operates as a normal handler, and is subject to
the full set of phases when handling a server request. While this mode is
slower than the default, it allows the cache to be used in cases where full
processing is required, such as when content is subject to authorisation.</p>
<div class="example"><p><code>
# Run cache as a normal handler<br />
CacheQuickHandler off<br /><br />
</code></p></div>
<p>It is also possible, when the quick handler is disabled, for the
administrator to choose the precise location within the filter chain where
caching is to be performed, by adding the <strong>CACHE</strong> filter to
the chain.</p>
<div class="example"><p><code>
# Cache content before mod_include and mod_deflate<br />
CacheQuickHandler off<br />
AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html<br /><br />
</code></p></div>
<p>If the CACHE filter is specified more than once, the last instance will
apply.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheStoreExpired" id="CacheStoreExpired">CacheStoreExpired</a> <a name="cachestoreexpired" id="cachestoreexpired">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Attempt to cache responses that the server reports as expired</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheStoreExpired On|Off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheStoreExpired Off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>Since httpd 2.2.4, responses which have already expired are not
stored in the cache. The <code class="directive">CacheStoreExpired</code>
directive allows this behavior to be overridden.
<code class="directive">CacheStoreExpired</code> On
tells the server to attempt to cache the resource if it is stale.
Subsequent requests would trigger an If-Modified-Since request of
the origin server, and the response may be fulfilled from cache
if the backend resource has not changed.</p>
<div class="example"><p><code>
CacheStoreExpired On
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheStoreNoStore" id="CacheStoreNoStore">CacheStoreNoStore</a> <a name="cachestorenostore" id="cachestorenostore">Directive</a></h2>
<table class="directive">
<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>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheStoreNoStore On|Off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheStoreNoStore Off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>Ordinarily, requests or responses with Cache-Control: no-store header
values will not be stored in the cache. The
<code class="directive">CacheStoreNoCache</code> directive allows this
behavior to be overridden. <code class="directive">CacheStoreNoCache</code> On
tells the server to attempt to cache the resource even if it contains
no-store header values. Resources requiring authorization will
<em>never</em> be cached.</p>
<div class="example"><p><code>
CacheStoreNoStore On
</code></p></div>
<div class="warning"><h3>Warning:</h3>
As described in RFC 2616, the no-store directive is intended to
"prevent the inadvertent release or retention of sensitive information
(for example, on backup tapes)." Enabling this option could store
sensitive information in the cache. You are hereby warned.
</div>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#cacheignorecachecontrol">CacheIgnoreCacheControl</a></code></li>
<li><code class="directive"><a href="#cachestoreprivate">CacheStorePrivate</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="CacheStorePrivate" id="CacheStorePrivate">CacheStorePrivate</a> <a name="cachestoreprivate" id="cachestoreprivate">Directive</a></h2>
<table class="directive">
<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>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheStorePrivate On|Off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheStorePrivate Off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache</td></tr>
</table>
<p>Ordinarily, responses with Cache-Control: private header values will not
be stored in the cache. The <code class="directive">CacheStorePrivate</code>
directive allows this behavior to be overridden.
<code class="directive">CacheStorePrivate</code> On
tells the server to attempt to cache the resource even if it contains
private header values. Resources requiring authorization will
<em>never</em> be cached.</p>
<div class="example"><p><code>
CacheStorePrivate On
</code></p></div>
<div class="warning"><h3>Warning:</h3>
This directive will allow caching even if the upstream server has
requested that the resource not be cached. This directive is only
ideal for a 'private' cache.
</div>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#cacheignorecachecontrol">CacheIgnoreCacheControl</a></code></li>
<li><code class="directive"><a href="#cachestorenostore">CacheStoreNoStore</a></code></li>
</ul>
</div>
</div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="/en/mod/mod_cache.html" title="English">&nbsp;en&nbsp;</a> |
<a href="/fr/mod/mod_cache.html" hreflang="fr" rel="alternate" title="Fran�ais">&nbsp;fr&nbsp;</a> |
<a href="/ja/mod/mod_cache.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
<a href="/ko/mod/mod_cache.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
</div><div id="footer">
<p class="apache">Copyright 2010 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>
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div>
</body></html>