manual/mod/mod_expires.html

	mod_expires.html revision b0e3ab3976be7487e581aa06e37b75f0f4f0ded7
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest<HTML>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest <HEAD>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <TITLE>Apache module mod_expires</TITLE>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest </HEAD>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest <BODY
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  BGCOLOR="#FFFFFF"
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  TEXT="#000000"
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  LINK="#0000FF"
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  VLINK="#000080"
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  ALINK="#FF0000"
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest >
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <!--#include virtual="header.html" -->
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <H1 ALIGN="CENTER">Module mod_expires</H1>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <P>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  This module is contained in the <CODE>mod_expires.c</CODE> file, and
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  is <STRONG>not</STRONG> compiled in by default.  It provides for the
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  generation of <CODE>Expires</CODE> headers according to user-specified
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  criteria.
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  </P>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <H2>Summary</H2>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <P>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  This module controls the setting of the <CODE>Expires</CODE> HTTP
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  header in server responses.  The expiration date can set to be
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest  relative to either the time the source file was last modified, or to
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  the time of the client access.
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  </P>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <P>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  The <CODE>Expires</CODE> HTTP header is an instruction to the client
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  about the document's validity and persistence.  If cached, the document
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  may be fetched from the cache rather than from the source until this
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest  time has passed.  After that, the cache copy is considered
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  &quot;expired&quot; and invalid, and a new copy must be obtained from
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest  the source.
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  </P>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <H2>Directives</H2>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <P>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <MENU>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest   <LI><A
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest        HREF="#expiresactive"
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest       >ExpiresActive</A>
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest   </LI>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest   <LI><A
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest        HREF="#expiresbytype"
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest       >ExpiresByType</A>
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest   </LI>
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest   <LI><A
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest        HREF="#expiresdefault"
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest       >ExpiresDefault</A>
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest   </LI>
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest  </MENU>
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest  <HR>
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest  <H2><A NAME="expiresactive">
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest   ExpiresActive directive
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  </A></H2>
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest  <!--%plaintext &lt;?INDEX {\tt ExpiresActive} directive&gt; -->
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <P>
bf41c4342792552d38ff8e8857d4869470694fe3Andrew Forrest  <STRONG>Syntax:</STRONG> ExpiresActive <EM>boolean</EM>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <BR>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <STRONG>Context:</STRONG> server config, virtual host, directory, .htaccess
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <br>
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <STRONG>Override:</STRONG> Indexes
1351c9607d0f3eb5f61b8c90cf53b997dc7744b7Andrew Forrest  <br>
  <STRONG>Status:</STRONG> Extension
  <br>
  <STRONG>Module:</STRONG> mod_expires
  </P>
  <P>
  This directive enables or disables the generation of the
  <CODE>Expires</CODE> header for the document realm in question.  (That
  is, if found in an <CODE>.htaccess</CODE> file, for instance, it
  applies only to documents generated from that directory.)  If set to
  <EM><CODE>Off</CODE></EM>, no <CODE>Expires</CODE> header will be
  generated for any document in the realm (unless overridden at a lower
  level, such as an <CODE>.htaccess</CODE> file overriding a server
  config file).  If set to <EM><CODE>On</CODE></EM>, the header will be
  added to served documents according to the criteria defined by the
  <A
   HREF="#expiresbytype"
  >ExpiresByType</A>
  and
  <A
   HREF="#expiresdefault"
  >ExpiresDefault</A>
  directives (<EM>q.v.</EM>).
  </P>
  <P>
  Note that this directive does not guarantee that an
  <CODE>Expires</CODE> header will be generated.  If the criteria aren't
  met, no header will be sent, and the effect will be as though this
  directive wasn't even specified.
  </P>
  <HR>
  <H2><A NAME="expiresbytype">
   ExpiresByType directive
  </A></H2>
  <!--%plaintext &lt;?INDEX {\tt ExpiresByType} directive&gt; -->
  <P>
  <STRONG>Syntax:</STRONG> ExpiresByType <EM>mime-type &lt;code&gt;seconds</EM>
  <BR>
  <STRONG>Context:</STRONG> server config, virtual host, directory, .htaccess
  <br>
  <STRONG>Override:</STRONG> Indexes
  <br>
  <STRONG>Status:</STRONG> Extension
  <br>
  <STRONG>Module:</STRONG> mod_expires
  </P>
  <P>
  This directive defines the value of the <CODE>Expires</CODE> header
  generated for documents of the specified type (<EM>e.g.</EM>,
  <CODE>text/html</CODE>).  The second argument sets the number of
  seconds that will be added to a base time to construct the expiration
  date.
  </P>
  <P>
  The base time is either the last modification time of the file, or the
  time of the client's access to the document.  Which should be used is
  specified by the <CODE><EM>&lt;code&gt;</EM></CODE> field;
  <STRONG>M</STRONG> means that the file's last modification time should
  be used as the base time, and <STRONG>A</STRONG> means the client's
  access time should be used.
  </P>
  <P>
  The difference in effect is subtle.  If <EM>M</EM> is used, all current
  copies of the document in all caches will expire at the same time,
  which can be good for something like a weekly notice that's always
  found at the same URL.  If <EM>A</EM> is used, the date of expiration
  is different for each client; this can be good for image files that
  don't change very often, particularly for a set of related documents
  that all refer to the same images (<EM>i.e.</EM>, the images will be
  accessed repeatedly within a relatively short timespan).
  </P>
  <P>
  <STRONG>Example:</STRONG>
  </P>
  <P>
  <PRE>
   ExpiresActive On                  # enable expirations
   ExpiresByType image/gif A2592000  # expire GIF images after a month
                                     #  in the client's cache
   ExpiresByType text/html M604800   # HTML documents are good for a
                                     #  week from the time they were
                                     #  changed, period
  </PRE>
  </P>
  <P>
  Note that this directive only has effect if <CODE>ExpiresActive
  On</CODE> has been specified.  It overrides, for the specified MIME
  type <EM>only</EM>, any expiration date set by the
  <A
   HREF="#expiresdefault"
  >ExpiresDefault</A>
  directive.
  </P>
  <P>
  You can also specify the expiration time calculation using an
  <A
   HREF="#AltSyn"
  >alternate syntax</A>,
  described later in this document.
  </P>
  <HR>
  <H2><A NAME="expiresdefault">
   ExpiresDefault directive
  </A></H2>
  <!--%plaintext &lt;?INDEX {\tt ExpiresDefault} directive&gt; -->
  <P>
  <STRONG>Syntax:</STRONG> ExpiresDefault <EM>&lt;code&gt;seconds</EM>
  <BR>
  <STRONG>Context:</STRONG> server config, virtual host, directory, .htaccess
  <br>
  <STRONG>Override:</STRONG> Indexes
  <br>
  <STRONG>Status:</STRONG> Extension
  <br>
  <STRONG>Module:</STRONG> mod_expires
  </P>
  <P>
  This directive sets the default algorithm for calculating the
  expiration time for all documents in the affected realm.  It can be
  overridden on a type-by-type basis by the
  <A
   HREF="#expiresbytype"
  >ExpiresByType</A>
  directive.  See the description of that directive for details about
  the syntax of the argument, and the
  <A
   HREF="#AltSyn"
  >alternate syntax</A>
  description as well.
  </P>
  <HR>
  <H2>
   <A NAME="AltSyn">Alternate Interval Syntax</A>
  </H2>
  <P>
  The
  <A
   HREF="#expiresdefault"
  ><SAMP>ExpiresDefault</SAMP></A>
  and
  <A
   HREF="#expiresbytype"
  ><SAMP>ExpiresByType</SAMP></A>
  directives can also be defined in a more readable syntax of the form:
  </P>
  <DL>
   <DD><CODE>ExpiresDefault "&lt;base&gt; [plus] {&lt;num&gt; &lt;type&gt;}*"
    <BR>
    ExpiresByType type/encoding "&lt;base&gt; [plus] {&lt;num&gt; &lt;type&gt;}*"</CODE>
   </DD>
  </DL>
  <P>
  where &lt;base&gt; is one of:
  </P>
  <MENU>
   <LI><SAMP>access</SAMP>
   </LI>
   <LI><SAMP>now</SAMP> (equivalent to '<SAMP>access</SAMP>')
   </LI>
   <LI><SAMP>modification</SAMP>
   </LI>
  </MENU>
  </P>
  <P>
  The '<SAMP>plus</SAMP>' keyword is optional.  &lt;num&gt; should be an
  integer value [acceptable to <SAMP>atoi()</SAMP>], and &lt;type&gt;
  is one of:
  </P>
  <MENU>
   <LI><SAMP>years</SAMP>
   </LI>
   <LI><SAMP>months</SAMP>
   </LI>
   <LI><SAMP>weeks</SAMP>
   </LI>
   <LI><SAMP>days</SAMP>
   </LI>
   <LI><SAMP>hours</SAMP>
   </LI>
   <LI><SAMP>minutes</SAMP>
   </LI>
   <LI><SAMP>seconds</SAMP>
   </LI>
  </MENU>
  <P>
  For example, any of the following directives can be used to make
  documents expire 1 month after being accessed, by default:
  </P>
  <DL>
   <DD><CODE>ExpiresDefault "access plus 1 month"
    <BR>
    ExpiresDefault "access plus 4 weeks"
    <BR>
    ExpiresDefault "access plus 30 days"
   </DD>
  </DL>
  <P>
  The expiry time can be fine-tuned by adding several '&lt;num&gt; &lt;type&gt;'
  clauses:
  </P>
  <DL>
   <DD><CODE>ExpiresByType text/html "access plus 1 month 15 days 2 hours"
    <BR>
    ExpiresByType image/gif "modification plus 5 hours 3 minutes"
   </DD>
  </DL>

  <!--#include virtual="footer.html" -->
 </BODY>
</HTML>