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.png" /></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 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_expires">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_expires">Report a bug</a></li></ul><h3>See also</h3>
  75 <ul class="seealso">
  76 <li><a href="#comments_section">Comments</a></li></ul></div>
  77 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  78 <div class="section">
  79 <h2><a name="AltSyn" id="AltSyn">Alternate Interval Syntax</a></h2>
  80     <p>The <code class="directive"><a href="#expiresdefault">ExpiresDefault</a></code> and
  81     <code class="directive"><a href="#expiresbytype">ExpiresByType</a></code> directives
  82     can also be defined in a more readable syntax of the form:</p>
  83
  84     <pre class="prettyprint lang-config">ExpiresDefault "<var>base</var>  [plus <var>num</var> <var>type</var>] [<var>num</var> <var>type</var>] ..."
  85 ExpiresByType type/encoding "<var>base</var>  [plus <var>num</var> <var>type</var>] [<var>num</var> <var>type</var>] ..."</pre>
  86
  87
  88     <p>where <var>base</var> is one of:</p>
  89
  90     <ul>
  91       <li><code>access</code></li>
  92
  93       <li><code>now</code> (equivalent to
  94       '<code>access</code>')</li>
  95
  96       <li><code>modification</code></li>
  97     </ul>
  98
  99     <p>The <code>plus</code> keyword is optional. <var>num</var>
 100     should be an integer value [acceptable to <code>atoi()</code>],
 101     and <var>type</var> is one of:</p>
 102
 103     <ul>
 104       <li><code>years</code></li>
 105       <li><code>months</code></li>
 106       <li><code>weeks</code></li>
 107       <li><code>days</code></li>
 108       <li><code>hours</code></li>
 109       <li><code>minutes</code></li>
 110       <li><code>seconds</code></li>
 111     </ul>
 112
 113     <p>For example, any of the following directives can be used to
 114     make documents expire 1 month after being accessed, by
 115     default:</p>
 116
 117     <pre class="prettyprint lang-config">ExpiresDefault "access plus 1 month"
 118 ExpiresDefault "access plus 4 weeks"
 119 ExpiresDefault "access plus 30 days"</pre>
 120
 121
 122     <p>The expiry time can be fine-tuned by adding several
 123     '<var>num</var> <var>type</var>' clauses:</p>
 124
 125     <pre class="prettyprint lang-config">ExpiresByType text/html "access plus 1 month 15 days 2 hours"
 126 ExpiresByType image/gif "modification plus 5 hours 3 minutes"</pre>
 127
 128
 129     <p>Note that if you use a modification date based setting, the
 130     Expires header will <strong>not</strong> be added to content
 131     that does not come from a file on disk. This is due to the fact
 132     that there is no modification time for such content.</p>
 133 </div>
 134 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 135 <div class="directive-section"><h2><a name="ExpiresActive" id="ExpiresActive">ExpiresActive</a> <a name="expiresactive" id="expiresactive">Directive</a></h2>
 136 <table class="directive">
 137 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables generation of <code>Expires</code>
 138 headers</td></tr>
 139 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ExpiresActive On|Off</code></td></tr>
 140 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ExpiresActive Off</code></td></tr>
 141 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 142 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 143 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 144 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_expires</td></tr>
 145 </table>
 146     <p>This directive enables or disables the generation of the
 147     <code>Expires</code> and <code>Cache-Control</code> headers for
 148     the document realm in question.  (That is, if found in an
 149     <code>.htaccess</code> file, for instance, it applies only to
 150     documents generated from that directory.) If set to
 151     <code>Off</code>, the headers will not be generated for any
 152     document in the realm (unless overridden at a lower level, such as
 153     an <code>.htaccess</code> file overriding a server config
 154     file). If set to <code>On</code>, the headers will be added to
 155     served documents according to the criteria defined by the
 156     <code class="directive"><a href="#expiresbytype">ExpiresByType</a></code> and
 157     <code class="directive"><a href="#expiresdefault">ExpiresDefault</a></code>
 158     directives (<em>q.v.</em>).</p>
 159
 160     <p>Note that this directive does not guarantee that an
 161     <code>Expires</code> or <code>Cache-Control</code> header will be
 162     generated. If the criteria aren't met, no header will be sent, and
 163     the effect will be as though this directive wasn't even
 164     specified.</p>
 165
 166 </div>
 167 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 168 <div class="directive-section"><h2><a name="ExpiresByType" id="ExpiresByType">ExpiresByType</a> <a name="expiresbytype" id="expiresbytype">Directive</a></h2>
 169 <table class="directive">
 170 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Value of the <code>Expires</code> header configured
 171 by MIME type</td></tr>
 172 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ExpiresByType <var>MIME-type</var>
 173 <var>&lt;code&gt;seconds</var></code></td></tr>
 174 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 175 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 176 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 177 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_expires</td></tr>
 178 </table>
 179     <p>This directive defines the value of the <code>Expires</code>
 180     header and the <code>max-age</code> directive of the
 181     <code>Cache-Control</code> header generated for documents of the
 182     specified type (<em>e.g.</em>, <code>text/html</code>). The second
 183     argument sets the number of seconds that will be added to a base
 184     time to construct the expiration date.  The <code>Cache-Control:
 185     max-age</code> is calculated by subtracting the request time from
 186     the expiration date and expressing the result in seconds.</p>
 187
 188     <p>The base time is either the last modification time of the
 189     file, or the time of the client's access to the document. Which
 190     should be used is specified by the
 191     <code><var>&lt;code&gt;</var></code> field; <code>M</code>
 192     means that the file's last modification time should be used as
 193     the base time, and <code>A</code> means the client's access
 194     time should be used.</p>
 195
 196     <p>The difference in effect is subtle. If <code>M</code> is used,
 197     all current copies of the document in all caches will expire at
 198     the same time, which can be good for something like a weekly
 199     notice that's always found at the same URL. If <code>A</code> is
 200     used, the date of expiration is different for each client; this
 201     can be good for image files that don't change very often,
 202     particularly for a set of related documents that all refer to
 203     the same images (<em>i.e.</em>, the images will be accessed
 204     repeatedly within a relatively short timespan).</p>
 205
 206     <div class="example"><h3>Example:</h3><pre class="prettyprint lang-config"># enable expirations
 207 ExpiresActive On
 208 # expire GIF images after a month in the client's cache
 209 ExpiresByType image/gif A2592000
 210 # HTML documents are good for a week from the
 211 # time they were changed
 212 ExpiresByType text/html M604800</pre>
 213 </div>
 214
 215     <p>Note that this directive only has effect if
 216     <code>ExpiresActive On</code> has been specified. It overrides,
 217     for the specified MIME type <em>only</em>, any expiration date
 218     set by the <code class="directive"><a href="#expiresdefault">ExpiresDefault</a></code>
 219     directive.</p>
 220
 221     <p>You can also specify the expiration time calculation using
 222     an <a href="#AltSyn">alternate syntax</a>, described earlier in
 223     this document.</p>
 224
 225 </div>
 226 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 227 <div class="directive-section"><h2><a name="ExpiresDefault" id="ExpiresDefault">ExpiresDefault</a> <a name="expiresdefault" id="expiresdefault">Directive</a></h2>
 228 <table class="directive">
 229 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Default algorithm for calculating expiration time</td></tr>
 230 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ExpiresDefault <var>&lt;code&gt;seconds</var></code></td></tr>
 231 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 232 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 233 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 234 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_expires</td></tr>
 235 </table>
 236     <p>This directive sets the default algorithm for calculating the
 237     expiration time for all documents in the affected realm. It can be
 238     overridden on a type-by-type basis by the <code class="directive"><a href="#expiresbytype">ExpiresByType</a></code> directive. See the
 239     description of that directive for details about the syntax of the
 240     argument, and the <a href="#AltSyn">alternate syntax</a>
 241     description as well.</p>
 242
 243 </div>
 244 </div>
 245 <div class="bottomlang">
 246 <p><span>Available Languages: </span><a href="../en/mod/mod_expires.html" title="English">&nbsp;en&nbsp;</a> |
 247 <a href="../fr/mod/mod_expires.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 248 <a href="../ja/mod/mod_expires.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 249 <a href="../ko/mod/mod_expires.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 250 </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>
 251 <script type="text/javascript"><!--//--><![CDATA[//><!--
 252 var comments_shortname = 'httpd';
 253 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_expires.html';
 254 (function(w, d) {
 255     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 256         d.write('<div id="comments_thread"><\/div>');
 257         var s = d.createElement('script');
 258         s.type = 'text/javascript';
 259         s.async = true;
 260         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 261         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 262     }
 263     else {
 264         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 265     }
 266 })(window, document);
 267 //--><!]]></script></div><div id="footer">
 268 <p class="apache">Copyright 2017 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>
 269 <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[//><!--
 270 if (typeof(prettyPrint) !== 'undefined') {
 271     prettyPrint();
 272 }
 273 //--><!]]></script>
 274 </body></html>