granicus.if.org Git - apache/blob - docs/manual/mod/mod_expires.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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_expires - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <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" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <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>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.gif" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <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>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_expires</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_expires.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/mod_expires.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  31 <a href="../ja/mod/mod_expires.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  32 <a href="../ko/mod/mod_expires.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  33 </div>
  34 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Generation of <code>Expires</code> and
  35 <code>Cache-Control</code> HTTP headers according to user-specified
  36 criteria</td></tr>
  37 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  38 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>expires_module</td></tr>
  39 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_expires.c</td></tr></table>
  40 <h3>Summary</h3>
  41
  42     <p>This module controls the setting of the <code>Expires</code>
  43     HTTP header and the <code>max-age</code> directive of the
  44     <code>Cache-Control</code> HTTP header in server responses. The
  45     expiration date can set to be relative to either the time the
  46     source file was last modified, or to the time of the client
  47     access.</p>
  48
  49     <p>These HTTP headers are an instruction to the client about the
  50     document's validity and persistence. If cached, the document may
  51     be fetched from the cache rather than from the source until this
  52     time has passed. After that, the cache copy is considered
  53     "expired" and invalid, and a new copy must be obtained from the
  54     source.</p>
  55
  56     <p>To modify <code>Cache-Control</code> directives other than
  57     <code>max-age</code> (see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9">RFC
  58     2616 section 14.9</a>), you can use the <code class="directive"><a href="../mod/mod_headers.html#header">Header</a></code> directive.</p>
  59
  60     <p> When the <code>Expires</code> header is already part of the response
  61     generated by the server, for example when generated by a CGI script or
  62     proxied from an origin server, this module does not change or add
  63     an <code>Expires</code> or <code>Cache-Control</code> header.</p>
  64 </div>
  65 <div id="quickview"><h3>Topics</h3>
  66 <ul id="topics">
  67 <li><img alt="" src="../images/down.gif" /> <a href="#AltSyn">Alternate Interval Syntax</a></li>
  68 </ul><h3 class="directives">Directives</h3>
  69 <ul id="toc">
  70 <li><img alt="" src="../images/down.gif" /> <a href="#expiresactive">ExpiresActive</a></li>
  71 <li><img alt="" src="../images/down.gif" /> <a href="#expiresbytype">ExpiresByType</a></li>
  72 <li><img alt="" src="../images/down.gif" /> <a href="#expiresdefault">ExpiresDefault</a></li>
  73 </ul>
  74 <ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  75 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  76 <div class="section">
  77 <h2><a name="AltSyn" id="AltSyn">Alternate Interval Syntax</a></h2>
  78     <p>The <code class="directive"><a href="#expiresdefault">ExpiresDefault</a></code> and
  79     <code class="directive"><a href="#expiresbytype">ExpiresByType</a></code> directives
  80     can also be defined in a more readable syntax of the form:</p>
  81
  82     <pre class="prettyprint lang-config">ExpiresDefault "<var>base</var>  [plus <var>num</var> <var>type</var>] [<var>num</var> <var>type</var>] ..."
  83 ExpiresByType type/encoding "<var>base</var>  [plus <var>num</var> <var>type</var>] [<var>num</var> <var>type</var>] ..."</pre>
  84
  85
  86     <p>where <var>base</var> is one of:</p>
  87
  88     <ul>
  89       <li><code>access</code></li>
  90
  91       <li><code>now</code> (equivalent to
  92       '<code>access</code>')</li>
  93
  94       <li><code>modification</code></li>
  95     </ul>
  96
  97     <p>The <code>plus</code> keyword is optional. <var>num</var>
  98     should be an integer value [acceptable to <code>atoi()</code>],
  99     and <var>type</var> is one of:</p>
 100
 101     <ul>
 102       <li><code>years</code></li>
 103       <li><code>months</code></li>
 104       <li><code>weeks</code></li>
 105       <li><code>days</code></li>
 106       <li><code>hours</code></li>
 107       <li><code>minutes</code></li>
 108       <li><code>seconds</code></li>
 109     </ul>
 110
 111     <p>For example, any of the following directives can be used to
 112     make documents expire 1 month after being accessed, by
 113     default:</p>
 114
 115     <pre class="prettyprint lang-config">ExpiresDefault "access plus 1 month"
 116 ExpiresDefault "access plus 4 weeks"
 117 ExpiresDefault "access plus 30 days"</pre>
 118
 119
 120     <p>The expiry time can be fine-tuned by adding several
 121     '<var>num</var> <var>type</var>' clauses:</p>
 122
 123     <pre class="prettyprint lang-config">ExpiresByType text/html "access plus 1 month 15 days 2 hours"
 124 ExpiresByType image/gif "modification plus 5 hours 3 minutes"</pre>
 125
 126
 127     <p>Note that if you use a modification date based setting, the
 128     Expires header will <strong>not</strong> be added to content
 129     that does not come from a file on disk. This is due to the fact
 130     that there is no modification time for such content.</p>
 131 </div>
 132 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 133 <div class="directive-section"><h2><a name="ExpiresActive" id="ExpiresActive">ExpiresActive</a> <a name="expiresactive" id="expiresactive">Directive</a></h2>
 134 <table class="directive">
 135 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables generation of <code>Expires</code>
 136 headers</td></tr>
 137 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ExpiresActive On|Off</code></td></tr>
 138 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ExpiresActive Off</code></td></tr>
 139 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 140 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 141 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 142 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_expires</td></tr>
 143 </table>
 144     <p>This directive enables or disables the generation of the
 145     <code>Expires</code> and <code>Cache-Control</code> headers for
 146     the document realm in question.  (That is, if found in an
 147     <code>.htaccess</code> file, for instance, it applies only to
 148     documents generated from that directory.) If set to
 149     <code>Off</code>, the headers will not be generated for any
 150     document in the realm (unless overridden at a lower level, such as
 151     an <code>.htaccess</code> file overriding a server config
 152     file). If set to <code>On</code>, the headers will be added to
 153     served documents according to the criteria defined by the
 154     <code class="directive"><a href="#expiresbytype">ExpiresByType</a></code> and
 155     <code class="directive"><a href="#expiresdefault">ExpiresDefault</a></code>
 156     directives (<em>q.v.</em>).</p>
 157
 158     <p>Note that this directive does not guarantee that an
 159     <code>Expires</code> or <code>Cache-Control</code> header will be
 160     generated. If the criteria aren't met, no header will be sent, and
 161     the effect will be as though this directive wasn't even
 162     specified.</p>
 163
 164 </div>
 165 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 166 <div class="directive-section"><h2><a name="ExpiresByType" id="ExpiresByType">ExpiresByType</a> <a name="expiresbytype" id="expiresbytype">Directive</a></h2>
 167 <table class="directive">
 168 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Value of the <code>Expires</code> header configured
 169 by MIME type</td></tr>
 170 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ExpiresByType <var>MIME-type</var>
 171 <var>&lt;code&gt;seconds</var></code></td></tr>
 172 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 173 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 174 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 175 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_expires</td></tr>
 176 </table>
 177     <p>This directive defines the value of the <code>Expires</code>
 178     header and the <code>max-age</code> directive of the
 179     <code>Cache-Control</code> header generated for documents of the
 180     specified type (<em>e.g.</em>, <code>text/html</code>). The second
 181     argument sets the number of seconds that will be added to a base
 182     time to construct the expiration date.  The <code>Cache-Control:
 183     max-age</code> is calculated by subtracting the request time from
 184     the expiration date and expressing the result in seconds.</p>
 185
 186     <p>The base time is either the last modification time of the
 187     file, or the time of the client's access to the document. Which
 188     should be used is specified by the
 189     <code><var>&lt;code&gt;</var></code> field; <code>M</code>
 190     means that the file's last modification time should be used as
 191     the base time, and <code>A</code> means the client's access
 192     time should be used.</p>
 193
 194     <p>The difference in effect is subtle. If <code>M</code> is used,
 195     all current copies of the document in all caches will expire at
 196     the same time, which can be good for something like a weekly
 197     notice that's always found at the same URL. If <code>A</code> is
 198     used, the date of expiration is different for each client; this
 199     can be good for image files that don't change very often,
 200     particularly for a set of related documents that all refer to
 201     the same images (<em>i.e.</em>, the images will be accessed
 202     repeatedly within a relatively short timespan).</p>
 203
 204     <div class="example"><h3>Example:</h3><pre class="prettyprint lang-config"># enable expirations
 205 ExpiresActive On
 206 # expire GIF images after a month in the client's cache
 207 ExpiresByType image/gif A2592000
 208 # HTML documents are good for a week from the
 209 # time they were changed
 210 ExpiresByType text/html M604800</pre>
 211 </div>
 212
 213     <p>Note that this directive only has effect if
 214     <code>ExpiresActive On</code> has been specified. It overrides,
 215     for the specified MIME type <em>only</em>, any expiration date
 216     set by the <code class="directive"><a href="#expiresdefault">ExpiresDefault</a></code>
 217     directive.</p>
 218
 219     <p>You can also specify the expiration time calculation using
 220     an <a href="#AltSyn">alternate syntax</a>, described earlier in
 221     this document.</p>
 222
 223 </div>
 224 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 225 <div class="directive-section"><h2><a name="ExpiresDefault" id="ExpiresDefault">ExpiresDefault</a> <a name="expiresdefault" id="expiresdefault">Directive</a></h2>
 226 <table class="directive">
 227 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Default algorithm for calculating expiration time</td></tr>
 228 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ExpiresDefault <var>&lt;code&gt;seconds</var></code></td></tr>
 229 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 230 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 231 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 232 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_expires</td></tr>
 233 </table>
 234     <p>This directive sets the default algorithm for calculating the
 235     expiration time for all documents in the affected realm. It can be
 236     overridden on a type-by-type basis by the <code class="directive"><a href="#expiresbytype">ExpiresByType</a></code> directive. See the
 237     description of that directive for details about the syntax of the
 238     argument, and the <a href="#AltSyn">alternate syntax</a>
 239     description as well.</p>
 240
 241 </div>
 242 </div>
 243 <div class="bottomlang">
 244 <p><span>Available Languages: </span><a href="../en/mod/mod_expires.html" title="English">&nbsp;en&nbsp;</a> |
 245 <a href="../fr/mod/mod_expires.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 246 <a href="../ja/mod/mod_expires.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 247 <a href="../ko/mod/mod_expires.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 248 </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>
 249 <script type="text/javascript"><!--//--><![CDATA[//><!--
 250 var comments_shortname = 'httpd';
 251 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_expires.html';
 252 (function(w, d) {
 253     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 254         d.write('<div id="comments_thread"><\/div>');
 255         var s = d.createElement('script');
 256         s.type = 'text/javascript';
 257         s.async = true;
 258         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 259         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 260     }
 261     else {
 262         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 263     }
 264 })(window, document);
 265 //--><!]]></script></div><div id="footer">
 266 <p class="apache">Copyright 2016 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>
 267 <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[//><!--
 268 if (typeof(prettyPrint) !== 'undefined') {
 269     prettyPrint();
 270 }
 271 //--><!]]></script>
 272 </body></html>