Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_ssi_module.xml @ 2668:e067ad74b0cd
Corrected links to Response Object in njs reference.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Thu, 04 Mar 2021 16:38:14 +0000 |
parents | 5cacd6fffade |
children |
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 | 12 lang="en" |
2206
5cacd6fffade
Eliminated some examples of unsafe prefix locations.
Ruslan Ermilov <ru@nginx.com>
parents:
2134
diff
changeset
|
13 rev="12"> |
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 |
918
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
58 <directive name="ssi_last_modified"> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
59 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
60 <default>off</default> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
61 <context>http</context> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
62 <context>server</context> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
63 <context>location</context> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
64 <appeared-in>1.5.1</appeared-in> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
65 |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
66 <para> |
966 | 67 Allows preserving the <header>Last-Modified</header> header field |
918
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
68 from the original response during SSI processing |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
69 to facilitate response caching. |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
70 </para> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
71 |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
72 <para> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
73 By default, the header field is removed as contents of the response |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
74 are modified during processing and may contain dynamically generated elements |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
75 or parts that are changed independently of the original response. |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
76 </para> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
77 |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
78 </directive> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
79 |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
726
diff
changeset
|
80 |
725
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
81 <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
|
82 <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
|
83 <default>1k</default> |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
84 <context>http</context> |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
85 <context>server</context> |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
86 <context>location</context> |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
87 |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
88 <para> |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
89 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
|
90 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
|
91 <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
|
92 </para> |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
93 |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
94 </directive> |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
95 |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
96 |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
97 <directive name="ssi_silent_errors"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
98 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
99 <default>off</default> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
100 <context>http</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
101 <context>server</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
102 <context>location</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
103 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
104 <para> |
966 | 105 If enabled, suppresses the output of the |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
106 “<literal>[an error occurred while processing the directive]</literal>” |
966 | 107 string if an error occurred during SSI processing. |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
108 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
109 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
110 </directive> |
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 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
113 <directive name="ssi_types"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
114 <syntax><value>mime-type</value> ...</syntax> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
115 <default>text/html</default> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
116 <context>http</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
117 <context>server</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
118 <context>location</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
119 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
120 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
121 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
|
122 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
|
123 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
|
124 </para> |
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 </directive> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
127 |
725
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
128 |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
129 <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
|
130 <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
|
131 <default>256</default> |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
132 <context>http</context> |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
133 <context>server</context> |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
134 <context>location</context> |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
135 |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
136 <para> |
966 | 137 Sets the maximum length of parameter values in SSI commands. |
725
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
138 </para> |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
139 |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
140 </directive> |
64085bf227f6
Documented 'min_file_chunk' and 'value_length' SSI module directives.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
141 |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
142 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
143 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
144 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
145 <section id="commands" name="SSI Commands"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
146 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
147 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
148 SSI commands have the following generic format: |
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 <!--# command parameter1=value1 parameter2=value2 ... --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
151 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
152 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
154 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
155 The following commands are supported: |
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 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 <tag-name><literal>block</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
159 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
160 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
|
161 in the <literal>include</literal> command. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
162 The block can contain other SSI commands. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
163 The command has the following parameter: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
164 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
165 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
166 <tag-name><literal>name</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
167 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
168 block name. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
169 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
170 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
171 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
172 Example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
173 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
174 <!--# block name="one" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
175 stub |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
176 <!--# endblock --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
177 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
178 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
179 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
180 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
181 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
182 <tag-name><literal>config</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
183 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
184 Sets some parameters used during SSI processing, namely: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
185 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
186 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
187 <tag-name><literal>errmsg</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
188 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
189 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
|
190 By default, the following string is output: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
191 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
192 [an error occurred while processing the directive] |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
193 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
194 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
195 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
196 <tag-name><literal>timefmt</literal></tag-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 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
|
199 used to output date and time. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
200 By default, the following format is used: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
201 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
202 "%A, %d-%b-%Y %H:%M:%S %Z" |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
203 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
204 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
|
205 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
206 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
207 |
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 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
210 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
211 <tag-name><literal>echo</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
212 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
213 Outputs the value of a variable. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
214 The command has the following parameters: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
215 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
216 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
217 <tag-name><literal>var</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
218 <tag-desc> |
966 | 219 the variable name. |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
220 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
221 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
222 <tag-name><literal>encoding</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
223 <tag-desc> |
966 | 224 the encoding method. |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 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
|
226 <literal>entity</literal>. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
227 By default, <literal>entity</literal> is used. |
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 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
230 <tag-name><literal>default</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
231 <tag-desc> |
966 | 232 a non-standard parameter that sets a string to be output |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
233 if a variable is undefined. |
1875
4687cbd3c933
SSI: corrected how "echo var" outputs undefined variables.
Ruslan Ermilov <ru@nginx.com>
parents:
1194
diff
changeset
|
234 By default, “<literal>(none)</literal>” is output. |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
235 The command |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
236 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
237 <!--# echo var="name" default="<emphasis>no</emphasis>" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
238 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
239 replaces the following sequence of commands: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
240 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
241 <!--# if expr="$name" --><!--# echo var="name" --><!--# |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
242 else --><emphasis>no</emphasis><!--# endif --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
243 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
244 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
245 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
246 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
247 </tag-desc> |
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 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
250 <tag-name><literal>if</literal></tag-name> |
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 Performs a conditional inclusion. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
253 The following commands are supported: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
254 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
255 <!--# if expr="..." --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
256 ... |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
257 <!--# elif expr="..." --> |
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 <!--# else --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
260 ... |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
261 <!--# endif --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
262 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
263 Only one level of nesting is currently supported. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
264 The command has the following parameter: |
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 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
267 <tag-name><literal>expr</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
268 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
269 expression. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
270 An expression can be: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
271 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
272 <list type="bullet"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
273 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
274 <listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
275 variable existence check: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
276 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
277 <!--# if expr="$name" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
278 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
279 </listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
280 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
281 <listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
282 comparison of a variable with a text: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
283 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
284 <!--# if expr="$name = <value>text</value>" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
285 <!--# if expr="$name != <value>text</value>" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
286 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
287 </listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
288 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
289 <listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
290 comparison of a variable with a regular expression: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
291 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
292 <!--# if expr="$name = /<value>text</value>/" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
293 <!--# if expr="$name != /<value>text</value>/" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
294 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
295 </listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
296 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
297 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
298 If a <value>text</value> contains variables, |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
299 their values are substituted. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
300 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
|
301 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
|
302 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
303 <!--# if expr="$name = /(.+)@(?P<domain>.+)/" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
304 <!--# echo var="1" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
305 <!--# echo var="domain" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
306 <!--# endif --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
307 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
308 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
309 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
310 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
311 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
312 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
313 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
314 <tag-name><literal>include</literal></tag-name> |
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 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
|
317 The command has the following parameters: |
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 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
320 <tag-name><literal>file</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 specifies an included file, for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
323 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
324 <!--# include file="footer.html" --> |
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 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
327 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
328 <tag-name><literal>virtual</literal></tag-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 specifies an included request, for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
331 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
332 <!--# include virtual="/remote/body.php?argument=value" --> |
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 Several requests specified on one page and processed by proxied or |
2134
4cafd82e5007
Added info about gRPC to various modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2122
diff
changeset
|
335 FastCGI/uwsgi/SCGI/gRPC servers run in parallel. |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
336 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
|
337 parameter should be used. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
338 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
339 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
340 <tag-name><literal>stub</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
341 <tag-desc> |
966 | 342 a non-standard parameter that names the block whose |
343 content will be output if the included request results in an empty | |
344 body or if an error occurs during the request processing, for example: | |
399
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 <!--# block name="one" -->&nbsp;<!--# endblock --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
347 <!--# 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
|
348 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
349 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
|
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 <tag-name><literal>wait</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
353 <tag-desc> |
966 | 354 a non-standard parameter that instructs to wait for a request to fully |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
355 complete before continuing with SSI processing, for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
356 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
357 <!--# 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
|
358 </example> |
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 |
2118
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1875
diff
changeset
|
361 <tag-name id="ssi_include_set"><literal>set</literal></tag-name> |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
362 <tag-desc> |
966 | 363 a non-standard parameter that instructs to write a successful result |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
364 of request processing to the specified variable, |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
365 for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
366 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
367 <!--# 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
|
368 </example> |
2118
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1875
diff
changeset
|
369 The maximum size of the response is set by the |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1875
diff
changeset
|
370 <link doc="ngx_http_core_module.xml" id="subrequest_output_buffer_size"/> |
2122
86a73b6f32f2
Added example to ssi include set.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2118
diff
changeset
|
371 directive (1.13.10): |
86a73b6f32f2
Added example to ssi include set.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2118
diff
changeset
|
372 <example> |
2206
5cacd6fffade
Eliminated some examples of unsafe prefix locations.
Ruslan Ermilov <ru@nginx.com>
parents:
2134
diff
changeset
|
373 location /remote/ { |
2122
86a73b6f32f2
Added example to ssi include set.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2118
diff
changeset
|
374 subrequest_output_buffer_size 64k; |
86a73b6f32f2
Added example to ssi include set.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2118
diff
changeset
|
375 ... |
86a73b6f32f2
Added example to ssi include set.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2118
diff
changeset
|
376 } |
86a73b6f32f2
Added example to ssi include set.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2118
diff
changeset
|
377 </example> |
2118
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1875
diff
changeset
|
378 Prior to version 1.13.10, only the results of responses obtained using the |
994
f09f77ef45e9
Documented extended support of SSI "include virtual= set=".
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
379 <link doc="ngx_http_proxy_module.xml">ngx_http_proxy_module</link>, |
f09f77ef45e9
Documented extended support of SSI "include virtual= set=".
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
380 <link doc="ngx_http_memcached_module.xml">ngx_http_memcached_module</link>, |
f09f77ef45e9
Documented extended support of SSI "include virtual= set=".
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
381 <link doc="ngx_http_fastcgi_module.xml">ngx_http_fastcgi_module</link> (1.5.6), |
f09f77ef45e9
Documented extended support of SSI "include virtual= set=".
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
382 <link doc="ngx_http_uwsgi_module.xml">ngx_http_uwsgi_module</link> (1.5.6), |
f09f77ef45e9
Documented extended support of SSI "include virtual= set=".
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
383 and <link doc="ngx_http_scgi_module.xml">ngx_http_scgi_module</link> (1.5.6) |
2118
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1875
diff
changeset
|
384 modules could be written into variables. |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1875
diff
changeset
|
385 The maximum size of the response was set with the |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1875
diff
changeset
|
386 <link doc="ngx_http_proxy_module.xml" id="proxy_buffer_size"/>, |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1875
diff
changeset
|
387 <link doc="ngx_http_memcached_module.xml" id="memcached_buffer_size"/>, |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1875
diff
changeset
|
388 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_buffer_size"/>, |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1875
diff
changeset
|
389 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_buffer_size"/>, |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1875
diff
changeset
|
390 and <link doc="ngx_http_scgi_module.xml" id="scgi_buffer_size"/> |
0b3103eabdf1
Documented the "subrequest_output_buffer_size" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1875
diff
changeset
|
391 directives. |
399
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 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
394 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
395 |
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 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
399 <tag-name><literal>set</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
400 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
401 Sets a value of a variable. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
402 The command has the following parameters: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
403 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
404 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
405 <tag-name><literal>var</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
406 <tag-desc> |
966 | 407 the variable name. |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
408 </tag-desc> |
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 <tag-name><literal>value</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
411 <tag-desc> |
966 | 412 the variable value. |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
413 If an assigned value contains variables, |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
414 their values are substituted. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
415 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
416 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
417 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
418 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
419 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
420 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
421 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
422 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
423 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
424 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
425 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
426 <section id="variables" name="Embedded Variables"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
427 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
428 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
429 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
|
430 two embedded variables: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
431 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
432 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
994
diff
changeset
|
433 <tag-name id="var_date_local"><var>$date_local</var></tag-name> |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
434 <tag-desc> |
966 | 435 current time in the local time zone. |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
436 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
|
437 with the <literal>timefmt</literal> parameter. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
438 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
439 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
994
diff
changeset
|
440 <tag-name id="var_date_gmt"><var>$date_gmt</var></tag-name> |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
441 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
442 current time in GMT. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
443 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
|
444 with the <literal>timefmt</literal> parameter. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
445 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
446 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
447 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
448 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
449 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
450 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
451 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
452 </module> |