diff options
author | Justin Erenkrantz <jerenkrantz@apache.org> | 2004-10-23 19:45:55 +0200 |
---|---|---|
committer | Justin Erenkrantz <jerenkrantz@apache.org> | 2004-10-23 19:45:55 +0200 |
commit | 41ee74561cd41dff407b519c1f63975bcc3f42f0 (patch) | |
tree | 948bbba4003238ce866117446d76ada2ebb1b41b /docs/manual | |
parent | Note a backport. (diff) | |
download | apache2-41ee74561cd41dff407b519c1f63975bcc3f42f0.tar.xz apache2-41ee74561cd41dff407b519c1f63975bcc3f42f0.zip |
mod_cache: Add CacheIgnoreHeaders directive.
(Justin made some minor tweaks to the patch.)
PR: 30399
Submitted by: R�diger Pl�m <r.pluem@t-online.de>
Reviewed by: Justin Erenkrantz
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@105569 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual')
-rw-r--r-- | docs/manual/mod/mod_cache.xml | 55 |
1 files changed, 54 insertions, 1 deletions
diff --git a/docs/manual/mod/mod_cache.xml b/docs/manual/mod/mod_cache.xml index 1f8957633e..b69310b9b3 100644 --- a/docs/manual/mod/mod_cache.xml +++ b/docs/manual/mod/mod_cache.xml @@ -1,7 +1,7 @@ <?xml version="1.0"?> <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd"> <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?> -<!-- $Revision: 1.17 $ --> +<!-- $Revision: 1.18 $ --> <!-- Copyright 2002-2004 The Apache Software Foundation @@ -332,4 +332,57 @@ will complete caching the file even if the request is cancelled.</description> </usage> </directivesynopsis> +<directivesynopsis> +<name>CacheIgnoreHeaders</name> +<description>Do not store the given HTTP header(s) in the cache. +</description> +<syntax>CacheIgnoreHeaders <var>header-string</var> [<var>header-string</var>] ...</syntax> +<default>CacheIgnoreHeaders None</default> +<contextlist><context>server config</context><context>virtual host</context> +</contextlist> + +<usage> + <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 <directive>CacheIgnoreHeaders</directive>:</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><directive>CacheIgnoreHeaders</directive> 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><directive>CacheIgnoreHeaders</directive> 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), <directive>CacheIgnoreHeaders</directive> can be set to + <code>None</code>.</p> + + <example><title>Example 1</title> + CacheIgnoreHeaders Set-Cookie + </example> + + <example><title>Example 2</title> + CacheIgnoreHeaders None + </example> + + <note type="warning"><title>Warning:</title> + If headers like <code>Expires</code> which are needed for proper cache + management are not stored due to a + <directive>CacheIgnoreHeaders</directive> setting, the behaviour of + mod_cache is undefined. + </note> +</usage> +</directivesynopsis> + </modulesynopsis> |