Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_ssi_module.xml @ 726:7b28d6ae4539

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Bumped revision.
author Vladimir Homutov <vl@nginx.com>
date Fri, 12 Oct 2012 13:22:32 +0000
parents 64085bf227f6
children ae785c6aaa91
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
399
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
580
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 546
diff changeset
3 <!--
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 546
diff changeset
4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 546
diff changeset
5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 546
diff changeset
6 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 546
diff changeset
7
399
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 <module name="Module ngx_http_ssi_module"
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 link="/en/docs/http/ngx_http_ssi_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
12 lang="en"
726
7b28d6ae4539 Bumped revision.
Vladimir Homutov <vl@nginx.com>
parents: 725
diff changeset
13 rev="2">
399
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15 <section id="summary">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 <para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 The <literal>ngx_http_ssi_module</literal> module is a filter
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 that processes SSI (Server Side Includes) commands in responses
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 passing through it.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 Currently, the list of supported SSI commands is incomplete.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22 </para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 </section>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 <section id="example" name="Example Configuration">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29 <para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 location / {
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 ssi on;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 ...
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 }
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 </para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 </section>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41 <section id="directives" name="Directives">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 <directive name="ssi">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 <syntax><literal>on</literal> | <literal>off</literal></syntax>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45 <default>off</default>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 <context>http</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47 <context>server</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48 <context>location</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 <context>if in location</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 <para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52 Enables or disables processing of SSI commands in responses.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 </para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55 </directive>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57
725
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
58 <directive name="ssi_min_file_chunk">
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
59 <syntax><literal>size</literal></syntax>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
60 <default>1k</default>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
61 <context>http</context>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
62 <context>server</context>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
63 <context>location</context>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
64
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
65 <para>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
66 Sets the minimum <value>size</value> for parts of a response stored on disk,
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
67 starting from which it makes sense to send them using
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
68 <link doc="ngx_http_core_module.xml" id="sendfile"/>.
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
69 </para>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
70
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
71 </directive>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
72
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
73
399
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74 <directive name="ssi_silent_errors">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 <syntax><literal>on</literal> | <literal>off</literal></syntax>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 <default>off</default>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77 <context>http</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 <context>server</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79 <context>location</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81 <para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82 Allows to suppress output of the string
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 “<literal>[an error occurred while processing the directive]</literal>”
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84 if an error occurred during SSI processing.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85 </para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87 </directive>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 <directive name="ssi_types">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91 <syntax><value>mime-type</value> ...</syntax>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 <default>text/html</default>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93 <context>http</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 <context>server</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 <context>location</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97 <para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98 Enables processing of SSI commands in responses with the specified MIME types
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99 in addition to “<literal>text/html</literal>”.
546
694db9597ee0 Documented the special value "*" in various "*_type" directives.
Ruslan Ermilov <ru@nginx.com>
parents: 399
diff changeset
100 The special value “<literal>*</literal>” matches any MIME type (0.8.29).
399
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101 </para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
102
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103 </directive>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104
725
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
105
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
106 <directive name="ssi_value_length">
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
107 <syntax><value>length</value></syntax>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
108 <default>256</default>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
109 <context>http</context>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
110 <context>server</context>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
111 <context>location</context>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
112
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
113 <para>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
114 Sets the maximum length for values of parameters in SSI commands.
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
115 </para>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
116
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
117 </directive>
64085bf227f6 Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents: 589
diff changeset
118
399
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
119 </section>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122 <section id="commands" name="SSI Commands">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124 <para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125 SSI commands have the following generic format:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
126 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
127 &lt;!--# command parameter1=value1 parameter2=value2 ... --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
129 </para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
130
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
131 <para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
132 The following commands are supported:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
133 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
134
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
135 <tag-name><literal>block</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
136 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
137 Defines a block that can be used as a stub
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
138 in the <literal>include</literal> command.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
139 The block can contain other SSI commands.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
140 The command has the following parameter:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
142 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
143 <tag-name><literal>name</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
144 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
145 block name.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
146 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
147 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
148
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
149 Example:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
150 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
151 &lt;!--# block name="one" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
152 stub
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
153 &lt;!--# endblock --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
154 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
155
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
156 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
157
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
158
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
159 <tag-name><literal>config</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
160 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
161 Sets some parameters used during SSI processing, namely:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
162
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
163 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
164 <tag-name><literal>errmsg</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
165 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
166 a string that is output if an error occurs during SSI processing.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
167 By default, the following string is output:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
168 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
169 [an error occurred while processing the directive]
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
170 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
171 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173 <tag-name><literal>timefmt</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175 a format string passed to the <c-func>strftime</c-func> function
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
176 used to output date and time.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
177 By default, the following format is used:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
178 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
179 "%A, %d-%b-%Y %H:%M:%S %Z"
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
180 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181 The “<literal>%s</literal>” format is suitable to output time in seconds.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
186
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
187
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188 <tag-name><literal>echo</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
189 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
190 Outputs the value of a variable.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
191 The command has the following parameters:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
192
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194 <tag-name><literal>var</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
195 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
196 variable name.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
197 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
198
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
199 <tag-name><literal>encoding</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
200 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
201 encoding method.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
202 Possible values include <literal>none</literal>, <literal>url</literal>, and
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
203 <literal>entity</literal>.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
204 By default, <literal>entity</literal> is used.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
205 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
206
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
207 <tag-name><literal>default</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
208 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
209 non-standard parameter that sets a string to be output
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
210 if a variable is undefined.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
211 By default, “<literal>none</literal>” is output.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
212 The command
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
213 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
214 &lt;!--# echo var="name" default="<emphasis>no</emphasis>" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
215 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
216 replaces the following sequence of commands:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
217 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
218 &lt;!--# if expr="$name" --&gt;&lt;!--# echo var="name" --&gt;&lt;!--#
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
219 else --&gt;<emphasis>no</emphasis>&lt;!--# endif --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
220 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
221 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
222 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
223
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
224 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
225
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
226
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
227 <tag-name><literal>if</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
228 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
229 Performs a conditional inclusion.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
230 The following commands are supported:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
231 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
232 &lt;!--# if expr="..." --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
233 ...
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
234 &lt;!--# elif expr="..." --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
235 ...
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
236 &lt;!--# else --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
237 ...
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
238 &lt;!--# endif --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
239 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
240 Only one level of nesting is currently supported.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
241 The command has the following parameter:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
242
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
243 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
244 <tag-name><literal>expr</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
245 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
246 expression.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
247 An expression can be:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
248
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
249 <list type="bullet">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
250
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
251 <listitem>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
252 variable existence check:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
253 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
254 &lt;!--# if expr="$name" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
255 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
256 </listitem>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
257
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
258 <listitem>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
259 comparison of a variable with a text:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
260 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
261 &lt;!--# if expr="$name = <value>text</value>" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
262 &lt;!--# if expr="$name != <value>text</value>" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
263 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
264 </listitem>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
265
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
266 <listitem>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
267 comparison of a variable with a regular expression:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
268 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
269 &lt;!--# if expr="$name = /<value>text</value>/" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
270 &lt;!--# if expr="$name != /<value>text</value>/" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
271 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
272 </listitem>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
273 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
274
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
275 If a <value>text</value> contains variables,
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
276 their values are substituted.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
277 A regular expression can contain positional and named captures
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
278 that can later be used through variables, for example:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
279 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
280 &lt;!--# if expr="$name = /(.+)@(?P&lt;domain&gt;.+)/" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
281 &lt;!--# echo var="1" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
282 &lt;!--# echo var="domain" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
283 &lt;!--# endif --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
284 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
285 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
286 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
287
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
288 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
289
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
290
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
291 <tag-name><literal>include</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
292 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
293 Includes the result of another request into a response.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
294 The command has the following parameters:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
295
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
296 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
297 <tag-name><literal>file</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
298 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
299 specifies an included file, for example:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
300 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
301 &lt;!--# include file="footer.html" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
302 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
303 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
304
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
305 <tag-name><literal>virtual</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
306 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
307 specifies an included request, for example:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
308 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
309 &lt;!--# include virtual="/remote/body.php?argument=value" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
310 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
311 Several requests specified on one page and processed by proxied or
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
312 FastCGI servers run in parallel.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
313 If sequential processing is desired, the <literal>wait</literal>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
314 parameter should be used.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
315 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
316
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
317 <tag-name><literal>stub</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
318 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
319 non-standard parameter that names the block whose
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
320 content will be output if an included request results in an empty
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
321 body or if an error occurs during request processing, for example:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
322 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
323 &lt;!--# block name="one" --&gt;&amp;nbsp;&lt;!--# endblock --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
324 &lt;!--# include virtual="/remote/body.php?argument=value" stub="one" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
325 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
326 The replacement block content is processed in the included request context.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
327 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
328
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
329 <tag-name><literal>wait</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
330 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
331 non-standard parameter that instructs to wait for a request to fully
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
332 complete before continuing with SSI processing, for example:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
333 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
334 &lt;!--# include virtual="/remote/body.php?argument=value" wait="yes" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
335 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
336 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
337
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
338 <tag-name><literal>set</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
339 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
340 non-standard parameter that instructs to write a successful result
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
341 of request processing to the specified variable,
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
342 for example:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
343 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
344 &lt;!--# include virtual="/remote/body.php?argument=value" set="one" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
345 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
346 It should be noted that only the results of responses obtained using the
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
347 <link doc="ngx_http_proxy_module.xml">ngx_http_proxy_module</link> and
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
348 <link doc="ngx_http_memcached_module.xml">ngx_http_memcached_module</link>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
349 modules can be written into variables.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
350 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
351
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
352 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
353
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
354 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
355
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
356
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
357 <tag-name><literal>set</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
358 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
359 Sets a value of a variable.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
360 The command has the following parameters:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
361
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
362 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
363 <tag-name><literal>var</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
364 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
365 variable name.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
366 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
367
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
368 <tag-name><literal>value</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
369 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
370 variable value.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
371 If an assigned value contains variables,
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
372 their values are substituted.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
373 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
374 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
375
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
376 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
377
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
378 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
379 </para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
380
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
381 </section>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
382
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
383
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
384 <section id="variables" name="Embedded Variables">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
385
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
386 <para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
387 The <literal>ngx_http_ssi_module</literal> module supports
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
388 two embedded variables:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
389 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
390
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
391 <tag-name><var>$date_local</var></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
392 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
393 current time in local time zone.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
394 The format is set by the <literal>config</literal> command
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
395 with the <literal>timefmt</literal> parameter.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
396 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
397
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
398 <tag-name><var>$date_gmt</var></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
399 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
400 current time in GMT.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
401 The format is set by the <literal>config</literal> command
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
402 with the <literal>timefmt</literal> parameter.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
403 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
404
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
405 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
406 </para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
407
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
408 </section>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
409
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
410 </module>