Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_headers_module.xml @ 770:a879f261f3db

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Reduced unnecessary diffs between "add_header" and "expires" texts.
author Ruslan Ermilov <ru@nginx.com>
date Tue, 20 Nov 2012 06:52:11 +0000
parents 3974a50b2142
children b4fc7d571e48
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
353
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
580
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 427
diff changeset
3 <!--
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 427
diff changeset
4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 427
diff changeset
5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 427
diff changeset
6 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 427
diff changeset
7
353
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 <module name="Module ngx_http_headers_module"
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 link="/en/docs/http/ngx_http_headers_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
12 lang="en"
762
3974a50b2142 Documented that "expires" adds or modifies headers only on certain response codes.
Sergey Budnevitch <sb@waeme.net>
parents: 686
diff changeset
13 rev="3">
353
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15 <section id="summary">
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 <para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 The <literal>ngx_http_headers_module</literal> module allows to emit
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 the <header>Expires</header> and <header>Cache-Control</header> header
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 fields, and to add arbitrary fields to a response header.
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 </para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23 </section>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24
364
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 353
diff changeset
25
353
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 <section id="example" name="Example Configuration">
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 <para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29 <example>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 expires 24h;
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 expires modified +24h;
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 expires @24h;
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 expires 0;
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 expires -1;
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 expires epoch;
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 add_header Cache-Control private;
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37 </example>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 </para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40 </section>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 <section id="directives" name="Directives">
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45 <directive name="add_header">
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 <syntax><value>name</value> <value>value</value></syntax>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47 <default/>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48 <context>http</context>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 <context>server</context>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 <context>location</context>
686
f368bff5c70a Documented missing contexts in the http_headers module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
51 <context>if in location</context>
353
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 <para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54 Adds the specified field to a response header provided that
427
d4464d7bff6c Bring the list of response codes acceptable by ngx_http_headers_module
Ruslan Ermilov <ru@nginx.com>
parents: 367
diff changeset
55 the response code equals 200, 204, 206, 301, 302, 303, 304, or 307.
353
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 A value can contain variables.
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 </para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 </directive>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 <directive name="expires">
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 <syntax>[<literal>modified</literal>] <value>time</value></syntax>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 <syntax>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65 <literal>epoch</literal> |
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
66 <literal>max</literal> |
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
67 <literal>off</literal></syntax>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68 <default>off</default>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69 <context>http</context>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 <context>server</context>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71 <context>location</context>
686
f368bff5c70a Documented missing contexts in the http_headers module.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
72 <context>if in location</context>
353
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74 <para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 Enables or disables adding or modifying the <header>Expires</header>
770
a879f261f3db Reduced unnecessary diffs between "add_header" and "expires" texts.
Ruslan Ermilov <ru@nginx.com>
parents: 762
diff changeset
76 and <header>Cache-Control</header> response header fields provided that
a879f261f3db Reduced unnecessary diffs between "add_header" and "expires" texts.
Ruslan Ermilov <ru@nginx.com>
parents: 762
diff changeset
77 the response code equals 200, 204, 206, 301, 302, 303, 304, or 307.
353
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 A parameter can be a positive or negative
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79 <link doc="../syntax.xml">time</link>.
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 </para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82 <para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 A time in the <header>Expires</header> field is computed as a sum of the
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84 current time and <value>time</value> specified in the directive.
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85 If the <literal>modified</literal> parameter is used (0.7.0, 0.6.32)
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86 then time is computed as a sum of the file’s modification time and
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87 <value>time</value> specified in the directive.
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88 </para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 <para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91 In addition, it is possible to specify a time of the day using
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 the “<literal>@</literal>” prefix (0.7.9, 0.6.34):
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93 <example>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 expires @15h30m;
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 </example>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 </para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98 <para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99 The <literal>epoch</literal> parameter corresponds to the absolute time
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100 “<literal>Thu, 01 Jan 1970 00:00:01 GMT</literal>”.
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101 The contents of the <header>Cache-Control</header> field depends
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
102 on the sign of the specified time:
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103 <list type="bullet">
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
105 <listitem>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106 time is negative — <header>Cache-Control: no-cache</header>.
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
107 </listitem>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109 <listitem>
367
f4033b9bc4ec - Removed unnecessary instances of unbreakable space.
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
110 time is positive or zero —
353
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 <header>Cache-Control: max-age=<value>t</value></header>,
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 where <value>t</value> is a time specified in the directive, in seconds.
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 </listitem>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
114
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115 </list>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116 </para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
118 <para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
119 The <literal>max</literal> parameter sets <header>Expires</header>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 to the value “<literal>Thu, 31 Dec 2037 23:55:55 GMT</literal>”,
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 and <header>Cache-Control</header> to 10 years.
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122 </para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124 <para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125 The <literal>off</literal> parameter disables adding or modifying the
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
126 <header>Expires</header> and <header>Cache-Control</header> response
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
127 header fields.
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128 </para>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
129
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
130 </directive>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
131
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
132 </section>
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
133
7b6155ac373b Revised the Russian version of ngx_http_headers_module and translated
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
134 </module>