Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_ssi_module.xml @ 531:ee6fa4805637
Donor added.
author | Maxim Konovalov <maxim@nginx.com> |
---|---|
date | Thu, 07 Jun 2012 12:30:49 +0000 |
parents | a56540cdcea5 |
children | 694db9597ee0 |
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 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
4 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
5 <module name="Module ngx_http_ssi_module" |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
6 link="/en/docs/http/ngx_http_ssi_module.html" |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
7 lang="en"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
8 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
9 <section id="summary"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
10 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
12 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
|
13 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
|
14 passing through it. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
15 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
|
16 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
17 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
18 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
19 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
20 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
21 <section id="example" name="Example Configuration"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
22 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
23 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
24 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
25 location / { |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
26 ssi on; |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
27 ... |
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 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
30 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
31 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
32 </section> |
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 <section id="directives" name="Directives"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
36 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
37 <directive name="ssi"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
38 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
39 <default>off</default> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
40 <context>http</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
41 <context>server</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
42 <context>location</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
43 <context>if in location</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
44 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
45 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
46 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
|
47 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
48 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
49 </directive> |
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 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
52 <directive name="ssi_silent_errors"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
53 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
54 <default>off</default> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
55 <context>http</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
56 <context>server</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
57 <context>location</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
58 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
59 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
60 Allows to suppress output of the string |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
61 “<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
|
62 if an error occurred during SSI processing. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
63 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
64 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
65 </directive> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
66 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
67 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
68 <directive name="ssi_types"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
69 <syntax><value>mime-type</value> ...</syntax> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
70 <default>text/html</default> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
71 <context>http</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
72 <context>server</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
73 <context>location</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
74 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
75 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
76 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
|
77 in addition to “<literal>text/html</literal>”. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
78 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
79 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
80 </directive> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
81 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
82 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
83 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
84 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
85 <section id="commands" name="SSI Commands"> |
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 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
88 SSI commands have the following generic format: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
89 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
90 <!--# command parameter1=value1 parameter2=value2 ... --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
91 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
92 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
93 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
94 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
95 The following commands are supported: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
97 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
98 <tag-name><literal>block</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
99 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
100 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
|
101 in the <literal>include</literal> command. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
102 The block can contain other SSI commands. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
103 The command has the following parameter: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
104 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
105 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
106 <tag-name><literal>name</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
107 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
108 block name. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
109 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
110 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
111 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
112 Example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
113 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
114 <!--# block name="one" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
115 stub |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
116 <!--# endblock --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
117 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
118 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
119 </tag-desc> |
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 <tag-name><literal>config</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
123 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
124 Sets some parameters used during SSI processing, namely: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
125 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
126 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
127 <tag-name><literal>errmsg</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
128 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
129 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
|
130 By default, the following string is output: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
131 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
132 [an error occurred while processing the directive] |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
133 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
134 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
135 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
136 <tag-name><literal>timefmt</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
137 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
138 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
|
139 used to output date and time. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
140 By default, the following format is used: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
141 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
142 "%A, %d-%b-%Y %H:%M:%S %Z" |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
143 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
144 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
|
145 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
146 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
147 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
148 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
149 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
150 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
151 <tag-name><literal>echo</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
152 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 Outputs the value of a variable. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
154 The command has the following parameters: |
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 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
157 <tag-name><literal>var</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
159 variable 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 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
162 <tag-name><literal>encoding</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
163 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
164 encoding method. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
165 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
|
166 <literal>entity</literal>. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
167 By default, <literal>entity</literal> is used. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
168 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
169 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
170 <tag-name><literal>default</literal></tag-name> |
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 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
|
173 if a variable is undefined. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
174 By default, “<literal>none</literal>” is output. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
175 The command |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
176 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
177 <!--# echo var="name" default="<emphasis>no</emphasis>" --> |
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 replaces the following sequence of commands: |
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 <!--# if expr="$name" --><!--# echo var="name" --><!--# |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
182 else --><emphasis>no</emphasis><!--# endif --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
183 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
184 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
185 </list> |
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 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
188 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
189 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
190 <tag-name><literal>if</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
191 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
192 Performs a conditional inclusion. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
193 The following commands are supported: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
194 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
195 <!--# if expr="..." --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
196 ... |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
197 <!--# elif expr="..." --> |
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 <!--# else --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
200 ... |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
201 <!--# endif --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
202 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
203 Only one level of nesting is currently supported. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
204 The command has the following parameter: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
205 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
206 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
207 <tag-name><literal>expr</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 expression. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
210 An expression can be: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
211 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
212 <list type="bullet"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
213 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
214 <listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
215 variable existence check: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
216 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
217 <!--# if expr="$name" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
218 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
219 </listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
220 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
221 <listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
222 comparison of a variable with a text: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
223 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
224 <!--# if expr="$name = <value>text</value>" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 <!--# if expr="$name != <value>text</value>" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
226 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
227 </listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
228 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
229 <listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
230 comparison of a variable with a regular expression: |
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 <!--# if expr="$name = /<value>text</value>/" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
233 <!--# if expr="$name != /<value>text</value>/" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
234 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
235 </listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
236 </list> |
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 If a <value>text</value> contains variables, |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
239 their values are substituted. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
240 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
|
241 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
|
242 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
243 <!--# if expr="$name = /(.+)@(?P<domain>.+)/" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
244 <!--# echo var="1" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
245 <!--# echo var="domain" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
246 <!--# endif --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
247 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
248 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
249 </list> |
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 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
252 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
253 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
254 <tag-name><literal>include</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
255 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
256 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
|
257 The command has the following parameters: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
258 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
259 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
260 <tag-name><literal>file</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
261 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
262 specifies an included file, for example: |
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 <!--# include file="footer.html" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
265 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
266 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
267 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
268 <tag-name><literal>virtual</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
269 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
270 specifies an included request, for example: |
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 <!--# include virtual="/remote/body.php?argument=value" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
273 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
274 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
|
275 FastCGI servers run in parallel. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
276 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
|
277 parameter should be used. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
278 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
279 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
280 <tag-name><literal>stub</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
281 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
282 non-standard parameter that names the block whose |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
283 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
|
284 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
|
285 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
286 <!--# block name="one" -->&nbsp;<!--# endblock --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
287 <!--# include virtual="/remote/body.php?argument=value" stub="one" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
288 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
289 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
|
290 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
291 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
292 <tag-name><literal>wait</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
293 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
294 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
|
295 complete before continuing with SSI processing, for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
296 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
297 <!--# include virtual="/remote/body.php?argument=value" wait="yes" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
298 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
299 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
300 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
301 <tag-name><literal>set</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
302 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
303 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
|
304 of request processing to the specified variable, |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
305 for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
306 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
307 <!--# include virtual="/remote/body.php?argument=value" set="one" --> |
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 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
|
310 <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
|
311 <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
|
312 modules can be written into variables. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
313 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
314 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
315 </list> |
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-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
318 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
319 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
320 <tag-name><literal>set</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
321 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
322 Sets a value of a variable. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
323 The command has the following parameters: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
324 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
325 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
326 <tag-name><literal>var</literal></tag-name> |
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 variable name. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
329 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
330 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
331 <tag-name><literal>value</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
332 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
333 variable value. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
334 If an assigned value contains variables, |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
335 their values are substituted. |
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 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
338 |
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 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
341 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
342 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
343 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
344 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
345 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
346 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
347 <section id="variables" name="Embedded Variables"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
348 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
349 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
350 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
|
351 two embedded variables: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
352 <list type="tag"> |
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-name><var>$date_local</var></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
355 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
356 current time in local time zone. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
357 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
|
358 with the <literal>timefmt</literal> parameter. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
359 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
360 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
361 <tag-name><var>$date_gmt</var></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
362 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
363 current time in GMT. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
364 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
|
365 with the <literal>timefmt</literal> parameter. |
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 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
369 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
370 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
371 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
372 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
373 </module> |